SpringBoot 根据目录路径生成接口的url路径

傷城~ 2023-07-08 06:00 2阅读 0赞

首先我们新建一个AutoPrefixUrlMapping类，继承自RequestMappingHandlerMapping，用以获取新的url

public class AutoPrefixUrlMapping extends RequestMappingHandlerMapping { 
    
        // 从配置文件中读取根目录
        @Value("${api-package}")
        private String apiPackagePath;
    
        @Override
        protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) { 
    
            RequestMappingInfo mappingInfo =  super.getMappingForMethod(method, handlerType);
            if (mappingInfo != null){ 
                String prefix = this.getPrefix(handlerType);
                RequestMappingInfo newMappingInfo = RequestMappingInfo.paths(prefix).build().combine(mappingInfo);
                return newMappingInfo;
            }
            return mappingInfo;
        }
    
        // 获取前缀
        private String getPrefix(Class<?> handlerType){ 
    
            String packageName = handlerType.getPackage().getName();
            String newPath = packageName.replaceAll(this.apiPackagePath, "");
    
            return newPath.replace(".","/");
        }
    }

配置文件application.proprties如下：

api-package = com.lyn.miniprogram.api

用以声明url的根目录  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x0MzI2MDMwNDM0_size_16_color_FFFFFF_t_70]  
然后我们创建一个AutoPrefixConfiguration类，用以将AutoPrefixUrlMapping加入Springboot的容器中

@Component
    public class AutoPrefixConfiguration implements WebMvcRegistrations { 
    
        @Override
        public RequestMappingHandlerMapping getRequestMappingHandlerMapping() { 
            return new AutoPrefixUrlMapping();
        }
    }

测试接口如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x0MzI2MDMwNDM0_size_16_color_FFFFFF_t_70 1]  
url会自动带上 /v1的前缀，测试通过！当然，如果目录层级更复杂，通过上述代码也是可以实现的。  
![在这里插入图片描述][20200225140216160.png]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x0MzI2MDMwNDM0_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200225135709967.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x0MzI2MDMwNDM0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x0MzI2MDMwNDM0_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200225135943900.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2x0MzI2MDMwNDM0,size_16,color_FFFFFF,t_70
[20200225140216160.png]: https://img-blog.csdnimg.cn/20200225140216160.png