Spring Boot实现各种参数校验

本文涉及的产品
服务治理 MSE Sentinel/OpenSergo,Agent数量 不受限
可观测可视化 Grafana 版,10个用户账号 1个月
简介: 这些是Spring Boot中实现参数校验的一些常见方法,你可以根据项目需求选择适合的方式来进行参数校验。

Spring Boot中可以使用各种方式进行参数校验,以下是一些常见的方法:

  1. 使用注解进行参数校验:Spring Boot提供了一系列的注解,如 @NotNull@NotBlank@Min@Max等,用于在Controller层的方法参数上进行参数校验。例如:
@PostMapping("/createUser")
public ResponseEntity<String> createUser(@RequestBody @Valid User user) {
    // 执行创建用户逻辑
    return ResponseEntity.ok("用户创建成功");
}

在上述示例中,@Valid注解用于启用参数校验,而 User类中的注解如 @NotNull用于对字段进行具体的校验。

  1. 自定义校验注解:你也可以创建自定义的参数校验注解,以满足特定的业务需求。例如,如果需要校验用户名是否唯一,可以创建一个自定义注解 @UniqueUsername,并在相应的Service层方法中进行校验。
@Target({ ElementType.FIELD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = UniqueUsernameValidator.class)
public @interface UniqueUsername {
    String message() default "用户名已存在";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}
  1. 全局异常处理:在Spring Boot中,你可以创建一个全局异常处理器来捕获参数校验失败的异常,并返回友好的错误信息给客户端。可以通过实现 HandlerExceptionResolver接口或使用 @ControllerAdvice注解来实现全局异常处理。
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationException(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getFieldErrors().forEach(error -> errors.put(error.getField(), error.getDefaultMessage()));
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errors);
    }
}

上述代码中,MethodArgumentNotValidException会捕获参数校验失败的异常,并将错误信息封装成JSON返回给客户端。

这些是Spring Boot中实现参数校验的一些常见方法,你可以根据项目需求选择适合的方式来进行参数校验。

目录
相关文章
|
4天前
|
Java Spring
SpringBoot接收参数的方式
本文介绍了Java Spring Boot中处理GET请求的多种方式。可以使用方法参数直接接收,或者通过`@RequestParam`注解指定必传参数。此外,可以用实体类接收多个相关参数,但不能同时使用`@RequestParam`。还可以通过`HttpServletRequest`对象获取参数,或利用`@PathVariable`接收路径变量。对于数组和集合参数,需注意使用`@RequestParam`注解。
|
11天前
|
Java
Springboot 使用自定义注解结合AOP方式校验接口参数
Springboot 使用自定义注解结合AOP方式校验接口参数
Springboot 使用自定义注解结合AOP方式校验接口参数
|
12天前
|
Java 关系型数据库 MySQL
【JavaEE】Spring事务-@Transactional参数介绍-事务的隔离级别以及传播机制
【JavaEE】Spring事务-@Transactional参数介绍-事务的隔离级别以及传播机制
16 0
|
12天前
|
前端开发 Java
SpringBoot之自定义注解参数校验
SpringBoot之自定义注解参数校验
24 2
|
12天前
|
存储 JSON 算法
SpringBoot之JWT令牌校验
SpringBoot之JWT令牌校验
31 2
|
12天前
|
Java 微服务 Spring
Spring Boot中获取配置参数的几种方法
Spring Boot中获取配置参数的几种方法
24 2
|
12天前
|
开发框架 Java 开发者
Spring Boot接收参数的多种方式
【4月更文挑战第20天】
16 0
|
JSON 数据安全/隐私保护 数据格式
SpringBoot中的异常处理与参数校验_2
  兄弟们好,这次来跟老铁交流两个问题,异常和参数校验,在说参数校验之前我们先来说异常处理吧,因为后面参数的校验会牵扯到异常处理这块的内容。   说到异常处理,我不知道大家有没有写过或者遇到过如下的写法。
211 0
|
Java 数据库连接
SpringBoot 2.0参数校验Hibernate Validator
SpringBoot 2.0参数校验Hibernate Validator
SpringBoot 2.0参数校验Hibernate Validator