Java参数校验（最佳实践）

验证参数

关于JSR-303规范 JSR-303是JAVA
EE6中的一项子规范，validation-api是一套标准（JSR-303），叫做Bean
Validation，Hibernate
Validator是Bean Validation的参考实现，提供了JSR-303
规范中所有内置constraint的实现，除此之外Hibernate Validator还附加了一些constraint。

1、校验常用的值Apache Commons Validator完成常用的校验

<dependency><groupId>commons-validator</groupId><artifactId>commons-validator</artifactId><version>1.7</version>
</dependency>

2、校验非空，大小，数字，布尔，范围等使用（javax.validation.validation-api）

如果是Spring Boot项目工程，可忽略此步骤，因为在Spring Boot组件内部已经内置了validation-api

<dependency><groupId>javax.validation</groupId><artifactId>validation-api</artifactId><version>1.1.0.Final</version>
</dependency>

3、校验非空，大小，数字，布尔，范围等使用（org.hibernate.hibernate-validator）

如果是Spring Boot项目工程，可忽略此步骤，因为在Spring Boot组件内部已经内置了hibernate-validator

<dependency><groupId>org.hibernate</groupId><artifactId>hibernate-validator</artifactId><version>5.2.0.Final</version>
</dependency>

使用

package com.b2c.aiyou.device.inventory.dto;import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.*;
import lombok.experimental.Accessors;import javax.validation.constraints.*;
import java.io.Serializable;
import java.util.Date;
import java.util.List;@Data
@ToString
@Builder
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@ApiModel
public class InventoryEntity implements Serializable {private static final long serialVersionUID = 1L;/*** 类别CODE*/@NotBlank(message = "类别CODE不能为Null")@Size(min = 8, max = 32, message = "类别CODE长度必须在{min}~{max}之间")@ApiModelProperty(value = "类别CODE")private String categoryCode;/*** 类型CODE*/@NotBlank(message = "类型CODE不能为Null")@Size(min = 8, max = 32, message = "类型长度必须在{min}~{max}之间")@ApiModelProperty(value = "类型CODE")private String typeCode;/*** 最高库存量*/@DecimalMax(value = "100000", message = "最高库存量必须小于或等于{value}")@ApiModelProperty(value = "最高库存量")private Integer inventoryMax;/*** 最低库存量*/@DecimalMin(value = "100", message = "最低库存量必须大于或等于{value}")@ApiModelProperty(value = "最低库存量")private Integer inventoryMin;/*** 最小进货量*/@Min(value = 100, message = "最小进货量必须大于或等于{value}")@ApiModelProperty(value = "最小进货量")private Integer restockMin;/*** 最大进货量*/@Max(value = 10000, message = "最大进货量必须小于或等于{value}")@ApiModelProperty(value = "最大进货量")private Integer restockMax;/*** 进货日期*/@Future(message = "进货日期必须大于当前日期")@ApiModelProperty(value = "进货日期")private Date restockTime;/*** 进货周期*/@NotEmpty(message = "进货周期不能为Null")@ApiModelProperty(value = "进货日期")private List<String> periodTime;/*** 备注*/@ApiModelProperty(value = "备注")@Size(min = 50, max = 500, message = "备注内容必须在{min}~{max}之间")private String remark;}

package com.b2c.aiyou.device.inventory.dto;import com.b2c.aiyou.device.common.annotation.Log;
import com.b2c.aiyou.device.inventory.service.IInventoryService;
import com.b2c.aiyou.common.constant.ResultCodeEnum;
import com.b2c.aiyou.common.result.AppException;
import com.b2c.aiyou.common.result.JSONResult;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;import javax.validation.Valid;@Slf4j
@RestController
@RequestMapping("/inventory")
public class InventoryController {@PostMapping("/addInventory")public JSONResult addInventory(@Valid @RequestBody InventoryDTO inventoryDTO, BindingResult bindingResult) {try {// 字段校验if (bindingResult.hasErrors()) {return JSONResult.failure(bindingResult);}// TODO 其它校验int result = this.inventoryService.insertInventory(inventoryDTO);if (result > 0) {// 成功处理逻辑return JSONResult.success();} else {// 失败处理逻辑return JSONResult.failure();}} catch (AppException e) {log.info("异常信息:{}", e);return JSONResult.failure(ResultCodeEnum.Failure.getCode(), e.getMessage());}}}

注意：在需要校验的对象后面，必须添加BindingResult来接收校验结果，并对校验结果进行处理bindingResult.hasErrors()，否则校验无意义。

直接在controller里面使用BindingResult，来处理结果，不是太友好。一般在controller里面不加BindingResult，校验参数出现的异常，通过全局异常进行捕获处理

/*** 方法参数校验* @param exception 参数校验异常* @return 错误信息*/
@ExceptionHandler(MethodArgumentNotValidException.class)
public Result<String> handleMethodArgumentNotValidException(final MethodArgumentNotValidException exception) {final String errorMessage = exception.getBindingResult().getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining("; "));log.error("参数校验异常: {}", errorMessage, exception);return ResultUtil.fail(errorMessage);
}

4、总结

1、不管项目是springmvc还是springboot项目，都是可以使用validation-api来做参数校验，校验出现的异常，可以通过全局异常进行捕获处理。

2、在controller层校验成功的前提是，对传入的参数，前面加上@Valid注解

3、在 Controller 类中添加接口，POST 方法中接收设置了 @Valid 相关注解的实体对象，然后在参数中添加 @Valid 注解来开启效验功能，需要注意的是， @Valid 对 Get 请求中接收的平面参数请求无效，一般可以进行手动校验参数，抛出自定义参数错误异常

4、对于一些校验邮箱、ip等，可以使用Apache Commons Validator完成常用的校验

5、一般hibernate-validator校验参数使用的比较少，一般使用其他两个即可

6、如果实体类有嵌套的话，嵌套实体类上要加上@Valid注解