Compiler时开启插件的注释功效,Boot中应用小插件Lombok

ca88会员登录中心 3
ca88会员登录中心

对于IJ这些IDE工具以来,大家会设置一些插件来支持大家更加好的拓张开垦,像lombok便是生机勃勃款不错的插件,使用注脚的秘技在类型编写翻译时拉拉扯扯我们转换代码,像getter,setter,tostring等等,它们平日都以一些重复的代码,而lombok正是赞助大家转移那一个重新代码的,对于二个IJ的工具以来,假使你不运营编写翻译时注脚作用,那么项目在build时会报错!

前言:

逛开源社区的时候无意发掘的,用了生龙活虎段时间,认为仍然是能够,特此推荐一下。

lombok
提供了简便易行的讲授的款式来增派大家简化消除一些亟须有但显得很丰腴的 java
代码。非常是对此 POJO,光说不做不是作者的作风,先来走访吧。

lombok的合French Open址: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”

ca88会员登录中心 1

然后再安装lombok插件

ca88会员登录中心 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文件时会自动将钦点模板的剧情写入。

ca88会员登录中心,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所示:

ca88会员登录中心 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官方文书档案地址

完结,歇息!

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图