SpringBoot多controller添加URL前缀的实现方法

目录
  • 前言
  • 一、配置文件内添加前缀配置
  • 二、配置映射的实体
  • 三、自定义注解
  • 四、自定义PathMatch添加前缀
  • 五、测试

前言

在某些情况下，服务的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前缀内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • SpringBoot中controller深层详细讲解

    在基于spring框架的项目开发中,必然会遇到controller层,它可以很方便的对外提供数据接口服务,也是非常关键的出口,所以非常有必要进行规范统一,使其既简洁又优雅. controller层的职责为负责接收和响应请求,一般不负责具体的逻辑业务的实现.controller主要工作如下: 接收请求并解析参数: 调用service层执行具体的业务逻辑(可能包含参数校验): 捕获业务异常做出反馈: 业务逻辑执行成功做出响应: 目前controller层代码会存在的问题: 参数校验过多地耦合了业务代

  • SpringBoot开发详解之Controller接收参数及参数校验

    SpringBoot开发详解之Controller接收参数及参数校验

    目录 Controller 中注解使用 传输参数的几种Method 获取参数的几种常用注解 使用对象直接获取参数 使用@Valid对参数进行校验 总结 Controller 中注解使用 接受参数的几种传输方式以及几种注解: 在上一篇中,我们使用了JDBC链接数据库,完成了简单的后端开发.但正如我在上文中抛出的问题,我们能不能更好的优化我们在Controller中接受参数的方式呢?这一篇中我们就来聊一聊怎么更有效的接收Json参数. 传输参数的几种Method 在定义一个Rest接口时,我们通常会

  • SpringBoot Controller中的常用注解

    目录 概述 常用注解简介 1.@Controller 2.@RestController 3.@RequestMapping 4.@RequestBody 5.@RequestParam 6.@PathVariable 总结 概述 Controller是Spring接受并处理网页请求的组件,是整个应用的入口,因此学会Controller的常用注解对理解一个应用是重中之重.SpringBoot的Controller中经常会用到注解@Controller.@RestController.@Reque

  • springboot中的controller注意事项说明

    关于controller注意事项 spring boot的controller水深无比,经过学习,我总结一些tips,以便以后参照,减少错误: 1.controller主要有两个标签 @Controller和@RestController,两个标签无法同时发挥作用,前者标注的类只能返回静态文件,后者标注的类用于返回数据类型如json字符串 2.使用@Controller标签时 templates下的文件并不能被识别(自己试验过,发现和网上很多说法都不一样),只有static文件夹下文件能直接被读

  • springboot项目完整后端请求Controller层优雅处理

    springboot项目完整后端请求Controller层优雅处理

    目录 前言 Controller 层参数接收 统一状态码 | 返回格式 | 封装 ResultVo 统一校验 | 原始做法 | @Validated 参数校验 | 优化异常处理 统一响应 | 统一包装响应 | NOT 统一响应 统一异常 前言 本篇主要要介绍的就是 controller 层的处理,一个完整的后端请求由 4 部分组成: 接口地址(也就是 URL 地址) 请求方式(一般就是 get.set,当然还有 put.delete) 请求数据(request,有 head 跟 body) 响应

  • SpringBoot多controller添加URL前缀的实现方法

    目录 前言 一.配置文件内添加前缀配置 二.配置映射的实体 三.自定义注解 四.自定义PathMatch添加前缀 五.测试 前言 在某些情况下,服务的controller中前缀是一致的,例如所有URL的前缀都为/context-path/api/v1,需要为某些URL添加统一的前缀. 能想到的处理办法为修改服务的context-path,在context-path中添加api/v1,这样修改全局的前缀能够解决上面的问题,但存在弊端,如果URL存在多个前缀,例如有些URL需要前缀为api/v2,就

  • php动态添加url查询参数的方法

    本文实例讲述了php动态添加url查询参数的方法.分享给大家供大家参考.具体分析如下: 这段代码可以动态为url添加key-value查询参数,如果参数已经存在则会用新的进行覆盖 function add_querystring_var($url, $key, $value) { $url=preg_replace('/(.*)(?|&)'.$key.'=[^&]+?(&)(.*)/i','$1$2$4',$url.'&'); $url=substr($url,0,-1);

  • SpringBoot2.x实现给Controller的RequestMapping添加统一前缀

    目录 给Controller的RequestMapping添加统一前缀 总结一下 有几个方法 springboot项目添加全局前缀 spring的配置 spring boot的配置 给Controller的RequestMapping添加统一前缀 如何给Controller的RequestMapping添加统一前缀,比如"/api",为什么要添加统一访问前缀,其实是为了后面的接口的管理. 切记:约定与规范好过一切技术处理 ! 比如: 项目A必须所有访问接口URL必须增加 /api/pr

  • SpringBoot根据目录结构自动配置Url前缀方式

    SpringBoot根据目录结构自动配置Url前缀方式

    目录 自定义RequestMappingInfo 通过接口的形式发现类 在很多其他框架中,比如Python的Flask.node.js的KOA,Controller要想能够响应前端的请求都需要我们主动去注册到应用程序上.而Spring不需要我们自己去注册,由Spring通过扫描注解的方式去主动发现. 自定义RequestMappingInfo Spring中的RequestMappingHandlerMapping专门来负责处理标注了@RequestMapping的控制器.创建一个类继承并覆盖其

  • springboot controller 增加指定前缀的两种实现方法

    目录 controller 增加指定前缀 1.增加配置 2.过滤拦截 springboot服务端口.项目前缀的配置 在application.properties中配置 controller 增加指定前缀 1.增加配置 server.servlet.context-path: /api 这种是最常见的,加上这个配置后,所有的url,必须带上/api的前缀,才能访问到该url 2.过滤拦截 这种是加上/api也可以访问,不加/api也可以访问,适合项目重构修改的适合用 import org.apa

  • SpringBoot之Controller的使用详解

    SpringBoot之Controller的使用详解

    本文介绍了 SpringBoot之Controller的使用,分享给大家,具体如下: 1.@Controller:处理http请求 2.@RestController:Spring4之后新加的注解,原来返回json需要@ResponseBody配合@Controller 3.@RequestMapping 配置url映射 1.现在有一个需求(即可以使用localhost:8080/hello和localhost:8080/hi都可以访问): @RestController public clas

  • Springboot框架整合添加redis缓存功能

    Springboot框架整合添加redis缓存功能

    目录 一:安装Redis 二:添加Redis依赖 三:添加Redis配置信息 四:创建RedisConfigurer 五:创建Redis常用方法 六:接口测试 Hello大家好,本章我们添加redis缓存功能 .另求各路大神指点,感谢 一:安装Redis 因本人电脑是windows系统,从https://github.com/ServiceStack/redis-windows下载了兼容windows系统的redis 下载后直接解压到自定义目录,运行cmd命令,进入到这个文件夹,在这个文件夹下运

  • springboot+dynamicDataSource动态添加切换数据源方式

    springboot+dynamicDataSource动态添加切换数据源方式

    目录 springboot dynamicDataSource动态添加切换数据源 1.修改初始加载的数据源map 2.此时一开始的时候就会加载数据库中的 3.但是发现新增数据源或修改数据源时无法操作 dynamicDataSource动态添加移除数据源 数据源model 切换接口 springboot dynamicDataSource动态添加切换数据源 之前有篇写了切换数据源的方法,那些可以在yml中配置固定的几个数据源进行切换后面需要新需求 在数据库实现增删改查数据源 然后连. 之前配置的就

  • vue如何给页面增加url前缀

    目录 vue页面增加url前缀 vue路径上设置指定的前缀 解决 总结 vue页面增加url前缀 在main.js中找到这段代码 const createRouter = () => new Router({   mode: 'history', // require service support   scrollBehavior: () => ({ y: 0 }),   routes: constantRoutes }) 加上 base: 'web', //页面路由前缀 修改后代码: co

  • AngularJS利用Controller完成URL跳转

    具体写法举例: 1.js定义一个controller function MyCtrl($scope, $location) { $scope.jumpToUrl = function(path) { //TODO:add code here }; } 2.html里面应用controller <div ng-controller='MyCtrl'> <button ng-click="jumpToUrl('/signin')">signin</button

随机推荐