Lombok 介绍

背景

Java开发过程，经常需要编写各种java bean或者数据库的entity，这些对象中有非常多的getxxxx()，setxxxx()方法。当然现在的IDE都非常方便可以快速帮你生成这些方法，但是假设哪天某个属性类型发生了变化，你除了修改属性类型外还得去修改get和set方法。这样就非常麻烦

什么是Lombok

先上官网：Project Lombok
Lombok 是一个通过注解可以达到减少java代码的库。如有了这库我们再也不需要编写get、set 等方法。

IDEA 中插件安装

IDEA 中我们知道如果一个对象没有get方法，而你去调用肯定会报错，为了避免在使用Lombok的项目中IDEA疯掉，我们得在IDEA安装一个 Lombok Plus得插件。

Setting –> Plugins –> Browse repositories ….–> lombok plugin –> 点击安装 –> 安装完成重启IDEA –> 安装成功

工程引入相关依赖

刚提到Lombok是一个代码库，那我们就引入这个库。pom.xml添加依赖如下：

<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.6</version>
            <scope>provided</scope>
        </dependency>

使用

在讲使用前，我们先看看Lombok 官网的文档，支持哪些注解，注解中文转自使用Lombok简化你的代码 - yanweiqi - 博客园：

• @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);

因为我也是第一次使用这个库，我就拿几个觉得对以后有帮助的注解写个demo。

@Getter/@Setter

该注解可以使用在类或者属性上。则该类或者对应的属性就默认生成了get和set方法。

@Getter
@Setter
class UserEntity {
    private Long id;
    private String userName;
    private Integer age;
    private Boolean boy;
}
public class LombokTest {
    @Test
    public void testGetAndSet(){
        UserEntity user = new UserEntity();
        user.setAge(30);
        user.setBoy(true);
        user.setId(5L);
        user.setUserName("MeYoung");
        System.out.println(user.getAge());
        System.out.println(user.getBoy());
        System.out.println(user.getId());
        System.out.println(user.getUserName());
    }
  }

ToString

可以用于类或者属性名上，默认情况会按顺序打印每个字段，并以逗号风格。

• ToString.Exclude 用于属性上时，表示排除该属性生成tostring
• ToString.Include 用于属性上表示不排除该属性
• callSuper 是否输出父类的toString方法,默认为false
• includeFieldNames 是否包含字段名称,默认为true

注意如果一个属性是静态的则 @ToString将无效

@ToString(callSuper=true,includeFieldNames=false)
class Demo02{
    private static Long id=1L;
    private String userName="Me";
    @ToString.Exclude private Integer age =30;
    @ToString.Include private Boolean boy = true;
}
public class LombokTest {
    @Test
    public void demo02() {
        Demo02 demo02 = new Demo02();
        System.out.println(demo02.toString());
    }
}

控制台输出：

Demo02(super=com.miyang.MyBatisDemo.Demo02@a8f0b4, Me, true)

当然因为父类没有 toString方法，所以看到的打印出内存地址。

NonNull

该注解使用在属性上，该注解用于属的非空检查，当放在setter方法的字段上，将生成一个空检查，如果为空，则抛出NullPointerException。

class Demo03{
    public void noNullExample(@NonNull String a){
        System.out.println(a);
    }
}
public class LombokTest {
    @Test
    public void demo03() {
        String a = null;
        Demo03 demo03 = new Demo03();
        demo03.noNullExample(a);
    }
}

如果不加NonNull 则会输出null。 如果加了 NonNull 则输出如下：

Data

类加上@Data注解，想打与这个类默认加了@ToString、@EqualsAndHashCode和@RequiredArgsConstructor 以及每个字段都有@Setter和@getter。

AllArgsConstructor

注解在类上，给类加上全参的构造方法。

如上图new 一个UserEntity对象时，如果不给构造方法传参，会报错。

Value

这个注解用在 类 上，会生成含所有参数的构造方法，get 方法，此外还提供了equals、hashCode、toString 方法。
注意：没有setter

@Value
class UserEntity {
    private Long id;
    private String userName;
    private Integer age;
    private Boolean boy;
}
public class LombokTest {
    @Test
    public void test04(){
        UserEntity userEntity= new UserEntity(1L,"ASDF",30,false);
        System.out.println(userEntity.getAge());
        System.out.println(userEntity.getId());
        System.out.println(userEntity.getBoy());
        System.out.println(userEntity.getUserName());
        System.out.println(userEntity.toString());
        System.out.println(userEntity.hashCode());
        UserEntity userEntity2= new UserEntity(1L,"ASDF",30,false);
        System.out.println(userEntity2.equals(userEntity));
    }
}

控制台输出：

30
1
false
ASDF
UserEntity(id=1, userName=ASDF, age=30, boy=false)
-1551711609
true

SneakyThrows

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

@Test
    @SneakyThrows
    public void test05(){
        Thread.sleep(5000);
    }

log

支持多种log打印，这里以Slf4j 为例子。

@Slf4j
public class LombokTest {
    @Test
    public void log(){
        log.info("info........");
        log.error("error........");
        log.debug("debug........");
        log.error("error........");
    }
  }

关于@Log注解，怎么跟Spring 结合打印我们期望的样子，下个章节演示。