Java使用注解进行参数校验

news2024/10/10 17:30:08

在Java中，使用注解来校验请求参数通常与Spring框架结合使用，特别是当你使用Spring MVC或Spring Boot时。Spring提供了一套完整的校验机制，通过注解来实现参数的自动校验。

以下是一个使用注解进行参数校验的示例：

1. 添加依赖

首先，确保你的项目中包含了Spring Boot的校验依赖。如果你使用Maven，可以在pom.xml文件中添加以下依赖：

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

2. 创建校验类

定义一个类来作为校验规则的载体：

import javax.validation.constraints.Min;
import javax.validation.constraints.Max;

public class RangeConstraint {

    @Min(1)
    @Max(3)
    private int value;

    public int getValue() {
        return value;
    }

    public void setValue(int value) {
        this.value = value;
    }
}

3. 在Controller中使用校验

在你的控制器中，使用@Valid或@Validated注解来触发校验：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;

@RestController
public class ParameterController {

    @GetMapping("/checkParam")
    public String checkParameter(@Valid RangeConstraint rangeConstraint) {
        return "Parameter is valid: " + rangeConstraint.getValue();
    }
}

4. 处理校验错误

你可以使用@ExceptionHandler来处理校验异常：

import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.http.HttpStatus;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public String handleValidationExceptions(MethodArgumentNotValidException ex) {
        StringBuilder errors = new StringBuilder();
        for (FieldError fieldError : ex.getBindingResult().getFieldErrors()) {
            errors.append(fieldError.getField()).append(": ").append(fieldError.getDefaultMessage()).append("; ");
        }
        return errors.toString();
    }
}