springboot怎么做请求参数校验

springboot

小亿

2024-01-19 18:55:34

栏目: 编程语言

在Spring Boot中，可以使用Spring框架提供的@Validated和@Valid注解来对请求参数进行校验。

首先，需要在pom.xml文件中添加以下依赖：

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

然后，在Controller类的方法参数上使用@Validated注解，并在需要校验的参数前面使用@Valid注解。例如：

import org.springframework.validation.annotation.Validated;
import javax.validation.Valid;
import javax.validation.constraints.NotBlank;

@RestController
@Validated
public class UserController {

    @PostMapping("/users")
    public ResponseEntity createUser(@Valid @RequestBody User user) {
        // 处理创建用户的逻辑
        // ...
    }
    
}

public class User {

    @NotBlank(message = "用户名不能为空")
    private String username;

    // getter和setter方法
    // ...
}

在上面的例子中，使用了@NotBlank注解对username参数进行校验，如果参数为空或者只包含空格，则会抛出校验异常，响应结果中会包含相应的错误信息。

另外，还可以自定义校验注解，例如：

import javax.validation.Constraint;
import javax.validation.Payload;
import javax.validation.constraints.Pattern;
import java.lang.annotation.*;

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {})
@Pattern(regexp = "^[A-Z0-9]{8}$", message = "订单号必须是8位大写字母和数字的组合")
@Documented
public @interface OrderNo {
    String message() default "";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

public class Order {

    @OrderNo
    private String orderNo;

    // getter和setter方法
    // ...
}

在自定义的校验注解中，可以使用Spring提供的@Pattern等注解来进行基本的校验规则定义，然后再结合自定义的校验规则进行校验。

以上就是使用Spring Boot进行请求参数校验的方法。在实际开发中，可以根据具体的业务需求来定义和使用校验注解，以保证请求参数的有效性。

springboot怎么做请求参数校验

最新问答

相关标签