脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → 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 接口统一前缀内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Java基础学习之字符缓冲流的应用

    Java基础学习之字符缓冲流的应用

    这篇文章主要为大家详细介绍了Java基础中的字符缓冲流的相关应用，例如复制Java文件等，文中的示例代码讲解详细，感兴趣的小伙伴可以跟随小编一起学习一
    2022-09-09
  • 如何理解SpringMVC

    如何理解SpringMVC

    Spring Web MVC是一种基于Java的实现了Web MVC设计模式的请求驱动类型的轻量级Web框架，即使用了MVC架构模式的思想，将web层进行职责解耦，基于请求驱动指的就是使用请求-响应模型，框架的目的就是帮助我们简化开发
    2021-06-06
  • Hibernate实现悲观锁和乐观锁代码介绍

    Hibernate实现悲观锁和乐观锁代码介绍

    这篇文章主要介绍了Hibernate实现悲观锁和乐观锁的有关内容，涉及hibernate的隔离机制，以及实现悲观锁和乐观锁的代码实现，需要的朋友可以了解下。
    2017-09-09
  • Java请求调用参数格式为form-data类型的接口代码示例

    Java请求调用参数格式为form-data类型的接口代码示例

    这篇文章主要给大家介绍了关于Java请求调用参数格式为form-data类型的接口的相关资料,文中给出了详细的代码示例,对大家的学习或者工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-08-08
  • RocketMQ消息积压原因及处理方法

    RocketMQ消息积压原因及处理方法

    RocketMQ是一种可靠的、可扩展的消息中间件，广泛应用于分布式系统中的消息通信，然而，在高并发的场景下，由于消息产生速度超过消费速度，可能会导致消息积压的问题，本文将介绍RocketMQ消息积压的原因和如何处理积压问题
    2023-06-06
  • Java OpenCV图像处理之图形与文字绘制

    Java OpenCV图像处理之图形与文字绘制

    这篇文章主要为大家介绍了如何利益Java OpenCV实现在图像上绘制文字与形状，文中的示例代码讲解详细，感兴趣的小伙伴可以跟随小编一起动手试一试
    2022-02-02
  • gataway断言工作流程源码剖析

    gataway断言工作流程源码剖析

    这篇文章主要为大家介绍了gataway断言工作流程源码剖析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2024-01-01
  • Spring Bean六种作用域的适用场景和使用方式

    Spring Bean六种作用域的适用场景和使用方式

    本文主要介绍了Spring Bean六种作用域的适用场景和使用方式，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2023-07-07
  • 详解spring中的Aware接口功能

    详解spring中的Aware接口功能

    Spring的依赖注入的最大亮点是所有的Bean对Spring容器的存在是没有意识的，我们可以将Spring容器换成其他的容器，Spring容器中的Bean的耦合度因此也是极低的,本文重点给大家介绍spring中的Aware接口，感兴趣的朋友一起看看吧
    2022-02-02
  • jmeter实现接口关联的两种方式(正则表达式提取器和json提取器)

    jmeter实现接口关联的两种方式(正则表达式提取器和json提取器)

    Jmeter用于接口测试时，后一个接口经常需要用到前一次接口返回的结果，本文主要介绍了jmeter实现接口关联的两种方式，感兴趣的小伙伴们可以参考一下
    2021-11-11

最新评论