Jackson 注解的使用经验 #1

唠叨几句

公司项目涉及到金额运算，我作为后端的设计以及编码，对所有进入系统的金额字段，全部使用放大了 100 倍并四舍五入后的整数作为金额的数据类型。我为了避免浮点数计算带来的问题，把所有浮点数拒绝于系统之外。但是，前端就不高兴了。

毕竟前端是搞前端的嘛。。对他们来说浮点数计算问题几乎都不可能碰上。。这时候作为一个后端人员就要展现自己的宽容大量和万能了（偷笑）。

因为后端系统的视图层清一色使用 JSON 作为返回格式，所以我们只需要对要返回给前端的数据动手脚就行了。

先明确一下目标：所有有存储金额数据的对象，在返回给前端的时候，金额数据要变成缩小 100 倍的浮点数。

开始

假设我有一个类 Order.class ，上面以放大了 100 倍的方式存储金额

public class Order {
  private Integer id;
  private List<Items> items;
  private Integer value;
  
  //...
  
  //这里我只写涉及到的变量的 getter 和 setter
  public Integer getValue(){
    return value;
  }
  
  public void setValue(Integer value){
    this.value = value;
  }
  
  //...
}

Jackson 转换出来之后就会变成这样

{
  "id" : 1,
  "items" : [
    .....
  ],
  "value" : 18978 /* 189.78￥，因为我这里放大 100 倍存储*/
}

这下前端就不乐意了，过来找我说要变回去原来的数值，这里要使用到 @JsonProperty, @JsonIgnore, @JsonGetter, @JsonSetter 这几个注解

public class Order {
  private Integer id;
  private List<Items> items;
  private Integer value;
  
  //...
  
  //这里我只写涉及到的变量的 getter 和 setter
  @JsonIgnore
  public Integer getValue(){
    return value;
  }
  
  @JsonProperty
  public void setValue(Integer value){
    this.value = value;
  }
  
  @JsonGetter("cost")
  public Double getValueDouble(){
    return ((double) (value)) / 100;
  }
  
  @JsonSetter("cost")
  public void setValueDouble(){
    this.value = Math.toIntExact(Math.round(totalCost * 100));
  }
  
  //...
}

这时候，给前端的 JSON 就会变成这样

{
  "id" : 1,
  "items" : [
    .....
  ],
  "cost" : 189.78 /* 这里就是正常的数值了 */
}

解释

至于为什么要这样做呢？

@JsonIgnore 的用途是告诉 Jackson 要忽略一个属性。这个注解打在 getter 上面，setter 将被同时忽略。那么对于前端来说，这个属性就是不可见的了。然而后端在执行计算的时候，则可以继续使用这个属性。

@JsonGetter 和 @JsonSetter 实际上是 @JsonProperty 两个别称，功能是用于改变属性的 getter 和 setter。传参留空的话，则说明它们作为一个与被标注的 getter 同名的属性显示在输出的 JSON 上面。传参填上，则用填上的值覆盖输出 JSON 上指定属性的 getter 和 setter。

至于我为什么需要在被忽略的 setter 上面打上 @JsonProperty ，是因为这样可以让已经使用了 value 字段作为金额数据存储的已经被持久化的 JSON 数据在下次返回给前端的时候也能输出正确的 cost 属性。我这里以订单里面的 items 字段作为例子。

public class Item{
  private String title;
  private Integer value;
  
  //...
  
  //只写用到的 getter 和 setter
  @JsonIgnore
  public Integer getValue(){
    return value;
  }
  
  @JsonProperty
  public void setValue(Integer value){
    this.value = value;
  }
  
  @JsonGetter("cost")
  public Double getValueDouble(){
    return ((double)value) / 100;
  }
  
  @JsonSetter("cost")
  public void setValueDouble(Double value){
    this.value = Math.toIntExact(Math.round(value * 100));
  }
}

因为之前的数据库里，Order 的 items 字段已经是以这个形式存储到数据库里了：

[
  {"title" : "item1", "value" : "10000"},	//金额都放大了 100 倍
  {"title" : "item2", "value" : "29850"}
]

保留 value 字段，新建 cost 字段的话，后端的所有涉及到金额的算法就不需要改变也能正常工作。getter 打上 @JsonPropert 的话，Jackson 在反序列化的时候检测到 value 字段就会自己填上 value ，这样旧的数据也能够兼容上了。而新提交的数据将会变成这样：

[
  {"title" : "item1", "cost" : "100.00"},	//金额都是正常的
  {"title" : "item2", "cost" : "298.50"}
]

反序列化的时候， Jackson 会自动使用 setValueDouble 方法填入数据，那么后端通过 getValue 拿出来的数据也还是放大了 100 倍的，不受影响。

再唠叨几句

实际上我还用过 Jackson 的反序列化和序列化类来做这个，但发现这就是兜了弯路了。毕竟为了这点小事创建两个类有点小题大做了吧。。

之前想着直接忽略掉原来的 value 参数，然后在新的 getter 上打上 @JsonProerty("value") ，结果 Jackson 认为 setValue 和 setValueDouble 是两个相同的 setter 于是拒绝反序列化了，只好更改了变量名称。