SpringBoot项目启动过程动态修改接口请求路径

背景

最近遇到一个技术需求，需要对其他多个已有的服务进行整合打包为一个整体的服务，项目启动过程发现一个问题，在controller层多个服务之间存在相同的RequestMapping接口请求路径，导致服务无法启动。

目前的接口定义规范为：/服务名(context-path)/接口版本号/模块名/接口名

例如通过用户Id查询用户信息的接口，在统一认证服务和用户管理服务有如下接口定义

统一认证服务：/sso/v1.0/user/get/{id}

用户管理服务：/user/v1.0/user/get/{id}

当我们把统一认证服务和用户管理服务进行整合为一个服务时，/v1.0/user/get/{id}请求路径发生重复，导致服务无法启动。

解决方案

为了解决服务之间接口定义冲突的问题，我们准备对接口的请求路径进行动态修改，主要是通过controller类所在的包路径进行服务名的识别，并加入到接口请求路径的最前面。

举个栗子：

统一认证服务controller层伪代码如下：

package cn.codest.sso.web;

@RestController
@Api(tags = "统一认证服务")
@RequestMapping("/v1.0/user")
@RequiredArgsConstructor
public class SSOController {

    private final UserService userService;

    @GetMapping("/get/{id}")
    @ApiOperation(value = "用户查询", httpMethod = "GET", notes = "用户查询")
    public SwaggerResultUtil getById(String id){
        return SwaggerResultUtil.resultSuccess(userService.get(id));
    }

}

通过重载RequestMappingHandlerMapping类的getMappingForMethod方法，实现在项目启动过程中注册/v1.0/user/get/{id}接口时，识别package的路径cn.codest.sso.web提取业务标识sso，修改接口注册地址为/sso/v1.0/user/get/{id}，具体代码如下：

@Slf4j
@Configuration
@Order(Ordered.HIGHEST_PRECEDENCE)
public class PackagePathRequestMappingHandler extends RequestMappingHandlerMapping {

    private static final String PACKAGE_PREFIX = "cn.codest";

    private static final String SERVICE_PREFIX = "service";

    private static final String PROVIDER_PREFIX = "providerD";

    /**
     * 包名对应的服务名缓存类
     */
    private final LinkedHashMap<String, String> services = new LinkedHashMap<>(8);

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

        // 判断当前注册的controller接口属于业务层controller，部分中间件例如swagger也会进行接口注册
        if (!StringUtils.startsWith(handlerType.getName(), PACKAGE_PREFIX)
                || !AnnotatedElementUtils.hasAnnotation(method, RequestMapping.class)
                || AnnotatedElementUtils.hasAnnotation(handlerType, FeignClient.class)) {
            return super.getMappingForMethod(method, handlerType);
        }

        try {
            // 构造RequestMapping对象
            RequestMappingInfo mapping = super.getMappingForMethod(method, handlerType);
            // 根据包路径获取服务名
            String serviceName = getServiceName(handlerType.getName());
            if (StringUtils.isBlank(serviceName)) {
                return mapping;
            }
            // 增加服务名前缀
            return RequestMappingInfo.paths(serviceName).build().combine(mapping);
        } catch (Exception e) {
            log.error("重写RequestMapping请求路径时发生错误[class: {}, method: {}]", handlerType.getName(), method.getName(), e);
            throw e;
        }
    }

    protected String getServiceName(String className) {
        // 分割类限定名
        String[] packages = className.split("\\.");

        // 判断包路径长度
        if (packages.length > 3) {
            // 获取子产品包名
            String serviceName = packages[2];

            // 读取缓存
            if (services.containsKey(serviceName)) {
                return services.get(serviceName);
            } else if (StringUtils.startsWith(serviceName, SERVICE_PREFIX)) {  // service服务
                services.put(serviceName, serviceName.replace(SERVICE_PREFIX, StringUtils.EMPTY));
            } else if (StringUtils.startsWith(serviceName, PROVIDER_PREFIX.toLowerCase())) {    // provider服务
                services.put(serviceName, serviceName.replace(PROVIDER_PREFIX.toLowerCase(), PROVIDER_PREFIX));
            }

            return services.get(serviceName);
        }

        return StringUtils.EMPTY;
    }

}

注册自定义RequestMappingHandler，项目使用的SpringBoot版本为2.0.x，不同版本注册方式不同，可以自行查阅官方文档。

public class CustomWebMvcConfig implements WebMvcRegistrations {

    @Override
    public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
        RequestMappingHandlerMapping handlerMapping = new PackagePathRequestMappingHandler();
        handlerMapping.setOrder(Ordered.HIGHEST_PRECEDENCE);
        return handlerMapping;
    }

}