如何高效而简洁的进行参数校验

我们先看看简单而常用的参数校验

   @PostMapping("insertTicket")

   public Result insertTicket(@RequestBody InsertTicketRequest ticketRequest) {

       Result result = new Result();

       // 校验非空

       if (!StringUtils.hasLength(ticketRequest.getName())) {

           result.setSuccess(false);

           result.setMsg("name is empty");

           return result;

       }

       // 校验邮箱

       String regEx1 = "^([a-z0-9A-Z]+[-|\\.]?)+[a-z0-9A-Z]@([a-z0-9A-Z]+(-[a-z0-9A-Z]+)?\\.)+[a-zA-Z]{2,}$";

       Pattern p = Pattern.compile(regEx1);

       Matcher m = p.matcher(ticketRequest.getEmail());

       if (!m.matches()) {

           result.setSuccess(false);

           result.setMsg("email is incorrect");

           return result;

       }

       // 其他校验。。。

       // 此处才开始编写功能

       TicketInfo ticketInfo = new TicketInfo();

       BeanUtils.copyProperties(ticketRequest, ticketInfo);

       ticketInfoService.insertOne(ticketInfo);

       result.setSuccess(true);

       return result;

   }

我们可以看到代码大部分都被校验给占用了，而且行数还不少！

项目中有使用Preconditions，但用起来却也不尽如人意。

推动世界前进的人开始思考，有没有更加简洁的校验方式？

有！

例如接下来我们要介绍的Hibernate Validator。

使用步骤：

1. 引入jar包

<dependency>

   <groupId>org.hibernate.validatorgroupId>

   <artifactId>hibernate-validatorartifactId>

   <version>7.0.0.Finalversion>

dependency>

<dependency>

   <groupId>javax.validationgroupId>

   <artifactId>validation-apiartifactId>

   <version>2.0.1.Finalversion>

dependency>

或者直接使用spring-boot-starter-validation，也是依赖Hibernate Validator

<dependency>

   <groupId>org.springframework.bootgroupId>

   <artifactId>spring-boot-starter-validationartifactId>

   <version>2.5.5version>

dependency>

2. @RequestBody此处加入@Valid，启用注解校验

@PostMapping("insertTicketValid")

public Result insertTicketValid(@Valid @RequestBody InsertTicketRequest ticketRequest) {

   Result result = new Result();

   TicketInfo ticketInfo = new TicketInfo();

   BeanUtils.copyProperties(ticketRequest, ticketInfo);

   ticketInfoService.insertOne(ticketInfo);

   result.setSuccess(true);

   return result;

}

3. 添加字段校验注解

@Data

public class InsertTicketRequest {

   @NotEmpty

   private String ticketCode;

   @NotEmpty(message = "用户名称不能为空")

   @Size(max = 32, message = "名字过长")

   private String name;

   @Email(message = "Email格式不对")

   private String email;

   @Min(value = 0, message = "年龄必须大于0")

   private int age;

   @NotEmpty

   private String mobile;

}

4. 如果是单个参数校验, 则在类上加@Validated

@Validated

@RestController

@RequestMapping("/ticket")

public class TicketController {

   @Autowired

   TicketInfoService ticketInfoService;

   @GetMapping("listSuggestion")

   public Result listSuggestion(@RequestParam @NotNull Long auditContentId)    {

       // ...

   }

优点总结

• 将校验逻辑剥离出去，降低耦合
  
• 以注解形式实现校验，减少代码
  
• 配合Lombok使用，让实体类短小而精悍

常用的校验注解