Spring自定义注解实现接口版本管理

 更新时间:2023年11月23日 10:16:36   作者:chaojunma  
这篇文章主要介绍了Spring自定义注解实现接口版本管理,RequestMappingHandlerMapping类是与 @RequestMapping相关的,它定义映射的规则,即满足怎样的条件则映射到那个接口上,需要的朋友可以参考下

1.定义版本注解

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface ApiVersion {
    String value();
}

2.自定义HandlerMapping

public class CustomRequestMappingHandlerMapping extends RequestMappingHandlerMapping {
 
    @Override   // ①
    protected RequestCondition<ApiVesrsionCondition> getCustomTypeCondition(Class<?> handlerType) {
        ApiVersion apiVersion = AnnotationUtils.findAnnotation(handlerType, ApiVersion.class);
        return createCondition(apiVersion);
    }
 
    @Override  //②
    protected RequestCondition<ApiVesrsionCondition> getCustomMethodCondition(Method method) {
        ApiVersion apiVersion = AnnotationUtils.findAnnotation(method, ApiVersion.class);
        return createCondition(apiVersion);
    }
    //③  实例化RequestCondition
    private RequestCondition<ApiVesrsionCondition> createCondition(ApiVersion apiVersion) {
        return apiVersion == null ? null : new ApiVesrsionCondition(apiVersion.value());
    }
 
}

我们知道,光定义注解是没什么用的,重要的是我们识别到注解,做相应的事。RequestMappingHandlerMapping类是与 @RequestMapping相关的,它定义映射的规则。即满足怎样的条件则映射到那个接口上。

①处构建类级的映射要求,AnnotationUtils.findAnnotation根据在类上面的注解实例化一个注解类。然后构造RequestCondition。

②处构建类级的映射要求,AnnotationUtils.findAnnotation根据在方法上面的注解实例化一个注解类。然后构造RequestCondition。 AnnotationUtils.findAnnotation是用到Spring的工具类,根据标注的注解识别注解。很方便,比通过反射的方式来找到注解要方便。

3.自定义条件匹配

public class ApiVersionCondition implements RequestCondition<ApiVersionCondition> {
 
    // Header中版本号名称
    private final static String API_VERSION = "apiVersion";
 
    private final static String VERSION_SEPATATOR = ".";
 
    // 路径中版本的前缀, 这里用 /v[1-9]/的形式
    private final static String VERSION_PREFIX_PATTERN = "(\\d+)(.\\d+)*";
 
    private String apiVersion;
 
    public ApiVersionCondition(String apiVersion) {
        this.apiVersion = apiVersion;
    }
 
    @Override
    public ApiVersionCondition combine(ApiVersionCondition other) {
        // 采用最后定义优先原则,则方法上的定义覆盖类上面的定义
        return new ApiVersionCondition(other.getApiVersion());
    }
 
    @Override
    @Nullable
    public ApiVersionCondition getMatchingCondition(HttpServletRequest request) {
        String apiVersion = request.getHeader(API_VERSION);
 
        if (StringUtils.isBlank(apiVersion) || !apiVersion.matches(VERSION_PREFIX_PATTERN)) {
            return null;
        }
 
        if (convertNumber(apiVersion) == convertNumber(this.apiVersion)) {
            return this;
        }
 
        return null;
    }
 
    @Override
    public int compareTo(ApiVersionCondition other, HttpServletRequest request) {
        // 优先匹配最新的版本号
        return convertNumber(other.getApiVersion()) - convertNumber(this.apiVersion);
    }
 
    public String getApiVersion() {
        return apiVersion;
    }
 
 
    private int convertNumber(String version) {
        return Integer.parseInt(version.replace(VERSION_SEPATATOR, ""));
    }
}

4.自定义条件匹配

最后则是需要将我们的 HandlerMapping 注册到 Spring MVC 容器,在这里我们借助WebMvcConfigurationSupport来手动注册,如下:

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
 
    @Override
    @Bean
    public RequestMappingHandlerMapping requestMappingHandlerMapping() {
        RequestMappingHandlerMapping handlerMapping = new CustomRequestMappingHandlerMapping();
        handlerMapping.setOrder(0);
        handlerMapping.setInterceptors(getInterceptors());
        return handlerMapping;
    }
}

测试

定义几个接口,用于区分不同的版本,如下:

    @ApiVersion("1.0.1")
    @GetMapping("/test")
    public String test1(){
        log.info("版本控制测试!");
        return "V1测试成功";
    }
 
 
    @ApiVersion("1.0.2")
    @GetMapping("/test")
    public String test2(){
        log.info("版本控制测试!");
        return "V2测试成功";
    }

启动服务,请求localhost:8080/test, Header中携带版本号1.0.1, test1执行。Header中携带版本号1.0.2, test2执行。

到此这篇关于Spring自定义注解实现接口版本管理的文章就介绍到这了,更多相关Spring实现接口版本管理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java实现简单控制台五子棋游戏

    java实现简单控制台五子棋游戏

    这篇文章主要为大家详细介绍了java实现简单控制台五子棋游戏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-11-11
  • resty的缓存技术设计及使用

    resty的缓存技术设计及使用

    这篇文章主要为大家介绍了resty缓存技术的设计及使用示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
    2022-03-03
  • 关于Spring中的@Configuration中的proxyBeanMethods属性

    关于Spring中的@Configuration中的proxyBeanMethods属性

    这篇文章主要介绍了关于Spring中的@Configuration中的proxyBeanMethods属性,需要的朋友可以参考下
    2023-07-07
  • 解析Java的JVM以及类与对象的概念

    解析Java的JVM以及类与对象的概念

    这篇文章主要介绍了解析Java的JVM以及类与对象的概念,是Java入门学习中的基础知识,需要的朋友可以参考下
    2015-09-09
  • 一次踩坑记录 @valid注解不生效 排查过程

    一次踩坑记录 @valid注解不生效 排查过程

    这篇文章主要介绍了一次踩坑记录 @valid注解不生效 排查过程,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • 详解Java中NullPointerException异常的原因详解以及解决方法

    详解Java中NullPointerException异常的原因详解以及解决方法

    这篇文章主要介绍了详解Java中NullPointerException异常的原因详解以及解决方法。文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • JDBC实现数据库增删改查功能

    JDBC实现数据库增删改查功能

    这篇文章主要为大家详细介绍了JDBC实现数据库增删改查功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-07-07
  • SpringBoot中的Bean注入问题

    SpringBoot中的Bean注入问题

    SpringBoot开发中,Bean注入是关键,涉及构造函数注入、Setter注入和字段注入等方法,常见问题包括Bean未找到、循环依赖、多个实现注入等,推荐使用构造函数注入以增强代码测试性和维护性,并关注Bean的生命周期和作用域
    2024-09-09
  • 详解使用Spring Boot的AOP处理自定义注解

    详解使用Spring Boot的AOP处理自定义注解

    本篇文章主要介绍了详解使用Spring Boot的AOP处理自定义注解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-01-01
  • SpringBoot集成Jasypt敏感信息加密的操作方法

    SpringBoot集成Jasypt敏感信息加密的操作方法

    这篇文章主要介绍了SpringBoot集成Jasypt加密敏感信息,包括敏感信息加密的作用,项目集成Jasypt方式详解,本文给大家介绍的非常详细,需要的朋友可以参考下
    2022-05-05

最新评论