快捷導(dǎo)航

解析SpringBoot自定義參數(shù)校驗注解

更新時間：2023年10月17日 16:36:17 作者：閃耀的瞬間

這篇文章主要介紹了SpringBoot自定義參數(shù)校驗注解,引入依賴,spring validation是在hibernate-validator上做了一層封裝,文中提到了定義參數(shù)校驗注解與處理器的示例代碼,感興趣的朋友跟隨小編一起看看吧

1.引入依賴，spring validation是在hibernate-validator上做了一層封裝

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

2.定義參數(shù)校驗注解與處理器

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
@Documented
@Retention(value = RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
@Constraint(validatedBy = OrderCountValidator.class)
public @interface OrderCountValid {
    String message() default "訂單數(shù)量超出庫存";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
public class OrderCountValidator implements ConstraintValidator<OrderCountValid , Integer> {
    //可以注入mapper、service進來
    @Autowired
    private OrderService orderService;
    @Override
    public boolean isValid(Integer buyCount, ConstraintValidatorContext context) {
        return orderService.OrderCountValid(buyCount);
    }
}

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
public class OrderCountValidator implements ConstraintValidator<OrderCountValid , Integer> {
    //可以注入mapper、service進來
    @Autowired
    private OrderService orderService;
    @Override
    public boolean isValid(Integer buyCount, ConstraintValidatorContext context) {
        return orderService.OrderCountValid(buyCount);
    }
}

3.控制器層

@RestController
@RequestMapping(value = "/order")
public class OrderController {
    @PostMapping("/placeOrder")
    public String placeOrder(@RequestBody @Valid Order order){
        return "success";
    }
}

4.全局異常處理器，自定義校驗注解校驗失敗會拋出 javax.validation.ConstraintViolationException

import org.springframework.stereotype.Component;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.stream.Collectors;
@RestControllerAdvice
@Component
public class GlobalExceptionHandler {
    // 當(dāng)直接校驗具體參數(shù)時會出現(xiàn)javax.validation.ConstraintViolationException
    @ExceptionHandler(value = ConstraintViolationException.class)
    public String handleException1(ConstraintViolationException e) {
        // 拼接參數(shù)
        String errorMsg = e.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.joining(", "));
        return errorMsg;
    }
    // 當(dāng)直接校驗具體參數(shù)時會出現(xiàn)org.springframework.web.bind
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public String handleException2(MethodArgumentNotValidException e) {
        BindingResult exceptions = e.getBindingResult();
        // 判斷異常中是否有錯誤信息，如果存在就使用異常中的消息，否則使用默認消息
        if (exceptions.hasErrors()) {
            // 這里默認錯誤消息
            return exceptions.getFieldError().getDefaultMessage();
        }
        return "請求參數(shù)錯誤";
    }
}

到此這篇關(guān)于SpringBoot自定義參數(shù)校驗注解的文章就介紹到這了,更多相關(guān)SpringBoot校驗注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: