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

因为之前的数据库里,Orderitems 字段已经是以这个形式存储到数据库里了:

[
  {"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 认为 setValuesetValueDouble 是两个相同的 setter 于是拒绝反序列化了,只好更改了变量名称。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,117评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,328评论 1 293
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,839评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,007评论 0 206
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,384评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,629评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,880评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,593评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,313评论 1 243
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,575评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,066评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,392评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,052评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,082评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,844评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,662评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,575评论 2 270

推荐阅读更多精彩内容