溫馨提示×

springboot怎么做請求參數(shù)校驗

小億
90
2024-01-19 18:55:34
欄目: 編程語言

在Spring Boot中，可以使用Spring框架提供的@Validated和@Valid注解來對請求參數(shù)進行校驗。

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

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

然后，在Controller類的方法參數(shù)上使用@Validated注解，并在需要校驗的參數(shù)前面使用@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) {
        // 處理創(chuàng)建用戶的邏輯
        // ...
    }
    
}

public class User {

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

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

在上面的例子中，使用了@NotBlank注解對username參數(shù)進行校驗，如果參數(shù)為空或者只包含空格，則會拋出校驗異常，響應(yīng)結(jié)果中會包含相應(yīng)的錯誤信息。

另外，還可以自定義校驗注解，例如：

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位大寫字母和數(shù)字的組合")
@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等注解來進行基本的校驗規(guī)則定義，然后再結(jié)合自定義的校驗規(guī)則進行校驗。

以上就是使用Spring Boot進行請求參數(shù)校驗的方法。在實際開發(fā)中，可以根據(jù)具體的業(yè)務(wù)需求來定義和使用校驗注解，以保證請求參數(shù)的有效性。

0 踩