JAX-RS中自定义WebApplicationException经ExceptionMapper处理仍打日志求助

这是个很常见的JAX-RS坑，我之前在使用Jersey的时候也遇到过，我来给你拆解原因和解决方案：

原因分析 #

你的ExceptionMapper确实正确处理了异常并生成了自定义JSON响应，但JAX-RS容器（比如Jersey、RESTEasy这类实现）默认会把WebApplicationException及其子类的堆栈信息记录到服务器日志——哪怕你已经通过Mapper处理了业务响应。

这是因为容器的异常处理链分为两步：

1. 先触发你的ExceptionMapper生成HTTP响应返回给客户端；
2. 但容器本身仍会将这个异常视为“需要记录的错误”，传递给底层日志组件，所以你会在日志里看到堆栈跟踪。

解决方案 #

根据你使用的JAX-RS实现，有几种干净的解决方式：

1. 针对Jersey的配置（最推荐） #

在你的ResourceConfig子类中添加一个配置属性，告诉容器不要为WebApplicationException自动记录日志：

public class MyRestApplication extends ResourceConfig {
    public MyRestApplication() {
        // 注册你的异常处理器
        register(ErrorHandler.class);
        // 关键配置：禁用默认的错误日志记录
        property(ServerProperties.RESPONSE_SET_STATUS_OVER_SEND_ERROR, true);
    }
}

这个属性会让容器直接设置响应状态码，而不是调用sendError()方法——后者正是触发日志记录的元凶。

2. 针对RESTEasy的配置 #

如果你用的是RESTEasy，可以在web.xml中添加上下文参数：

<context-param>
    <param-name>resteasy.log.exceptions</param-name>
    <param-value>false</param-value>
</context-param>

或者在Application子类中通过代码配置：

public class MyRestApplication extends Application {
    @Override
    public Map<String, Object> getProperties() {
        Map<String, Object> props = new HashMap<>();
        props.put("resteasy.log.exceptions", false);
        return props;
    }
}

3. 通用方案：在ExceptionMapper中手动控制日志 #

如果需要跨容器兼容，或者不想修改全局配置，可以在你的ErrorHandler里手动处理日志，同时清空异常的堆栈跟踪：

@Provider
public class ErrorHandler implements ExceptionMapper<WebApplicationException> {
    private static final Logger logger = Logger.getLogger(ErrorHandler.class.getName());

    @Override
    public Response toResponse(WebApplicationException e) {
        int status = e.getResponse().getStatus();
        // 手动记录需要的信息（用WARN级别代替ERROR，避免堆栈）
        logger.warn("Handled REST error: Status {} - Message: {}", status, e.getMessage());
        
        JsonObject errorResponse = Json.createObjectBuilder()
                .add("status", status)
                .add("message", e.getMessage())
                .build();
        
        // 清空堆栈跟踪，防止容器记录详细错误
        e.setStackTrace(new StackTraceElement[0]);
        
        return Response.status(status)
                .entity(errorResponse)
                .type(MediaType.APPLICATION_JSON)
                .build();
    }
}

4. 改用自定义异常（更彻底的通用方案） #

如果不想依赖WebApplicationException的子类，可以自定义一个专属的REST异常，容器不会默认记录这类自定义异常的堆栈：

// 自定义异常
public class RestApiException extends RuntimeException {
    private final int httpStatus;

    public RestApiException(int httpStatus, String message) {
        super(message);
        this.httpStatus = httpStatus;
    }

    public int getHttpStatus() {
        return httpStatus;
    }
}

然后对应专属的ExceptionMapper：

@Provider
public class RestApiExceptionHandler implements ExceptionMapper<RestApiException> {
    @Override
    public Response toResponse(RestApiException e) {
        JsonObject errorResponse = Json.createObjectBuilder()
                .add("status", e.getHttpStatus())
                .add("message", e.getMessage())
                .build();
        return Response.status(e.getHttpStatus())
                .entity(errorResponse)
                .type(MediaType.APPLICATION_JSON)
                .build();
    }
}

之后抛出异常时用throw new RestApiException(404, "custom message");，容器只会交给你的Mapper处理，不会自动记录堆栈。

内容的提问来源于stack exchange，提问作者Goos van den Bekerom