lombok插件的安装与使用

---

typora-root-url: img

lombok插件

JAVA面向对象编程中的封闭性和安全性

​ 封闭性即对类中的域变量进行封闭操作，即用private来修饰他们，如此一来其他类则不能对该变量访问。这样我们就将这些变量封闭在了类内部，这样就提高了数据的安全性。

​ 我们可以通过两种方法操作这些域变量，第一种即通过public方式的构造器（或称构造函数），对象一实例化就对该变量赋值。第二种就是通过set和get方法进行赋值和取值，这样就能提高域变量的安全性，同时又保证了域变量的封装型。

​ 所以当我们创建POJO类时，都会生成set，get方法，虽然有快捷方式，但每个类都要做重复的生成操作，而且当变量名或者是修饰符改变了，我们就要删除set，get方法，重新生成。那么我们怎么做能提高生产效率，不做重复工作呢？这时我们可以使用lombok插件来代替我们生成get、set等方法。

lombok介绍

lombok 提供了简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 java 代码。通过使用对应的注解，可以在编译源码的时候生成对应的方法，所以不会影响任何运行效率。

@Data：注解在类上；包含了@ToString，@EqualsAndHashCode，@Getter / @Setter和@RequiredArgsConstructor的功能，提供类所有属性的 getter 和 setter 方法，此外还提供了equals、canEqual、hashCode、toString 方法

@Setter：注解在属性上；为属性提供 setter 方法

@Getter：注解在属性上；为属性提供 getter 方法

@ToString：注解在类上；生成toString()方法，默认情况下，它会按顺序（以逗号分隔）打印你的类名称以及每个字段。可以这样设置不包含哪些字段@ToString(exclude = "id") / @ToString(exclude = {"id","name"})

如果继承的有父类的话，可以设置callSuper 让其调用父类的toString()方法，例如：@ToString(callSuper = true)

@EqualsAndHashCode：注解在类上；生成hashCode()和equals()方法，默认情况下，它将使用所有非静态，非transient字段。但可以通过在可选的exclude参数中来排除更多字段。或者，通过在parameter参数中命名它们来准确指定希望使用哪些字段。

@NonNull：  注解在属性上；标识属性是不能为空，为空则抛出异常。

@Slf4j ：注解在类上；根据用户实际使用的日志框架生成log日志对象。

@Log4j ：注解在类上；为类提供一个 属性名为log 的 log4j 日志对象

@NoArgsConstructor：注解在类上；为类提供一个无参的构造方法。当类中有final字段没有被初始化时，编译器会报错，此时可用@NoArgsConstructor(force = true)，然后就会为没有初始化的final字段设置默认值 0 / false / null。对于具有约束的字段（例如@NonNull字段），不会生成检查或分配，因此请注意，正确初始化这些字段之前，这些约束无效。

@AllArgsConstructor：注解在类上；为类提供一个全参的构造方法

默认生成的方法是public的，如果要修改方法修饰符可以设置AccessLevel的值，例如：@Getter(access = AccessLevel.PROTECTED)
  
@RequiredArgsConstructor：注解在类上；会生成构造方法（可能带参数也可能不带参数），如果带参数，这参数只能是以final修饰的未经初始化的字段，或者是以@NonNull注解的未经初始化的字段@RequiredArgsConstructor(staticName = "of")会生成一个of()的静态方法，并把构造方法设置为私有的。

lombok插件的安装与使用

安装

​ 1.打开IntelliJ IDEA后点击菜单栏中的File–>Settings–>Plugins进行插件的安装，在搜索页面输入lombok,点击便可安装。

注意：安装成功后我们可以看到右侧的Restart IDE按钮，此时可先不操作，因为我们还有后续的配置工作。安装完成后我们再回到Plugins，此时在右侧可以搜索到lombok，而安装前是不行的。

2.配置注解处理器

​ Settings设置页面，我们点击Build0->Execution->Deployment–>选择Compiler–>选中Annotation Processors，然后在右侧勾选Enable annotation processing即可。

使用

​ 1.导入lombok依赖

        <!--lombok插件-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.18</version>
        </dependency>

​ 2.接下来我们编辑一个实体类Student，添加三个属性，最后在类名上添加@Data属性，这个注解可以帮我们在.class文件中生成类中所有属性的get/set方法、equals、canEqual、hashCode、toString方法等。

​ 3.在菜单栏点击View–>Tool Windows–>Structure（快捷键Alt+7），便可以看到类中所有的方法了，这些都是lombok帮我自动生成的。

优点：

​ 动态生成方法，可以根据输入的类型，新增的属性，进行动态生成。

​ 详情如下面：