springboot整合数据校验以及错误处理

文章展示了如何在SpringBoot项目中引入数据校验依赖,并创建全局异常处理器来捕获和处理各种异常,包括参数校验异常、自定义异常、运行时异常等。同时,文中还演示了如何实现分组校验,针对不同场景如添加和修改,设置不同的验证规则,并通过Controller方法进行测试验证。
摘要由CSDN通过智能技术生成

1、引入数据校验的依赖,用的是springboot的数据校验,如下所示:

<!--  参数校验  -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

2、新建一个全局异常类,包括获取参数校验异常、自定义异常、运行异常、未知异常、错误信息,代码如下:

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

    /**
     * springbootstarter自带的参数校验异常
     * 返回第一个参数异常的信息
     * @param e
     * @return
     */
    @ExceptionHandler(BindException.class)
    public Result handleValidation(BindException e) {
        log.error("数据校验出现问题");
        return Result.failure(e.getBindingResult().getFieldErrors().get(0).getDefaultMessage());
    }

    /**
     * javax参数校验异常
     * @param e
     * @return
     */
    @ExceptionHandler(value= MethodArgumentNotValidException.class)
    public Result handleVaildException(MethodArgumentNotValidException e){
        BindingResult bindingResult = e.getBindingResult();
        Map<String,String> errorMap = new HashMap<>();
        bindingResult.getFieldErrors().forEach((fieldError)->{
            errorMap.put(fieldError.getField(),fieldError.getDefaultMessage());
        });
        log.error("数据校验出现问题{},异常类型:{},异常数据:{}",e.getMessage(),e.getClass(),errorMap);
        return Result.failure("参数校验失败"+errorMap);
    }

    /**
     * 参数为单个参数或多个参数
     * @param e
     * @return
     */
    @ExceptionHandler(value = ConstraintViolationException.class)
    public Result handleConstraintViolationException(ConstraintViolationException e) {
        // 从异常对象中拿到ObjectError对象
        String errorMessage = e.getConstraintViolations()
                .stream()
                .map(ConstraintViolation::getMessage)
                .collect(Collectors.toList()).get(0);
        log.error("数据校验出现问题{},异常类型:{},异常数据:{}",e.getMessage(),e.getClass(),errorMessage);
        return Result.failure("参数校验失败"+errorMessage);
    }

    /**
     * 处理自定义异常
     */
    @ExceptionHandler(RRException.class)
    public Result handleRRException(RRException e){
        StackTraceElement[] stackTrace = e.getStackTrace();
        log.error("处理自定义异常:---> 异常类:{},异常方法:{},异常行号:{},异常信息:{}",stackTrace[0].getClassName(),stackTrace[0].getMethodName(),stackTrace[0].getLineNumber(),e.getMessage());
        return Result.failure("网络繁忙,请稍后再试");
    }

    /**
     * 处理运行时异常
     * @param e
     * @return
     */
    @ExceptionHandler(value = RuntimeException.class)
    public Result handler(RuntimeException e){
        StackTraceElement[] stackTrace = e.getStackTrace();
        log.error("运行时异常:---------{}",e.getMessage());
        log.error("运行时异常定位信息:---> 异常类:{},异常方法:{},异常行号:{},异常信息:{}",stackTrace[0].getClassName(),stackTrace[0].getMethodName(),stackTrace[0].getLineNumber(),e.getMessage());
        return Result.failure(e.getMessage());
    }

    /**
     * 错误信息
     * @param throwable
     * @return
     */
    @ExceptionHandler(value = Throwable.class)
    public Result handleException(Throwable throwable){
        log.error("错误异常-------{}",throwable);
        return Result.failure();
    }

    /**
     * 未知异常
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    public Result handleException(Exception e){
        log.error("未知异常信息-------{}",e.getMessage());
        return Result.failure();
    }

}

3、新建一个controller做一个单参数校验,代码如下:

 @PostMapping("/createUser")
    public Result createUser(@NotEmpty(message = "name不能为空") String name,
                             @Max(value = 100, message = "请输入数字") Integer age){
        return Result.success();
    }

4、发起请求,看返回的结果如下图所示:
apiPost结果图
IDEA捕获的异常
5、分组校验,一般分为添加校验和修改校验,新建两个接口,代码分别如下:

public interface AddGroup extends Default {
}
public interface UpdateGroup extends Default {
}

6、实体类添加参数的校验,代码如下:

@TableId(type = IdType.ASSIGN_ID)
    @NotNull(message = "ID不能为空",groups = {AddGroup.class})
    private Long id;

    @TableField("name")
    @Size(message = "账号长度建议在5~15",min = 5,max = 15,groups = {AddGroup.class})
    @NotBlank(message = "账号不能为空",groups ={AddGroup.class, UpdateGroup.class})
    private String username;

    @NotNull(message = "年龄不能为空",groups = {AddGroup.class,UpdateGroup.class})
    private Integer age;
    @NotBlank(message = "邮箱不能为空",groups = {AddGroup.class})
    private String email;

7、在controller写方法进行测试,分别对不同的分组进行测试,代码如下:

/**
     * AddGroup
     * @param user
     * @return
     */
    @PostMapping("/addGroup")
    public Result addGroup(@Validated(AddGroup.class) UserDAO user){
        return Result.success();
    }
/**
     * UpdateGroup
     * @param user
     * @return
     */
    @PostMapping("/updateGroup")
    public Result updateGroup(@Validated(UpdateGroup.class) UserDAO user){
        return Result.success();
    }
    /**
     * error
     * @param num
     * @return
     */
    @PostMapping("/error")
    public Result error(int num){
        int i = 1/num;
        return Result.success();
    }

8、测试结果展示:
addGroup测试结果:
add
updateGroup测试结果:
update
error测试结果:
error
项目异常捕捉打印:
异常

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
Spring Boot提供了很方便的数据校验功能,可以通过注解方式实现。要使用数据校验功能,首先需要在项目的pom.xml文件中添加相关的依赖。其中,我们可以使用spring-boot-starter-validation依赖来引入数据校验功能。 在代码中,我们可以使用javax.validation.constraints包中的注解来对数据进行校验。常用的注解包括@NotNull、@NotEmpty、@Size、@Min、@Max等。例如,使用@NotNull注解来标记一个字段不能为空。 首先,在需要校验的类中,添加注解@Validated,这样Spring Boot会自动校验被注解标记的字段。然后,在需要校验的字段上添加相关的校验注解,如@NotNull。最后,在Controller的方法参数上添加@Valid注解,来触发数据校验。 下面是一个示例代码,展示了如何在Spring Boot中进行数据校验。 ```java import org.springframework.validation.annotation.Validated; import javax.validation.constraints.NotNull; @RestController @Validated public class UserController { @PostMapping("/user") public String addUser(@Valid @RequestBody User user) { // 业务逻辑处理 // ... return "User added successfully"; } public class User { @NotNull private String username; // getters and setters } } ``` 在上述示例中,我们定义了一个UserController类,其中的addUser方法用于添加用户。在User类中,我们使用了@NotNull注解来标记username字段不能为空。在addUser方法的参数中,我们使用了@Valid注解来触发数据校验。 通过以上配置,当我们发送一个POST请求到"/user"的时候,Spring Boot会自动校验请求体中的数据。如果校验失败,会返回相应的错误信息。如果校验通过,会执行业务逻辑并返回成功信息。 总结一下,Spring Boot提供了简单易用的数据校验功能,可以通过注解方式实现。通过添加相应的依赖和配置,我们可以在项目中方便地使用数据校验功能,保证数据的有效性和完整性。 :https://www.jianshu.com/p/2dabf4f0b72e :https://www.baeldung.com/spring-boot-bean-validation
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

FirstTalent

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值