SpringBoot多controller添加URL前缀的实现方法
更新时间：2023年02月15日 16:58:33 作者：码农-文若书生
这篇文章主要介绍了SpringBoot多controller添加URL前缀的方法,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
前言
在某些情况下，服务的controller中前缀是一致的，例如所有URL的前缀都为/context-path/api/v1，需要为某些URL添加统一的前缀。
能想到的处理办法为修改服务的context-path，在context-path中添加api/v1，这样修改全局的前缀能够解决上面的问题，但存在弊端，如果URL存在多个前缀，例如有些URL需要前缀为api/v2，就无法区分了，如果服务中的一些静态资源不想添加api/v1，也无法区分。
下面通过自定义注解的方式实现某些URL前缀的统一添加。
一、配置文件内添加前缀配置
如果需要多种前缀，添加多组配置，例如添加：api.prefix.v2=/api/v2
###############url前缀配置##################
api.prefix.v1=/api/v1
二、配置映射的实体
@Data
@Component
@ConfigurationProperties(prefix = "api.prefix")
public class ApiPrefix {
private String v1;
}
三、自定义注解
此注解功能与@RestController一致，对应api.prefix.v1的配置，如果有多组配置，定义多个注解即可
@RestController
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiV1RestController {
}
四、自定义PathMatch添加前缀
添加一个配置类继承WebMvcConfigurer，重写configurePathMatch方法，为类上有ApiV1RestController注解的controller中的接口添加对应的前缀。
@AutoConfiguration
public class WebMvcConfig implements WebMvcConfigurer {
@Autowired
private ApiPrefix apiPrefix;
@Override
public void configurePathMatch(PathMatchConfigurer configurer) {
configurer.addPathPrefix(apiPrefix.getV1(), c -> c.isAnnotationPresent(ApiV1RestController.class));
}
}
五、测试
需要在对应的controller上使用@ApiV1RestController注解代替@RestController注解
@ApiV1RestController
@RequestMapping("/test/apiv1")
public class TestApiV1RestController {
@GetMapping()
public ResponseEntity get() {
return new ResponseEntity();
}
}
到此这篇关于SpringBoot多controller添加URL前缀的实现方法的文章就介绍到这了,更多相关SpringBoot添加URL前缀内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要介绍了关于jvm的垃圾回收器以及触发full gc的场景,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-04-04
这篇文章主要介绍了Java的Struts框架与其环境配置教程,Struts框架是Java注明的SSH三大web开发框架之一,需要的朋友可以参考下2015-11-11
大概总结一下日期相关API操作原因是对于日期的操作我们开发中还是很常见的，包括在数据库中保存日期，以及之前String类中对字符串的一些处理开发中都很常见，希望对大家有所帮助2022-11-11
这篇文章主要介绍了springboot 整合 freemarker代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2019-10-10
本篇文章主要介绍了浅谈Spring Boot 异常处理篇，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-08-08
这篇文章主要介绍了@RequestBody注解的原理及使用技巧分享，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-10-10
这篇文章主要给大家介绍了关于Java中锁的实现和内存语义的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2018-11-11
java字符串日期类Date和Calendar相互转化及相关常用方法
Java语言的Calendar(日历),Date(日期),和DateFormat(日期格式)组成了Java标准的一个基本但是非常重要的部分,下面这篇文章主要给大家介绍了关于java字符串日期类Date和Calendar相互转化及相关常用方法的相关资料,需要的朋友可以参考下2023-12-12
这篇文章主要介绍了使用 Java8 实现观察者模式的方法（下）的相关资料,需要的朋友可以参考下2016-02-02
这篇文章主要介绍了Java新API的时间格式化，新的时间API的时间格式化由java.time.format.DateTimeFormatter负责，更多相关资料需要的小伙伴可以参考一下2022-05-05
最新评论