如何优雅的实现无侵入性参数校验之spring-boot-starter-validation

在开发过程中,参数校验是一个非常重要的环节。但是,传统的参数校验方法往往需要在代码中手动添加大量的 if-else 语句,这不仅繁琐,而且容易出错。为了解决这个问题,我们可以使用无侵入性参数校验的方式来简化代码并提高开发效率。

而在 Spring Boot 中,我们可以使用 spring-boot-starter-validation 来实现无侵入性参数校验。这个 Starter 可以帮助我们自动完成参数校验,而不需要手动添加大量的代码。

使用 spring-boot-starter-validation 的方式非常简单。首先,在 pom.xml 中添加如下依赖:

maven 复制代码
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

然后,在需要校验参数的方法中添加 @Validated 注解,并在需要校验的参数前添加 @NotBlank、@NotNull、@Min、@Max 等注解即可。例如:

java 复制代码
@PostMapping("/user")
public User createUser(@Validated @RequestBody User user) {
    return userService.createUser(user);
}

在上面的代码中,@Validated 注解表示需要进行参数校验,@RequestBody 注解表示接收的是一个 JSON 对象,而 User 类中的 @NotBlank、@NotNull 等注解表示对 User 对象中的相应属性进行校验。

例如:

java 复制代码
public class User {
	@NotBlank(message = "用户名不能为空")
	private String username;
	@NotBlank(message = "密码不能为空")
	private String password;
}

需要注意的是,如果参数校验不通过,会抛出 MethodArgumentNotValidException 异常。我们可以通过添加一个全局异常处理器来处理这个异常。例如:

java 复制代码
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<String> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        List<ObjectError> allErrors = bindingResult.getAllErrors();
        List<String> errorList = allErrors.stream().map(ObjectError::getDefaultMessage).collect(Collectors.toList());
        return ResponseEntity.badRequest().body(errorList.toString());
    }
}

在上面的代码中,我们定义了一个 GlobalExceptionHandler 类,并使用 @ControllerAdvice 注解表示这是一个全局异常处理器。当出现 MethodArgumentNotValidException 异常时,会调用 handleMethodArgumentNotValidException 方法来处理异常,并将校验失败的错误信息返回给客户端。

总之,使用 spring-boot-starter-validation 可以帮助我们实现无侵入性参数校验,从而简化代码并提高开发效率。希望本文能对大家有所帮助!

相关推荐
Zane19944 分钟前
HashSet、TreeSet、LinkedHashSet:底层都是"套壳"
java·后端
相顾若初见18 分钟前
RuoYi后端jar镜像制作
java·jar
MacroZheng25 分钟前
程序员看文档神器,装上它,看Spring官方文档就一目了然了!
java·人工智能·后端
深漂的华哥34 分钟前
Ruoyi-Vue-Plus(V5.6.2) 开发环境搭建
java·前端·spring boot·后端·spring·ruoyi
wanger6137 分钟前
AI应用开发知识点总结
java
Escalating_xu39 分钟前
【C++ vector 深度解析】从常用接口、扩容机制与迭代器失效到核心模拟实现
java·c++·面试
今天AI了吗39 分钟前
AI 数据安全治理框架:模型能力与数据权限的边界在哪里
java·linux·开发语言·人工智能·python·深度学习·机器学习
LCG元41 分钟前
【实战】树莓派物联网开发:DHT11温湿度采集与MQTT云上报全流程
java·jvm·物联网
斯内普吖42 分钟前
(开源)农产品电商系统实战指南 基于 Java + SpringBoot + Vue + MySQL
java·vue.js·spring boot·mysql·开源
SimonKing1 小时前
AI逆向实战:一个壁纸网站被我5分钟摸透了,你也能
java·后端·程序员