对此IJ那些IDE工具以来,大家会设置一些插件来救助大家更加好的展开开拓,像lombok正是意气风发款不错的插件,使用评释的秘籍在品种编写翻译时推搡大家转移代码,像getter,setter,tostring等等,它们日常都是有的重新的代码,而lombok就是赞助大家转移那么些重新代码的,对于三个IJ的工具以来,假诺您不运转编写翻译时注脚作用,那么项目在build时会报错!

前言:

逛开源社区的时候无意开掘的,用了大器晚成段时间,感到还能,特此推荐一下。

lombok
提供了简便易行的笺注的款式来扶植大家简化清除一些亟须有但显得很丰腴的 java
代码。非常是对于 POJO,光说不做不是本身的品格,先来看看啊。

lombok的合法国网球国际比赛址:http://projectlombok.org/

lombok讲授在线扶植文书档案:http://projectlombok.org/features/index.

lombok 其实到那边作者就介绍完了,开个噱头,其实官英特网有 lombok
六分八十八秒的摄像解说,里面讲的也很领会了,並且还只怕有文书档案能够参照。在那处自个儿就不扯太多,先来看一下lombok
的设置,其实那几个官方网站录制上也是有讲到啦

前言

事先写了须臾间后台代码,开采后台项目中动用了八个很好用的插件——Lombok。它扶持程序猿制止写一些setter、getter、toString等机械化的代码,减弱了程序猿的教条劳动。既然是Java项目,那么在Android中应有也是能用的,于是在Android项目中也尝试了瞬间。

拉开build时的笺注

 “Settings > Build >
Compiler > Annotation Processors”

图片 1

下一场再设置lombok插件

图片 2

在档案的次序里安插关于lombok的依据项

compileOnly('org.projectlombok:lombok:1.16.20')

最后就能够在代码中动用lombok的笺注了

/**
 * 用户实体
 *
* @Data :注解在类上;提供类所有属性的 getting 和 setting 方法,此外还提供了equals、canEqual、hashCode、toString 方法
* @Setter:注解在属性上;为属性提供 setting 方法
* @etter:注解在属性上;为属性提供 getting 方法
* @og4j :注解在类上;为类提供一个 属性名为log 的 log4j 日志对象
* @oArgsConstructor:注解在类上;为类提供一个无参的构造方法
* @llArgsConstructor:注解在类上;为类提供一个全参的构造方法
*/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserInfo {
    @Id
    private String id;
    @NotNull
    private String name;
    private String email;
}

好了,启用插件申明就说起此地,谢谢阅读!

 

lombok 注解:

lombok 提供的讲明非常少,能够参照官方录制的上课和官方文书档案。

lombok讲授在线扶助文书档案:http://projectlombok.org/features/index.

上边介绍多少个自己常用的 lombok 注明:

@Data:注明在类上;提供类具备属性的 getting 和 setting
方法,此外还提供了equals、canEqual、hashCode、toString 方法
@Setter:注脚在品质上;为属性提供 setting 方法
@Getter:评释在性质上;为属性提供 getting 方法
@Log4j :申明在类上;为类提供三个 属性名字为log 的 log4j 日志对象
@NoArgsConstructor:注解在类上;为类提供一个无参的构造方法
@AllArgsConstructor:注脚在类上;为类提供三个全参的构造方法

下边是粗略示例

1.不使用 lombok 的方案

public class Person {

    private String id;
    private String name;
    private String identity;
    private Logger log = Logger.getLogger(Person.class);

    public Person() {     
    }

    public Person(String id, String name, String identity) {
        this.id = id;
        this.name = name;
        this.identity = identity;
    }

    public String getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public String getIdentity() {
        return identity;
    }

    public void setId(String id) {
        this.id = id;
    }

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

    public void setIdentity(String identity) {
        this.identity = identity;
    }
}

2.使用 lombok 的方案:

@Data 
@Log4j
@NoArgsConstructor 
@AllArgsConstructor 
public class Person { 
    private String id; 
    private String name; 
    private String identity; 
} 

下面的七个 java
类,从功能上来看,它们的功能是同风流浪漫的,相相比较之下,很精通,使用 lombok
要简明大多,非常是在类的习性非常多的景况下,同不时间也防止了改换字段名字时候忘记修章名所犯的中低端错误。

是因为本身在测量检验类中运用log变量,竟然是飘红的,可是真正编写翻译运维又不会报错,对于偏执性精神障碍的本身明明供给找到消除的方案。由此下边特地讲讲基于IDEA+SpringBoot+lombok的使用方案。

依赖

平时来讲是Gradle文件配置。因为Lombok的原理是遵照申明生成代码,所以供给运用apt。
在Project的build.gradle文件中增添对apt的依赖

buildscript {
    repositories {
        jcenter()
        mavenCentral()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.1.2'
        //添加apt依赖
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
    }
}

在app的build.gradle文件中期维改正

//应用apt插件
apply plugin: 'com.neenbedankt.android-apt'
...

dependencies {
        compile 'org.projectlombok:lombok:1.16.8'  //添加lombok依赖
        ...
}

目标

使用Lombok压实开支功效。

代码

lombok使用Annotation来评释有些类供给丰硕getter,setter等,下边是利用lombok和不行使lombok的自己检查自纠。

@Setter
@Getter
@ToString
public class XXX implements Entity {

    String id;

}

public class XXX implements Entity {

    String id;

    public String getId(){
        return this.id;
    }

    public void setId(String id){
        this.id = id;
    }
}

能够看看咱们不再供给手工业去写Getter和Setter了。

创设项目

本章的种类不关乎数额访谈,所以加多的注重也少之又少,pom.xml配置文件如下所示:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.ozan</groupId>
    <artifactId>sell</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>sell</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.10.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>


</project>

lombok的依附仅仅唯有一个,lombok基于配置在编写翻译class文件时会自动将钦定模板的剧情写入。

AS插件

增添了依附之后,固然编写翻译时是不利的。不过因为Android
Studio语法识别器不认知@Getter和@Setter阐明,所以要求增多Lombok插件。
在装置页面 -> plugins -> browser repository -> 搜索lombok ->
install
得逞安装之后,再写譬如XXX.getId()方法时AS就不会报错了。

创设实体

为了有支持演示lombok的美妙之处,大家简要创建一个客户实体,基于该实体进行布署lombok注明,实体代码如下所示:

public class UserBean
{
    //名称
    private String name;
    //年龄
    private int age;
    //家庭住址
    private String address;
}

上边我们先来看看大家最常用的getter/setter基于lombok何以选取。

Getter/Setter


Getter/Setter申明成效域可以是实体类也足以是切实可行的属性字段,下边大家仅仅对name属性增添评释,代码如下所示:

//...省略
//名称
@Getter
@Setter
private String name;

要是想让lombok生效大家还要求针对idea工具举行插件的装置,上边我们根据顺序展开Idea配置File
> Settings > Plugins > Browse repositories… >
输入lombok,插件就能够被自动物检疫索出来,分界面如下图1所示:

图片 3


故此增加lombok的插件是不行有供给的,不然项目在未编写翻译前随地飘红。

笔者的工具已经安装了该插件,全数在右边手是绝非其余按键的,倘若您的工具未有安装该插件,侧面会有二个梅红的按键,按键的内容则是Install,点击安装后重启Idea就能够了。
为了便于大家一向运用SpringBoot项目为大家创立的测量检验类来证明我们的lombok注明是不是已经生效,测量试验类代码如下所示:

@RunWith(JUnit4.class)
//@RunWith(SpringRunner.class)
//@SpringBootTest
public class Chapter29ApplicationTests {

    @Test
    public void testLombok()
    {
        //测试Getter/Setter
        UserBean user = new UserBean();
        user.setName("测试lombok");
        System.out.println(user.getName());
    }
}

能够看见我们得以健康使用name属性的getter/setter方法,不过其余属性的却是不可能调用,上面大家修改注明Getter/Setter地点,配置到实体类上。校勘后的代码如下所示:

//省略...
@Getter
@Setter
public class UserBean
{
    //名称
    private String name;
    //年龄
    private int age;
    //家庭住址
    private String address;
}

我们再来测量检验下其它属性是还是不是足以访谈到了,测量试验类修正代码如下所示:

//省略...
@Test
    public void testLombok()
    {
        //测试Getter/Setter
        UserBean user = new UserBean();
        user.setName("测试lombok");
        user.setAge(10);
        user.setAddress("测试地址");

        System.out.println(user.getName()+"  " + user.getAge() +"  "+user.getAddress());
    }

能够见见大家改善配置地点后UserBean实体内的装有属性都独具了Getter/Setter方法,那样大家在开荒中就无需再去做多余的变通操作了。

ToString


除了上述的Getter/SetterLombok还为我们提供了自动生成toString方法的讲解@ToString,该表明的成效域仅仅是在实体类上,大家改进实体类增加该注明,在测量检验类中调用toString方法查看输出内容如下:

System.out.println(user.toString());
//输出:
UserBean(name=测试lombok, age=10, address=sss测试地址)

Lombok自动创造的toString方法会将装有的习性都带有何况调用后得以出口。

AllArgsConstructor


Lombok还提供了任何参数的构造函数的自动生成,该注脚的作用域也是唯有在实体类上,因为独有实体类才会设有构造函数。订正加多该申明何况测量试验调用,如下所示:

UserBean u = new UserBean("构造lombok",1,"测试地址");
//输出:
UserBean(name=构造lombok, age=1, address=sss测试地址)

留心:该注脚配置后会自动生成三个现实全体参数的构造函数,参数的风华正茂意气风发与天性定义的各类黄金年代致。

NoArgsConstructor

自然除了全体参数的构造函数,Lombok还提供了并未有参数的构造函数,使用办法与@AllArgsConstructor生机勃勃致。

到此处或然你就有疑问了,我为着多个类加多这么多申明麻烦呢?还不及工具生成getter/setter来的快呢,那好Lombok针对那些难点也做出了减轻方案。

Data


咱俩应用@Data阐明就足以分包@ToString、@Getter、@Setter方法,当然大家利用构造函数时依旧内需单独增添申明,下边大家改革实体类加多@Data阐明代码如下所示:

/*@Getter
@Setter
@ToString*/
@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserBean
{
    //名称
    private String name;
    //年龄
    private int age;
    //家庭住址
    private String address;

    public String getAddress() {
        return "sss"+address;
    }
}

我们将@ToString、@Getter、@Setter四个注解注释掉后增添@Data,依据法定所说当时大家的测量试验类应该不会身不由己任何的不得了,大家张开测量检验类查看是或不是符合规律。

翻开后果真,未有现身别的的不胜,那也认证了@Data评释确实含有了上边四个评释。

Slf4j


再有二个利器,Lombok为我们松手了各类日志组件的扶持,我们在SpringBoot项目开支中大致都是选择logback作为日志组件,而logback是基于slf4j实现的。所以大家在实体类上直接助长@Slf4j就能够自行创设三个日记对象作为类内全局字段,自动创设的代码如下所示:

private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(Chapter29ApplicationTests.class);

为了测量检验本人在Chapter29ApplicationTests测验类上加多了@Slf4j,调用效果如下所示:

//调用:
log.info(u.toString());
//输出:
23:55:46.100 [main] INFO com.yuqiyu.chapter29.Chapter29ApplicationTests - UserBean(name=构造lombok, age=1, address=sss测试地址)

总结


上述内容正是本章的整整陈述,本章首要讲授Lombok用以便于开辟的注释组件。Lombok即便如此提供的零部件非常的少,不过每多少个都以我们供给的,正是因为如此进而大大缩短了小编们的专门的工作量,尤其是这种不起眼却又必须要写的代码。Lombok官方文档地址

完结,歇息!

相关文章