接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法 |
您所在的位置:网站首页 › hibernate校验框架 › 接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法 |
目录 1:JSR303校验 1.1:统一校验的需求 1.2:统一校验实现 1.3:分组校验 1.4:校验规则不满足? 1:JSR303校验1.1:统一校验的需求前端请求后端接口传输参数,是在controller中校验还是在Service中校验? 答案是都需要校验,只是分工不同。 Contoller中校验请求参数的合法性,包括:必填项校验,数据格式校验,比如:是否是符合一定的日期格式,等。 Service中要校验的是业务规则相关的内容,比如:课程已经审核通过所以提交失败。 Service中根据业务规则去校验不方便写成通用代码,Controller中则可以将校验的代码写成通用代码。 早在JavaEE6规范中就定义了参数校验的规范,它就是JSR-303,它定义了Bean Validation,即对bean属性进行校验。 SpringBoot提供了JSR-303的支持,它就是spring-boot-starter-validation,它的底层使用Hibernate Validator,Hibernate Validator是Bean Validation 的参考实现。 所以,我们准备在Controller层使用spring-boot-starter-validation完成对请求参数的基本合法性进行校验。 1.2:统一校验实现首先添加依赖 Java org.springframework.boot spring-boot-starter-validation在javax.validation.constraints包下有很多这样的校验注解,直接使用注解定义校验规则即可。 规则如下: 示例:一个接口的参数校验 上边用到了@NotEmpty和@Size两个注解,@NotEmpty表示属性不能为空,@Size表示限制属性内容的长短。 定义好校验规则还需要开启校验,在controller方法中添加@Validated注解,如下 如果校验出错Spring会抛出MethodArgumentNotValidException异常,我们需要在统一异常处理器中捕获异常,解析出异常信息。 @ResponseBody //处理器捕获入口参数报的错误进入该方法内进行处理 @ExceptionHandler(MethodArgumentNotValidException.class) @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) public RestErrorResponse methodArgumentNotValidException(MethodArgumentNotValidException e){ //创建一个集合进行接收不合法信息 List msgList = new ArrayList(); BindingResult bindingResult = e.getBindingResult(); //入口参数校验,可能有多个参数信息都不合法,存放 bindingResult.getFieldErrors().stream().forEach(fieldError -> msgList.add(fieldError.getDefaultMessage())); //处理集合内的不合法提示,为字符串 String msg = StringUtils.join(msgList, ","); //记录异常 log.error("系统异常{}",msg); //解析出异常信息 RestErrorResponse restErrorResponse = new RestErrorResponse(msg); return restErrorResponse; }使用httpclient进行测试一下
可以看到校验器生效。 1.3:分组校验有时候在同一个属性上设置一个校验规则不能满足要求,比如:订单编号由系统生成,在添加订单时要求订单编号为空,在更新 订单时要求订单编写不能为空。此时就用到了分组校验,同一个属性定义多个校验规则属于不同的分组,比如:添加订单定义@NULL规则属于insert分组,更新订单定义@NotEmpty规则属于update分组,insert和update是分组的名称,是可以修改的。 下边举例说明 我们用class类型来表示不同的分组,所以我们定义不同的接口类型(空接口)表示不同的分组,由于校验分组是公用的,所以定义在 公共调用的工程中。如下: /** * 定义一个校验分组 */ public class ValidationGroups { public interface Inster{}; public interface Update{}; public interface Delete{}; }在接收参数的模型类中进行填写分组 在Controller方法中启动校验规则指定要使用的分组名: 再次测试,由于这里指定了update分组,所以抛出 异常信息:添加课程名称不能为空。 如果修改分组为ValidationGroups.Inster.class,异常信息为:修改课程名称不能为空。
如果javax.validation.constraints包下的校验规则满足不了需求怎么办? 1、手写校验代码 。 2、自定义校验规则注解。 如何自定义校验规则注解,请自行查阅资料实现。 |
今日新闻 |
推荐新闻 |
CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |