Android中消除Java冗长代码神器——Lombok

简介

Android中经常需要建一些数据的实体类,然后实现它们的getter和setter的方法,虽然有JsonFormat的插件可以一键生成对应的getter和setter的方法,但是如果一个实体类有几十个变量的话,生成大量的代码,使这个实体类不够简洁。而Lombok正是一个可以消除Java冗长代码,使代码更精简和优雅的注解工具。它可以在编译期自动生成getter/setter/toString/equals/hashCode/constructor等方法,而在实体类中隐藏掉(不写)这些方法(代码中还可以引用),从而减少代码量,使代码更精简。

Lombok官网地址:https://projectlombok.org/ 它可以用于Java开发,也可以用于Android开发,用法基本相同,下面主要讲在Android Studio平台下的使用。

安装插件和开启Annotation process

在Android Studio下,进入setting/Plugins/Browse repositories,搜索Lombok,如下图,然后点击安装,重启Android Studio


接着,要使代码主要添加了Lombok的相关注解就编译生成对应的方法,就要开启Annotation process。进入File/Other Settings/Defalut Settings中,如下图,在Complier/Annotatioin Processors中勾选上Enable annotation processing即可

添加依赖

Lombok官网的Android使用说明中,要求android plugin版本要不小于0.4.3,然后添加以下依赖即可:

provided "org.projectlombok:lombok:1.12.6"

使用provided而不是compile,是编译时使用,但不打包到apk中,更多的使用方法,参考:gradle中compile,provided,compile files,compile project有何区别?

用法

1.@Getter @Setter

直接在变量定义前加相应的方法

class Person{
    @Getter @Setter private String name;
    @Setter(AccessLevel.PROTECTED) private int age;
}

对应的完整写法就是

class Person{
    private String name;
    private int age;

    public String getName(){
        return name;
    }

    public void setName(String name){
        this.name=name;
    }

    public void setAge(String age){
        this.age=age;
    }
}

2.@NonNull

@Getter @Setter @NonNull
private Model model;

等价于

@NonNull
private Model model;

@NonNull
public Model getModel(){
    return model;
}

public void setModel(@NonNull Model model){
    if(model==null){
        throw new NullPointerException("model");
    } else {
        this.model = model;
    }
}

3.@Data

相当于同时使用@ToString, @EqualsAndHashCode, @Getter和@Setter

具体代码略

其他注解参考官网:https://projectlombok.org/features/index.html

Java界的神器-使用Lombok来消除你的冗余代码量,这篇文章写得比较完整,就不重复写了

补充(2016.08.23):
JakeWharton大神并不建议使用Anyone Using Project Lombok?

Using Lombok.png

---EOF---

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,566评论 25 707
  • 本文章涉及代码已放到github上annotation-study 1.Annotation为何而来 What:A...
    zlcook阅读 28,921评论 15 116
  • 最近两个月一直过着吃土的日子,《大鱼海棠》忍了没看等网播,这部萌片上了就舍弃了《盗墓笔记》果断选择它了。 有人说这...
    三米GZ阅读 665评论 0 0
  • 《圆梦》 时至今日, 两大幸事: 父母予命; 娶你为妻。 我妻袁梦, 圆我之梦, 金玉其外, 玉金其中。 当然当然...
    山林风火阅读 262评论 0 0
  • 佛昙简介: 佛昙是历史悠久的古镇。因芙蓉山下从前有一口清潭,映现山顶一块状如佛头的天然岩石,称佛潭,以至成为...
    5bfd687371b8阅读 1,042评论 0 0