Java @Validated注解详解：参数验证实例与最佳实践

版权申诉

50 浏览量更新于2024-09-11 收藏 65KB PDF 举报

"本文将深入探讨Java中如何利用@Validated注解进行参数验证，提高代码的简洁性和可维护性。首先，我们先了解什么是@Validated注解。在Java中，`@Validated`是JSR 303/JSR 349 Bean Validation标准的一部分，它允许我们在方法参数级别进行预验证，确保数据的完整性。这个注解可以用于字段、getter或setter方法，以及整个类。文章详细介绍了如何在实体类中使用@Validated。例如，作者举了一个名为`User`的实体类，其中包含`id`、`tenantId`和`name`等字段，通过`@NotBlank`注解对这些字段进行非空验证，并指定了不同的错误消息和验证组。在控制器方法中，如`addUser`和`updateUser`，作者展示了如何在HTTP请求的`@RequestBody`中应用@Validated，以及如何根据操作的类型（如新增或更新）指定不同的验证组。对于`addUser`方法，因为是新用户添加，所以只验证了`User`实体的全部字段。而在`updateUser`方法中，除了常规的验证外，还额外添加了`Update.class`组，这意味着在更新操作时，不仅检查默认验证规则，还会执行针对更新操作的特定验证规则。此外，文章也提及了如何自定义验证组，例如`Add`、`Update`、`Delete`和`Search`，这种灵活性使得开发者可以根据业务需求更精细地控制验证过程。通过这种方式，不仅可以简化代码，还能确保输入数据的准确性，避免因错误数据导致的潜在问题。这篇文章提供了一种实用的编程实践，帮助Java开发者在处理HTTP请求时采用更加模块化和易于管理的参数验证方式。无论是初学者还是经验丰富的开发者，都可以从中受益，提升代码质量和开发效率。"

Java使用使用@Validated注解进行参数验证的方法注解进行参数验证的方法

主要介绍了Java使用@Validated注解进行参数验证的方法，文中通过示例代码介绍的非常详细，对大家的学习

或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

目前项目中大部分代码进行参数验证都是写代码进行验证，为了提升方便性和代码的简洁性，所以整理了下使用注解进行参数

验证。使用效果如下：

// 要验证的实体类

@Data

public class User implements Serializable {

@NotBlank(message = "id不能为空！",groups = Update.class)

protected String id = "";

@NotBlank(message = "商户id不能为空！")

protected String tenantId;

@NotBlank(message = "名称不能为空！")

protected String name = "";

}

// controller

// 在要验证的参数上添加@Validated注解即可

@PostMapping("add")

public boolean addUser(@Validated @RequestBody User user) {

ProdAllotStandard info = allotStandardService.getProdAllotStandardWithDetailById(id);

return info;

}

// 修改则需要比添加的基础上多验证一个id，可以通过group的方式进行区分

// 实体类上不设置groups，默认会是Default，所以修改的时候，我们需要指定Update和Default这两个组

// group是可以自定义的，我默认定义了Add，Update，Delete，Search这四个组

@PostMapping("update")

public boolean updateUser(@Validated({Update.class, Default.class}) @RequestBody User user) {

ProdAllotStandard info = allotStandardService.getProdAllotStandardWithDetailById(id);

return info;

}

// 当然该注解也支持service上实现，同样的使用方法，在service的实现类的参数上加上对应注解即可，如：

public boolean addUser(@Validated User user) {

}

// 通过不同group的搭配，我们就可以灵活的在实体类上配置不同场景的验证了

// group为一个接口，用以下方式创建

public interface Add {

}

下面看一下具体的实现，验证框架的核心实现采用的是hibernate-validator，我采用的是5.4.3.Final版本。

controller和service的实现方式不同，下面分别介绍下。

不管哪种实现，我们都需要先定义一个异常和一个异常拦截器，当参数校验出现问题时，我们就抛出对应异常。

// 为了简短，省略了部分代码

public class ParamsException extends RuntimeException{

private String code;

public BusinessException() {

}

public ParamsException(String code,String message) {

super(message);

this.code = code;

}

public ParamsException(String message) {

super(message);

}

// 定义异常处理类

@ControllerAdvice

public class ExceptionAdvice {

private static Logger L = LoggerFactory.getLogger(ExceptionAdvice.class);

// 对所有的ParamsException统一进行拦截处理，如果捕获到该异常，则封装成MessageBody返回给前端

@ExceptionHandler(value = ParamsException.class)

@ResponseStatus(HttpStatus.OK)

@ResponseBody

public MessageBody handleParamsException(HttpServletRequest request, BusinessException e){

L.error(e.getMessage(),e);

return getErrorMessageBody(e.getData(),e.getMessage(),e.getMessage(),

StringUtils.isEmpty(e.getCode())?ResponseCode.BUSINESS_ERROR:e.getCode());

}

private MessageBody getErrorMessageBody(Object data,String message,String errorInfo,String code){

MessageBody body = new MessageBody();

下载后可阅读完整内容，剩余3页未读，立即下载

weixin_38686267

粉丝: 6
资源: 945

Java @Validated注解详解：参数验证实例与最佳实践

Java如何使用JSR303校验数据与自定义校验注解

自定义注解进行参数校验的jar包

jersey-hk2-validate:HK2管理的任意服务的@Valid泽西岛验证

java @validated 方法参数

spring @Validated 什么意思

java中@validated

Spring Boot 中 @Valid 和 @Validated 注解有何区别

@validated加在类上

@valid与@validated区别

@validated 注解 使用 示例

最新资源

@validated 注解使用示例