Project Lombok
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.
翻译:
Project Lombok是一个java库,它自动插入到编辑器和构建工具中,增强java的性能。
不要再编写另一个getter或equals方法,使用一个注释,您的类有一个功能齐全的生成器,自动记录变量,等等。
2.安装
小辣椒的官网现在地址是:https://projectlombok.org/download
小辣椒是一个jar包,导入Eclipse时,需要双击jar包,找到对应的eclipse/eclipse.exe,然后点击安装更新,确认在eclipse目录下存在limbok.jar包,并且eclipse.ini文件中有 -javaagent:lombok.jar说明安装成功。
3.使用
注解说明:
- val:用在局部变量前面,相当于将变量声明为final类型
- @NonNull:给方法参数增加这个注解会自动在方法内对该参数进行是否为空的校验,如果为空,则抛出空指针异常NullPointerException
- @Cleanup:自动管理资源,用在局部变量之前,在当前变量范围内即将执行完毕退出之前会自动清理资源,自动生成try-finally这样的代码来关闭流
- @Getter/@Setter:用在属性上,再也不用自己手写getter和setter方法了,还可以指定访问范围
- @ToString:用在类上,可以自动复写toString方法,当然还可以加其他参数,例如:@ToString(exclude="id")排除id属性,或者@ToString(callSuper=true,includeFueldNames=true)调用父类的toString方法,包含所有属性
- @EquesAndHashCode:用在类上,自动生成equals方法和hashCode方法
- @NoArgsConstructor,@RequiredArgsConstructor and @AllArgsConstructor:用在类上,自动生成五参构造和使用所有参数的构造函数以及把所有@NonNull属性作为参数的构造函数。如果指定staticName="of"参数,同事还会生成一个返回类对象的静态工厂方法,比使用构造函数方便很多
- @Data:注解在类上,相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstructor这些注解,对于POJO类十分有用
- @Value:用在类上,是@Data的不可变形式,相当于为属性添加final声明,只提供getter方法而不统共setter方法
- @Builder:用在类、构造器、方法上,为你提供复杂的builder APIs,让你可以像如下方式一样调用Person.builder().name("Adam Savage").city("San Francisco").job("Unchained Reaction").build();更多说明参考Builder
- @SneakyThrows:自动抛受检异常,而无需显式在方法上使用throws语句
- @Synchronized:用在方法上,将方法声明为同步的,并自动加锁,而锁对象是一个私有的属性$lock或$LOCK,而java中的synchronized关键字锁对象是this,锁在this或者自己的类对象上存在副作用,就是你不能阻止非受控代码去锁this或者类对象,这可能会导致竞争条件或者其他线程错误
- @Getter(lazy=true):可以替代经典的Double Check Lock样板代码
- @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);
4.安装后Eclipse打不开问题
别瞎搞了,就是lombok与Eclipse的版本不兼容,换个低版本的吧。
参考文档:
https://www.jianshu.com/p/97f7b8bc3359
https://blog.csdn.net/winfredzen/article/details/78718216