快捷導(dǎo)航

詳解SpringBoot中@NotNull,@NotBlank注解使用

更新時間：2022年08月23日 14:29:41 作者：羈客%

這篇文章主要為大家詳細(xì)介紹了Spring?Boot中集成Validation與@NotNull,@NotBlank等注解的簡單使用，感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下

一.添加依賴

<!-- spring-boot 2.3及以上的版本只需要引入下面的依賴 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

二.在類中使用驗(yàn)證注解

1.創(chuàng)建驗(yàn)證實(shí)體類（嵌套使用）

@Data
public class UserDto{
 
    @NotBlank(message = "請輸入用戶名稱")
    private String userName;
 
    @NotBlank(message = "請正確輸入密碼")
    @Length(min = 6,max = 18)
    private String password;
 
    @Email(message = "請正確輸入郵箱")
    private String email;
 
 
    @Valid
    @NotEmpty(message = "角色不能為空")
    private List<RoleDto> roleDtos;
 
}
//被嵌套的類
@Data
public class roleDto{
 
    @NotNull(message = "角色I(xiàn)D不能為空")
    private Integer roleId;
 
    @NotBlank(message = "請輸入角色名稱")
    private String roleName;
 
    @NotBlank(message = "請輸入角色名稱")
    private String roleCode;
 
    private String desc;
}

2.創(chuàng)建全局異常處理器，對message信息進(jìn)行處理，并返回給前端

@Component
@Slf4j
public class GlobalValidHandler implements HandlerExceptionResolver {
 
    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        ModelAndView modelAndView = new ModelAndView(new MappingJackson2JsonView());
        String errorMsg;
        if (ex instanceof BindException) {
        //對于驗(yàn)證注解在實(shí)體類的屬性中的異常處理
            BindException bex = (BindException) ex;
            errorMsg = Objects.requireNonNull(bex.getBindingResult().getFieldError()).getDefaultMessage();
        } else if (ex instanceof ConstraintViolationException) {
        //對于驗(yàn)證注解直接在方法參數(shù)中使用的異常處理
            ConstraintViolationException cve = (ConstraintViolationException) ex;
            errorMsg = cve.getMessage();
            if (errorMsg != null) {
                errorMsg = errorMsg.substring(errorMsg.indexOf(": ") + 2);
            }
        } else {
        //其他
            errorMsg = ex.getMessage();
        }
        modelAndView.addObject("msg", errorMsg);
        modelAndView.addObject("code", HttpServletResponse.SC_BAD_REQUEST);
        return modelAndView;
    }
}

3.在controller中的使用

@RestController
@RequestMapping("/user")
public class UserController{
 
    @Autowired
    private UserService userService;
 
    @PostMapping("/add")
    public ApiResult addUser(@Valid @RequsetBody UserDto userDto){
        return ApiResult.data(userService.addUser(userDto));
    }
}

三.在方法參數(shù)中使用驗(yàn)證注解，與@RequsetParam注解同時使用，注意類上使用@Validated

@Validated
@RestController
@RequestMapping("/user")
public class UserController{
 
 @Autowired
 private UserSerivce userService;
 
 @GetMapping("/list")
 public ApiResult queryUsers(@RequestParam(name="userName", required = false, defaultValue = "")
                 @NotBlank(message = "請輸入用戶") String userName,
                 @RequestParam(name="pageNumber", required = false, defaultValue = 1) Integre pageNumber,
                 @RequestParam(name="pageSize", required = false, defaultValue = 10) Integre pageSize){
    return ApiResult.Data(userService.queryUsers(userName,pageNumber,pageSize));
 }
}

ps: 需要在全局變量中對驗(yàn)證注解進(jìn)行異常處理 GlobalValidHandler

四.自定義驗(yàn)證注解

1.定義驗(yàn)證注解

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = MyConstraintValidtor.class)
public @interface MyValidator {
 
    String message() default "校驗(yàn)未通過";
 
    Class<?>[] groups() default {};
 
    Class<? extends Payload>[] payload() default {};
}

2.實(shí)現(xiàn)驗(yàn)證注解的具體驗(yàn)證邏輯

public class MyConstraintValidator  implements ConstraintValidator<MyValidator, Object> {
    @Override
    public void initialize(MyValidator validator) {
        ConstraintValidator.super.initialize(validator);
    }
 
    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        //具體校驗(yàn)邏輯
        //........
        //........
 
        //舉個例 驗(yàn)證不為空
        return !ObjectUtils.isEmpty(value);
    }
}

3.使用

@Data
public class UserDto{
 
    @NotNull(message="用戶名不能為空")
    private String userName;
 
    @MyValidator(message="密碼不能為空")
    private String password;
}

到此這篇關(guān)于詳解SpringBoot中@NotNull,@NotBlank注解使用的文章就介紹到這了,更多相關(guān)SpringBoot注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: