SpringBoot项目启动过程动态修改接口请求路径的解决方案

 更新时间:2024年10月10日 09:19:16   作者:codest  
在SpringBoot服务整合过程中,遇到了多个服务中相同RequestMapping路径导致的启动问题,解决方案是通过修改RequestMappingHandlerMapping类的getMappingForMethod方法,本文给大家介绍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;
    }
}

到此这篇关于SpringBoot项目启动过程动态修改接口请求路径的文章就介绍到这了,更多相关SpringBoot动态修改接口请求路径内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • IDEA+GIT使用入门图文详解

    IDEA+GIT使用入门图文详解

    这篇文章主要介绍了IDEA+GIT使用入门详解,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-11-11
  • SpringBoot实现自定义启动器的示例详解

    SpringBoot实现自定义启动器的示例详解

    虽然Spring官方给我们提供了很多的启动器供我们使用,但有时候我们也会遇到某些特殊场景,这些启动器满足不了。这个时候就需要自定义一个启动器供我们使用,本文为大家介绍了SpringBoot实现自定义启动器的方法,希望对大家有所帮助
    2023-01-01
  • java并发编程专题(一)----线程基础知识

    java并发编程专题(一)----线程基础知识

    这篇文章主要介绍了java并发编程线程的基础知识,文中讲解非常详细,帮助大家更好的学习JAVA并发编程,感兴趣想学习JAVA的可以了解下
    2020-06-06
  • SpringBoot实现分布式验证码登录方案小结

    SpringBoot实现分布式验证码登录方案小结

    验证码登录作为一种有效的防护手段,可以防止恶意gongji、暴力pojie等,本文主要介绍了SpringBoot实现分布式验证码登录方案小结,具有一定的参考价值,感兴趣的可以了解一下
    2024-12-12
  • Spring Aware标记接口使用案例解析

    Spring Aware标记接口使用案例解析

    这篇文章主要介绍了Spring Aware标记接口使用案例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • Maven中exec插件执行Java程序的实现

    Maven中exec插件执行Java程序的实现

    在Maven项目中,可以使用Maven的插件来执行Java程序,本文主要介绍了Maven中exec插件执行Java程序的实现,具有一定的参考价值,感兴趣的可以了解一下
    2023-12-12
  • Java中基于推、拉模式的sentinel规则持久化详解

    Java中基于推、拉模式的sentinel规则持久化详解

    这篇文章主要介绍了Java中基于推、拉模式的sentinel规则持久化详解,推模式是sentinelDashboard 把规则推给Nacos,Nacos监听规则的变化推给微服务,拉模式是sentinelDashboard 把规则直接给微服务, Nacos定时的同步微服务端的规则,需要的朋友可以参考下
    2023-09-09
  • 关于java中Map的九大问题分析

    关于java中Map的九大问题分析

    这篇文章主要为大家详细分析了关于java中Map的九大问题,感兴趣的小伙伴们可以参考一下
    2016-08-08
  • Spring自动扫描无法扫描jar包中bean的解决方法

    Spring自动扫描无法扫描jar包中bean的解决方法

    在日常开发中往往会对公共的模块打包发布,然后调用公共包的内容。然而,最近对公司的公共模块进行整理发布后。spring却无法扫描到相应的bean,下面这篇文章主要给大家介绍了关于Spring自动扫描时无法扫描jar包中bean的解决方法,需要的朋友可以参考下。
    2017-06-06
  • SpringBoot Maven打包如何根据环境排除文件

    SpringBoot Maven打包如何根据环境排除文件

    文章介绍了在SpringBoot项目中,根据不同的环境(开发、测试、生产)进行JSP文件打包处理的方法,通过配置`pom.xml`文件中的``标签,可以实现开发环境保留`index.jsp`文件,测试环境和生产环境排除该文件
    2024-12-12

最新评论