优质文章，及时送达

作者 | 锦成同学

链接 | juejin.im/post/5d3fbeb46fb9a06b317b3c48

很痛苦遇到大量的参数进行校验,在业务中还要抛出异常或者不断的返回异常时的校验信息,在代码中相当冗长, 充满了if-else这种校验代码,今天我们就来学习 Spring 的javax.validation 注解式参数校验。

1. javax.validation的一系列注解可以帮我们完成参数校验,免去繁琐的串行校验

不然我们的代码就像下面这样:

<code>@PostMapping("/save/serial")/<code><code> public Object save(@RequestBody UserVO userVO) {/<code><code> String mobile = userVO.getMobile;/<code>
<code> //手动逐个 参数校验~ 写法/<code><code> if (StringUtils.isBlank(mobile)) {/<code><code> return RspDTO.paramFail("mobile:手机号码不能为空");/<code><code> } else if (!Pattern.matches("^[1][3,4,5,6,7,8,9][0-9]{9}$", mobile)) {/<code><code> return RspDTO.paramFail("mobile:手机号码格式不对");/<code><code> }/<code>
<code> //抛出自定义异常等~写法/<code><code> if (StringUtils.isBlank(userVO.getUsername)) {/<code><code> throw new BizException(Constant.PARAM_FAIL_CODE, "用户名不能为空");/<code><code> }/<code>
<code> // 比如写一个map返回/<code><code> if (StringUtils.isBlank(userVO.getSex)) {/<code><code> Map<string> result = new HashMap<>(5);/<string>/<code><code> result.put("code", Constant.PARAM_FAIL_CODE);/<code><code> result.put("msg", "性别不能为空");/<code><code> return result;/<code><code> }/<code><code> //.........各种写法 .../<code><code> userService.save(userVO);/<code><code> return RspDTO.success;/<code><code>}/<code>

这被大佬看见,一定说,都9102了还这么写,然后被劝退了…..

2. 什么是javax.validation

JSR303 是一套JavaBean参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们JavaBean的属性上面(面向注解编程的时代)，就可以在需要校验的时候进行校验了,在SpringBoot中已经包含在starter-web中,再其他项目中可以引用依赖,并自行调整版本:

<code> /<code><code> <dependency>/<code><code> <groupid>javax.validation/<groupid>/<code><code> <artifactid>validation-api/<artifactid>/<code><code> <version>1.1.0.Final/<version>/<code><code> /<code><code> /<code><code> <dependency>/<code><code> <groupid>org.hibernate/<groupid>/<code><code> <artifactid>hibernate-validator/<artifactid>/<code><code> <version>5.2.0.Final/<version>/<code><code> /<code>

3. 注解说明

• @Not：不能为，但可以为empty(""," "," ")

• @NotEmpty：不能为，而且长度必须大于0 (" "," ")

• @NotBlank：只能作用在String上，不能为，而且调用trim后，长度必须大于0("test") 即：必须有实际字符

此处只列出Hibernate Validator提供的大部分验证约束注解，请参考hibernate validator官方文档了解其他验证约束注解和进行自定义的验证约束注解定义。

实战演练

话不多说,直接走实践路线,同样使用的是SpringBoot的快速框架

详细代码见:

https://github.com/leaJone/mybot

1. @Validated 声明要检查的参数

<code> /**/<code><code> * 走参数校验注解/<code><code> */<code><code> * @param userDTO/<code><code> * @return/<code><code> *//<code><code> @PostMapping("/save/valid")/<code><code> public RspDTO save(@RequestBody @Validated UserDTO userDTO) {/<code><code> userService.save(userDTO);/<code><code> return RspDTO.success;/<code><code> }/<code>

2. 对参数的字段进行注解标注

<code>@Data/<code><code>public class UserDTO implements Serializable {/<code>
<code> private static final long serialVersionUID = 1L;/<code>
<code> /*** 用户ID*//<code><code> @Not(message = "用户id不能为空")/<code><code> private Long userId;/<code>
<code> /** 用户名*//<code><code> @NotBlank(message = "用户名不能为空")/<code><code> @Length(max = 20, message = "用户名不能超过20个字符")/<code><code> @Pattern(regexp = "^[\\\\\\u4E00-\\\\\\u9FA5A-Za-z0-9\\\\*]*$", message = "用户昵称限制：最多20字符，包含文字、字母和数字")/<code><code> private String username;/<code>
<code> /** 手机号*//<code><code> @NotBlank(message = "手机号不能为空")/<code><code> @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误")/<code><code> private String mobile;/<code>
<code> /**性别*//<code><code> private String sex;/<code>
<code> /** 邮箱*//<code><code> @NotBlank(message = "联系邮箱不能为空")/<code><code> @Email(message = "邮箱格式不对")/<code><code> private String email;/<code>
<code> /** 密码*//<code><code> private String password;/<code>
<code> /*** 创建时间 *//<code><code> @Future(message = "时间必须是将来时间")/<code><code> private Date createTime;/<code>
<code>}/<code>

3. 在全局校验中增加校验异常

MethodArgumentNotValidException是springBoot中进行绑定参数校验时的异常,需要在springBoot中处理,其他需要处理ConstraintViolationException异常进行处理.

为了优雅一点,我们将参数异常,业务异常,统一做了一个全局异常,将控制层的异常包装到我们自定义的异常中.

为了优雅一点,我们还做了一个统一的结构体,将请求的code,和msg,data一起统一封装到结构体中,增加了代码的复用性.

<code>@RestControllerAdvice/<code><code>public class GlobalExceptionHandler {/<code>
<code> private Logger logger = LoggerFactory.getLogger(getClass);/<code>
<code> private static int DUPLICATE_KEY_CODE = 1001;/<code><code> private static int PARAM_FAIL_CODE = 1002;/<code><code> private static int VALIDATION_CODE = 1003;/<code>
<code> /**/<code><code> * 处理自定义异常/<code><code> *//<code><code> @ExceptionHandler(BizException.class)/<code><code> public RspDTO handleRRException(BizException e) {/<code><code> logger.error(e.getMessage, e);/<code><code> return new RspDTO(e.getCode, e.getMessage);/<code><code> }/<code>
<code> /**/<code><code> * 方法参数校验/<code><code> *//<code><code> @ExceptionHandler(MethodArgumentNotValidException.class)/<code><code> public RspDTO handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {/<code><code> logger.error(e.getMessage, e);/<code><code> return new RspDTO(PARAM_FAIL_CODE, e.getBindingResult.getFieldError.getDefaultMessage);/<code><code> }/<code>
<code> /**/<code><code> * ValidationException/<code><code> *//<code><code> @ExceptionHandler(ValidationException.class)/<code><code> public RspDTO handleValidationException(ValidationException e) {/<code><code> logger.error(e.getMessage, e);/<code><code> return new RspDTO(VALIDATION_CODE, e.getCause.getMessage);/<code><code> }/<code>
<code> /**/<code><code> * ConstraintViolationException/<code><code> *//<code><code> @ExceptionHandler(ConstraintViolationException.class)/<code><code> public RspDTO handleConstraintViolationException(ConstraintViolationException e) {/<code><code> logger.error(e.getMessage, e);/<code><code> return new RspDTO(PARAM_FAIL_CODE, e.getMessage);/<code><code> }/<code>
<code> @ExceptionHandler(NoHandlerFoundException.class)/<code><code> public RspDTO handlerNoFoundException(Exception e) {/<code><code> logger.error(e.getMessage, e);/<code><code> return new RspDTO(404, "路径不存在，请检查路径是否正确");/<code><code> }/<code>
<code> @ExceptionHandler(DuplicateKeyException.class)/<code><code> public RspDTO handleDuplicateKeyException(DuplicateKeyException e) {/<code><code> logger.error(e.getMessage, e);/<code><code> return new RspDTO(DUPLICATE_KEY_CODE, "数据重复，请检查后提交");/<code><code> }/<code>

<code> @ExceptionHandler(Exception.class)/<code><code> public RspDTO handleException(Exception e) {/<code><code> logger.error(e.getMessage, e);/<code><code> return new RspDTO(500, "系统繁忙,请稍后再试");/<code><code> }/<code><code>}/<code>

4. 测试

如下文:确实做到了参数校验时返回异常信息和对应的code,方便了我们不再繁琐的处理参数校验

在ValidationMessages.properties 就是校验的message,有着已经写好的默认的message,且是支持i18n的,大家可以阅读源码赏析

自定义参数注解

1. 比如我们来个 自定义身份证校验 注解

<code>@Documented/<code><code>@Target({ElementType.PARAMETER, ElementType.FIELD})/<code><code>@Retention(RetentionPolicy.RUNTIME)/<code><code>@Constraint(validatedBy = IdentityCardNumberValidator.class)/<code><code>public @interface IdentityCardNumber {/<code>
<code> String message default "身份证号码不合法";/<code>
<code> Class> groups default {};/<code>
<code> Class extends Payload> payload default {};/<code><code>}/<code>

这个注解是作用在Field字段上，运行时生效，触发的是IdentityCardNumber这个验证类。

• message 定制化的提示信息，主要是从ValidationMessages.properties里提取，也可以依据实际情况进行定制

• groups 这里主要进行将validator进行分类，不同的类group中会执行不同的validator操作

• payload 主要是针对bean的，使用不多。

2. 然后自定义Validator

这个是真正进行验证的逻辑代码：

<code>public class IdentityCardNumberValidator implements ConstraintValidator<identitycardnumber> {/<identitycardnumber>/<code>
<code> @Override/<code><code> public void initialize(IdentityCardNumber identityCardNumber) {/<code><code> }/<code>
<code> @Override/<code><code> public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {/<code><code> return IdCardValidatorUtils.isValidate18Idcard(o.toString);/<code><code> }/<code><code>}/<code>

IdCardValidatorUtils在项目源码中,可自行查看

3. 使用自定义的注解

<code> @NotBlank(message = "身份证号不能为空")/<code><code> @IdentityCardNumber(message = "身份证信息有误,请核对后提交")/<code><code> private String clientCardNo;/<code>

4. 使用groups的校验

有的宝宝说同一个对象要复用,比如UserDTO在更新时候要校验userId,在保存的时候不需要校验userId,在两种情况下都要校验username,那就用上groups了:

先定义groups的分组接口Create和Update

<code>import javax.validation.groups.Default;/<code>
<code>public interface Create extends Default {/<code><code>}/<code>
<code>import javax.validation.groups.Default;/<code>
<code>public interface Update extends Default{/<code><code>}/<code>

再在需要校验的地方@Validated声明校验组

<code> /**/<code><code> * 走参数校验注解的 groups 组合校验/<code><code> */<code><code> * @param userDTO/<code><code> * @return/<code><code> *//<code><code> @PostMapping("/update/groups")/<code><code> public RspDTO update(@RequestBody @Validated(Update.class) UserDTO userDTO) {/<code><code> userService.updateById(userDTO);/<code><code> return RspDTO.success;/<code><code> }/<code>

在DTO中的字段上定义好groups = {}的分组类型

<code>@Data/<code><code>public class UserDTO implements Serializable {/<code>
<code> private static final long serialVersionUID = 1L;/<code>
<code> /*** 用户ID*//<code><code> @Not(message = "用户id不能为空", groups = Update.class)/<code><code> private Long userId;/<code>
<code> /**/<code><code> * 用户名/<code><code> *//<code><code> @NotBlank(message = "用户名不能为空")/<code><code> @Length(max = 20, message = "用户名不能超过20个字符", groups = {Create.class, Update.class})/<code><code> @Pattern(regexp = "^[\\\\\\u4E00-\\\\\\u9FA5A-Za-z0-9\\\\*]*$", message = "用户昵称限制：最多20字符，包含文字、字母和数字")/<code><code> private String username;/<code>
<code> /**/<code><code> * 手机号/<code><code> *//<code><code> @NotBlank(message = "手机号不能为空")/<code><code> @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误", groups = {Create.class, Update.class})/<code><code> private String mobile;/<code>
<code> /**/<code><code> * 性别/<code><code> *//<code><code> private String sex;/<code>
<code> /**/<code><code> * 邮箱/<code><code> *//<code><code> @NotBlank(message = "联系邮箱不能为空")/<code><code> @Email(message = "邮箱格式不对")/<code><code> private String email;/<code>
<code> /**/<code><code> * 密码/<code><code> *//<code><code> private String password;/<code>
<code> /*** 创建时间 *//<code><code> @Future(message = "时间必须是将来时间", groups = {Create.class})/<code><code> private Date createTime;/<code>
<code>}/<code>

注意:在声明分组的时候尽量加上 extend javax.validation.groups.Default 否则,在你声明@Validated(Update.class)的时候,就会出现你在默认没添加groups = {}的时候的校验组@Email(message = "邮箱格式不对"),会不去校验,因为默认的校验组是groups = {Default.class}.

5. restful风格用法

在多个参数校验,或者@RequestParam 形式时候,需要在controller上加注@Validated

<code> @GetMapping("/get")/<code><code> public RspDTO getUser(@RequestParam("userId") @Not(message = "用户id不能为空") Long userId) {/<code><code> User user = userService.selectById(userId);/<code><code> if (user == ) {/<code><code> return new RspDTO<user>.nonAbsent("用户不存在");/<user>/<code><code> }/<code><code> return new RspDTO<user>.success(user);/<user>/<code><code> }/<code>

<code>@RestController/<code><code>@RequestMapping("user/")/<code><code>@Validated/<code><code>public class UserController extends AbstractController { .../<code>

总结

用起来很简单,soEasy,重点参与的统一结构体返回,统一参数校验,是减少我们代码大量的try catch 的法宝,我觉得在项目中,将异常处理好,并将异常做好日志管理,才是很好的升华,文章浅显,只是一个菜鸟的进阶笔记.

-END-

閱讀更多 程序猿久一 的文章

關鍵字: 校验 劝退 送达