使用 Google AutoValue 自动生成代码

转载请注明出处:http://tedyin.me/2016/04/11/auto-value/

Java中通常定义一个模型类时,需要定义一堆不同类型的成员变量,而且为了满足面向对象的基本特征,又要定义一堆相应的GetterSetter等方法,这个过程是非常枯燥的要写一堆样板代码。虽然现在 IDE 可以很好的帮我们生成这些样板代码,但是如果看到一个模型类里面有这么一堆的方法,总觉是会觉得不够清晰。

我只想知道这个模型有哪些属性,以及特殊的方法,并不想知道大家都有的东西,你却非要让我看。。。

好了,现在有办法可以解决这个问题了,使用 Google 开源的 AutoValue 就可以解决上述烦恼,而且最近AutoValue项目支持了大家期待已久的Extension API,使得AutoValue更加灵活,至于这个Extension API是干啥的后面会讲到,现在暂时不用去关心他。

普通的 Java 模型

我们这里举个故事(Story)的例子,一个故事模型拥有一个id,以及一个title。下面我们来看下用Java代码来表示该模型的写法。

不太严谨的写法

我们先来看下一般情况下我们是怎么定义这个 POJO 的业务模型的。

public class Story{
  public int id;
  public String title;
}

上面的写法非常简单,不过有些情况下可能会有问题,比如对象比较时,而且也不符合封装的要求,不过一般情况下业务逻辑简单,还处在快速迭代的时候这样写也没什么问题,而且重点是他 只有4行代码!

比较规范的写法

下面看下正常情况下的写法:

public class Story{
  private int id;
  private String title;

  public Story(int id, String title){
    this.id = id;
    this.title = title;
  }

  public int id(){
    return this.id;
  }

  public int title(){
    return this.title;
  }
}

这样写符合了面向对象的基本特征封装的要求,但是如果这个Story是在列表或者集合中有用到比较的时候,这么写是有问题的,应该继续覆盖hashCode()equals()方法,如果有特殊格式的输出,还得覆盖toString()方法。

把这些东西都补全的写法如下:

public class Story{
  private int id;
  private String title;

  public Story(int id, String title){
    this.id = id;
    this.title = title;
  }

  public int id(){
    return this.id;
  }

  public int title(){
    return this.title;
  }

  @Override
  public String toString(){
    return id + title;
  }

  @Override
  public int hashCode() {
    int hash = 7;
    hash = 31 * hash + this.id;
    hash = 31 * hash + (null == title ? 0 : title.hashCode());
    return hash;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || !(o instanceof Stroy)) return false;
    Story s = (Story) o;
    if (s.id != s.id) return false;
    return s.title.equals(s.title);
  }
}

上面的版本是一个比较完整的模型写法,相比起最初的版本,代码多了不少从原来的4行变成了现在的39行!
OMG!现在的版本还没有实现Parcelable接口,如果再在他的基础上实现Parcelable接口,那代码又得增加十几行,想想都心累啊。

使用AutoValue拯救你的代码

我本想要一个只有几行的模型类,但是出于各方面原因,我得到了一个几十行代码的模型类,为了解决这个问题伟大的Google开发了AutoValue这个库来自动生成这些样板代码,解放我们的双手,让我们把更多的精力放在更重要的事情上。

使用AutoValue

使用方法很简单,只需要在你的项目中引入AutoValue的插件即可

dependencies {
  apt 'com.google.auto.value:auto-value:1.2'
}

然后在代码中使用@AutoValue注解来指定哪个类需要生成类似于上面的样板代码。下面我们使用AutoValue来重新实现一下Story模型。

@AutoValue
public abstract class Story{
  public abstract int id();
  public abstract String title();
}

使用@AutoValue注解后,AutoValue会生成一个AutoValue_你的类名为名称的类,这个类是包级私有的,他里面有私有的成员变量,对应的构造函数,以及重写的hashCode()equals()toString()方法,而且这些方法都是被测试过的确保无误的,你可以放心的使用。由于这个生成的子类是包级私有的,所以这里在给Story提供构造方法的时候需要提供一个静态的构造方法,代码如下:

@AutoValue
public abstract class Story{
  public abstract int id();
  public abstract String title();
  public static Story create(int id, String title){
    new AutoValue_Story(id,title);
  }
}

好了,使用AutoValue后,这短短几行代码就完成了上面几十行代码干的事,而且这样生成出来的代码都是被测试过准确无误的,这也避免了一些因为手误或者逻辑错误导致的BUG的产生,是不是很爽?必须很爽啊!

But... 我们要更爽一点!

AutoValue Extension API

大家注意到没有上面使用AutoValue实现的Story模型并没有实现Parcelable接口,那如果要实现这个接口是不是又得一堆代码呢?当然不会,因为我们有Extension API,因为有了他我们可以使用基于他实现出来的AutoValue: Parcel Extension来实现Parcelable接口。

使用 Parcel Extension 实现 Parcelable 接口

首先我们需要在项目中集成 AutoValue Parcel Extension

dependencies {
  provided 'com.google.auto.value:auto-value:1.2'
  apt 'com.google.auto.value:auto-value:1.2'
  apt 'com.ryanharter.auto.value:auto-value-parcel:0.2.1'
}

然后再在代码中加入implements Parcelable即可

@AutoValue
public abstract class Story implements Parcelable{
  public abstract int id();
  public abstract String title();
  public static Story create(int id, String title){
    new AutoValue_Story(id,title);
  }
}

是不是已经体会到了AutoValue Extension的厉害了?反正我是觉得碉堡了!
有了这个扩展功能,能干的事情就多了,常规的像对象序列化成 JSON 字符串,将 JSON 字符串解析成对象等这些事情就不用自己再去动手去写了,直接用AutoValue生成就可以了,再也不用去写那些toJson()fromJson之类的方法了,真是爽歪歪啊!

更多的 AutoValue Extension

目前已经有人实现了一些 AutoValue 的扩展了,具体的可以看这里。如果这些都无法满足你的需求,那你可以使用 AutoValue Extension API去自己实现一个 AutoValue 的扩展。

参考

An Introduction to AutoValue

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

推荐阅读更多精彩内容