一个有意思的 Java Library - Lombok

Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java. Lombok 提供编辑器的插件及编译时的 Library,帮助我们来改善 Java 的开发。
Never write another getter or equals method again. Early access to future java features such as val, and much more. 你可以不需要再手动编写 get/set/equals 方法。

Lombok 支持的 features

参见 https://projectlombok.org/features/all
The Lombok javadoc is available, but we advise these pages.

  • val

    • Finally! Hassle-free final local variables. 不可变变量
  • var

    • Mutably! Hassle-free local variables. 可变变量
  • @NonNull

    • How I learned to stop worrying and love the NullPointerException.
  • @Cleanup

    • Automatic resource management: Call your close() methods safely with no hassle.
  • @Getter/@Setter

    • Never write public int getFoo() {return foo;} again.
  • @ToString

    • No need to start a debugger to see your fields: Just let lombok generate a toString for you! 创建一个 toString 方法,包含所有的字段
  • @EqualsAndHashCode

    • Equality made easy: Generates hashCode and equals implementations from the fields of your object..
  • @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

    • Constructors made to order: Generates constructors that take no arguments, one argument per final / non-nullfield, or one argument for every field.
  • @Data

    • All together now: A shortcut for @ToString, @EqualsAndHashCode, @Getter on all fields, and @Setter on all non-final fields, and @RequiredArgsConstructor!
  • @Value

    • Immutable classes made very easy.
  • @Builder

... and Bob's your uncle: No-hassle fancy-pants APIs for object creation!

  • @SneakyThrows

    • To boldly throw checked exceptions where no one has thrown them before!
  • @Synchronized

    • synchronized done right: Don't expose your locks.
  • @Getter(lazy=true)

    • Laziness is a virtue! 延时加载
  • @Log

    • Captain's Log, stardate 24435.7: "What was that line again?"

Lombok 的示例 - 如何自动构造 get/set/constructor/toString 方法

编写一个实体类:

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

@AllArgsConstructor
@ToString
public class Student {

    @Getter @Setter
    private String name;

    @Getter @Setter
    private int age;
}

调用他的 get/set/constructor/toString 方法:

public class StudentMain {
    public static void main(String args[]) {
        Student s = new Student("Tom", 19);

        s.setAge(20);

        System.out.println(s.toString());

    }
}

安装一个 IntelliJ IDEA 的 Lombok 如下插件:
如果不安装这个插件,IntelliJ IDEA 编辑器会出现红色下滑线,例如 s.setAge(20); 显示找不到 setAge 方法,这个插件使得编辑器能够理解 Student 类中的 @... 注释。

IntelliJ IDEA 的 Lombok 插件

利用 Lombok 进行编译:
自从 Java 6起,javac 就支持“JSR 269 Pluggable Annotation Processing API”规范,只要程序实现了该API,就能在 javac 运行的时候得到调用。
Lombok 本质上就是这样的一个实现了"JSR 269 API"的程序。具体流程如下:

    1. javac 对源代码进行分析,生成一棵抽象语法树(AST)
    1. 运行过程中调用实现了"JSR 269 API"的 Lombok 程序
    1. Lombok 对第一步骤得到的抽象语法树(AST)进行处理,依据是代码中定义的各种 @... 注释
    1. javac使用修改后的抽象语法树(AST)生成字节码文件

将编译产生的字节码文件 Student.class 反编译后,可以看出源代码如下:

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package com.demo;

import java.beans.ConstructorProperties;

public class Student {
    private String name;
    private int age;

    @ConstructorProperties({"name", "age"})
    public Student(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String toString() {
        return "Student(name=" + this.getName() + ", age=" + this.getAge() + ")";
    }

    public String getName() {
        return this.name;
    }

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

    public int getAge() {
        return this.age;
    }

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

运行输出如下:
Student(name=Tom, age=20)


引用:
Project Lombok

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

推荐阅读更多精彩内容