对此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官方文档地址

完结,歇息!

相关文章