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

Posted 2023-02-26

【中文标题】Jersey/Jackson：如何捕获 json 映射异常？

【英文标题】：Jersey/Jackson: how to catch json mapping exception?

【发布时间】：2015-03-29 15:49:15

【问题描述】：

我想在我的 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 异常。我想捕捉这个异常。

【问题讨论】：

另见：java.net/jira/browse/JERSEY-2722

【参考方案1】：

最终对我有用的是为JsonMappingException 声明一个ExceptionMapper 提供程序，例如

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();
    

【讨论】：

这种方法看起来不错，但是我可以在哪里抛出并捕获这个异常，以便我可以在 JsonMappingExceptionMapper 中发回适当的响应。响应（）。我已经实现了与您的示例相同的 JsonMappingExceptionMapper，但它不会调用 toResponse 方法，它会抛出 JsonMappingException 但我无法捕捉到它。知道在哪里以及如何捕获 JsonMappingException 吗？？

是的，如果 POST 正文没有反序列化为 Customer 对象，它应该被 Jersey 抛出。确保您已将 JsonMappingExceptionMapper 注册到 Jersey 应用程序...在我的情况下，我通过 Spring 组件集成注册它们。

您将此组件放在应用程序的什么位置？

@DanielVilas-Boas，你将把它放在同一个包中，或者比你声明了@ComponentScan 配置 bean 或类似的位置更深。有关基于 Java 的配置的组件扫描的更多信息，请参阅docs.spring.io/spring/docs/current/spring-framework-reference/…。

【参考方案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);

请参阅此Jersey and Jackson example。