避免代表JSON的POJO的样板代码

时间:2017-12-13 10:13:28

标签: java json oop auto-value

我正在创建一个包含许多不同NetworkMessages的库,这些库通常采用JSON格式,现在需要相应的Java模型。

关于它的事情是这些消息很容易在JSON中有大约100个字段。其中一些强制性(30%),其中一些可选(70%)

所以我最关心的是如何最小化相应模型中的锅炉板代码。因为,就像我说的那样,那些POJO可以很容易地拥有大约100个字段,以及许多getter,以及构造函数中的许多字段。

我将举一个小Message的示例,但请记住,消息通常要大得多(更多字段)。

MessageA.java

@JsonInclude(Include.NON_EMPTY)
public class MessageA extends NetworkMessage {

    private final String a;

    private final String b;

    private final String c;

    private final String d;

    private final String e;

    private final String f;

    private final String g;

    private final String h;

    private final String i;

    private final String j;

    private final String k;

    @JsonCreator
    private MessageA(
            // required fields
            @JsonProperty(value = "a", required = true) String a, 
            @JsonProperty(value = "b", required = true) String b,
            @JsonProperty(value = "c", required = true) String c,
            @JsonProperty(value = "d", required = true) String d, 
            @JsonProperty(value = "e", required = true) String e, 
            @JsonProperty(value = "f", required = true) String f,

            // optional fields
            @JsonProperty(value = "g") String g, 
            @JsonProperty(value = "h") String h, 
            @JsonProperty(value = "i") String i, 
            @JsonProperty(value = "j") String j,
            @JsonProperty(value = "k") String k) {

        this.a = a;
        this.b = b;
        this.c = c;
        this.d = d;
        this.e = e;
        this.f = f;
        this.g = g;
        this.h = h;
        this.i = i;
        this.j = j;
        this.k = k;
    }

    public Optional<String> getG() {
        return Optional.ofNullable(g);
    }

    public Optional<String> getH() {
        return Optional.ofNullable(h);
    }

    public Optional<String> getI() {
        return Optional.ofNullable(i);
    }

    public Optional<MessageType> getJ() {
        return Optional.ofNullable(j);
    }

    public Optional<String> getK() {
        return Optional.ofNullable(k);
    }

    public String getA() {
        return a;
    }

    public String getB() {
        return b;
    }

    public String getC() {
        return c;
    }

    public String getD() {
        return d;
    }

    public String getE() {
        return e;
    }

    public String getF() {
        return f;
    }
}

现在,我试图通过使用Google的AutoValue库来解决其中一些问题,然后代码看起来好一些,但仍然需要调用包含许多字段的构造函数。

MessageA.java

@AutoValue
@JsonInclude(Include.NON_EMPTY)
public abstract class MessageA extends NetworkMessage {

    // required fields
    @Nonnull public abstract String getFieldA();

    @Nonnull public abstract String getFieldB();

    @Nonnull public abstract String getFieldC();

    @Nonnull public abstract String getFieldD();

    @Nonnull public abstract String getFieldE();

    @Nonnull public abstract String getFieldF();

    // optional fields
    @Nullable public abstract String getFieldG();

    @Nullable public abstract String getFieldH();

    @Nullable public abstract String getFieldI();

    @Nullable public abstract String getFieldJ();

    @Nullable public abstract String getFieldK();

    @JsonCreator
    private static MessageA create(
              // required fields
              @JsonProperty(value = "a", required = true) String a,
              @JsonProperty(value = "b", required = true) String b,
            @JsonProperty(value = "c", required = true) String c,
            @JsonProperty(value = "d", required = true) String d,
            @JsonProperty(value = "e", required = true) String e,
            @JsonProperty(value = "f", required = true) String f,

            // optional fields
            @JsonProperty(value = "g") String g,
            @JsonProperty(value = "h") String h,
            @JsonProperty(value = "i") String i,
            @JsonProperty(value = "j") String j,
            @JsonProperty(value = "k") String k) {

        return new AutoValue_MessageA(
                a, b, c, d, e, f, g, h, I, j, k);
    }
}

现在这样更好,但是有一个问题,我不能有可选的返回类型,所以我可以在我的代码中浮动空值,并且应该在其他地方执行大量的空检查。

您的建议是什么,以及采用哪种方式?

1 个答案:

答案 0 :(得分:0)

如果你真的想要/需要将这些Json消息表示为POJO,你至少可以通过定义所需的字段并使用Lombok获取getter / setter /来绕过所有样板getter / setter / Ctor噪声Ctor一代。 通过使用@Data @Data注释班级,您可以免费获得getters / setter / ctor,而无需看到Boilerplate。

@Data
public class MessageA extends NetworkMessage {

private final String a;

会导致一个看起来像这样的课程(以及更多)

@Data
public class MessageA extends NetworkMessage {

private final String a;
public MessageA(String a){
  this.a=a;
}
public String getA(){
  return this.a;
}

/*
*No setter since the field is private
*public void setA(String a){
*  this.a=a;
*}

*public boolean equals(Object o){...}
*public String toString(){...}
*/

我一直在使用lombok来避免必要的混乱。

但也许你最好不要使用那些数据类。这些巨大的消息看起来并不像是代表一个概念,而是几个嵌套的概念。否则只需将JSON存储为JSONObject并提供直接从JSON获取值的getter(您可以更方便地配置/验证复杂条件)