文档说明修改

This commit is contained in:
wangchengjun
2022-01-11 23:09:00 +08:00
parent f269ee11cb
commit daacb13cdd
2 changed files with 52 additions and 91 deletions
+3 -67
View File
@@ -25,7 +25,7 @@ jero-boot 低代码开发平台
- 语言:Java 8
- IDE(JAVA) Eclipse安装lombok插件 或者 IDEA
- IDE(JAVA)IDEA安装lombok插件
- 依赖管理:Maven
@@ -40,6 +40,7 @@ jero-boot 低代码开发平台
- 字段内容全部使用小写,多个单词之间使用 _ 隔开,并且每个字段需要有注释
- 每个表中都需要有id,用varchar(36
- 新建的表中必须要有创建人、创建时间、更新人、更新时间、所属部门五个字段
- id的增长规则设定保持统一,统一按照框架生成的内容形成
## 系统规范
@@ -56,13 +57,6 @@ jero-boot 低代码开发平台
系统导入使用注解`@ExcelImport`进行字段校验
- 系统常量定义在`com.jero.common.constant.CommonConstant`
## 技术文档
- 在线文档: [http://doc.xxx.com](http://doc.xxx.com)
- 常见问题: [http://xxx.com/doc/qa](http://xxx.com/doc/qa)
## 专项文档
#### 一、查询过滤器用法
@@ -111,63 +105,5 @@ QueryWrapper<?> queryWrapper = QueryGenerator.initQueryWrapper(?, req.getParamet
> 功能说明: 一键生成的代码(包括:controller、service、dao、mapper、entity、vue
- 模板位置: src/main/resources/jero/code-template
- 技术文档: http://doc.xxx.com/
- 文件配置路径: jero-boot/jero-boot-single-startup/src/main/resources/jero/jero_config.properties
#### 四、编码排重使用示例
重复校验效果:
![输入图片说明](https://static.oschina.net/uploads/img/201904/19191836_eGkQ.png "在这里输入图片标题")
1.引入排重接口,代码如下:
```
import { duplicateCheck } from '@/api/api'
```
2.找到编码必填校验规则的前端代码,代码如下:
```
<a-input placeholder="请输入编码" v-decorator="['code', validatorRules.code ]"/>
code: {
rules: [
{ required: true, message: '请输入编码!' },
{validator: this.validateCode}
]
},
```
3.找到rules里validator对应的方法在哪里,然后使用第一步中引入的排重校验接口.
以用户online表单编码为示例,其中四个必传的参数有:
```
{tableName:表名,fieldName:字段名,fieldVal:字段值,dataId:表的主键},
```
具体使用代码如下:
```
validateCode(rule, value, callback){
let pattern = /^[a-z|A-Z][a-z|A-Z|\d|_|-]{0,}$/;
if(!pattern.test(value)){
callback('编码必须以字母开头,可包含数字、下划线、横杠');
} else {
var params = {
tableName: "onl_cgreport_head",
fieldName: "code",
fieldVal: value,
dataId: this.model.id
};
duplicateCheck(params).then((res)=>{
if(res.success){
callback();
}else{
callback(res.message);
}
})
}
},
```
# 6.访问后台项目(注意要开启swagger)
http://localhost:8080/jero-boot/doc.html
```
+49 -24
View File
@@ -124,30 +124,55 @@ yarn run lint
> @vue/cli 升级后,eslint 规则更新了。由于影响到全部 .vue 文件,需要逐个验证。既暂时关闭部分原本不验证的规则,后期维护时,在逐步修正这些 rules
Docker 镜像使用
----
#### 编码排重使用示例
```
# 1.修改前端项目的后台域名
.env.development
域名改成: http://Jero-boot-system:8080/Jero-boot
# 2.先进入打包前端项目
yarn run build
重复校验效果:
![输入图片说明](https://static.oschina.net/uploads/img/201904/19191836_eGkQ.png "在这里输入图片标题")
# 3.构建镜像
docker build -t nginx:jeroboot .
# 4.启动镜像
docker run --name Jero-boot-nginx -p 80:80 -d nginx:jeroboot
# 5.配置host
# jeroboot
127.0.0.1 Jero-boot-redis
127.0.0.1 Jero-boot-mysql
127.0.0.1 Jero-boot-system
1.引入排重接口,代码如下:
```
import { duplicateCheck } from '@/api/api'
```
2.找到编码必填校验规则的前端代码,代码如下:
# 6.访问前台项目
http://localhost:80
```
```
<a-input placeholder="请输入编码" v-decorator="['code', validatorRules.code ]"/>
code: {
rules: [
{ required: true, message: '请输入编码!' },
{validator: this.validateCode}
]
},
```
3.找到rules里validator对应的方法在哪里,然后使用第一步中引入的排重校验接口.
以用户online表单编码为示例,其中四个必传的参数有:
```
{tableName:表名,fieldName:字段名,fieldVal:字段值,dataId:表的主键},
```
具体使用代码如下:
```
validateCode(rule, value, callback){
let pattern = /^[a-z|A-Z][a-z|A-Z|\d|_|-]{0,}$/;
if(!pattern.test(value)){
callback('编码必须以字母开头,可包含数字、下划线、横杠');
} else {
var params = {
tableName: "onl_cgreport_head",
fieldName: "code",
fieldVal: value,
dataId: this.model.id
};
duplicateCheck(params).then((res)=>{
if(res.success){
callback();
}else{
callback(res.message);
}
})
}
},
```