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动态修改接口请求路径内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java servlet 使用 PrintWriter 时的编码与乱码的示例代码

    Java servlet 使用 PrintWriter 时的编码与乱码的示例代码

    本篇文章主要介绍了Java servlet 使用 PrintWriter 时的编码与乱码的示例代码,探讨了 PrintWriter 的缺省编码与普通字符流的缺省编码的差异,具有一定的参考价值,有兴趣的可以了解一下
    2017-11-11
  • Java实现迷你图书管理系统案例全程

    Java实现迷你图书管理系统案例全程

    这篇文章主要为大家详细介绍了如何利用java语言实现简单的图书管理系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-12-12
  • 浅谈SpringBoot集成Redis实现缓存处理(Spring AOP实现)

    浅谈SpringBoot集成Redis实现缓存处理(Spring AOP实现)

    这篇文章主要介绍了浅谈SpringBoot集成Redis实现缓存处理(Spring AOP实现),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-12-12
  • 完美解决Get和Post请求中文乱码的问题

    完美解决Get和Post请求中文乱码的问题

    下面小编就为大家带来一篇完美解决Get和Post请求中文乱码的问题。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-05-05
  • Java如何实现长图文生成的示例代码

    Java如何实现长图文生成的示例代码

    这篇文章主要介绍了Java如何实现长图文生成的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-08-08
  • Java enum关键字不识别的快速解决办法

    Java enum关键字不识别的快速解决办法

    这篇文章主要介绍了Java enum关键字不识别的快速解决办法,非常不错,具有参考借鉴价值,感兴趣的朋友一起看看吧
    2016-09-09
  • Java中连接Mongodb进行增删改查的操作详解

    Java中连接Mongodb进行增删改查的操作详解

    MongoDB是一个基于分布式文件存储的数据库,由C++语言编写,旨在为WEB应用提供可扩展的高性能数据存储解决方案,本文给大家介绍了Java中连接Mongodb进行操作,文中有详细的代码示例供大家参考,需要的朋友可以参考下
    2024-06-06
  • JVM要双亲委派的原因及如何打破它

    JVM要双亲委派的原因及如何打破它

    平时做业务开发比较少接触类加载器,但是如果想深入学习,了解类加载的原理是必不可少的.java的类加载器有哪些?什么是双亲委派?为什么要双亲委派?如何打破它?接下来本文就带大家详细介绍这些知识 ,需要的朋友可以参考下
    2021-06-06
  • springboot Actuator的指标监控可视化功能详解

    springboot Actuator的指标监控可视化功能详解

    SpringBoot Actuator是springboot为简化我们对微服务项目的监控功能抽取出来的模块,使得我们每个微服务快速引用即可获得生产界别的应用监控、审计等功能。这篇文章主要介绍了springboot Actuator的指标监控可视化,需要的朋友可以参考下
    2021-08-08
  • 浅谈Spring boot cache使用和原理

    浅谈Spring boot cache使用和原理

    这篇文章主要介绍了浅谈Spring boot cache使用和原理,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-09-09

最新评论