lombok使用方法记录

发表于 | 更新于: | 分类于

maven引入jar包

1
2
3
4
5
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.20</version>
</dependency>

给IDE安装插件

  由于 Lombok 采取的注解形式的，在编译后，自动生成相应的方法，为了不让 IDE’疯了’，需要下载插件了支持它.
  以 idea 为例：查找插件 lombok plugin 安装即可。

一般注解

注解代码 用法
@Getter get方法
@Setter set方法
@ToString ToString方法
@EqualsAndHashCode equals方法和hashcode方法
@AllArgsConstructor 会生成一个包含所有变量，同时如果变量使用了NotNull annotation ， 会进行是否为空的校验，全部参数的构造函数的自动生成，该注解的作用域也是只有在实体类上，参数的顺序与属性定义的顺序一致。
@NoArgsConstructor 无参构造函数
@RequiredArgsConstructor 会生成一个包含常量（final），和标识了@NotNull的变量 的构造方法
@NonNull 非空检查,可以帮助我们避免空指针

构造器

  1. 使用staticName启用静态工厂模式，如下所示：
    @RequiredArgsConstructor(staticName=”of”)。与普通构造函数不同，这种静态工厂方法将推断泛型。这意味着您的API用户可以写入MapEntry.of(“foo”, 5)而不是使用new MapEntry(“foo”, 5)。

  2. 在构造方法上添加注解。使用方法 

    1
    2
    @RequiredArgsConstructor(onConstructor=@__({@AnnotationsGoHere}))}
    @RequiredArgsConstructor(onConstructor=@__({@Autowired}))}  //例子

  3. 使用access标识构造器访问权限修饰符，默认为lombok.AccessLevel.PUBLIC。如：

    1
    @AllArgsConstructor(access = lombok.AccessLevel.PROTECTED)
  4. @NoArgsConstructor(force = true)会初始化所有字段为0或者false或者null，初始化所有的参数为默认值

@val @var

自动类型推断，简单来说，就是弱类型
val注解变量申明是final类型 var注解变量是非final类型

@Data

  自动为所有字段添加@ToString, @EqualsAndHashCode, @Getter方法，为非final字段添加@Setter,和@RequiredArgsConstructor
  注意的是，同时使用@Data 和 @AllArgsConstructor后 ，默认的无参构造函数失效，如果需要它，要重新设置 @NoArgsConstructor

@Accessors(chain = true)

开启链式风格

1
2
3
4
5
6
7
8
9
10
11
12
@Accessors(chain = true)
@Setter
@Getter
public class Student {
    private String name;
    private int age;
}


Student student = new Student()
        .setAge(24)
        .setName("zs");

@Slf4j

直接调用log

1
log.info(xxxx);

@Log

使用的是 java.util.logging.Logger ，直接使用 变量 log。

@Builder

使用建筑者模式构建对象。

@Cleanup

自动化关闭流，相当于 jdk1.7 种的 try with resource

1
2
3
4
@Cleanup
InputStream in = new FileInputStream(args[0]);
@Cleanup
OutputStream out = new FileOutputStream(args[1]);

@SneakyThrows

当我们需要抛出异常，在当前方法上调用，不用显示的在方法名后面写 throw

1
@SneakyThrows(Exception.class)

@Synchronized

方法中所有的代码都加入到一个代码块中，默认静态方法使用的是全局锁，普通方法使用的是对象锁，当然也可以指定锁的对象。

1
2
3
4
5
private final Object lock = new Object();
@Synchronized("lock")
public void foo() {
    // Do something
}










参考内容：

  官方文档
  你真的会写java吗?
  使用Lombok来优雅的编码