Jersey/Jackson：如何捕获 json 映射异常？

Question

我想在我的 Restful 服务中捕获 json 映射异常，以防输入 json 无效。

它抛出

org.codehaus.jackson.map.JsonMappingException

，但我不知道如何或在哪里捕获此异常。我想捕获这个异常并发回适当的错误响应。

@JsonInclude(JsonInclude.Include.NON_NULL)
@Generated("org.jsonschema2pojo")
@JsonPropertyOrder({
        "name",
        "id"
})
public class Customer {
    @JsonProperty("name")
    private String name;

    @JsonProperty("id")
    private String id;
     <setter/getter code>
}

public class MyService {
   @POST
    @Consumes(MediaType.APPLICATION_JSON)
    public final Response createCustomer(@Context HttpHeaders headers,
            Customer customer) {
        System.out.println("Customer data: " + customer.toString());
        return Response.ok("customer created").build();
    }
}

一切正常，但如果 json 主体格式不正确，则会抛出

JsonMappingException

异常。我想捕获这个异常。

Answer 1

最终对我有用的是为

ExceptionMapper

声明一个

JsonMappingException

提供者，例如

import org.codehaus.jackson.map.JsonMappingException;
import org.springframework.stereotype.Component;

import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ExceptionMapper;
import javax.ws.rs.ext.Provider;

@Component
@Provider
public class JsonMappingExceptionMapper implements ExceptionMapper<JsonMappingException> {
    @Override
    public Response toResponse(JsonMappingException exception) {
        return Response.status(Response.Status.BAD_REQUEST).build();
    }
}

Answer 2

使用 Jersey 3、Jackson 2.x 和 Grizzly HTTP 服务器进行测试。

创建一个

ExceptionMapper

作为

@Provider

来捕捉

JsonMappingException

。

import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.ext.ExceptionMapper;
import jakarta.ws.rs.ext.Provider;

@Provider
public class CustomJsonExceptionMapper
      implements ExceptionMapper<JsonMappingException> {

  private static final ObjectMapper mapper = new ObjectMapper();

  @Override
  public Response toResponse(JsonMappingException exception) {

      ObjectNode json = mapper.createObjectNode();
      //json.put("error", exception.getMessage());
      json.put("error", "json mapping error");
      return Response.status(Response.Status.BAD_REQUEST)
              .entity(json.toPrettyString())
              .build();
  }

}

在

ResourceConfig

中注册上述异常映射器

public static HttpServer startHttpServer() {

       final ResourceConfig config = new ResourceConfig();
       config.register(YourResource.class);
      
       // custom ExceptionMapper
       config.register(CustomJsonExceptionMapper.class);

       return GrizzlyHttpServerFactory.createHttpServer(BASE_URI, config);
}

请参阅此泽西和杰克逊示例。

Answer 3

除了接受的答案之外，我还必须使用我的

JsonMappingExceptionMapper

注册

ResourceConfig

并指定

bindingPriority = 1

，因为否则它会调用默认的

JsonMappingExceptionMapper

:

resourceConfig.register(JsonMappingExceptionMapper.class, 1);