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字符串匹配算法indexOf函数的实现方法

    浅谈JAVA字符串匹配算法indexOf函数的实现方法

    这篇文章主要介绍了浅谈字符串匹配算法indexOf函数的实现方法,indexOf函数我们可以查找一个字符串(模式串)是否在另一个字符串(主串)出现过。对此感兴趣的可以来了解一下
    2020-07-07
  • Spring Boot中RabbitMQ自动配置的介绍、原理和使用方法

    Spring Boot中RabbitMQ自动配置的介绍、原理和使用方法

    本文介绍了Spring Boot中RabbitMQ自动配置的介绍、原理和使用方法,通过本文的介绍,我们希望读者能够更好地理解Spring Boot中RabbitMQ的使用方法,并在项目中更加灵活地应用,感兴趣的朋友跟随小编一起看看吧
    2023-07-07
  • Java 抽象类和接口的实现

    Java 抽象类和接口的实现

    本文主要介绍了Java 抽象类和接口,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2007-03-03
  • java必学必会之this关键字

    java必学必会之this关键字

    java必学必会之this关键字,java中this的用法进行了详细的分析介绍,感兴趣的小伙伴们可以参考一下
    2015-12-12
  • java 工厂模式的讲解及优缺点的介绍

    java 工厂模式的讲解及优缺点的介绍

    这篇文章主要介绍了java 工厂模式的讲解及优缺点的介绍的相关资料, 简单工厂模式,又称为静态工厂方法(Static Factory Method)模式,它属于类创建型模式,需要的朋友可以参考下
    2017-08-08
  • 基于SpringBoot实现代码在线运行工具

    基于SpringBoot实现代码在线运行工具

    这篇文章主要介绍了如何利用SpringBoot实现简单的代码在线运行工具(类似于菜鸟工具),文中的示例代码讲解详细,需要的可以参考一下
    2022-06-06
  • java全角、半角字符的关系以及转换详解

    java全角、半角字符的关系以及转换详解

    这篇文章主要介绍了
    2013-11-11
  • SpringCloud OpenFeign超时控制示例详解

    SpringCloud OpenFeign超时控制示例详解

    在Spring Cloud中使用OpenFeign时,可以通过配置来控制请求的超时时间,这篇文章主要介绍了SpringCloud OpenFeign超时控制,需要的朋友可以参考下
    2024-05-05
  • java中spi使用详解

    java中spi使用详解

    java中spi(service provider interface)是jdk内置的一种服务发现机制,可以基于配置,在运行时加载指定服务。这篇文章主要介绍了java中spi使用,需要的朋友可以参考下
    2020-09-09
  • 全面了解java基本类型和封装类型的区别及应用

    全面了解java基本类型和封装类型的区别及应用

    下面小编就为大家带来一篇全面了解java基本类型和封装类型的区别及应用。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-09-09

最新评论