目录

Life in Flow

知不知，尚矣；不知知，病矣。
不知不知，殆矣。

X

Lombok

   
    0 0 410686931

Lombok的优点

Lombok：可以让你的POJO代码特别简洁，不止简单在 BO/VO/DTO/DO等大量使用，还有设计模式，对象比对等

domain/model/dto/do/vo/vo等等
大家写最看最多的的就是set和get方法，定义一个user对象，生成set/get方法

缺点：大量冗余简单的代码出现在java对象里面

Lombok安装使用

  • 添加IDE工具对Lombok的支持 
    点击File-- Settings设置界面，安装Lombok插件，然后重启idea
  • 项目添加依赖进行版本管理
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.16</version>
<scope>provided</scope>
</dependency>

<!--https://mvnrepository.com/artifact/org.projectlombok/lombok/1.18.16-->
<!--scope=provided，说明它只在编译阶段生效，不需要打入包中, Lombok在编译期将带Lombok注解的Java文件正确编译为完整的Class文件-->

@Setter/@Getter

  • 基于项目的实体类测试
    • User实体类
  • 常见注解@Getter/@Setter
    • 作用类上，生成所有成员变量的getter/setter方法
    • 作用于成员变量上，生成该成员变量的getter/setter方法
  • 编译查看字节码 mvn compile
  • 进一步控制
    • 方法控制访问级别 set和get注解加上 @Getter(AccessLevel.PROTECTED)
    • 不行生成set、get方法
  • 代码
@Setter
@Getter
public class UserDO {

    /**
     * 不想生成 get方法
     */
    @Getter(AccessLevel.NONE)
    private int age;
  
    /**
     * 控制访问权限
     */
    @Getter(AccessLevel.PROTECTED)
    private int salary;
  
    /**
     * final 只会生成get
     */
    private final String name="二当家小D";
  
    /**
     * 下面两个静态成员变量不会生成set/get方法
     */
    static Date createTime = new Date();
    private static final String address = "广东省广州市";
}

@NonNull

  • 作用于方法上或者属性，用于非空判断，如果为空则抛异常
   public void test(@NonNull  String email){
          this.email = email;
   }
  • 字节码
    public void test(@NonNull String email) {
          if (email == null) {
              throw new NullPointerException("email is marked non-null but is null");
          } else {
              this.email = email;
          }
      }

@NoArgsConstructor

  • 生成无参构造器

@AllArgsConstructor

  • 生成全参构造器（非final类型的成员变量）

@RequiredArgsConstructor

  • 指定参数的构造函数，有以下的特征的字段

    • final类型未被初始化的属性, 标记了@NonNull的属性
    • 注意：@NoArgsConstructor不能加！！！

@ToString

  • 不包括某个字段
@ToString(exclude = {"age"})
  • 只输出某个字段
@ToString(of = {"name"})

@EqualsAndHashCode

  • @EqualsAndHashCode
  • 作用于类，覆盖默认的equals和hashCode, 作用于全部属性
  • 不包括某个属性
@EqualsAndHashCode(exclude = {"age"})

只输出某个属性

@EqualsAndHashCode(of = {"name"})

@Data

  • @Data, 定义一个干净的类，增加此注解，mvn compile查看字节码
  • 作用于类上，是以下注解的集合
    • @ToString
    • @EqualsAndHashCode
    • @Getter
    • @Setter
    • @RequiredArgsConstructor

@Builder

  • 帮你生成了set、get方法，还在苦苦的一个个赋值？？？

  • 构造者模式：又称之为建造者模式

    • 场景：当一个bean类重载了多个构造方法时,并且参数随机使用时,考虑使用构造者模式
    • 谷歌的开源的protobuf协议生产的java bean赋值就是采用建造者模式

  • @Builder注解

    • 作用在类上
//添加
@Builder
@Data
public class StudentDO {
}

//使用
StudentDO studentDO = StudentDO.builder().age(1).email("794666918@qq").build();
System.out.println(studentDO);

@Log/@Slf4j

  • @Log / @Slf4j
    • 作用于类上，生成日志变量, 用于记录日志
  • 如果不生效，记得检查下面的配置，另外重新更新下lombok插件，重启idea
    • 开始按照创建的那边，记得开启 开启annotion processing
  • 使用
@Slf4j
public class UserServiceImpl{
    public void login(String email){
	//方便记录日志
        log.info("用户登录：{}",email);
    }
}

//字节码
public class StudentDO {
    private static final Logger log = Logger.getLogger(StudentDO.class.getName());
}

Lombok插件原理-对比反射技术

熟悉Java自定义注解的同学已经猜到是: JSR 269插件化注解处理

JSR 269:  Pluggable Annotation Processing API
实现在Javac编译阶段利用“Annotation Processor”对自定义的注解进行预处理后生成真正在JVM上面执行的“Class文件
地址：https://www.jcp.org/en/jsr/detail?id=269

Lombok解析流程如下

image-20201227112619988

Javac 解析成AST抽象语法树后, Lombok根据自己编写的注解处理器，动态地修改 AST增加新的节点（即Lombok自定义注解所需要生成的代码）,最终生成JVM可执行的字节码Class文件

可以看编译后的在target目录下的class文件

能实现上述效果的还有一个反射技术，那两个对比如何？

使用Annotation Processing自定义注解是在编译阶段进行修改
JDK的反射技术是在运行时动态修改

结论：反射更加灵活一些但是带来的性能损耗更加大

hashcode和equal方法

  • Equals⽅法
    • 顶级类Object⾥⾯的⽅法，所有类都是继承Object的，返回值boolean类型
    • 根据⾃定义的匹配规则，⽤于匹配两个对象是否⼀样, ⼀般逻辑是如下
  • HashCode⽅法
    • 顶级类Object⾥⾯的⽅法，所有类都是继承Object的，返回值int类型
    • 根据⼀定的hash规则(存储地址，字段，或者⻓度等)，映射成⼀个数值，即散列值
  //判断地址是否⼀样
  //⾮空判断和class类型判断
  //强转
  //对象⾥⾯的字段⼀⼀匹配

解析

如果两个对象相等，那么它们的hashCode()值一定相同（这里的相等是指，通过equals()比较两个对象时返回true）

如果两个对象hashCode()相等，它们并不一定相等。在散列表中hashCode()相等，即两个键值对的哈希值相等。
然而哈希值相等，并不一定能得出键值对相等，就出现所谓的哈希冲突场景，还需判断equals⽅法判断对象是否相等

应用场景：当向集合中插⼊对象时，如何判别在集合中是否已经存在该对象，⽐如Set确保存储对象的 唯⼀，并判断是不是同个对象呢？

依据hashCode和equals进⾏判断
所以Set存储的对象必须重写这两个⽅法 判断两个对象是否⼀样
⾸先判断插⼊obj的hashcode值是否存在，hashcode值不存在则直 接插⼊集合
值存在则还需判断equals⽅法判断对象是否相等

class User {
 private int age;
 private String name;
 private Date time;
 //省略setter和getter⽅法
 @Override
 public boolean equals(Object o) {
   if (this == o) return true;
   if (o == null || getClass() != o.getClass()) return false;
   Student student = (Student) o;
   return age == student.age &&
   Objects.equals(name, student.name) &&
   Objects.equals(time, student.time);
 }
 @Override
 public int hashCode() {
   return Objects.hash(age, name, time);
 }
}

优缺点适合场景

Lombok插件是不是万能的？？？

image-20201230141126142

缺点：

  • Lombok的使用要求一定要在IDE中安装对应的插件，如果项目组中有一个人使用了Lombok则都要用
  • 代码可读性，可调试性低，比如想知道某个类中的某个属性的getter方法都被哪些类引用
  • 影响升级，如果升级到某个新版本的JDK的时候，如果其中的特性在Lombok中不支持的话就会受到影响
  • 注意常见的细节点
比如只使用了@Data，而不使用@EqualsAndHashCode(callSuper=true)的话，会默认是@EqualsAndHashCode(callSuper=false),这时候生成的equals()方法只会比较子类的属性，不会考虑从父类继承的属性，无论父类属性访问权限是否开放,只要知道是否需要使用父类的属性即可，也提供定制化配置，所以不用过多担心
    • 优点：
      • 使用注解即可帮忙自动生成代码
      • 大大减少了代码量，使代码非常简洁
      • 部分注解在业务项目中开发能大大提高效率
  • 项目中应该用还是不用呢
    • 不建议开发中间件的项目使用，中间件设计的要求是解耦少依赖
    • 业务项目实体类可以用，且用的时候知道对应的常见的注解原理
  • Lombok
    • @Setter/@Getter
    • @NonNull
    • @NoArgsConstructor
    • @AllArgsConstructor
    • @RequiredArgsConstructor
    • @ToString
    • @EqualsAndHashCode
    • @Data
    • @Builder
    • @Log
    • @Slf4j
作者：Soulboy