ResourceHandler 与控制器中的通配符冲突

Question

我正在尝试为资源处理程序保留所有以/static/** 开头的路径。 不幸的是，我在请求映射中有一些从根路径/ 派生的通配符。像这样的：

我尝试了什么？

• ResourceHandlerRegistry#setOrder:

  @Override
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
      registry.addResourceHandler("/static/**")
              .addResourceLocations("classpath:/resources/static/");
  
      registry.setOrder(1);
  }
  

• 各种版本的拦截器（有或无顺序）：

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
      registry.addInterceptor(new ResourcesInterceptor())
              .excludePathPatterns("/static/**")
              .order(2);
  }
  

这是一个半心半意的成功（如果我将映射更改为/{profile}/{project}/**，它甚至可能都行不通），因为：

/static/style/home.css      # works
/static/style/home.cssxxx   # 404, works
/static/style               # catched by controller, expected: 404
/static                     # catched by controller, expected: 404

我发现了一些类似的问题，大部分没有答案或有一些肮脏的解决方案，例如：

• Exclude manually static path in every controller with wildcard by regex
• 更改您的映射
• Manage controllers order
• 创建指向/static/**的专用控制器
• [...]

总结：

• 我不想用正则表达式，因为以后会很痛苦
• 我也无法更改映射。我知道，这是最简单的方法，但我就是做不到。
• 更改订单不起作用
• 创建专用控制器仍然存在一些路径问题

我正在寻找一个简单的解决方案，完全自动化，最好从配置中获得。问题是：实现这一目标的正确方法是什么？

Answer 1

这个问题是由于 Spring 处理用户请求的方式造成的。有几个HandlerMappings，它们按指定的顺序执行。对我们来说最重要的是这两个：

1. RequestMappingHandlerMapping 在WebMvcConfigurationSupport 中注册了order=0（我们可以在源代码和文档中看到这一点）

   /**
    * Return a {@link RequestMappingHandlerMapping} ordered at 0 for mapping
    * requests to annotated controllers.
    */
   

2. AbstractHandlerMapping 在ResourceHandleRegistry 中实例化，默认顺序为Integer.MAX_VALUE-1

   private int order = Ordered.LOWEST_PRECEDENCE - 1;
   

当你创建一个路径为/{profile}/{project}的RequestMapping并尝试到达资源/static/somefile.css时，你发送的请求被RequestMappingHandlerMapping抓取，并没有到达ResourceHandlerRegistry创建的HandlerMapping。

解决此问题的一个简单方法是在addResourceHandlers 中将顺序设置为-1

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/static/**")
        .addResourceLocations("classpath:/resources/static/");

    registry.setOrder(-1);
}

然后适当的 HandlerMapping 将提供静态文件，如果没有这样的文件，它会将执行传递给您的控制器。

Answer 2

有点老套，但您可以在 profile 映射中使用正则表达式来排除静态：

对于/{profile}：

@RequestMapping("/{profile:^(?:static.+|(?!static).*)$}")

对于/{profile}/{project}：

@RequestMapping("/{profile:^(?:static.+|(?!static).*)$}/{project}")

---

编辑：

啊，我刚刚看到您已经发现 regex 作为一种可能的解决方案，并且想知道（在其他解决方案中）这是否是正确的方法。

就个人而言，我首选的解决方案是更改控制器的 URI。我发现所有其他解决方案都有些相似和 hacky：使用控制器前端静态，使用正则表达式作为配置文件 URI...

如果无法更改 URI，我想我会使用上面的正则表达式。我觉得它很明确。

Answer 3

我发现了基于自定义处理程序映射和伪控制器的有趣解决方案。 如果我们创建AbstractHandlerMapping bean，如果Spring不匹配任何其他Controller，它将被调用：

@Bean
public AbstractHandlerMapping profileHandlerMapping(RequestMappingHandlerAdapter handlerAdapter) {
    HandlerMethodArgumentResolverComposite argumentResolvers = new HandlerMethodArgumentResolverComposite();
    argumentResolvers.addResolvers(handlerAdapter.getArgumentResolvers());

    ProfileController profileHandlerMapping = new ProfileController(argumentResolvers);
    profileHandlerMapping.setOrder(2);

    return profileHandlerMapping;
}

伪控制器：

public class ProfileController extends AbstractHandlerMapping {

    private final HandlerMethodArgumentResolverComposite argumentResolvers;

    public ProfileController(HandlerMethodArgumentResolverComposite argumentResolvers) {
        this.argumentResolvers = argumentResolvers;
    }

    @Override
    protected Object getHandlerInternal(HttpServletRequest request) throws Exception {
        InvocableHandlerMethod handlerMethod = new InvocableHandlerMethod(this, getClass().getMethod("profile", HttpServletRequest.class));
        handlerMethod.setHandlerMethodArgumentResolvers(argumentResolvers);
        return handlerMethod;
    }

    @ResponseBody
    public String profile(HttpServletRequest request) {
        return "Profile: " + request.getRequestURI();
    }

}

优点：

• 不存在与通配符的冲突
• 以后易于维护，自动化
• 仅在没有匹配控制器的情况下调度，也不会发生与 404 冲突

缺点：

• 缺乏对某些基于动态注释的变量的支持，例如@PathVariable