Lombok的目的

用注解来替代POJO的getter/setter/toString；异常处理；I/O流的关闭操作。

Lombok的原理

  1. javac对源代码进行分析，生成一棵抽象语法树(AST)
  2. javac编译过程中调用实现了JSR 269的Lombok程序
  3. 此时Lombok就对第一步骤得到的AST进行处理，找到Lombok注解所在类对应的语法树 (AST)，然后修改该语法树(AST)，增加Lombok注解定义的相应树节点
  4. javac使用修改后的抽象语法树(AST)生成字节码文件

    Lombok的使用

  • val：用在局部变量前面，相当于将变量声明为final @Getter/@Setter: 作用类上，生成所有成员变量的getter/setter方法；作用于成员变量上，生成该成员变量的getter/setter方法。可以设定访问权限及是否懒加载等。
  • @ToString：作用于类，覆盖默认的toString()方法，可以通过of属性限定显示某些字段，通过exclude属性排除某些字段。
  • @EqualsAndHashCode：作用于类，覆盖默认的equals和hashCode
  • @NonNull：主要作用于成员变量和参数中，标识不能为空，否则抛出空指针异常
  • @NoArgsConstructor：生成无参构造器
  • @RequiredArgsConstructor：生成包含final和@NonNull注解的成员变量的构造器
  • @AllArgsConstructor：生成全参构造器
  • @Data：作用于类上，是以下注解的集合：@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor
  • @Builder：作用于类上，将类转变为建造者模式
  • @Cleanup：自动关闭资源，针对实现了java.io.Closeable接口的对象有效，如：典型的IO流对象
  • @SneakyThrows：可以对受检异常进行捕捉并抛出
  • @Synchronized：作用于方法级别，可以替换synchronize关键字或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);