SpringBoot如何实现接口版本控制

import org.springframework.web.bind.annotation.Mapping;

import java.lang.annotation.*;

/**

  * 版本控制

  * @author Zac

  */

@Target ({ElementType.METHOD, ElementType.TYPE})

@Retention (RetentionPolicy.RUNTIME)

@Documented

@Mapping

public @interface ApiVersion {

     /**

      * 标识版本号

      * @return

      */

     double value();

}

import org.springframework.web.servlet.mvc.condition.RequestCondition;

import javax.servlet.http.HttpServletRequest;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

/**

  * 版本号匹配筛选器

  * @author Zac

  */

public class ApiVersionCondition implements RequestCondition<ApiVersionCondition> {

     /**

      * 路径中版本的正则表达式匹配， 这里用 /1.0的形式

      */

     private static final Pattern VERSION_PREFIX_PATTERN = Pattern.compile( "^\\S+/([1-9][.][0-9])$" );

     private double apiVersion;

      public ApiVersionCondition( double apiVersion) {

         this .apiVersion = apiVersion;

     }

     @Override

     public ApiVersionCondition combine(ApiVersionCondition other) {

         // 采用最后定义优先原则，则方法上的定义覆盖类上面的定义

         return new ApiVersionCondition(other.getApiVersion());

     }

     @Override public ApiVersionCondition getMatchingCondition(HttpServletRequest request) {

          Matcher m = VERSION_PREFIX_PATTERN.matcher(request.getRequestURI());

         if (m.find()) {

             Double version = Double.valueOf(m.group( 1 ));

             // 如果请求的版本号大于配置版本号， 则满足

             if (version >= this .apiVersion) {

                 return this ;

             }

         }

         return null ;

     }

     @Override

     public int compareTo(ApiVersionCondition other, HttpServletRequest request) {

         // 优先匹配最新的版本号

         return Double.compare(other.getApiVersion(), this .apiVersion);

     }

     public double getApiVersion() {

         return apiVersion;

     }

}

import org.springframework.core.annotation.AnnotationUtils;

import org.springframework.web.servlet.mvc.condition.RequestCondition;

import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

import java.lang.reflect.Method;

/**

  * 版本号匹配拦截器

  * @author Zac

  */

public class CustomRequestMappingHandlerMapping extends RequestMappingHandlerMapping {

      @Override protected RequestCondition<ApiVersionCondition> getCustomTypeCondition(Class<?> handlerType) {

         ApiVersion apiVersion = AnnotationUtils.findAnnotation(handlerType, ApiVersion. class );

         return createCondition(apiVersion);

     }

     @Override protected RequestCondition<ApiVersionCondition> getCustomMethodCondition(Method method) {

         ApiVersion apiVersion = AnnotationUtils.findAnnotation(method, ApiVersion. class );

         return createCondition(apiVersion);

     }

     private RequestCondition<ApiVersionCondition> createCondition(ApiVersion apiVersion) {

         return apiVersion == null ? null : new ApiVersionCondition(apiVersion.value());

     } 

}

import org.springframework.boot.SpringBootConfiguration;

import org.springframework.boot.autoconfigure.web.WebMvcRegistrationsAdapter;

import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

@SpringBootConfiguration

public class WebMvcRegistrationsConfig extends WebMvcRegistrationsAdapter {

     @Override

     public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {

         return new CustomRequestMappingHandlerMapping();

     } 

}

controller层实现

/**

      * version

      * @return

      */

     @GetMapping ( "/api/test/{version}" )

     @ApiVersion ( 2.0 )

     public String searchTargetImage() {

         return "Hello! Welcome to Version2" ;

     } 

/**

      * 多目标类型搜索，关联图片查询接口

      *

      * @param attribute

      * @return

      */

     @GetMapping ( "/api/test/{version}" )

     @ApiVersion ( 1.0 )

     public AppResult searchTargetImage() {

         return "Hello! Welcome to Version1" ;

     }

package com.yugioh.api.common.core.version;

import org.springframework.web.bind.annotation.Mapping;

import java.lang.annotation.*;

/**

  * 接口版本

  *

  * @author lieber

  */

@Target ({ElementType.METHOD, ElementType.TYPE})

@Retention (RetentionPolicy.RUNTIME)

@Documented

@Mapping

public @interface ApiVersion { 

     String value() default "1.0.0" ;

}

package com.yugioh.api.common.core.version;

import lombok.AllArgsConstructor;

import lombok.Getter;

import lombok.extern.slf4j.Slf4j;

import org.springframework.web.servlet.mvc.condition.RequestCondition;

import javax.servlet.http.HttpServletRequest;

import java.util.Objects;

import java.util.regex.Matcher;

import java.util.regex.Pattern;

/**

  * 版本控制

  *

  * @author lieber

  */

@AllArgsConstructor

@Getter

@Slf4j

public class ApiVersionCondition implements RequestCondition<ApiVersionCondition> {

     private String version;

     private final static Pattern VERSION_PREFIX_PATTERN = Pattern.compile( ".*v(\\d+(.\\d+){0,2}).*" );

     public final static String API_VERSION_CONDITION_NULL_KEY = "API_VERSION_CONDITION_NULL_KEY" ;

     @Override

     public ApiVersionCondition combine(ApiVersionCondition other) {

         // 方法上的注解优于类上的注解

         return new ApiVersionCondition(other.getVersion());

     }

     @Override

     public ApiVersionCondition getMatchingCondition(HttpServletRequest request) {

         Matcher m = VERSION_PREFIX_PATTERN.matcher(request.getRequestURI());

         if (m.find()) {

             String version = m.group( 1 );

             if ( this .compareTo(version)) {

                 return this ;

             }

         }

         // 将错误放在request中，可以在错误页面明确提示，此处可重构为抛出运行时异常

         request.setAttribute(API_VERSION_CONDITION_NULL_KEY, true );

         return null ;

     }

     @Override

     public int compareTo(ApiVersionCondition other, HttpServletRequest request) {

         return this .compareTo(other.getVersion()) ? 1 : - 1 ;

     }

     private boolean compareTo(String version) {

         return Objects.equals(version, this .version);

     }

}

package com.yugioh.api.common.core.version;

import org.springframework.core.annotation.AnnotatedElementUtils;

import org.springframework.core.annotation.AnnotationUtils;

import org.springframework.web.servlet.mvc.condition.RequestCondition;

import org.springframework.web.servlet.mvc.method.RequestMappingInfo;

import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

import java.lang.reflect.Method;

/**

  * 自定义匹配处理器

  *

  * @author lieber

  */

public class ApiVersionRequestMappingHandlerMapping extends RequestMappingHandlerMapping {

     private final static String VERSION_PREFIX = "{version}" ;

     @Override

     protected RequestCondition<?> getCustomTypeCondition(Class<?> handlerType) {

         ApiVersion apiVersion = AnnotationUtils.findAnnotation(handlerType, ApiVersion. class );

         return createCondition(apiVersion);

     }

     @Override

     protected RequestCondition<?> getCustomMethodCondition(Method method) {

         ApiVersion apiVersion = AnnotationUtils.findAnnotation(method, ApiVersion. class );

         return createCondition(apiVersion);

     }

     @Override

     protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) {

         RequestMappingInfo requestMappingInfo = super .getMappingForMethod(method, handlerType);

         if (requestMappingInfo == null ) {

             return null ;

         }

         return createCustomRequestMappingInfo(method, handlerType, requestMappingInfo);

     }

     private RequestMappingInfo createCustomRequestMappingInfo(Method method, Class<?> handlerType, RequestMappingInfo requestMappingInfo) {

         ApiVersion methodApi = AnnotatedElementUtils.findMergedAnnotation(method, ApiVersion. class );

         ApiVersion handlerApi = AnnotatedElementUtils.findMergedAnnotation(handlerType, ApiVersion. class );

         if (methodApi != null || handlerApi != null ) {

             return RequestMappingInfo.paths(VERSION_PREFIX).options( this .config).build().combine(requestMappingInfo);

         }

         return requestMappingInfo;

     }

     private RequestMappingInfo.BuilderConfiguration config = new RequestMappingInfo.BuilderConfiguration();

     private RequestCondition<ApiVersionCondition> createCondition(ApiVersion apiVersion) {

         return apiVersion == null ? null : new ApiVersionCondition(apiVersion.value());

     }

}

package com.yugioh.api.common.core.version;

import lombok.Data;

import org.springframework.boot.context.properties.ConfigurationProperties;

import org.springframework.context.annotation.Configuration;

/**

  * 版本管理器配置

  *

  * @author lieber

  */

@Data

@Configuration

@ConfigurationProperties (prefix = "api.config.version" , ignoreInvalidFields = true )

public class ApiVersionConfig {

     /**

      * 是否开启

      */

     private boolean enable;

}

package com.yugioh.api.common.core.version;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.autoconfigure.web.servlet.WebMvcRegistrations;

import org.springframework.context.annotation.Configuration;

import org.springframework.core.Ordered;

import org.springframework.core.annotation.Order;

import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

/**

  * @author lieber

  */

@Configuration

@Order (Ordered.HIGHEST_PRECEDENCE)

public class ApiWebMvcRegistrations implements WebMvcRegistrations {

     private final ApiVersionConfig apiVersionConfig;

     @Autowired

     public ApiWebMvcRegistrations(ApiVersionConfig apiVersionConfig) {

         this .apiVersionConfig = apiVersionConfig;

     }

     @Override

     public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {

         if (apiVersionConfig.isEnable()) {

             return new ApiVersionRequestMappingHandlerMapping();

         }

         return null ;

     }

}