JSON响应使用Jackson和JAX-RS异常映射器转义了报价

时间:2019-05-19 01:36:53

标签: java json jax-rs resteasy jackson2

我有一个简单的要求,即如果应用程序遇到异常,我的JAX-RS Rest端点应返回具有500个HTTP标头状态的自定义JSON响应。

构造响应所需的数据来自具有多个属性的对象(请参见下文)。问题是,我只对每个属性(几十个)中的一个或两个值感兴趣。而且我无法修改这些模型/类中的任何一个(某些模型/类具有用于JSON处理的Jackson注释,例如,在序列化期间应丢弃null属性)。

let data = JSON.parse(JSON.stringify(process.env.SOME_COMPLEX_DATA));

我应该看到的预期JSON在客户端(例如,浏览器-在Edge中进行测试):

public class MainObject {
  private FirstProperty firstProperty;
  private SecondProperty secondProperty;
  private ThirdProperty thirdProperty;
  // other codes
  public String toString() {
    ObjectMapper mapper = new ObjectMapper();
    try { return mapper.writeValueAsString(this); }
    catch (Exception e) {  return null; }
  }
}

public class FirstProperty {
  private boolean bol = true;
  private double dob = 5.0;
  private List<String> subProperty;
  // other properties
  public String toString() {
    ObjectMapper mapper = new ObjectMapper();
    try { return mapper.writeValueAsString(this); }
    catch (Exception e) {  return null; }
  }
}

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)
public class SecondProperty {
  private String str;
  private List<String> subProperty;
  // other properties
  public String toString() {
    ObjectMapper mapper = new ObjectMapper();
    try { return mapper.writeValueAsString(this); }
    catch (Exception e) {  return null; }
  }
}

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)
public class ThirdProperty {
  private int intProp = true;
  private List<String> subProperty;
  // other properties
  public String toString() {
    ObjectMapper mapper = new ObjectMapper();
    try { return mapper.writeValueAsString(this); }
    catch (Exception e) {  return null; }
  }
}

相反,我所有的字段名及其值都转义了引号,并在整个值周围加了双引号,例如:

{
  "firstProperty" : { "subProperty" : [ "val1" ] },
  "secondProperty" : { "str" : "val2", "subproperty" : [ "val3", "val6" ] },
  "thirdProperty" : { "subProperty" : [ "val4" ] }
}

请注意在花括号之前和之后的多余{ "firstProperty" : "{ \"subProperty\" : [ \"val1\" ] }", "secondProperty" : "{ \"str\" : \"val2\", \"subproperty\" : [ \"val3\", \"val6\" ] }", "thirdProperty" : "{ \"subProperty\" : [ \"val4\" ] }" } 。我的环境是:

"

我消除了代码中的大多数“噪声”,以查看发生在什么时候。这是控制器:

Java 1.8.45
FasterXML Jackson 2.9.8
Spring Boot 2.0.1
RestEasy (JBoss) JAX-RS
JBoss 6.4

然后将响应发送回给JAX-RS @Path("/") public class MainController { @GET @Produces(MediaType.APPLICATION_JSON) @Path("/rest/path") public MainObject getMainObject throws MyCustomException { // A service call that throws MyCustomException } }

ExceptionMapper

由于我只需要从每个类型中发回很小一部分的整体属性,所以我创建了一个自定义@Provider public class MyCustomExceptionMapper extends ExceptionMapper<MyCustomException> { @Override public Response toResponse(MyCustomException ex) { HashMap<String, Object> responseBody = new HashMap<>(); String strEx = ex.getStrEx(); // Comes from SecondProperty.str stored in MyCustomException, not that it matters // Instantiate an empty object that contains MainObject obj = new MainObject(); obj.getFirstProperty().setSubProperty(ex.getStrs()); obj.getSecondProperty().setStr(strEx); obj.getSecondProperty().setSubProperty(ex.getStrs()); obj.getThirdProperty().setSubProperty(ex.getStrs()); responseBody.put("firstProperty", serializeFirstProperty(obj.getFirstProperty())); responseBody.put("secondProperty", serializeSecondProperty(obj.getSecondProperty())); responseBody.put("thirdProperty", serializeThirdProperty(obj.getThirdProperty())); Response response = Response.status(/* 500 status */).entity(responseBody).build(); return response; } } ,它将仅填充所需的属性。为简洁起见,我只做StdSerializer,但它们或多或少都是相同的:

serializeFirstProperty()

然后使用这些辅助方法,例如:

private StdSerializer<FirstProperty> getFPSerializer(FirstProperty firstProperty) {
  return new StdSerializer<FirstProperty>(FirstProperty.class) {
    @Override
    public void serialize(FirstProperty value, JsonGenerator gen, SerializerProvider provider) throws IOException {

      gen.writeStartObject();
      if (/* there are items in FirstProperty.subProperty */) {
        gen.writeArrayFieldStart("subProperty");
        for (String str : value.getSubProperty()) {
          gen.writeString(str);
        }
        gen.writeEndArray();
      }
      gen.writeEndObject();
    }
}

private <T> ObjectMapper getCustomOM(StdSerializer<?> serializer) {
  ObjectMapper mapper = new ObjectMapper();

  SimpleModule sm = new SimpleModule();
  sm.addSerializer(serializer);
  mapper.registerModule(module);

  return mapper;
}

我尝试了private String serializeFirstProperty(FirstProperty firstProperty) { ObjectMapper mapper = getCustomOM(getFPSerializer(firstProperty)); String ser = null; try { ser = mapper.writeValueAsString(firstProperty); } catch (JsonProcessingException e) { return null; } return ser; } 的无数配置,例如ObjectMapper(找不到disable(JsonParser.Feature.ALLOW_BACKLASH_ESCAPING_ANY_CHARACTER)的任何相关标志,我真的想以类似的方式将其禁用)。

或者明确地从JsonGenerator返回Object,或者在返回serializeFirstProperty()时用\"中的"替换所有serializeFirstProperty()

或设置自定义ser的{​​{1}}或无济于事地使用JAX-RS StdSerializer。我似乎总是用引号引起一个“字符串”值,例如:

JsonGenerator.setCharacterEscapes(new CharacterEscapes() { //... }

如果我只是做

Response

这会以某种方式产生正确的JSON输出,但是,它包含许多不必要的属性,在这种异常处理情况下,我不需要这些属性。

有趣的是,当我窥视"firstProperty" : "{ \"subProperty\" : [ \"val1\" ] }" (或responseBody.put("firstProperty", mapper.writeValueAsString(obj.getFirstProperty())); 映射)时,一切看起来都正确(我看不到带有双引号的值)。

还请注意,不仅我无法修改模型,而且它们的某些属性会在创建过程中使用默认值实例化,因此非空包含不起作用,如果我将它们显示在最终JSON中不要使用自定义序列化。

有人知道是什么引起了这种转义和多余的报价吗?

1 个答案:

答案 0 :(得分:1)

我想我第一次回答这个问题时就误解了。

问题是您将属性序列化为字符串(使用mapper.writeValueAsString(this),然后将其添加到您认为是字符串的responseBody json对象映射中,但是是 Java对象映射的字符串。在您的运行时情况下,它是映射到另一个字符串的字符串(序列化的json对象表示为Java字符串),Java字符串也是Java对象。

您要做的是构造一个Java对象responseBody而不是一个映射。它应充当具有所有特定属性等的DTO,然后使用映射器在一个动作中将其序列化。因为如果您首先将属性序列化为json字符串,那么从Java的角度来看,它只是一个字符串,并且映射器没有机会将其解释为json对象。