使用 JAX-RS（泽西岛）和@RolesAllowed的定制 HTTP 状态响应

java jax-rs jersey jsr250

2022-09-03 05:02:24

通过我非常简单的 JAX-RS 服务，我将 Tomcat 与 JDBC 领域结合使用进行身份验证，因此我正在处理 JSR 250 注释。

问题是我想在HTTP状态响应中返回自定义消息正文。状态代码（403）应保持不变。例如，我的服务如下所示：

@RolesAllowed({ "ADMIN" })
@Path("/users")
public class UsersService {

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
    public String getUsers() {
        // get users ...
        return ...;
    }
}

如果角色与“ADMIN”不同的用户访问该服务，我想将响应消息更改为类似如下内容（取决于媒体类型 [xml/json]）：

<error id="100">
    <message>Not allowed.</message>
</error>

目前，泽西岛返回以下正文：

HTTP Status 403 - Forbidden

type Status report
message Forbidden
description Access to the specified resource (Forbidden) has been forbidden.
Apache Tomcat/7.0.12

如何更改默认邮件正文？有没有办法处理（可能引发的）异常来构建我自己的HTTP状态响应？

答案 1

处理此类事情的最简单方法是引发异常并注册异常映射器以转换为在这种情况下要发送的消息类型。所以，假设你抛出一个，然后你会有一个这样的处理程序（为了清楚起见，在一些地方有完整的类名）：AccessDeniedException

@javax.ws.rs.ext.Provider
public class AccessDeniedHandler
        implements javax.ws.rs.ext.ExceptionMapper<AccessDeniedException> {
    public javax.ws.rs.core.Response toResponse(AccessDeniedException exn) {
        // Construct+return the response here...
        return Response.status(403).type("text/plain")
                .entity("get lost, loser!").build();
    }
}

注册异常映射器的方式因您使用的框架而异，但对于泽西岛，您应该只使用 .我会让你自己弄清楚你想要如何生成你想要的错误文档，但我确实建议将故障作为某种HTTP错误代码来处理（这更令人讨厌...）@Provider

答案 2

通过创建（映射异常的）可以“捕获”应用程序引发的某些异常：ExceptionMapperWebApplicationException

@Provider
public class MyExceptionMapper implements ExceptionMapper<WebApplicationException> {

    @Override
    public Response toResponse(WebApplicationException weException) {

        // get initial response
        Response response = weException.getResponse();

        // create custom error
        MyError error = ...;

        // return the custom error
        return Response.status(response.getStatus()).entity(error).build();
    }
}

您还需要将包添加到应用程序 Web.xml以注册提供程序：

<init-param>
    <param-name>com.sun.jersey.config.property.packages</param-name>
    <param-value>
        com.myapp.userservice; // semi-colon seperated
        com.myapp.mappedexception
    </param-value>
</init-param>