Browse Source

add 代码生成器 增加校验注解

疯狂的狮子li 4 years ago
parent
commit
d2c745d3fd

+ 5 - 2
README.md

@@ -13,7 +13,7 @@
 * 监控框架 spring-boot-admin 全方位服务监控
 * 校验框架 validation 增强接口安全性 严谨性
 * 文档框架 knife4j 美化接口文档
-* 代码生成器可以一键生成前后端代码
+* 代码生成器 一键生成前后端代码
 
 ## 修改RuoYi功能
 
@@ -32,17 +32,20 @@
 ### 代码改动
 
 * 所有原生功能使用 Mybatis-Plus 与 Lombok 重写
+* 增加 IServicePlus 与 BaseMapperPlus 可自定义通用方法
 * 代码生成模板 改为适配 Mybatis-Plus 的代码
 * 代码生成模板 拆分出 Vo,QueryBo,AddBo,EditBo 等领域对象
-* 增加 IServicePlus 与 BaseMapperPlus 可自定义通用方法
+* 代码生成模板 增加 文档注解 与 校验注解 简化通用操作
 * 项目修改为 maven多环境配置
 * 项目配置修改为 application.yml 统一管理
 
 ### 其他
+
 * 同步升级 RuoYi-Vue 3.4.0
 * 单模块 fast 分支 [RuoYi-Vue-Plus-fast](https://gitee.com/JavaLionLi/RuoYi-Vue-Plus/tree/fast/)
 
 ## 关注作者(扫码请备注: "加群")
+
 ![](https://images.gitee.com/uploads/images/2021/0508/235345_5503356a_1766278.jpeg)
 
 ## 重点注意事项

+ 6 - 0
ruoyi-generator/src/main/resources/vm/java/addBo.java.vm

@@ -5,6 +5,7 @@ import io.swagger.annotations.ApiModelProperty;
 import com.fasterxml.jackson.annotation.JsonFormat;
 import lombok.Data;
 import java.util.Date;
+import javax.validation.constraints.*;
 
 
 #foreach ($import in $importList)
@@ -27,6 +28,11 @@ public class ${ClassName}AddBo {
     @ApiModelProperty("$column.columnComment")
 #if($column.javaType == 'Date')
     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+#end
+#if($column.javaType == 'String')
+    @NotBlank(message = "$column.columnComment不能为空")
+#else
+    @NotNull(message = "$column.columnComment不能为空")
 #end
     private $column.javaType $column.javaField;
 #end

+ 12 - 15
ruoyi-generator/src/main/resources/vm/java/controller.java.vm

@@ -4,16 +4,11 @@ import java.util.List;
 import java.util.Arrays;
 
 import lombok.RequiredArgsConstructor;
+import javax.validation.constraints.*;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.PutMapping;
-import org.springframework.web.bind.annotation.DeleteMapping;
-import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.RequestBody;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.*;
+import org.springframework.validation.annotation.Validated;
 import com.ruoyi.common.annotation.Log;
 import com.ruoyi.common.core.controller.BaseController;
 import com.ruoyi.common.core.domain.AjaxResult;
@@ -52,11 +47,11 @@ public class ${ClassName}Controller extends BaseController {
     @PreAuthorize("@ss.hasPermi('${permissionPrefix}:list')")
     @GetMapping("/list")
 #if($table.crud || $table.sub)
-    public TableDataInfo<${ClassName}Vo> list(${ClassName}QueryBo bo) {
+    public TableDataInfo<${ClassName}Vo> list(@Validated ${ClassName}QueryBo bo) {
         return i${ClassName}Service.queryPageList(bo);
     }
 #elseif($table.tree)
-    public AjaxResult<List<${ClassName}Vo>> list(${ClassName}QueryBo bo) {
+    public AjaxResult<List<${ClassName}Vo>> list(@Validated ${ClassName}QueryBo bo) {
         List<${ClassName}Vo> list = i${ClassName}Service.queryList(bo);
         return AjaxResult.success(list);
     }
@@ -69,7 +64,7 @@ public class ${ClassName}Controller extends BaseController {
     @PreAuthorize("@ss.hasPermi('${permissionPrefix}:export')")
     @Log(title = "${functionName}", businessType = BusinessType.EXPORT)
     @GetMapping("/export")
-    public AjaxResult<${ClassName}Vo> export(${ClassName}QueryBo bo) {
+    public AjaxResult<${ClassName}Vo> export(@Validated ${ClassName}QueryBo bo) {
         List<${ClassName}Vo> list = i${ClassName}Service.queryList(bo);
         ExcelUtil<${ClassName}Vo> util = new ExcelUtil<${ClassName}Vo>(${ClassName}Vo.class);
         return util.exportExcel(list, "${functionName}");
@@ -81,7 +76,8 @@ public class ${ClassName}Controller extends BaseController {
     @ApiOperation("获取${functionName}详细信息")
     @PreAuthorize("@ss.hasPermi('${permissionPrefix}:query')")
     @GetMapping("/{${pkColumn.javaField}}")
-    public AjaxResult<${ClassName}Vo> getInfo(@PathVariable("${pkColumn.javaField}" ) ${pkColumn.javaType} ${pkColumn.javaField}) {
+    public AjaxResult<${ClassName}Vo> getInfo(@NotNull(message = "主键不能为空")
+                                                  @PathVariable("${pkColumn.javaField}") ${pkColumn.javaType} ${pkColumn.javaField}) {
         return AjaxResult.success(i${ClassName}Service.queryById(${pkColumn.javaField}));
     }
 
@@ -92,7 +88,7 @@ public class ${ClassName}Controller extends BaseController {
     @PreAuthorize("@ss.hasPermi('${permissionPrefix}:add')")
     @Log(title = "${functionName}", businessType = BusinessType.INSERT)
     @PostMapping()
-    public AjaxResult<Void> add(@RequestBody ${ClassName}AddBo bo) {
+    public AjaxResult<Void> add(@Validated @RequestBody ${ClassName}AddBo bo) {
         return toAjax(i${ClassName}Service.insertByAddBo(bo) ? 1 : 0);
     }
 
@@ -103,7 +99,7 @@ public class ${ClassName}Controller extends BaseController {
     @PreAuthorize("@ss.hasPermi('${permissionPrefix}:edit')")
     @Log(title = "${functionName}", businessType = BusinessType.UPDATE)
     @PutMapping()
-    public AjaxResult<Void> edit(@RequestBody ${ClassName}EditBo bo) {
+    public AjaxResult<Void> edit(@Validated @RequestBody ${ClassName}EditBo bo) {
         return toAjax(i${ClassName}Service.updateByEditBo(bo) ? 1 : 0);
     }
 
@@ -114,7 +110,8 @@ public class ${ClassName}Controller extends BaseController {
     @PreAuthorize("@ss.hasPermi('${permissionPrefix}:remove')")
     @Log(title = "${functionName}" , businessType = BusinessType.DELETE)
     @DeleteMapping("/{${pkColumn.javaField}s}")
-    public AjaxResult<Void> remove(@PathVariable ${pkColumn.javaType}[] ${pkColumn.javaField}s) {
+    public AjaxResult<Void> remove(@NotEmpty(message = "主键不能为空")
+                                       @PathVariable ${pkColumn.javaType}[] ${pkColumn.javaField}s) {
         return toAjax(i${ClassName}Service.deleteWithValidByIds(Arrays.asList(${pkColumn.javaField}s), true) ? 1 : 0);
     }
 }

+ 6 - 0
ruoyi-generator/src/main/resources/vm/java/editBo.java.vm

@@ -5,6 +5,7 @@ import io.swagger.annotations.ApiModelProperty;
 import com.fasterxml.jackson.annotation.JsonFormat;
 import lombok.Data;
 import java.util.Date;
+import javax.validation.constraints.*;
 
 #foreach ($import in $importList)
 import ${import};
@@ -27,6 +28,11 @@ public class ${ClassName}EditBo {
     @ApiModelProperty("$column.columnComment")
 #if($column.javaType == 'Date')
     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
+#end
+#if($column.javaType == 'String')
+    @NotBlank(message = "$column.columnComment不能为空")
+#else
+    @NotNull(message = "$column.columnComment不能为空")
 #end
     private $column.javaType $column.javaField;
 #end

+ 7 - 2
ruoyi-generator/src/main/resources/vm/java/queryBo.java.vm

@@ -6,8 +6,7 @@ import lombok.Data;
 import lombok.EqualsAndHashCode;
 
 import java.util.Date;
-import java.util.Map;
-import java.util.HashMap;
+import javax.validation.constraints.*;
 
 #foreach ($import in $importList)
 import ${import};
@@ -29,6 +28,7 @@ import com.ruoyi.common.core.domain.TreeEntity;
 #elseif($table.tree)
 #set($Entity="TreeEntity")
 #end
+
 @Data
 @EqualsAndHashCode(callSuper = true)
 @ApiModel("${functionName}分页查询对象")
@@ -55,6 +55,11 @@ public class ${ClassName}QueryBo extends ${Entity} {
 	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
 #end
 	@ApiModelProperty("$column.columnComment")
+#if($column.javaType == 'String')
+	@NotBlank(message = "$column.columnComment不能为空")
+#else
+	@NotNull(message = "$column.columnComment不能为空")
+#end
 	private $column.javaType $column.javaField;
 #end
 #end

+ 14 - 13
ruoyi-ui/src/views/index.vue

@@ -5,19 +5,20 @@
         <h2>RuoYi-Vue-Plus后台管理框架</h2>
         <p>
           基于 RuoYi-Vue 集成 Mybatis-Plus Lombok Hutool 等便捷开发工具 适配重写相关业务 便于开发 定期与 RuoYi-Vue 同步
-          * 前端开发框架 Vue、Element UI
-          * 后端开发框架 Spring Boot、Redis
-          * 容器框架 Undertow 基于 Netty 的高性能容器
-          * 权限认证框架 Spring Security、Jwt,支持多终端认证系统
-          * 关系数据库 MySQL 适配 8.X
-          * 缓存数据库 Redis 适配 6.X
-          * 数据库开发框架 Mybatis-Plus 快速 CRUD 增加开发效率 插件化支持各类需求
-          * 网络框架 Feign、OkHttp3 接口化管理 HTTP 请求
-          * 工具类框架 Hutool、Lombok 减少代码冗余 增加安全性
-          * 监控框架 spring-boot-admin 全方位服务监控
-          * 校验框架 validation 增强接口安全性 严谨性
-          * 文档框架 knife4j 美化接口文档
-          * 代码生成器可以一键生成前后端代码
+          <br/>
+          * 前端开发框架 Vue、Element UI<br/>
+          * 后端开发框架 Spring Boot、Redis<br/>
+          * 容器框架 Undertow 基于 Netty 的高性能容器<br/>
+          * 权限认证框架 Spring Security、Jwt,支持多终端认证系统<br/>
+          * 关系数据库 MySQL 适配 8.X<br/>
+          * 缓存数据库 Redis 适配 6.X<br/>
+          * 数据库开发框架 Mybatis-Plus 快速 CRUD 增加开发效率 插件化支持各类需求<br/>
+          * 网络框架 Feign、OkHttp3 接口化管理 HTTP 请求<br/>
+          * 工具类框架 Hutool、Lombok 减少代码冗余 增加安全性<br/>
+          * 监控框架 spring-boot-admin 全方位服务监控<br/>
+          * 校验框架 validation 增强接口安全性 严谨性<br/>
+          * 文档框架 knife4j 美化接口文档<br/>
+          * 代码生成器 一键生成前后端代码<br/>
         </p>
         <p>
           <b>当前版本:</b> <span>v{{ version }}</span>