Compiler时开启插件的注解功能,Boot中使用小插件Lombok

图片 3

Compiler时开启插件的注解功能,Boot中使用小插件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
的安装,其实那几个官方网址摄像上也会有讲到啦

张开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的使用方案。

目标

使用Lombok抓实开辟效用。

创设项目

本章的档期的顺序不关乎数量访问,所以增多的正视也比超级少,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文件时会自动将钦命模板的内容写入。

创制实体

为了便利演示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官方文书档案地址

完结,歇息!

admin

网站地图xml地图