>

Compiler时开启插件的笺注成效,Boot中使用小插件

- 编辑:金沙国际平台登录 -

Compiler时开启插件的笺注成效,Boot中使用小插件

对此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 的安装,其实这一个官方网址录像上也会有讲到啦

敞开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官方文书档案地址

完结,歇息!

本文由编程发布,转载请注明来源:Compiler时开启插件的笺注成效,Boot中使用小插件