脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot 接口统一前缀

SpringBoot实现接口统一前缀

 更新时间：2023年07月25日 10:08:15   作者：catoop  
本文主要介绍了SpringBoot实现接口统一前缀，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

需求

需求如题，想给一个 spring boot 项目的所有请求路径添加统一前缀，可以通过 context-path 来配置。但是在同时存在静态资源和 Controller 接口的项目中，如果希望静态资源从根路径访问，并且所有接口拥有统一路径前缀，则需要通过 Spring 层面来解决这个问题（context-path 是 web 容器层面的，如果配置它则会把静态资源都包含进去）。

如下接口示例：

# 3个静态资源
http://localhost:8080/index.html
http://localhost:8080/home.js
http://localhost:8080/dog.png

# 3个统一前缀为 /api
http://localhost:8080/api/test/show
http://localhost:8080/api/test/display
http://localhost:8080/api/test/print

如上URL示例中，希望放在 springboot 根目录 static 中的静态资源能直接通过根路径访问。其他 Controller 接口的前缀 “/api” 可以在配置文件中自定义配置变更。

实现

实现方法很简单，如下代码和配置文件：

1、GlobalControllerPathPrefixConfiguration.java

package com.example.demospringbean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
 * 为 Controller 接口配置统一前缀
 *
 * @author shanhy
 * @date 2023-03-20 15:50
 */
@Configuration
public class GlobalControllerPathPrefixConfiguration implements WebMvcConfigurer {
    @Value("${spring.controller.path-prefix:}")
    private String pathPrefix;
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix(pathPrefix, c -> c.isAnnotationPresent(RestController.class));
    }
}

2、application.properties

spring.controller.path-prefix=/api

配置文件中参数 spring.controller.path-prefix 也可以是多级路径，例如 /api/demo。

3、TestController.java

/**
 * 接口示例
 * 
 * @author shanhy
 * @date 2023-03-20 15:49
 */
@RestController
@RequestMapping("/test")
public class TestController {
    @GetMapping("/show")
    public String show(){
        return "OK";
    }
}

最后将 dog.png 放在 springboot 项目的 static 目录中用来测试。

验证

打开浏览器分别访问如下路径可以正常显示结果，表示成功。

http://localhost:8080/dog.png
http://localhost:8080/api/test/show

到此这篇关于SpringBoot实现接口统一前缀的文章就介绍到这了,更多相关SpringBoot 接口统一前缀内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • SpringBoot security安全认证登录的实现方法

    SpringBoot security安全认证登录的实现方法

    这篇文章主要介绍了SpringBoot security安全认证登录的实现方法，也就是使用默认用户和密码登录的操作方法，本文结合实例代码给大家介绍的非常详细，需要的朋友可以参考下
    2023-02-02
  • mybatis原理概述入门教程

    mybatis原理概述入门教程

    这篇文章主要介绍了在今天这篇博文中，我将要介绍一下mybatis的框架原理，以及mybatis的入门程序，实现用户的增删改查，她有什么优缺点以及mybatis和hibernate之间存在着怎么样的关系，大家这些问题一起通过本文学习吧
    2016-09-09
  • Java 实现声音播放程序

    Java 实现声音播放程序

    这篇文章主要介绍了Java 实现声音播放程序的示例代码，帮助大家更好的理解和使用Java，感兴趣的朋友可以了解下
    2020-12-12
  • SpringData Repository Bean方法定义规范代码实例

    SpringData Repository Bean方法定义规范代码实例

    这篇文章主要介绍了SpringData Repository Bean方法定义规范代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-08-08
  • 详解Java中字符串缓冲区StringBuffer类的使用

    详解Java中字符串缓冲区StringBuffer类的使用

    StringBuffer与String类似,只不过StringBuffer在进行字符串处理时不生成新的对象,下面我们就来详解Java中字符串缓冲区StringBuffer类的使用:
    2016-06-06
  • Java实现矩阵加减乘除及转制等运算功能示例

    Java实现矩阵加减乘除及转制等运算功能示例

    这篇文章主要介绍了Java实现矩阵加减乘除及转制等运算功能,结合实例形式总结分析了java常见的矩阵运算实现技巧,需要的朋友可以参考下
    2018-01-01
  • Java Spring使用hutool的HttpRequest发送请求的几种方式

    Java Spring使用hutool的HttpRequest发送请求的几种方式

    文章介绍了Hutool库中用于发送HTTP请求的工具,包括添加依赖、发送GET和POST请求的方法,以及GET请求的不同参数传递方式,感兴趣的朋友跟随小编一起看看吧
    2024-11-11
  • 详解使用Java原生代理实现AOP实例

    详解使用Java原生代理实现AOP实例

    本篇文章主要介绍了详解使用Java原生代理实现AOP实例，具有一定的参考价值，有兴趣的可以了解一下。
    2017-01-01
  • 深入解析Spring的DI依赖注入(配置文件方式)

    深入解析Spring的DI依赖注入(配置文件方式)

    文章介绍了Spring框架中的IOC（控制反转）和DI（依赖注入）概念,并展示了如何通过配置文件进行属性的set方法注入、构造方法注入及数组、集合等复杂类型的注入,通过实例代码和流程分析,清晰展示了依赖注入在Spring中的实现原理和使用方法,感兴趣的朋友跟随小编一起看看吧
    2025-12-12
  • Java组件javabean用户登录实例详解

    Java组件javabean用户登录实例详解

    这篇文章主要为大家详细介绍了Java组件javabean用户登录实例，内容有用户登录，注册和退出等，感兴趣的小伙伴们可以参考一下
    2016-05-05

最新评论