如何实现 Java SpringBoot 自动验证入参数据的有效性

Java SpringBoot 通过javax.validation.constraints下的注解，实现入参数据自动验证
如果碰到 @NotEmpty  否则不生效，注意看下 @RequestBody 前面是否加上了@Valid
Validation常用注解汇总

Constraint详细信息@Null被注释的元素必须为 null@NotNull被注释的元素必须不为 null@NotBlank被注释的元素不能为空（空格视为空）@NotEmpty被注释的元素不能为空 (允许有空格)@Size(max, min)被注释的元素的大小必须在指定的范围内@Min(value)被注释的元素必须是一个数字，其值必须大于等于指定的最小值@Max(value)被注释的元素必须是一个数字，其值必须小于等于指定的最大值@Pattern(value)被注释的元素必须符合指定的正则表达式@DecimalMin(value)被注释的元素必须是一个数字，其值必须大于等于指定的最小值@DecimalMax(value)被注释的元素必须是一个数字，其值必须小于等于指定的最大值@AssertTrue被注释的元素必须为 true@AssertFalse被注释的元素必须为 false@Digits (integer, fraction)被注释的元素必须是一个数字，其值必须在可接受的范围内@Past被注释的元素必须是一个过去的日期@Future被注释的元素必须是一个将来的日期示例

1. /**
2.    * 用户名
3.    */
4.   @NotBlank(message = "用户名不能为空")
5.   private String username;
6.   /**
7.    * 用户真实姓名
8.    */
9.   @NotBlank(message = "用户真实姓名不能为空")
10.   private String name;
12.   /**
13.    * 密码
14.    */
15.   @Pattern(regexp = "^(?:(?=.*[A-Z])(?=.*[a-z])(?=.*[0-9])(?=.*[^A-Za-z0-9]))(?=^[^\\u4e00-\\u9fa5]{0,}$).{8,20}$", message = "密码过于简单有被盗风险，请保证密码大于8位，并且由大小写字母、数字，特殊符号组成")  
16.   private String password;
18.   /**
19.    * 邮箱
20.    */
21.   @NotBlank(message = "邮箱不能为空")
22.   @Email(message = "邮箱格式不正确")
23.   private String email;
25.   /**
26.    * 手机号
27.    */
28.   @NotBlank(message = "手机号不能为空")
29.   @Pattern(regexp = "^(1[0-9])\\d{9}$", message = "手机号格式不正确")
30.   private String mobile;

复制代码

Demo

入参对象上，添加注解及说明

1. package com.vipsoft.web.entity;
3. import javax.validation.constraints.NotBlank;
4. import javax.validation.constraints.Size;
5. import java.io.Serializable;
7. /**
8. * 定时任务调度
9. */
10. public class QuartzJob implements Serializable {
12.     private static final long serialVersionUID = 1L;
14.     /**
15.      * 任务序号
16.      */
17.     private long jobId;
19.     /**
20.      * 任务名称
21.      */
22.     @NotBlank(message = "任务名称不能为空")
23.     @Size(max = 10, message = "任务名称不能超过10个字符")
24.     private String jobName;
26.     /**
27.      * 任务组名
28.      */
29.     @NotBlank(message = "任务组名不能为空")
30.     @Size(max = 10, message = "任务组名不能超过10个字符")
31.     private String jobGroup;
33.     /**
34.      * 调用目标字符串
35.      */
36.     private String invokeTarget;
38.     /**
39.      * 执行表达式
40.      */
41.     private String cronExpression;
43.     /**
44.      * cron计划策略 0=默认,1=立即触发执行,2=触发一次执行,3=不触发立即执行
45.      */
46.     private String misfirePolicy = "0";
48.     /**
49.      * 并发执行 0=允许,1=禁止
50.      */
51.     private String concurrent;
53.     /**
54.      * 任务状态（0正常 1暂停）
55.      */
56.     private String status;
58.     /**
59.      * 备注
60.      */
61.     private String remark;
62. }

复制代码

Controller @RequestBody 前面必须加上 @Valid 否则不生效

1. import javax.validation.Valid;
3. @RestController
4. @RequestMapping("schedule")
5. public class ScheduleController {
7.     private Logger logger = LoggerFactory.getLogger(ScheduleController.class);
9.     @Autowired
10.     IQuartzJobService jobService;
12.     @RequestMapping("/add")
13.     public ApiResult addTask(@Valid @RequestBody QuartzJob param) throws Exception {
14.         logger.info("添加调度任务 => {} ", JSONUtil.toJsonStr(param));
15.         
16.         return new ApiResult("添加成功");
17.     }
18. }

复制代码

异常处理，统一返回对象，方便前端解析
GlobalExceptionHandler

1. package com.vipsoft.web.exception;
3. import cn.hutool.core.util.StrUtil;
4. import com.vipsoft.web.utils.ApiResult;
5. import org.slf4j.Logger;
6. import org.slf4j.LoggerFactory;
7. import org.springframework.validation.BindException;
8. import org.springframework.validation.BindingResult;
9. import org.springframework.validation.FieldError;
10. import org.springframework.validation.ObjectError;
11. import org.springframework.web.HttpRequestMethodNotSupportedException;
12. import org.springframework.web.bind.MethodArgumentNotValidException;
13. import org.springframework.web.bind.annotation.ExceptionHandler;
14. import org.springframework.web.bind.annotation.RestControllerAdvice;
16. import java.util.List;
18. /**
19. * 全局异常处理器
20. */
21. @RestControllerAdvice
22. public class GlobalExceptionHandler {
24.     private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
26.     /**
27.      * 处理自定义异常
28.      */
29.     @ExceptionHandler(CustomException.class)
30.     public ApiResult handleException(CustomException e) {
31.         // 打印异常信息
32.         logger.error("### 异常信息:{} ###", e.getMessage());
33.         return new ApiResult(e.getCode(), e.getMessage());
34.     }
36.     /**
37.      * 参数错误异常
38.      */
39.     @ExceptionHandler({MethodArgumentNotValidException.class, BindException.class})
40.     public ApiResult handleException(Exception e) {
41.         if (e instanceof MethodArgumentNotValidException) {
42.             MethodArgumentNotValidException validException = (MethodArgumentNotValidException) e;
43.             BindingResult result = validException.getBindingResult();
44.             StringBuffer errorMsg = new StringBuffer();
45.             if (result.hasErrors()) {
46.                 List<ObjectError> errors = result.getAllErrors();
47.                 errors.forEach(p -> {
48.                     FieldError fieldError = (FieldError) p;
49.                     errorMsg.append(fieldError.getDefaultMessage()).append(",");
50.                     logger.error("### 请求参数错误：{" + fieldError.getObjectName() + "},field{" + fieldError.getField() + "},errorMessage{" + fieldError.getDefaultMessage() + "}");
51.                 });
52.                 return new ApiResult(6001, errorMsg.toString());
53.             }
54.         } else if (e instanceof BindException) {
55.             BindException bindException = (BindException) e;
56.             if (bindException.hasErrors()) {
57.                 logger.error("### 请求参数错误: {}", bindException.getAllErrors());
58.             }
59.         }
60.         return new ApiResult(6001, "参数无效");
61.     }
63.     /**
64.      * 处理HttpRequestMethodNotSupporte异常
65.      * @param e
66.      * @return
67.      */
68.     @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
69.     public Object methodHandler(HttpRequestMethodNotSupportedException e) {
70.         // 打印异常信息
71.         logger.error("### 异常信息:{} ###", e.getMessage());
72.         return new ApiResult(6000, e.getMessage());
73.     }
75.     /**
76.      * 处理所有不可知的异常
77.      */
78.     @ExceptionHandler(Exception.class)
79.     public ApiResult handleOtherException(Exception e) {
80.         // 打印异常信息
81.         logger.error("### 系统内部错误:{} ###", e.getMessage(), e);
82.         String warnMsg = StrUtil.isEmpty(e.getMessage()) ? "### 系统内部错误 ###" : e.getMessage();
83.         return new ApiResult(6000, "系统内部错误", e.getMessage());
84.     }
86. }

复制代码

统一返回对像 ApiResult

1. package com.vipsoft.web.utils;
4. //import com.github.pagehelper.PageInfo;
6. import java.io.Serializable;
8. public class ApiResult implements Serializable {
10.     /**
11.      * 返回编码 0:失败、1：成功
12.      */
13.     private int code;
15.     /**
16.      * 返回消息
17.      */
18.     private String message;
20.     /**
21.      * 返回对象
22.      */
23.     private Object data;
25.     /**
26.      * 分页对象
27.      */
28.     private Page page;
30.     public ApiResult() {
31.         this.code = 1;
32.         this.message = "请求成功";
33.     }
35.     public ApiResult(Integer code, String message) {
36.         this.code = code;
37.         this.message = message;
38.     }
40.     public ApiResult(Integer code, String message, Object data) {
41.         this.code = code;
42.         this.message = message;
43.         this.setData(data);
44.     }
46.     public ApiResult(Object data) {
47.         this.code = 1;
48.         this.message = "请求成功";
49.         this.setData(data);
50.     }
52. //    public ApiResult(PageInfo pageInfo) {
53. //        this.code = 1;
54. //        this.message = "请求成功";
55. //        this.setData(pageInfo.getList());
56. //        this.setPage(convertToPage(pageInfo));
57. //    }
58. //
59. //    public Page convertToPage(PageInfo pageInfo) {
60. //        Page result = new Page();
61. //        result.setTotalCount(pageInfo.getTotal());
62. //        result.setPageNum(pageInfo.getPageNum());
63. //        result.setPageCount(pageInfo.getPages());
64. //        result.setPageSize(pageInfo.getPageSize());
65. //        result.setPrePage(pageInfo.getPrePage());
66. //        result.setNextPage(pageInfo.getNextPage());
67. //        return result;
68. //    }
70.     public int getCode() {
71.         return code;
72.     }
74.     public void setCode(int code) {
75.         this.code = code;
76.     }
78.     public String getMessage() {
79.         return message;
80.     }
82.     public void setMessage(String message) {
83.         this.message = message;
84.     }
86.     public Object getData() {
87.         return data;
88.     }
90.     public void setData(Object data) {
91.         this.data = data;
92.     }
94.     public Page getPage() {
95.         return page;
96.     }
98.     public void setPage(Page page) {
99.         this.page = page;
100.     }
101. }

复制代码

运行结果如下


免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！