ContainerRequestFilter ContainerResponseFilter 没有被调用

Posted 2023-02-22

【中文标题】ContainerRequestFilter ContainerResponseFilter 没有被调用

【英文标题】：ContainerRequestFilter ContainerResponseFilter doesn't get called

【发布时间】：2014-07-03 11:12:01

【问题描述】：

我正在尝试通过创建一个小型 RESTful 服务来学习球衣。我想出于特定原因使用过滤器（比如我想将 ContainerResponseFilter 用于 CORS 标头以允许跨域请求）。但是，我只是无法让这些过滤器拦截我的电话。我已经看过所有关于这个问题的帖子，其中大多数都说要在注释提供者或 web.xml 中注册。 我尝试在 web.xml 中注册文件并为容器提供@Provider 注释

这是我的 web.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- This web.xml file is not required when using Servlet 3.0 container, 
     see implementation details http://jersey.java.net/nonav/documentation/latest/jax-rs.html#d4e194 -->
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">

    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/classes/spring/config/BeanLocations.xml</param-value>
    </context-param>

    <servlet>
        <servlet-name>Jersey Web Application</servlet-name>
        <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
        <init-param>
            <param-name>com.sun.jersey.config.property.packages</param-name>
            <param-value>com.rest.example</param-value>
        </init-param>
        <init-param>  
            <param-name>jersey.config.server.provider.packages</param-name>  
            <param-value>com.rest.example.cors</param-value>
        </init-param>
        <init-param>
            <param-name>com.sun.jersey.spi.container.ContainerResponseFilters</param-name>
            <param-value>com.rest.example.CORSFilter</param-value>
        </init-param>
        <init-param>
            <param-name>com.sun.jersey.spi.container.ContainerRequestFilters</param-name>
            <param-value>com.rest.example.RequestFilter</param-value>
        </init-param>

    </servlet>
    <servlet-mapping>
        <servlet-name>Jersey Web Application</servlet-name>
        <url-pattern>/webresources/*</url-pattern>
    </servlet-mapping>

</web-app>

这是我的过滤器：

package com.rest.example.cors;

import javax.ws.rs.ext.Provider;

import com.sun.jersey.spi.container.ContainerRequest;
import com.sun.jersey.spi.container.ContainerResponse;
import com.sun.jersey.spi.container.ContainerResponseFilter;

@Provider
public class CORSFilter implements ContainerResponseFilter 

    public ContainerResponse filter(ContainerRequest creq,
            ContainerResponse cresp) 

             cresp.getHttpHeaders().putSingle("Access-Control-Allow-Origin", "*");
             cresp.getHttpHeaders().putSingle("Access-Control-Allow-Credentials", "true");
             cresp.getHttpHeaders().putSingle("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT, OPTIONS, HEAD");
             cresp.getHttpHeaders().putSingle("Access-Control-Allow-Headers", "Content-Type, Accept, X-Requested-With");

            return cresp;
    



package com.rest.example.cors;

import javax.ws.rs.ext.Provider;

import com.sun.jersey.spi.container.ContainerRequest;
import com.sun.jersey.spi.container.ContainerRequestFilter;

@Provider
public class RequestFilter implements ContainerRequestFilter 

    public ContainerRequest filter(ContainerRequest request) 
        System.out.println("request filter");
        return request;
    

Link 到我的 github 项目。

【问题讨论】：

您使用的是什么容器/应用服务器和 Jersey 版本？另外，您是否尝试在 Jersey 应用程序类中注册过滤器？

我使用的是 1.8 版的球衣。我使用的是 STS 附带的 VMware VFabric。我们如何在 jersey 应用类中注册过滤器？

要注册您的过滤器，请将它们添加到您的 javax.ws.rs.core.Application 对象中的 getClasses 方法中，尽管看起来您的 web.xml 应该为您处理。是否正在调用您的 REST 方法？你怎么知道你的过滤器没有被调用？

我的 REST 方法被调用。我在我的过滤器中设置了一个调试点，代码从来没有达到调试点，但是它达到了资源方法。

只需添加包含 ResourceConfig 中所有过滤器的包详细信息。我也发布了一个例子。

【参考方案1】：

我添加了一个 Jersey Application 类并在该类中注册了过滤器，这解决了我的问题。还将我的球衣版本从 1.x 升级到 2.x

public class MyApplication extends ResourceConfig 

    /**
     * Register JAX-RS application components.
     */
    public MyApplication () 
        register(RequestContextFilter.class);
        register(JacksonFeature.class);
        register(CustomerResource.class);
        register(Initializer.class);
        register(JerseyResource.class);
        register(SpringSingletonResource.class);
        register(SpringRequestResource.class);
        register(CustomExceptionMapper.class);
    

【讨论】：

在 Tomcat 8.5 中部署的 Jersey 2.24 中对我有用，但我还必须在 web.xml 中注册应用程序类，如下所示：<init-param><param-name>javax.ws.rs.Application</param-name><param-value>MyApplication</param-value></init-param>（在 org.glassfish.jersey.servlet.ServletContainer 的 servlet 定义内）跨度>

绝对精彩！我完全忘记将它添加到我的 ApplicationClass 中。非常感谢您的提示。

【参考方案2】：

我在 Wildfly 10 上解决了这个问题/像这样轻松休息（CORSFilter 是我的 ContainerResponseFilter）：

import java.util.HashSet;
import java.util.Set;

import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;

@ApplicationPath("/rest")
public class JaxRsActivator extends Application 

    @Override
    public Set<Class<?>> getClasses() 
        final Set<Class<?>> resources = new HashSet<Class<?>>();

        resources.add(CORSFilter.class);

        return resources;
    

【讨论】：

谢谢，这也是我的问题。

【参考方案3】：

<init-param>
  <param-name>com.sun.jersey.spi.container.ContainerResponseFilters</param-name>
  <param-value>org.anchepedheplatform.infrastructure.core.filters.ResponseCorsFilter</param-value>
</init-param>

首先，我写了一个实现com.sun.jersey.spi.container.ContainerResponseFilter的类

import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.ResponseBuilder;

import com.sun.jersey.spi.container.ContainerRequest;
import com.sun.jersey.spi.container.ContainerResponse;
import com.sun.jersey.spi.container.ContainerResponseFilter;

/**
* Filter that returns a response with headers that allows for Cross-Origin
* Requests (CORs) to be performed against the platform API.
*/
public class ResponseCorsFilter implements ContainerResponseFilter 

  @Override
  public ContainerResponse filter(final ContainerRequest request, final ContainerResponse   response)  
      final ResponseBuilder resp = Response.fromResponse(response.getResponse());
      resp.header("Access-Control-Allow-Origin", "*")
      .header("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS");
      final String reqHead = request.getHeaderValue("Access-Control-Request-Headers");
      if (null != reqHead && !reqHead.equals(null)) 
      resp.header("Access-Control-Allow-Headers", reqHead);
      response.setResponse(resp.build());
      return response;
 

后来我把这个类的这个引用放在 intit-param web.xml 中。

【讨论】：

您提供的代码是从CORS-Compliant REST API with Jersey and ContainerResponseFilter这里获取的吗？

【参考方案4】：

如果您要扩展 ResourceConfig 类，那么注册所有提供者的过程可能会很乏味，并且可能会错过少数几个提供者。

这里可以使用 ResourceConfig 类型完成的操作是，您可以在默认构造函数中使用 packages 方法来指定 packages("")，它将包含您的剩余资源和提供程序。例如，假设我们有一个包com.test.poc.rest，其中包含所有其余服务和另一个包com.test.poc.providers，那么我们的resourceConig 将如下所示：

public class CustomResourceConfig extends ResourceConfig
    public CustomResourceConfig()
       super();
       packages("com.test.poc.rest;com.test.poc.providers");
       //register any custom features
       register(JacksonFeature.class);         // enabling JSON feature.
    

现在，boom jersey 将扫描带有 @Path 注释的 Web 服务和带有 @Provider 注释的提供程序。