提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档
文章目录
1.什么是Lombok插件
-
官方解释:
Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.
-
Lombok项目是一个java库,它可以自动插入到编辑器和构建工具中,增强java的性能。不需要再写getter、setter或equals方法,只要有一个注解,你的类就有一个功能齐全的构建器、自动记录变量等等。
-
lombok是一个可以通过简单的注解的形式来帮助我们简化消除一些必须有但显得很臃肿的 Java 代码的工具。
-
简单来说,比如我们新建了一个类,然后在其中写了几个属性,然后通常情况下我们需要手动去建立getter和setter方法啊,构造函数啊之类的,lombok的作用就是为了省去我们手动创建这些代码的麻烦,它能够在我们编译源码的时候自动帮我们生成这些方法。
2.Lombok的安装
2.1 在IDEA中安装lombok插件
①首先我们需要安装IntelliJ IDEA中的lombok插件,打开IntelliJ IDEA后点击菜单栏中的File–>Settings,或者使用快捷键Ctrl+Alt+S进入到设置页面。
②我们点击设置中的Plugins进行插件的安装,在右侧选择Browse repositories……,
③在搜索页面输入lombok变可以查询到下方的Lombok ,鼠标点击Lombok可在右侧看到Install按钮,点击该按钮便可安装。
我们在安装页面可以看到lombok具体支持的所有注解,在安装过程中有Downloading Plugins的提示,安装过程中进度条会变化。需要提醒的是,在安装过程中一定要保证网络连接可用且良好,否则可能会安装失败。安装成功后我们可以看到右侧的Restart按钮,此时可先不操作,因为我们还有后续的配置工作。安装完成后我们再回到Plugins,此时在右侧可以搜索到lombok,而安装前是不行的。
2.2 开启IDEA注释开发模式
还是在Settings设置页面,我们点击Build,Execution,Deployment–>选择Compiler–>选中Annotation Processors,然后在右侧勾选Enable annotation processing。
这样,Lombok插件与配置就整体搞定了,接下来就可以去使用了。
3.Lombok常用注解
注解 | 描述 |
---|---|
@Setter @Getter | 作用于属性上,自动生成getter和setter方法 |
@NonNull | 判断是否为空,如果为空,则抛出java.lang.NullPointerException |
@Synchronized | 作用在方法上,自动添加到同步机制,生成的代码并不是直接锁方法而是锁代码块 |
@ToString | 生成toString()方法,该注解有以下多个属性可以进一步设置 |
@Cleanup | 用于确保已分配的资源被释放,自动帮我们调用close()方法。比如IO的连接关闭。 |
@NoArgsConstructor | 自动生成无参数构造函数。 |
@AllArgsConstructor | 自动生成全参数构造函数。 |
@Data | 相当于@Setter + Getter + @ToString + @EqualsAndHashCode |
4.Lombok插件的使用
4.1 导入Lombok相关jar包/maven坐标
<!--Lombok插件-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.20</version>
</dependency>
4.2 定义一个实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
private Integer id;
private String name;
private Integer age;
}
4.3 结果
看见如下结果,证明使用成功