【Lombok】基本使用与常用注解

Lombok的使用

1. IDE中安装Lombok插件

目前Lombok支持多种IDE，其中包括主流的Eclips、Intellji IDEA、Myeclipse等都是支持的。

在IDEA中安装方式如下:

File → Settings → Plugins，输入“lombok”，选中“install”进行安装即可。

2. 导入相关依赖

Lombok 支持使用多重构建工具进行导入依赖，目前主要支持maven、gardle、ant等均支持。

如使用maven导入方式如下：

 <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.12</version>
    <scope>provided</scope>
</dependency>

 

3. 代码中使用注解

Lombok精简代码的方式主要是通过注解来实现，其中常用的有@Data、@Getter/@Setter、@Builder、@NonNull等。

如使用@Data注解，即可简单的定义一个Java Bean：

import lombok.Data;

@Data
public class User {

    private String id;
    private String age;
    private String name;
    private String job;

 }

 

使用@Data注解在类上，这样一来，这个实体类中的属性就不需要get，set和toString方法了，这对于POJO类十分有用。

4. 常用注释与含义

• @Date：加在类上，相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor这些注解；
• @AllArgsConstructor：加在类上，可以生成含实体类全参数的构造方法；
• @NoArgsConstructor：加在类上，可以生成无参构造方法；
• @RequiredArgsConstructor：加在类上，配合@NonNull注解使用，生成指定参数的构造方法。比如在age属性前面加@NonNull注解，则User生成需要age参数的构造方法；
• @Getter：加在类上，可以生成实体类所有属性的getter方法；
• @Setter：加在类上，可以生成实体类所有属性的setter方法；
• @ToString：加在类上，调用toString()方法，可以输出实体类中所有属性的值。