lombo笔记

最新推荐文章于 2025-03-18 20:17:18 发布

狂战绝世

最新推荐文章于 2025-03-18 20:17:18 发布

阅读量683

点赞数

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/u013631223/article/details/79092218

在编写Java web等类似的项目工程时，前端和后台的数据传输经常需要依靠Java bean中的变量进行存储和提取值的操作，当工程量太过巨大时，自行编写Java bean（包括变量结构设计、getter和setter操作）内容的工程量将会无比巨大，也容易出错，lombok插件在编译时即可根据源码的class设计类和使用方法自动生成相应的getter和setter操作，从而节省了在编写源码时所需的大量编写Java bean的重复工作。

lombok使用前需要在环境中引入jar包，个人理解可以在IDE环境配置中手动添加相关的lombok.jar包，据网上查找的资料似乎eclipse环境想使用lombok需要对jar包进行点击安装（没试过但觉得是扯淡），还有可以在maven的pom.xml文件中添加包的依赖（个人觉得这种方法目前更好一点），maven依赖格式如下：

<dependency>    

<groupId>org.projectlombok</groupId>    

<artifactId>lombok</artifactId>    

<version>1.16.6</version>    

<scope>provided</scope>

</dependency>

从别处抄来的lombok生成bean使用方法如下：

1. 在需要自动生成getter和setter方法的类上，加上@Data注解
2. 在编译类路径中加入lombok.jar包
3. 使用支持lombok的编译工具编译源代码
4. 编译得到的字节码文件中自动生成了getter和setter方法

范例：

import java.io.Serializable;
import lombok.Data;

@Data
public class BasicClusterInfo implements Serializable {

    private static final long serialVersionUID = 3478135817352393604L;
    private String hbaseKey;
    private int receiverCount;
}

上例中，在class BasicClusterInfo之前一行添加了@Data，因此环境在编译的时候exe文件会自动生成getter和setter方法，反编译后显示的结果如下：

public class BasicClusterInfo extends java.lang.Object implements java.io.Serializable{
    public BasicClusterInfo();
    public java.lang.String getHbaseKey();
    public int getReceiverCount();
    public void setHbaseKey(java.lang.String);
    public void setReceiverCount(int);
    public boolean equals(java.lang.Object);
    public boolean canEqual(java.lang.Object);
    public int hashCode();
    public java.lang.String toString();
}

Lombok注解说明

val：用在局部变量前面，相当于将变量声明为final
@NonNull：给方法参数增加这个注解会自动在方法内对该参数进行是否为空的校验，如果为空，则抛出NPE（NullPointerException）
@Cleanup：自动管理资源，用在局部变量之前，在当前变量范围内即将执行完毕退出之前会自动清理资源，自动生成try-finally这样的代码来关闭流
@Getter/@Setter：用在属性上，再也不用自己手写setter和getter方法了，还可以指定访问范围
@ToString：用在类上，可以自动覆写toString方法，当然还可以加其他参数，例如@ToString(exclude=”id”)排除id属性，或者@ToString(callSuper=true, includeFieldNames=true)调用父类的toString方法，包含所有属性
@EqualsAndHashCode：用在类上，自动生成equals方法和hashCode方法
@NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor：用在类上，自动生成无参构造和使用所有参数的构造函数以及把所有@NonNull属性作为参数的构造函数，如果指定staticName = “of”参数，同时还会生成一个返回类对象的静态工厂方法，比使用构造函数方便很多
@Data：注解在类上，相当于同时使用了@ToString、@EqualsAndHashCode、@Getter、@Setter和@RequiredArgsConstrutor这些注解，对于POJO类十分有用
@Value：用在类上，是@Data的不可变形式，相当于为属性添加final声明，只提供getter方法，而不提供setter方法
@Builder：用在类、构造器、方法上，为你提供复杂的builder APIs，让你可以像如下方式一样调用Person.builder().name("Adam Savage").city("San Francisco").job("Mythbusters").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);