使用注解对controller接口入参进行常用的校验(springboot + hibernate-validator)

源码地址:https://gitee.com/yk001/base.git

将hibernate-validator用于Controller,可以有效的规范api输入
并且在接口联调阶段,将不规范的请求挡在外部,规范调用方的入参。

1,引入包

		
			org.hibernate.validator
			hibernate-validator
			6.1.6.Final
		

2,controller

package com.yukang.base.controller;


import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.constraints.Max;


/**
 * Function: Hibernate-Validator使用demo. 
* Date: 2020/12/13 3:29 下午
* * @author yukang */ @RestController @Validated public class ValidatorController { @GetMapping("/entity") public String getEntity( @Max(10) @RequestParam(name="p1") Integer p1, @Max(10) @RequestParam(name="p2") Integer p2, @Max(10) @RequestParam(name="p3") Integer p3) { return "success"; } }

3,添加统一的异常处理

package com.yukang.base.config;

import com.yukang.base.common.CommonResultCode;
import com.yukang.base.common.GeneralResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletResponse;


/**
 * Function: GlobalExcept. 
* Date: 11/13/18 5:20 PM
* * @see * @since JDK 1.8 */ @Slf4j @ControllerAdvice("com.yukang.base.controller") @ResponseBody public class GlobalExceptionHandler { @ExceptionHandler(Exception.class) public GeneralResult otherExceptionHandler(HttpServletResponse response, Exception ex) { response.setStatus(500); GeneralResult tempResult = new GeneralResult(); tempResult.setCode(CommonResultCode.OPERATION_FAILED_UNKOWN); tempResult.setDescription(ex.getMessage()); return tempResult; } }

4,验证

curl -X GET "http://localhost:9001/entity?p1=15&p2=15&p3=15" -H "accept: */*"
{
  "code": 101,
  "data": null,
  "description": "getEntity.p1: 最大不能超过10, getEntity.p2: 最大不能超过10, getEntity.p3: 最大不能超过10"
}

你可能感兴趣的:(编程技巧,spring,boot)