仅在内容类型 === JSON 时更改 Java 过滤器中的内容类型或字符编码

Question

我正在尝试确保来自基于 Jersey 的 java 应用程序的所有 JSON 响应都有一个 UTF-8 字符编码参数附加到它们的 ContentType 标头。

因此，如果它是 JSON 响应，我希望 Content-Type 的响应标头为

内容类型：application/json;charset=UTF-8

EDIT: I know I can do this on a case by case basis, but I'd like to do it globally, so it affects all content responses that have a content type of "application/json".

如果我只是尝试在过滤器中设置字符编码而不考虑内容类型，它可以正常工作。但是如果 ContentType 是“application/json”，我只想设置字符编码。我发现 response.getContentType() 方法总是返回 null ，除非我先调用 chain.doFilter 。但是，如果我在此之后尝试更改字符编码，它似乎总是被覆盖。

import java.io.IOException;
import javax.servlet.*;
import javax.servlet.http.*;
import javax.ws.rs.core.MediaType;

public class EnsureJsonResponseIsUtf8Filter implements Filter
{
    private class SimpleWrapper extends HttpServletResponseWrapper
    {
        public SimpleWrapper(HttpServletResponse response)
        {
            super(response);
        }

        @Override
        public String getCharacterEncoding()
        {
            return "UTF-8";
        }
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException
    {
        chain.doFilter(request, response);

        if (response.getContentType() != null && response.getContentType().contains(MediaType.APPLICATION_JSON))
        {
            response.setCharacterEncoding("UTF-8");
            chain.doFilter(request, new SimpleWrapper((HttpServletResponse) response));
        }
    }

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

    @Override
    public void destroy()
    {
    }
}

我见过其他similar questions，但他们似乎都没有这个问题。我尝试将我的过滤器注册为第一个也是最后一个过滤器，但没有成功。

Answer 1

感谢此页面上的其他答案，我找到了一种方法......非常接近他们的建议，但事实证明我可以让它工作的唯一方法是覆盖“getOutputStream”并在那时查看 contentType 。我已将此过滤器作为链中的第一个过滤器，它似乎工作正常。

import java.io.IOException;
import javax.servlet.*;
import javax.servlet.http.*;
import javax.ws.rs.core.MediaType;

public class EnsureJsonIsUtf8ResponseFilter implements Filter
{
    final String APPLICATION_JSON_WITH_UTF8_CHARSET = MediaType.APPLICATION_JSON + ";charset=" + java.nio.charset.StandardCharsets.UTF_8;

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException
    {
        HttpServletResponse r = (HttpServletResponse) response;
        HttpServletResponse wrappedResponse = new HttpServletResponseWrapper(r) 
        {
            @Override
            public ServletOutputStream getOutputStream() throws java.io.IOException
            {
                ServletResponse response = this.getResponse();

                String ct = (response != null) ? response.getContentType() : null;
                if (ct != null && ct.toLowerCase().startsWith(MediaType.APPLICATION_JSON))
                {
                    response.setContentType(APPLICATION_JSON_WITH_UTF8_CHARSET);
                }

                return super.getOutputStream();
            }
        };

        chain.doFilter(request, wrappedResponse); 
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException
    {
        // This method intentionally left blank
    }

    @Override
    public void destroy()
    {
        // This method intentionally left blank
    }
}

Answer 2

这种方式是行不通的。

当您调用 chain.doFilter(request, response); 时，您的标头已被刷新，您以后无法重置它们。

你能做的实际上是一个快速而肮脏的把戏：

public void doFilter(...) {
    HttpServletResponse resp = new HttpServletResponseWrapper(response) {
    public void setContentType(String ct) {
        if(ct!=null && ct.toLowerCase().startsWith("application/json")) {
            super.setContentType("application/json;charset=UTF-8");
        } else {
            super.setContentType(ct);
        }
   }
}

// Set content type manually to override any potential defaults,
// See if you need it at all
response.setContentType("application/json;charset=UTF-8");

chain.doFilter(request, resp); // Inject our response!
}

编辑： ct.toUpperCase().startsWith("application/json") 更改为 ct.toLowerCase().startsWith("application/json")。

Answer 3

使用this answer 作为参考，您的问题的解决方案是重新编码 JSON 文本，如下所示：

public void doFilter(...) {
    final CharResponseWrapper wrappedResponse =
            new CharResponseWrapper((HttpServletResponse) response);

    chain.doFilter(request, wrappedResponse);

    final String content = wrappedResponse.toString();

    final String type = wrappedResponse.getContentType();
    if (type != null && type.contains(MediaType.APPLICATION_JSON)) {
        // Re-encode the JSON response as UTF-8.
        response.setCharacterEncoding("UTF-8");
        final OutputStream out = response.getOutputStream();
        out.write(content.getBytes("UTF-8"));
        out.close();
    }
    else {
        // Otherwise just write it as-is.
        final PrintWriter out = response.getWriter();
        out.write(content);
        out.close();
    }
}

Answer 4

这也可以使用ClientFilter 来实现，我刚刚看到一个 StackOverflow 帖子用于类似目的：

https://stackoverflow.com/a/7464585/26510

Answer 5

使用ContainerResponseFilter 成功：

public class ContentTypeEncodingFilter implements ContainerResponseFilter {
    @Override
    public void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext) throws IOException {
        String contentType = responseContext.getHeaderString(HttpHeaders.CONTENT_TYPE);
        if (contentType == null) {
            return;
        }
        ContentType parsedType = ContentType.parse(contentType);
        if (parsedType.getCharset() != null) {
            return;
        }
        ContentType encodedType = parsedType.withCharset(StandardCharsets.UTF_8);
        responseContext.getHeaders().putSingle(HttpHeaders.CONTENT_TYPE, encodedType.toString());
    }
}

Answer 6

不是 100% 确定我得到了您想要实现的目标。 调用后是否要设置标题字符集

chain.doFilter(request, response)

?

如果是这种情况，恐怕你不能，因为很可能在那个时候，在 chain.doFilter(request, response) 返回并处理请求之后，内容字符集已经发送到客户端，因此你不能再改变它了。