spring boot controller 增加指定前缀的两种方法

1、增加配置

server.servlet.context-path: /api
这种是最常见的,加上这个配置后,所有的url,必须带上/api的前缀,才能访问到该url

2、过滤拦截

这种是加上/api也可以访问,不加/api也可以访问,适合项目重构修改的适合用


import org.apache.commons.lang.StringUtils;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.Order;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;


@Configuration
@Order(1)
@WebFilter(filterName = "urlFilter", urlPatterns = "/api/*")
public class UrlFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        String servletPath = httpRequest.getServletPath();
        if (StringUtils.isNotBlank(servletPath) && servletPath.startsWith("/api")) {
            String newPath = servletPath.substring(4);
            request.getRequestDispatcher(newPath).forward(request, response);
        } else {
            chain.doFilter(request, response);
        }
    }

    @Override
    public void destroy() {

    }
}
<think>好的,用户现在遇到了Spring BootController配置未生效的问题,需要帮助解决。根据用户提供的引用资料和之前的对话,我需要先理清可能的原因,并给出相应的解决方案。 首先,用户之前的问题是关于@RequiredArgsConstructor注解的,现在转向了Controller配置的问题,可能需要考虑Spring Boot的配置机制、依赖管理、自动配置等方面的问题。 首先,用户提供的引用中有提到依赖项的配置,比如引用[1]中的依赖包括spring-boot-starter-web,这是Spring MVC的核心依赖,如果缺少这个依赖,Controller自然不会生效。所以第一个可能的原因是项目依赖中没有正确引入Web相关的starter。 然后,引用[3]提到添加了Actuator的依赖,但Actuator主要与监控和管理相关,可能和Controller配置无关,不过如果用户错误地配置了Actuator,可能会影响端点暴露,但可能性较低。 引用[5]提到静态资源的处理,如果用户配置了自定义的WebMvcConfigurerAdapter,可能会覆盖默认的配置,导致Controller的路径被修改或者拦截。因此,检查是否有自定义的MVC配置也是一个方向。 接下来,用户的问题中提到了配置未生效,可能的其他原因包括: 1. 包扫描问题:Controller类所在的包没有被Spring Boot的组件扫描到,导致未被注册为Bean。 2. 注解缺失:忘记在Controller类上使用@Controller或@RestController注解。 3. 方法注解问题:方法上没有使用@RequestMapping或其派生注解(如@GetMapping)。 4. 端口或上下文路径配置错误:应用可能运行在非默认的端口或上下文路径下,导致访问路径不正确。 5. 自动配置未生效:可能排除了Spring Boot自动配置,比如使用@EnableAutoConfiguration(exclude=...)排除了Web相关的配置。 6. 配置文件问题:例如application.properties或application.yml中的配置错误,如server.servlet.context-path未正确设置。 7. 过滤器或拦截器拦截了请求:自定义的过滤器或拦截器可能阻止了请求到达Controller。 8. 启动类位置问题:启动类没有放在根包下,导致组件扫描范围不正确。 根据引用[2],用户可能有配置文件的修改,比如设置spring.profiles.active或server.port,这可能导致应用运行在不同的端口或配置环境下,需要检查这些配置是否正确。 引用[4]提到Spring Boot的文档,可能需要引导用户查阅相关文档,特别是关于Web MVC的部分。 此外,用户之前的回答中提到了Lombok的注解,可能与当前问题无关,但需要考虑是否有其他注解或配置冲突。 接下来需要逐步分析每个可能的原因,并提供对应的解决方案。比如检查依赖是否正确,包扫描路径,注解是否齐全,配置是否正确,是否有自定义配置覆盖了默认行为等。同时,结合用户提供的引用资料中的信息,比如检查server.port是否被修改(引用[2]中的例子将端口改为8061),可能导致用户访问的端口不正确。 最后,建议用户使用Actuator的端点(如引用[3]中的内容)来检查Bean的注册情况,确认Controller是否被正确加载。</think>### Spring Boot Controller 配置未生效解决方案 针对 Controller 配置未生效问题,结合引用内容和 Spring Boot 机制,按以下步骤排查: #### 一、核心检查清单(按优先级排序) 1. **依赖完整性验证** 检查是否包含必要依赖(引用[1]): ```gradle // Gradle 配置示例 dependencies { implementation 'org.springframework.boot:spring-boot-starter-web' } ``` - 缺少 `spring-boot-starter-web` 会导致 MVC 配置完全失效 - 使用 `./gradlew dependencies` 检查依赖树 2. **包扫描范围确认** ```java @SpringBootApplication // 默认扫描启动类所在包及其子包 public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` - 若 Controller 在 `com.example.web` 而启动类在 `com.example.app` 会导致扫描失效 - 解决方案:添加显式扫描注解 ```java @ComponentScan(basePackages = "com.example.web") ``` 3. **端点配置验证**(引用[3]) 通过 Actuator 检查已注册端点: ```yaml # application.yml management: endpoints: web: exposure: include: mappings ``` 访问 `http://localhost:8080/actuator/mappings` 查看已注册的 Controller 方法 4. **端口冲突排查**(引用[2]) 检查是否修改了默认端口: ```yaml server: port: 8061 # 非默认端口需要调整访问地址 servlet: context-path: /api # 上下文路径变更 ``` #### 二、典型问题场景与解决方案 | 现象 | 排查点 | 解决方案 | |------|--------|----------| | 404 错误 | 1. 路径映射错误<br>2. 静态资源冲突(引用[5]) | 1. 使用 `@RequestMapping("/api/v1")` 明确路径前缀<br>2. 检查 `/static` 目录是否存在同名路由文件 | | 500 错误 | 1. 参数绑定失败<br>2. 拦截器异常 | 1. 添加 `@RequestParam` 注解<br>2. 检查过滤器链配置 | | 无日志输出 | 1. Controller 未加载<br>2. 日志级别过高 | 1. 检查启动日志中的 `RequestMappingHandlerMapping`<br>2. 设置 `logging.level.org.springframework.web=DEBUG` | #### 三、配置覆盖问题处理 当存在自定义 Web 配置时(引用[5]): ```java @Configuration public class WebConfig implements WebMvcConfigurer { @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { // 错误的资源映射可能覆盖 Controller 路由 registry.addResourceHandler("/**") .addResourceLocations("classpath:/custom-static/"); } } ``` - 建议使用 `@RestControllerAdvice` 代替全面覆盖配置 - 保留默认静态资源路径:`registry.setOrder(Ordered.LOWEST_PRECEDENCE)` #### 四、诊断工具推荐 1. **启动时检查** 观察控制台输出的关键日志: ```log Mapped "{[/hello], methods=[GET]}" onto public String hello() ``` 2. **Actuator 端点**(引用[3]) - `/actuator/mappings`:完整路由映射表 - `/actuator/conditions`:自动配置生效情况 3. **单元测试验证** ```java @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) @AutoConfigureMockMvc class MyControllerTest { @Autowired private MockMvc mockMvc; @Test void testHelloEndpoint() throws Exception { mockMvc.perform(get("/hello")) .andExpect(status().isOk()); } } ``` #### 五、配置文件优先级检查 排查 `bootstrap.yml` 的特殊配置(引用[2]): ```yaml # bootstrap.yml(高优先级) spring: cloud: config: uri: http://config-server:8888 ``` - 确认未在此文件中覆盖 `server.servlet.context-path` 等关键配置 - 区分 `application.yml` 和 `bootstrap.yml` 的作用域
评论 1
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值