JSR303在项目controller及service层中的应用

最新推荐文章于 2024-05-18 16:42:38 发布
最新推荐文章于 2024-05-18 16:42:38 发布
阅读量249 收藏
点赞数
文章标签： java Powered by 金山文档
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_73479463/article/details/128647724
版权

一、前言

项目中我们经常要对接口的入参做校验，如果在代码中写判断逻辑，不仅不美观且代码冗余，我们可以使用JSR303标注注解的方式来解决这样的问题。不仅在controller层可以使用JSR303做校验，service层也可以使用JSR303做校验。

二、版本问题

实战中，使用springboot2.7.2版本时需要导入以下依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

当使用springboot2.2.5.RELEASE则不需要另外导入依赖

结论：不同的springboot版本对validation-api jar的集成情况不同，实战中需要注意版本问题。

本文采用springboot2.2.5.RELEASE

三、controller层接口入参校验

1、接口入参为一个实体json

实体代码

@Data
public class User {

  private Integer id;

  @NotBlank private String name;

  @NotNull private Integer age;
}

接口代码

 @PostMapping("/save")
  public CommonRes save(@Valid @RequestBody User user) {

    CommonRes commonRes = new CommonRes();
    System.out.println("user = " + user);

    commonRes.setCode(200);
    commonRes.setData(user);
    return commonRes;
  }

请求接口

{
    "name":"",
    "age":""
}

接口响应结果

{
    "timestamp": "2022-09-28T05:11:03.192+0000",
    "status": 400,
    "error": "Bad Request",
    "errors": [
        {
            "codes": [
                "NotNull.user.age",
                "NotNull.age",
                "NotNull.java.lang.Integer",
                "NotNull"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.age",
                        "age"
                    ],
                    "arguments": null,
                    "defaultMessage": "age",
                    "code": "age"
                }
            ],
            "defaultMessage": "不能为null",
            "objectName": "user",
            "field": "age",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotNull"
        },
        {
            "codes": [
                "NotBlank.user.name",
                "NotBlank.name",
                "NotBlank.java.lang.String",
                "NotBlank"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.name",
                        "name"
                    ],
                    "arguments": null,
                    "defaultMessage": "name",
                    "code": "name"
                }
            ],
            "defaultMessage": "不能为空",
            "objectName": "user",
            "field": "name",
            "rejectedValue": "",
            "bindingFailure": false,
            "code": "NotBlank"
        },
        {
            "codes": [
                "NotNull.user.age",
                "NotNull.age",
                "NotNull.java.lang.Integer",
                "NotNull"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.age",
                        "age"
                    ],
                    "arguments": null,
                    "defaultMessage": "age",
                    "code": "age"
                }
            ],
            "defaultMessage": "不能为null",
            "objectName": "user",
            "field": "age",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotNull"
        }
    ],
    "message": "Validation failed for object='user'. Error count: 3",
    "path": "/user/save"
}

结果信息冗余，并不是我们想要的格式

后台日志

2022-09-28 13:11:03.190  WARN 21711 --- [io-10092-exec-4] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public com.example.jsr303demo.util.CommonRes com.example.jsr303demo.controller.UserController.save(com.example.jsr303demo.entity.User) with 3 errors: [Field error in object 'user' on field 'age': rejected value [null]; codes [NotNull.user.age,NotNull.age,NotNull.java.lang.Integer,NotNull]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.age,age]; arguments []; default message [age]]; default message [不能为null]] [Field error in object 'user' on field 'name': rejected value []; codes [NotBlank.user.name,NotBlank.name,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.name,name]; arguments []; default message [name]]; default message [不能为空]] [Field error in object 'user' on field 'age': rejected value [null]; codes [NotNull.user.age,NotNull.age,NotNull.java.lang.Integer,NotNull]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.age,age]; arguments []; default message [age]]; default message [不能为null]] ]

可添加一个全局异常处理，专门捕获并处理这个异常

@Slf4j
@RestControllerAdvice
public class MyExceptionControllerAdvice {

  /**
   * MethodArgumentNotValidException 异常捕获处理
   *
   * @param e
   * @return
   */
  @ExceptionHandler(value = MethodArgumentNotValidException.class)
  public CommonRes methodArgumentNotValidExceptionHandle(MethodArgumentNotValidException e) {

    CommonRes commonRes = new CommonRes();

    log.error("数据校验异常{}，异常类型：{}", e.getMessage(), e.getClass());

    Map<String, String> errorMap = new HashMap<>();
    e.getBindingResult()
        .getFieldErrors()
        .forEach(
            item -> {
              errorMap.put(item.getField(), item.getDefaultMessage());
            });

    commonRes.setCode(400);
    commonRes.setMsg("数据校验异常 MethodArgumentNotValidException");
    commonRes.setData(errorMap);
    return commonRes;
  }


}

再次请求结果为

{
    "code": 400,
    "msg": "数据校验异常 MethodArgumentNotValidException",
    "data": {
        "name": "不能为空",
        "age": "不能为null"
    }
}

2、接口入参是非json实体

去掉@RequestBody注解

@PostMapping("/save")
  public CommonRes save(@Valid User user) {

    CommonRes commonRes = new CommonRes();
    System.out.println("user = " + user);

    commonRes.setCode(200);
    commonRes.setData(user);
    return commonRes;
  }

结果为

{
    "timestamp": "2022-09-28T05:18:55.149+0000",
    "status": 400,
    "error": "Bad Request",
    "errors": [
        {
            "codes": [
                "NotBlank.user.name",
                "NotBlank.name",
                "NotBlank.java.lang.String",
                "NotBlank"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.name",
                        "name"
                    ],
                    "arguments": null,
                    "defaultMessage": "name",
                    "code": "name"
                }
            ],
            "defaultMessage": "不能为空",
            "objectName": "user",
            "field": "name",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotBlank"
        },
        {
            "codes": [
                "NotNull.user.age",
                "NotNull.age",
                "NotNull.java.lang.Integer",
                "NotNull"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.age",
                        "age"
                    ],
                    "arguments": null,
                    "defaultMessage": "age",
                    "code": "age"
                }
            ],
            "defaultMessage": "不能为null",
            "objectName": "user",
            "field": "age",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotNull"
        },
        {
            "codes": [
                "NotNull.user.age",
                "NotNull.age",
                "NotNull.java.lang.Integer",
                "NotNull"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.age",
                        "age"
                    ],
                    "arguments": null,
                    "defaultMessage": "age",
                    "code": "age"
                }
            ],
            "defaultMessage": "不能为null",
            "objectName": "user",
            "field": "age",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotNull"
        }
    ],
    "message": "Validation failed for object='user'. Error count: 3",
    "path": "/user/save"
}

后台日志

2022-09-28 13:18:55.149  WARN 22953 --- [io-10092-exec-5] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 3 errors
Field error in object 'user' on field 'name': rejected value [null]; codes [NotBlank.user.name,NotBlank.name,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.name,name]; arguments []; default message [name]]; default message [不能为空]
Field error in object 'user' on field 'age': rejected value [null]; codes [NotNull.user.age,NotNull.age,NotNull.java.lang.Integer,NotNull]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.age,age]; arguments []; default message [age]]; default message [不能为null]
Field error in object 'user' on field 'age': rejected value [null]; codes [NotNull.user.age,NotNull.age,NotNull.java.lang.Integer,NotNull]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [user.age,age]; arguments []; default message [age]]; default message [不能为null]]

没有得到我们想要的结果，是因为此时抛出的异常不是MethodArgumentNotValidException，而是BindException

因此我们需要添加BindException的全局异常处理

/**
     * 只打了@Valid在参数前，没有@RequestBody 验证错误后返回的异常
     * 
     * @param e 
     * @return
     */
    @ExceptionHandler(BindException.class)
    public CommonRes bindExceptionHandle(BindException e) {
      CommonRes commonRes = new CommonRes();

      log.error("数据校验异常{}，异常类型：{}", e.getMessage(), e.getClass());

      Map<String, String> errorMap = new HashMap<>();
      e.getBindingResult()
          .getFieldErrors()
          .forEach(
              item -> {
                errorMap.put(item.getField(), item.getDefaultMessage());
              });

      commonRes.setCode(400);
      commonRes.setMsg("数据校验异常 bindExceptionHandle");
      commonRes.setData(errorMap);
      return commonRes;
    }

再次请求结果为

{
    "code": 400,
    "msg": "数据校验异常 bindExceptionHandle",
    "data": {
        "name": "不能为空",
        "age": "不能为null"
    }
}

3、接口的入参不是一个实体

@GetMapping("/getUserByParam")
  public CommonRes getUserByParam(@NotNull Integer id) {

    CommonRes commonRes = new CommonRes();

    System.out.println("id = " + id);

    commonRes.setCode(200);
    commonRes.setData(id);
    return commonRes;
  }

此时请求id为空

localhost:10092/user/getUserByParam?id=

@NotNull并不起作用

在类上加入@Validated注解才会校验生效

@Validated
@RestController
@RequestMapping("/user")
public class UserController {
   // ...
}

再次请求结果为

{
    "timestamp": "2022-09-28T05:30:11.616+0000",
    "status": 500,
    "error": "Internal Server Error",
    "message": "getUserByParam.id: 不能为null",
    "path": "/user/getUserByParam"
}

后台日志抛出异常

2022-09-28 13:30:11.614 ERROR 24560 --- [io-10092-exec-4] o.a.c.c.C.[.[.[/].[dispatcherServlet]    : Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is javax.validation.ConstraintViolationException: getUserByParam.id: 不能为null] with root cause

javax.validation.ConstraintViolationException: getUserByParam.id: 不能为null


...

添加ConstraintViolationException全局异常捕获

/**
     * constraintViolationExceptionHandle 验证错误后返回的异常
     *
     * @param e 
     * @return
     */
    @ExceptionHandler(ConstraintViolationException.class)
    public CommonRes constraintViolationExceptionHandle(ConstraintViolationException e) {
      CommonRes commonRes = new CommonRes();

      log.error("数据校验异常{}，异常类型：{}", e.getMessage(), e.getClass());

      Map<String, String> errorMap = new HashMap<>();
      for (ConstraintViolation<?> constraintViolation : e.getConstraintViolations()) {
        errorMap.put(
            constraintViolation.getPropertyPath().toString(), constraintViolation.getMessage());
      }

      commonRes.setCode(400);
      commonRes.setMsg("数据校验异常 constraintViolationExceptionHandle");
      commonRes.setData(errorMap);
      return commonRes;
    }

再次请求结果为

{
    "code": 400,
    "msg": "数据校验异常 constraintViolationExceptionHandle",
    "data": {
        "getUserByParam.id": "不能为null"
    }
}

以上基本涵盖了入参为实体json、非json实体、非实体非json的三种异常处理

同理其他校验异常也可添加异常处理捕获，进而统一返回校验错误的接口返回信息

四、service层方法入参校验

service入参也可使用JSR303校验统一返回校验结果json

如代码如下

@Slf4j
@Service
public class UserServiceImpl implements UserService {
  @Override
  public void save(User user) {

    ValidatorFactory vf = Validation.buildDefaultValidatorFactory();
    Validator validator = vf.getValidator();
    Set<ConstraintViolation<Object>> set = validator.validate(user);
    for (ConstraintViolation<Object> constraintViolation : set) {
      log.error(constraintViolation.getPropertyPath() + ":" + constraintViolation.getMessage());
    }
  }
}

user字段为空时

控制台打印结果为

2022-09-28 13:49:09.107 ERROR 27242 --- [io-10092-exec-4] c.e.j.service.impl.UserServiceImpl       : name:不能为空
2022-09-28 13:49:09.107 ERROR 27242 --- [io-10092-exec-4] c.e.j.service.impl.UserServiceImpl       : age:不能为null

我们不妨将此段代码封装成工具类，在需要进行入参校验的实收调用一下即可

先定义一个自定义异常，用于此段逻辑

public class MyValidationException extends Exception {

  public MyValidationException() {
    super();
  }

  public MyValidationException(String message) {
    super(message);
  }
}

工具类抛出自定义异常

@Slf4j
public class MyValidationUtil {

  public static void myServiceValidate(Object o) throws Exception {
    ValidatorFactory vf = Validation.buildDefaultValidatorFactory();
    Validator validator = vf.getValidator();
    Set<ConstraintViolation<Object>> set = validator.validate(o);
    Map<String, String> errorMap = new HashMap<>();
    if (set != null && set.size() > 0) {
      for (ConstraintViolation<Object> constraintViolation : set) {
        log.error(constraintViolation.getPropertyPath() + ":" + constraintViolation.getMessage());
        errorMap.put(
            constraintViolation.getPropertyPath().toString(), constraintViolation.getMessage());
      }
      ObjectMapper objectMapper = new ObjectMapper();
      throw new MyValidationException(objectMapper.writeValueAsString(errorMap));
    }
  }
}

添加全局异常捕获MyValidationException

@ExceptionHandler(value = MyValidationException.class)
  public CommonRes handleServiceValidationException(MyValidationException e) {

    CommonRes commonRes = new CommonRes();

    log.error("数据校验异常:{}", e.getMessage());

    Map errorMap = null;
    if (!StringUtils.isEmpty(e.getMessage())) {
      ObjectMapper objectMapper = new ObjectMapper();
      try {
        errorMap = objectMapper.readValue(e.getMessage(), Map.class);
      } catch (JsonProcessingException ex) {
        ex.printStackTrace();
      }
    }

    commonRes.setCode(400);
    commonRes.setMsg("数据校验异常 service");
    commonRes.setData(errorMap);
    return commonRes;
  }

再次请求service方法，结果如下

{
    "code": 400,
    "msg": "数据校验异常 service",
    "data": {
        "name": "不能为空",
        "age": "不能为null"
    }
}

「已注销」
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Springboot 使用 JSR 303 对 Controller 控制层校验及 Service 服务层 AOP 校验 使用消息资源文件对消息国际化
10-18
主要介绍了Springboot 使用 JSR 303 对 Controller 控制层校验及 Service 服务层 AOP 校验 使用消息资源文件对消息国际化的相关知识,需要的朋友可以参考下
利用JSR-303做验证验证service层
csdn_life18的博客
08-23 741
我把注解@valid放在servevice层上是没有效果的，只有放在Controller上才有效果。 可以手动校验，调用ValidatorFactory工厂方法创建一个实例对象来校验，代码如下。 import javax.validation.ConstraintViolation; import javax.validation.Validation; import javax.valid...
JSR303是啥？有啥用处？
qq_62881798的博客
09-05 2549
注意：如下图，如果果定义两个方法，并且两个都需要用到书名sname不为空，那么可以用groups方法将两个方法用“{}”括起来。
Springboot 使用 JSR 303 对 Controller 控制层校验及 Service 服务层 AOP 校验，使用消息资源文件对消息国际化...
weixin_30621919的博客
12-18 423
导包和配置 导入 JSR 303 的包、hibernate valid 的包 <dependency> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> <version>6.0...
超详细关于JSR303服务端校验&&拦截器入门到案例使用
qq_63492318的博客
08-19 448
关于JSR303在服务端的校验，以及基于Springmvc的拦截器的使用，实现登录功能的权限控制...
JSR303的简单应用（谷粒商城
qq_47155894的博客
10-08 226
jsr的简单应用
SpringBoot中JSR303的示例代码
11-19
详细介绍了普通校验，分组校验，自定义注解校验等，全局异常处理，代码均为我自己编写，是我的学习笔记，并且发表了相关子蛾子，可以配合我的帖子查看，是一些简单的相关示例代码
jsr303校验.txt
01-27
jsr303校验.txt
jsr 303 jar包下载
01-24
按照课件推荐下载，准确有效，包括（hibernate-validator-4.3.2.Final.jar;jboss-logging-3.1.0.CR2.jar;validation-api-1.1.0.Alpha1.jar和jsr303约束文档）
springmvc_jsr303
12-29
项目中所需的jar包在压缩包中已提供,项目中用到了JSR303和hibernate-validator的技术,大量采用了注解@NotNull,@Email,@Length,@Max,@Pattern,@Size等,此外还采用了自定义注解,验证信息全部配置在属性文件中.
Spring实战--001--Service层支持JSR校验规则
学来所记，记来所思，思来所写
11-13 273
spring对AspectJ的支持，限于@Controller类中时，使用@Valid注解，已经在请求对象中使用JSR-xxx约束即可实现，对参数进行校验。但是在项目中，同时存在对Service层的参数进行校验。此文章通过切面对Service层的请求，进行支持JSR的校验规则。 Service层的JSR校验规则实现 导入必要的包 <!--aspectj--> <depen...
JSR303校验
weixin_46071647的博客
03-08 444
此时就用到了分组校验，同一个属性定义多个校验规则属于不同的分组，比如：添加订单定义@NULL规则属于insert分组，更新订单定义@NotEmpty规则属于update分组，insert和update是分组的名称，是可以修改的。使用基于JSR303的校验框架实现，SpringBoot提供了JSR-303的支持，它就是spring-boot-starter-validation，它包括了很多校验规则，只需要在模型类中通过注解指定校验规则，在controller方法上开启校验。
JSR303校验,分组校验,自定义注解校验,全局异常处理
在路上
08-14 545
从简单的使用步骤到自定义注解校验, 一文搞定
参数校验放在controller还是service_让你的代码更加简练-springboot使用JSR303校验
weixin_39966765的博客
11-29 469
痛点​​相信不少人写过这样都代码，对方法入参进行了各种校验。上面还是比较少的校验。如果遇到什么邮箱、手机号更复杂，对格式也需要进行校验。可能洋洋洒洒几百行代码就过去了。这种代码其实跟业务流程没有太多关系，但是又不能不做。那么有没有一种方法可以避免呢。当然有！就是JSR-303(JSR是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求，是Java界的一个...
JSR303参数校验与commons-lang3的常见验证
m0_37635053的博客
11-03 452
JSR303参数校验与commons-lang3的常见验证 一、JSR303参数校验 1.1、JSR303参数常用校验，使用的如下的包 在springboot项目中， validation的两个包已经包含在spring-boot-starter-web里面(可自己点进去看)，无须再引包，如果不是springboot项目需要引入validation校验的包 <dependency> <groupId>org.springframework.boot&l
@Resource 与 @Service注解
Jaylon Wang的专栏
02-20 1393
@Resource 与 @Service注解 spring中什么时候用@Resource，什么时候用@service当你需要定义某个类为一个bean，则在这个类的类名前一行使用@Service("XXX"),就相当于讲这个类定义为一个bean，bean名称为XXX;当需要在某个类中定义一个属性，并且该属性是一个已存在的bean，要为该属性赋值或注入时在该属性上一行使用@Resource(nam...
jar包增量更新分析
junlaiyan的专栏
05-16 263
借助jdeps分析出jar包的增量文件
SpringBoot接入Knife4j接口文档
最新发布
博主是个二次元死肥宅~
05-18 686
Knife4j是Java MVC框架集成Swagger生成Api文档的增强解决方案，前身是swagger-bootstrap-ui。
java实现拼图小游戏
monkey108的博客
05-16 622
本文主要提供用java实现的拼图小游戏源代码。
jsr303 springboot3
09-21
首先，你需要在项目中添加Hibernate Validator的maven依赖，然后在Controller层的方法参数上使用@Valid注解来开启参数校验。如果Controller层方法接受的参数是基本数据类型（如Integer、String），则需要在接收参数...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值