Spring Boot如何创建自定义注解并验证请求参数

深碍√TFBOYSˉ_ 2023-10-09 19:47 1阅读 0赞

> 自定义注解可以用于验证。

**微信搜索关注《Java学研大本营》，加入读者群，分享更多精彩**

当我在做一个 Spring Boot 项目时，我发现自定义注解可以用于验证。了解它如何工作以及我们如何使用自定义注释进行验证的最佳方法是创建简单的用例并尝试了解它是如何工作的。在这里，我将创建一个自定义注释来验证任何请求参数中的允许值。

### 什么是注解？ ###

“注解只不过是关于字段、参数、方法、构造函数、类型（类/接口/枚举）、包和注解类型的元数据”。

Java 注释是一种将元数据信息添加到我们的源代码的机制。它们是 JDK5 中添加的 Java 的一个强大部分。注释提供了使用 XML 描述符和标记接口的替代方法。

虽然我们可以将它们附加到包、类、接口、方法和字段上，但注释本身对程序的执行没有影响。

### 1.添加 spring-boot-starter-validation 依赖项 ###

验证启动器不再包含在 Web 启动器中。spring-boot-starter-validation 不再是 spring-boot-starter-web 和 spring-boot-starter-webflux 的传递依赖。

添加此依赖项以进行验证工作。

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

### 2.创建自定义注释 ###

import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.util.Arrays;
    import java.util.List;
    
    import javax.validation.Constraint;
    import javax.validation.ConstraintValidator;
    import javax.validation.ConstraintValidatorContext;
    import javax.validation.Payload;
    
    @Retention(RetentionPolicy.RUNTIME)
    @Constraint(validatedBy = { ValuesAllowed.Validator.class })
    public @interface ValuesAllowed {
    
     String message() default "Field value should be from list of ";
    
     Class<?>[] groups() default {};
    
     Class<? extends Payload>[] payload() default {};
    
     String propName();
    
     String[] values();
    
     class Validator implements ConstraintValidator<ValuesAllowed, String> {
      private String propName;
      private String message;
      private List<String> allowable;
    
      @Override
      public void initialize(ValuesAllowed requiredIfChecked) {
       this.propName = requiredIfChecked.propName();
       this.message = requiredIfChecked.message();
       this.allowable = Arrays.asList(requiredIfChecked.values());
      }
    
      public boolean isValid(String value, ConstraintValidatorContext context) {
       Boolean valid = this.allowable.contains(value);
    
       if (!Boolean.TRUE.equals(valid)) {
        context.disableDefaultConstraintViolation();
        context.buildConstraintViolationWithTemplate(message.concat(this.allowable.toString()))
          .addPropertyNode(this.propName).addConstraintViolation();
       }
       return valid;
      }
     }
    }

在这里，我们将添加一个约束来验证任何请求参数字段。我们的验证器将具有三个字段：第一个是`propName`定义任何自定义属性的字段，第二个是`values`包含 propName 允许值列表的字段，第三个是`message`保存错误消息的字段。

@Constraint(validatedBy = ValuesAllowed.Validator.class)

当验证失败时，我返回为 @ValuesAllowed 注释提到的错误消息。

String message() default "Field value should be from list of ";

我通过实现接口 ConstraintValidator 添加验证逻辑。我在重写的初始化方法中初始化接口变量。

在被覆盖的`isValid`方法中，我正在执行一个简单的检查，如果传递的值存在于允许值列表中。如果不存在，则抛出错误消息。

### 3.在控制器中添加验证 ###

在这里，我在`orderBy`请求参数上添加注释。我`orderBy`在注释中传递了一个自定义属性名称和 Request 的允许值列表。

用注解对Controller进行 `@Validated`注解，否则`ValuesAllowed`根本不会触发注解。

@RestController
    @RequestMapping("/api/opportunity")
    @Validated
    public class OpportunityController {
        @GetMapping("/vendors/list")
        public String getVendorpage(@RequestParam(required = false) String term,
                @RequestParam(required = false) Integer page, @RequestParam(required = false) Integer size,
                @ValuesAllowed(propName = "orderBy", values = { "OpportunityCount", "OpportunityPublishedCount", "ApplicationCount",
                        "ApplicationsApprovedCount" }) @RequestParam(required = false) String orderBy, @RequestParam(required = false) String sortDir) {
            return "success";
        }

### 注意 ###

如果发生任何验证错误并使用丑陋的堆栈跟踪污染日志，上面的代码将返回 HTTP 500。为了避免这种情况，我们可以`@ExceptionHandler`在控制器主体中放置一个方法（因此它的作用域仅适用于该控制器），然后您就可以控制 HTTP 状态：

@ExceptionHandler(ConstraintViolationException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    String handleConstraintViolationException(ConstraintViolationException e) {
        return "Validation error: " + e.getMessage();
    }

或者您可以将此方法放入单独的`@ControllerAdvice`类中，并对该验证具有更多控制权，例如在所有控制器或仅需要的控制器中使用它。

### 推荐书单 ###

#### 《项目驱动零起点学Java》 ####

![9d7d02d99e4df543e0417e457772cf1f.png][]

《项目驱动零起点学Java》共分 13 章，围绕 6 个项目和 258 个代码示例，分别介绍了走进Java 的世界、变量与数据类型、运算符、流程控制、方法、数组、面向对象、异常、常用类、集合、I/O流、多线程、网络编程相关内容。《项目驱动零起点学Java》总结了马士兵老师从事Java培训十余年来经受了市场检验的教研成果，通过6 个项目以及每章的示例和习题，可以帮助读者快速掌握Java 编程的语法以及算法实现。扫描每章提供的二维码可观看相应章节内容的视频讲解。

《项目驱动零起点学Java》贯穿6个完整项目，经过作者多年教学经验提炼而得，项目从小到大、从短到长，可以让读者在练习项目的过程中，快速掌握一系列知识点。

马士兵，马士兵教育创始人，毕业于清华大学，著名IT讲师，所讲课程广受欢迎，学生遍布全球大厂，擅长用简单的语言讲授复杂的问题，擅长项目驱动知识的综合学习。马士兵教育获得在线教育“名课堂”奖、“最受欢迎机构”奖。

赵珊珊，从事多年一线开发，曾为国税、地税税务系统工作。拥有7年一线教学经验，多年线上、线下教育的积累沉淀，培养学员数万名，讲解细致，脉络清晰。  
[《项目驱动零起点学Java》(马士兵，赵珊珊)【摘要 书评 试读】- 京东图书京东JD.COM图书频道为您提供《项目驱动零起点学Java》在线选购，本书作者：，出版社：清华大学出版社。买图书，到京东。网购图书，享受最低优惠折扣!![icon-default.png_t_N3I4][]https://item.jd.com/13607758.html][Java_ _ _- _JD.COM_Java_icon-default.png_t_N3I4_https_item.jd.com_13607758.html]

> > > > ### 精彩回顾 ###
> > 
> > [部署Spring Boot应用程序][Spring Boot]
> > 
> > [Java Spring Boot 3.0.0 RC1 震撼登场!][Java Spring Boot 3.0.0 RC1]

> > 微信搜索关注《Java学研大本营》
> > 
> > 访问【IT今日热榜】，发现每日技术热点

[9d7d02d99e4df543e0417e457772cf1f.png]: https://img-blog.csdnimg.cn/img_convert/9d7d02d99e4df543e0417e457772cf1f.png
[icon-default.png_t_N3I4]: https://csdnimg.cn/release/blog_editor_html/release2.2.5/ckeditor/plugins/CsdnLink/icons/icon-default.png?t=N3I4
[Java_ _ _- _JD.COM_Java_icon-default.png_t_N3I4_https_item.jd.com_13607758.html]: https://item.jd.com/13607758.html
[Spring Boot]: https://mp.weixin.qq.com/s?__biz=MzkzMDM3MjI3Nw==&mid=2247485902&idx=1&sn=f8a8b41aa78df26fbb4171bf8b14c938&chksm=c27a0614f50d8f02690b33e16513185067ad3fad6638a7f6eaf1a2b03bf01ed3fad164339cb8&scene=21#wechat_redirect
[Java Spring Boot 3.0.0 RC1]: https://mp.weixin.qq.com/s?__biz=MzkzMDM3MjI3Nw==&mid=2247485911&idx=1&sn=33ccbc9f8c9f98de24e05cdae26767f7&chksm=c27a060df50d8f1bb9d16fc293b5bd94faabacf4763d20f60a4962e709f1bd60efae4dd5a4ec&scene=21#wechat_redirect