lombok使用详解及Intellij IDEA 安装

最新推荐文章于 2024-04-27 14:44:27 发布

唐国平

最新推荐文章于 2024-04-27 14:44:27 发布

阅读量444

点赞数 1

分类专栏：杂项文章标签： lombok idea安装插件

本文链接：https://blog.csdn.net/m0_37742084/article/details/80051378

版权

杂项专栏收录该内容

2 篇文章 0 订阅

订阅专栏

项目中经常使用bean，entity等类，绝大部分数据类类中都需要get、set、toString、equals和hashCode方法，虽然eclipse和idea开发环境下都有自动生成的快捷方式，但自动生成这些代码后，如果bean中的属性一旦有修改、删除或增加时，需要重新生成或删除get/set等方法，给代码维护增加负担。而使用了lombok则不一样，使用了lombok的注解(@Setter,@Getter,@ToString,@@RequiredArgsConstructor,@EqualsAndHashCode或@Data)之后，就不需要编写或生成get/set等方法，很大程度上减少了代码量，而且减少了代码维护的负担。故强烈建议项目中使用lombok，去掉bean中get、set、toString、equals和hashCode等方法的代码。

一、实战

1.安装lombok插件：

具体流程如图：

1.1

1.2

1.3

2.添加lombok的maven的pom.xml依赖：

[java] view plain copy

<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.10</version>
</dependency>

3. 示例代码Student.java

[java] view plain copy

package com.lombok.demo;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
/**
* Created by zhangzh on 2017/2/8.
*/
@Setter
@Getter
@ToString
@EqualsAndHashCode
public class Student {
private String name;
private int age;
private String male;
private String studentNo;
}

4. 测试类LombokTest.java

[java] view plain copy

package com.lombok.demo;
import lombok.extern.java.Log;
/**
* Created by zhangzh on 2017/2/8.
*/
@Log
public class LombokTest {
public static void main(String[] args) {
Student student = new Student();
student.setAge(27);
student.setMale("man");
student.setName("lance");
student.setStudentNo("2017");
System.out.println(student.toString());
Student student2 = new Student();
student2.setAge(27);
student2.setMale("man");
student2.setName("lance");
student2.setStudentNo("2017");
System.out.println(student.equals(student2));
student2.setStudentNo("2018");
System.out.println(student.equals(student2));
log.info("lombok test");
}
}

5. 输出结果:

[java] view plain copy

Student(name=lance, age=27, male=man, studentNo=2017)
true
false
lombok test

结果分析，如果没有添加@Setter注解，则LombokTest中的student示例无法使用setAge()等方法。使用lombok之后，省去了许多没必要的get，set，toString，equals，hashCode代码，简化了代码编写，减少了代码量。
另外@Data注解的作用相当于 @Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode的合集。
另外@Log 省去了在LombokTest中添加 getLogger的如下代码：

private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());

看，简单吧!

下面列举下 lombok提供的注解：

val : 和 scala 中 val 同名, 可以在运行时确定类型;

@NonNull : 注解在参数上, 如果该类参数为 null , 就会报出异常, throw new NullPointException(参数名)

@Cleanup : 注释在引用变量前, 自动回收资源默认调用 close() 方法

@Getter/@Setter : 注解在类上, 为类提供读写属性,用在属性上，再也不用自己手写setter和getter方法了

@Getter(lazy=true) :可以替代经典的Double Check Lock样板代码

@ToString : 注解在类上，可以自动覆写toString方法，当然还可以加其他参数，例如@ToString(exclude=”id”)排除id属性

@EqualsAndHashCode : 注解在类上, 为类提供 equals() 和 hashCode() 方法

@NoArgsConstructor, @RequiredArgsConstructor, @AllArgsConstructor : 注解在类上, 为类提供无参,有指定必须参数, 全参构造函数

@Data : 注解在类上, 相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor这些注解，对于POJO类十分有用

@Value :用在局部变量前面，相当于将变量声明为final，用在类上，相当于为属性添加final声明，只提供getter方法，而不提供setter方法

@Builder : 注解在类上, 为类提供一个内部的 Builder

@SneakThrows :自动抛受检异常，而无需显式在方法上使用throws语句

@Synchronized : 注解在方法上, 为方法提供同步锁

@Log :根据不同的注解生成不同类型的log对象，但是实例名称都是log，有六种可选实现类

@CommonsLog Creates log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
@Log Creates log = java.util.logging.Logger.getLogger(LogExample.class.getName());
@Log4j Creates log = org.apache.log4j.Logger.getLogger(LogExample.class);
@Log4j2 Creates log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
@Slf4j Creates log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
@XSlf4j Creates log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

@Cleanup("dispose") org.eclipse.swt.widgets.CoolBar bar = new CoolBar(parent, 0);
@Cleanup InputStream in = new FileInputStream(args[0]);
@Cleanup OutputStream out = new FileOutputStream(args[1]);