Boot中运用小插件Lombok,在Android项目中央银行使Lombok

对此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
的装置,其实这几个官网摄像上也有讲到啦

前言

Boot中运用小插件Lombok,在Android项目中央银行使Lombok。前边写了一晃后台代码,发现后台项目中运用了三个很好用的插件——Lombok。它扶助程序员防止写一些setter、getter、toString等机械化的代码,减弱了程序员的机械劳动。既然是Java项目,那么在Android中应当也是能用的,于是在Android项目中也尝尝了须臾间。

前言

开卷开源项目标时候发现小编用了@data评释,在尚未安装lombok以前ide提示找不到相应的get、set方法,查阅资料后发现笔者是选拔了lombok插件。

开启build时的注明

 “Settings > Build >
Compiler > Annotation Processors”

www.5929.com 1

然后再安装lombok插件

www.5929.com 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 注解:

Boot中运用小插件Lombok,在Android项目中央银行使Lombok。lombok 提供的注释不多,能够参考官方录制的任课和合法文书档案。

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

上面介绍多少个本人常用的 lombok 证明:

@Data:注明在类上;提供类具有属性的 getting 和 setting
方法,别的还提供了equals、canEqual、hashCode、toString 方法
@Setter:注明在性质上;为属性提供 setting 方法
@Getter:阐明在品质上;为属性提供 getting 方法
@Log4j :注脚在类上;为类提供3个 属性名为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是1个得以经过不难的注明形式来扶持我们简化消除一些须要有但出示很臃肿的Java代码的工具,通过使用相应的诠释,能够在编写翻译源码的时候生成对应的方式。
lombok
的合法网址:http://projectlombok.org/


目标

使用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了。

lombok的安装

在IDEA下 file->settings-Plugins搜索lombok安装插件

www.5929.com 3

安装lombok插件

并在品种中添加lombok依赖

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

创设项目

本章的类型不关乎数量访问,所以添加的依赖也相比少,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的依靠仅仅只有1个,lombok基于配置在编写翻译class文件时会自动将钦定模板的始末写入。

AS插件

添加了借助之后,即便编写翻译时是不利的。不过因为Android
Studio语法识别器不认得@Getter和@Setter评释,所以必要添加Lombok插件。
在设置页面 -> plugins -> browser repository -> 搜索lombok ->
install
成功安装之后,再写比如XXX.getId()方法时AS就不会报错了。

lombok的注解:

lombok
注脚在线协助文书档案:http://projectlombok.org/features/indexwww.5929.com,.
上面介绍多少个常用的 lombok 表明:
@Data :评释在类上;提供类具有属性的 getting 和 setting 方法,
其它还提供了equals、canEqual、hashCode、toString 方法
@Setter:申明在品质上;为属性提供 setting 方法
@Getter:注脚在质量上;为属性提供 getting 方法
@Log4j :注脚在类上;为类提供3个 属性名为log 的 log4j 日志对象
@NoArgsConstructor:评释在类上;为类提供三个无参的构造方法
@AllArgsConstructor:注明在类上;为类提供叁个全参的构造方法


创设实体

为了便利演示lombok的神奇之处,大家大致创设七个用户实体,基于该实体实行安插lombok注脚,实体代码如下所示:

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

下边大家先来看看咱们最常用的getter/setter基于lombok哪些利用。

下边是3个例子:

使用lombok之前:

public class User {
    private String id;
    private int age;
    private String name;

    public String getId() {
        return id;
    }

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

    public int getAge() {
        return age;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name){
        this.name=name;
    } 
    public User(String id,int age,String name){
        this.id=id;
        this.age=age;
        this.name=name;
    }
}

使用lombok之后:

@data
@AllArgsConstructor
public class User {
    private String id;
    private int age;
    private String name;
}

Getter/Setter


Getter/Setter注解功用域能够是实体类也得以是有血有肉的习性字段,上边我们一味对name属性添加表明,代码如下所示:

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

倘诺想让lombok生效大家还索要针对idea工具举行插件的设置,上边大家依据顺序打开Idea配置File
> Settings > Plugins > Browse repositories… >
输入lombok,插件就会被自动检索出来,界面如下图1所示:

www.5929.com 4


因而添加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测试地址)

留神:该证明配置后会自动生成2个现实全体参数的构造函数,参数的种种与本性定义的逐条一致。

NoArgsConstructor

理所当然除了全部参数的构造函数,Lombok还提供了从未参数的构造函数,使用方法与@AllArgsConstructor一致。

到那边恐怕你就有疑难了,笔者为了2个类添加这么多注明麻烦呢?还不如工具生成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官方文书档案地址

完结,歇息!

Leave a Comment.