如何在Spring Boot中处理HTTP选项请求？

Question

首先，我阅读了“如何使用Spring MVC处理HTTP选项？”但答案似乎并不直接适用于Spring Boot。

看起来我应该这么做：

通过将dispatcherServlet的DispatchOptions Request设置为true

但是，考虑到我的代码中没有XML配置，也没有任何种类的DispatcherServlet初始化器类（在这个答案中提到），如何做到这一点呢？

在一个@RestController类中，我有一个这样的方法，它目前没有被调用。

@RequestMapping(value = "/foo", method = RequestMethod.OPTIONS)
public ResponseEntity options(HttpServletResponse response) {
    log.info("OPTIONS /foo called");
    response.setHeader("Allow", "HEAD,GET,PUT,OPTIONS");
    return new ResponseEntity(HttpStatus.OK);
}

Spring靴1.2.7。释放一个简单的设置与Spring REST guide中的设置没有太大区别。

Answer 1

使用Spring Boot 2.2.6，您可以轻松地将自定义方法选项添加到StrictHttpFirewall：

@Bean
public StrictHttpFirewall httpFirewall() {

    StrictHttpFirewall firewall = new StrictHttpFirewall();
    firewall.setAllowedHttpMethods(Arrays.asList("GET", "POST", "OPTIONS", "FOO"));

    return firewall;
}

Answer 2

我在使用基于Spring Boot 1.3. x的rest应用程序时遇到了这个问题，在诊断问题时，我允许我的Spring工具套件更新到最新版本。

当我在更新的STS中创建一个新的test Spring Boot RestController时，它就像Spring 4.3下的文档宣传一样工作。我注意到，在新的测试应用程序中，Maven依赖项跳到了spring boot 1.5.8，所以我只是更改了旧应用程序的依赖项，将其更新为spring boot 1.5.8/spring 4.3.12。这解决了这个问题，现在它的工作方式与RequestMapping注释一样，它指定了处理选项请求的兴趣。。。

@RequestMapping(value="/account/{id}", method={RequestMethod.OPTIONS,RequestMethod.GET})

... 现在将选项请求发送给处理程序。

因此，如果您能够更新到更高版本的Spring，您应该不需要定义任何特殊配置来启用OPTIONS请求方法处理（Spring 4.3.12/Spring Boot 1.5.8）。

Answer 3

从Spring Boot 1.3.0开始，可以使用以下属性配置此行为：

spring.mvc.dispatch-options-request=true

SpringBoot中的DispatcherServlet由DispatcherServletAutoConfigance定义。您可以在配置类中的某个位置创建自己的DispatcherServletbean，它将代替自动配置中的bean使用：

@Bean(name = DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
public DispatcherServlet dispatcherServlet() {
    DispatcherServlet dispatcherServlet = new DispatcherServlet();
    dispatcherServlet.setDispatchOptionsRequest(true);
    return dispatcherServlet;
}

但是请注意，定义您的DispatcherServletbean将禁用自动配置，因此您应该手动定义自动配置类中声明的其他bean，即DispatcherServlet的ServletSynstrationBean。

您可以创建BeanPostProcessor实现，它将在初始化bean之前将DispatchOptions请求属性设置为true。Yoy可以将其放在配置类中的某个位置：

@Bean
public DispatcherServletBeanPostProcessor dispatcherServletBeanPostProcessor() {
    return new DispatcherServletBeanPostProcessor();
}

public static class DispatcherServletBeanPostProcessor implements BeanPostProcessor {
    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        if (bean instanceof DispatcherServlet) {
            ((DispatcherServlet) bean).setDispatchOptionsRequest(true);
        }
        return bean;
    }

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        return bean;
    }
}

如果您的应用程序中有SpringBootServletializer，您可以执行以下操作来启用选项分派：

public class ServletInitializer extends SpringBootServletInitializer {
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(Application.class);
    }

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        super.onStartup(servletContext);
        servletContext.getServletRegistration(DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
                .setInitParameter("dispatchOptionsRequest", "true");
    }
}

但是，只有当你将应用程序作为WAR部署到Servlet容器中时，这才有效，因为当使用main方法运行你的Spring Boot应用程序时，SpringBootServletializer代码不会被执行。