Springboot中的GetMapping排除路径变量中的html文件

在Spring Boot中，@GetMapping注解用于映射HTTP GET请求到特定的处理方法。如果你想要排除路径变量中的HTML文件，可以通过配置Spring MVC的HandlerInterceptor或者使用@RequestMapping的excludePathPatterns属性来实现。

基础概念

@GetMapping: 这是Spring MVC提供的一个注解，用于将HTTP GET请求映射到特定的处理器方法。
路径变量: 在URL中可以定义一些变量，通过{variableName}的形式来表示，这些变量可以在控制器方法中作为参数获取。
HandlerInterceptor: Spring MVC中的一个接口，用于在请求处理的不同阶段执行自定义逻辑，如请求预处理、后处理等。

类型

全局拦截器: 通过实现WebMvcConfigurer接口并重写addInterceptors方法来注册全局的拦截器。
局部拦截器: 可以通过在控制器类或方法上使用@ControllerAdvice和@ExceptionHandler注解来实现局部拦截。

应用场景

当你想要阻止某些特定的URL模式（例如包含HTML文件的路径）被@GetMapping处理时，可以使用上述方法。

解决问题的方法

方法一：使用HandlerInterceptor

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Component
public class HtmlFileInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String uri = request.getRequestURI();
        if (uri.endsWith(".html")) {
            response.sendError(HttpServletResponse.SC_FORBIDDEN, "HTML files are not allowed.");
            return false;
        }
        return true;
    }
}

然后在配置类中注册这个拦截器：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private HtmlFileInterceptor htmlFileInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(htmlFileInterceptor);
    }
}

方法二：使用excludePathPatterns

如果你使用的是Spring Boot 2.6及以上版本，可以在@RequestMapping注解中使用excludePathPatterns属性来排除特定的路径模式：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping(excludePathPatterns = "*.html")
public class MyController {

    @GetMapping("/api/data")
    public String getData() {
        return "Data from API";
    }
}