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

 更新时间:2022年08月23日 14:29:41   作者:羁客%  
这篇文章主要为大家详细介绍了Spring Boot中集成Validation与@NotNull,@NotBlank等注解的简单使用,感兴趣的小伙伴可以跟随小编一起学习一下

一.添加依赖

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

二.在类中使用验证注解

1.创建验证实体类(嵌套使用)

@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 = "角色ID不能为空")
    private Integer roleId;
 
    @NotBlank(message = "请输入角色名称")
    private String roleName;
 
    @NotBlank(message = "请输入角色名称")
    private String roleCode;
 
    private String desc;
}

2.创建全局异常处理器,对message信息进行处理,并返回给前端

@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) {
        //对于验证注解在实体类的属性中的异常处理
            BindException bex = (BindException) ex;
            errorMsg = Objects.requireNonNull(bex.getBindingResult().getFieldError()).getDefaultMessage();
        } else if (ex instanceof ConstraintViolationException) {
        //对于验证注解直接在方法参数中使用的异常处理
            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));
    }
}

三.在方法参数中使用验证注解,与@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: 需要在全局变量中对验证注解进行异常处理 GlobalValidHandler

四.自定义验证注解

1.定义验证注解

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

2.实现验证注解的具体验证逻辑

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) {
        //具体校验逻辑
        //........
        //........
 
        //举个例 验证不为空
        return !ObjectUtils.isEmpty(value);
    }
}

3.使用

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

到此这篇关于详解SpringBoot中@NotNull,@NotBlank注解使用的文章就介绍到这了,更多相关SpringBoot注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 使用Spring Validation实现数据校验的代码详解

    使用Spring Validation实现数据校验的代码详解

    在现代Web应用开发中,数据校验是不可忽视的重要环节,Spring提供了强大的数据校验框架——Spring Validation,可以有效提升数据输入的安全性与应用的稳定性,本文将介绍如何使用Spring Validation进行数据校验,帮助您深入理解和灵活应用这一技术
    2024-11-11
  • Java动态代理简单介绍

    Java动态代理简单介绍

    动态代理指的是,代理类和目标类的关系在程序运行的时候确定的,客户通过代理类来调用目标对象的方法,是在程序运行时根据需要动态的创建目标类的代理对象。本文将通过案例详细讲解一下Java动态代理的原理及实现,需要的可以参考一下
    2022-08-08
  • SpringBoot中Mybatis + Druid 数据访问的详细过程

    SpringBoot中Mybatis + Druid 数据访问的详细过程

    Spring Boot 底层都是采用 SpringData 的方式进行统一处理各种数据库,SpringData也是Spring中与SpringBoot、SpringCloud 等齐名的知名项目,下面看下SpringBoot Mybatis Druid数据访问的详细过程,感兴趣的朋友一起看看吧
    2021-11-11
  • Java线程变量ThreadLocal详细解读

    Java线程变量ThreadLocal详细解读

    这篇文章主要介绍了Java线程变量ThreadLocal详细解读,多线程访问同一个变量的时候,很容易出现问题,特别是多线程对一个共享变量进行写入的时候,为了线程的安全在进行数据写入时候会进行数据的同步,需要的朋友可以参考下
    2024-01-01
  • 老生常谈Java中List与ArrayList的区别

    老生常谈Java中List与ArrayList的区别

    大家都知道List是接口,ArrayList是List接口的一个实现类,接下来通过本文给大家介绍Java中List与ArrayList的区别,需要的朋友可以参考下
    2022-08-08
  • Spring Cloud Alibaba Nacos 入门详解

    Spring Cloud Alibaba Nacos 入门详解

    这篇文章主要介绍了Spring Cloud Alibaba Nacos入门详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03
  • Javaweb会话跟踪技术Cookie和Session的具体使用

    Javaweb会话跟踪技术Cookie和Session的具体使用

    本文主要介绍了Javaweb会话跟踪技术Cookie&Session的具体使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07
  • JAVA实现JSON后端向前端传递数据

    JAVA实现JSON后端向前端传递数据

    本篇文章主要介绍了JAVA实现JSON后端向前端传递数据,这里整理了详细的代码,具有一定的参考价值,有需要的小伙伴可以参考下。
    2017-03-03
  • RestTemplate的URL请求示例

    RestTemplate的URL请求示例

    这篇文章主要为大家介绍了RestTemplate的URL请求示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-06-06
  • springboot+springmvc+mybatis项目整合

    springboot+springmvc+mybatis项目整合

    这篇文章主要为大家详细介绍了springboot+springmvc+mybatis项目的整合,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-04-04

最新评论