如何使用 JAX-RS 设置字符集？

Question

如何使用 JAX-RS 设置字符集？我尝试过 @Produces("text/html; charset=UTF-8") 但它被忽略了，只有 text/html 与 HTTP 标头一起发送。我想在 MessageBodyWriter 中设置字符集，但不想通过自己通过反射分析 @Produces 注释来提取媒体类型。

Answer 1

正如 Daemon 在评论中指出的那样，最新版本的 JAX-RS（包括截至 2012 年 9 月的稳定版本）现在do支持@Produces语法。所以你可以使用：

@Produces("text/html; charset=UTF-8")

Answer 2

只是为了保持最新状态。不确定旧版本的 Jersey 是否支持此功能，但如果您决定使用 ResponseBuilder.header(...) 方法，则可以使用 MediaType 方法 withCharset()。像这样：

return Response.status(Status.OK)
         .entity(result)
         .header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_TYPE.withCharset("utf-8"))
         .build());

Answer 3

还可以使用 ResponseBuilder.header(...) 方法使用字符集设置内容类型。请参阅下面的代码示例（使用 JAX-RS 1.1.1、CXF 2.3.1）。

final Response myResponse = Response.status(Response.Status.BAD_REQUEST)
    .entity("La requête n'est pas correcte.\n ...")
    .header(HttpHeaders.CONTENT_TYPE, MediaType.TEXT_PLAIN+"; charset=ISO-8859-15" )
    .build();

Answer 4

如果您想以 JAX-RS 实现中立的方式执行此操作，您可以重置 MessageBodyWriter 中的 Content-Type。类似于：

public void writeTo(Object obj,
                    Class<?> cls,
                    Type type,
                    Annotation[] annotations,
                    MediaType mt,
                    MultivaluedMap<String, Object> responseHttpHeaders,
                    OutputStream stream) throws IOException {
    responseHttpHeaders.putSingle(javax.ws.rs.core.HttpHeaders.CONTENT_TYPE, mt.toString() + ";charset=UTF-8");
}

如果每个资源方法除了 UTF-8 之外还有不同的字符集，您可能需要创建自定义注释并将其添加到每个资源方法中。然后，尝试在 writeTo() 方法中使用注释参数。

仅供参考，Apache Wink 支持在媒体类型上使用字符集和其他属性。我希望未来的 JAX-RS 规范修订能让这变得更容易。

Answer 5

首先在资源类方法上设置 @Produces 注释。

然后在返回类型的 MessageBodyWriter 中，您可以在 writeTo() 方法中执行此操作：

response.setContentType(mediaType.toString);

备注：您可以在 中注入 response作者：

@Context
protected HttpServletResponse response;

Answer 6

我所做的是获取 servlet 响应对象的实例：

protected @Context HttpServletResponse response;

然后将字符编码设置为 utf-8：

response.setCharacterEncoding("utf-8");

这对我有用。

Answer 7

如果使用 RESTEasy，您可以注册一个拦截器：

import org.jboss.resteasy.annotations.interception.ServerInterceptor;
import org.jboss.resteasy.core.ResourceMethodInvoker;
import org.jboss.resteasy.core.ServerResponse;
import org.jboss.resteasy.spi.Failure;
import org.jboss.resteasy.spi.HttpRequest;
import org.jboss.resteasy.spi.interception.PreProcessInterceptor;
import org.jboss.resteasy.plugins.providers.multipart.InputPart;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.ws.rs.WebApplicationException;
import javax.ws.rs.ext.Provider;

@Provider
@ServerInterceptor
public class ContentTypeSetter implements PreProcessInterceptor {
    @Override
    public ServerResponse preProcess(HttpRequest request, ResourceMethodInvoker resourceMethodInvoker) throws Failure, WebApplicationException {
        request.setAttribute(InputPart.DEFAULT_CONTENT_TYPE_PROPERTY, "*/*; charset=UTF-8");
        return null;
    }
}

注意：如果您手动设置 @Produces，它将覆盖此拦截器设置的 ContentType。如果这样做，请在@Produces中设置字符集