@Data注解简化代码

Posted qzkuan

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了@Data注解简化代码相关的知识，希望对你有一定的参考价值。

1 Lombok背景介绍

官方介绍如下：

Project Lombok makes java a spicier language by adding ‘handlers‘ that know how to build and compile simple, boilerplate-free, not-quite-java code.

大致意思是Lombok通过增加一些“处理程序”，可以让java变得简洁、快速。

2 Lombok使用方法

Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。例如开发中经常需要写的javabean，都需要花时间去添加相应的getter/setter，也许还要去写构造器、equals等方法，而且需要维护，当属性多时会出现大量的getter/setter方法，这些显得很冗长也没有太多技术含量，一旦修改属性，就容易出现忘记修改对应方法的失误。

Lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法。出现的神奇就是在源码中没有getter和setter方法，但是在编译生成的字节码文件中有getter和setter方法。这样就省去了手动重建这些代码的麻烦，使代码看起来更简洁些。

Lombok的使用跟引用jar包一样，可以在官网（https://projectlombok.org/download）下载jar包，也可以使用maven添加依赖：

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

接下来我们来分析Lombok中注解的具体用法。

2.1 @Data

@Data注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

import lombok.AccessLevel;
import lombok.Setter;
import lombok.Data;
import lombok.ToString;

@Data public class DataExample 
  private final String name;
  @Setter(AccessLevel.PACKAGE) private int age;
  private double score;
  private String[] tags;
  
  @ToString(includeFieldNames=true)
  @Data(staticConstructor="of")
  public static class Exercise<T> 
    private final String name;
    private final T value;

如不使用Lombok，则实现如下：

技术图片 
import java.util.Arrays;

public class DataExample 
  private final String name;
  private int age;
  private double score;
  private String[] tags;
  
  public DataExample(String name) 
    this.name = name;
  
  
  public String getName() 
    return this.name;
  
  
  void setAge(int age) 
    this.age = age;
  
  
  public int getAge() 
    return this.age;
  
  
  public void setScore(double score) 
    this.score = score;
  
  
  public double getScore() 
    return this.score;
  
  
  public String[] getTags() 
    return this.tags;
  
  
  public void setTags(String[] tags) 
    this.tags = tags;
  
  
  @Override public String toString() 
    return "DataExample(" + this.getName() + ", " + this.getAge() + ", " + this.getScore() + ", " + Arrays.deepToString(this.getTags()) + ")";
  
  
  protected boolean canEqual(Object other) 
    return other instanceof DataExample;
  
  
  @Override public boolean equals(Object o) 
    if (o == this) return true;
    if (!(o instanceof DataExample)) return false;
    DataExample other = (DataExample) o;
    if (!other.canEqual((Object)this)) return false;
    if (this.getName() == null ? other.getName() != null : !this.getName().equals(other.getName())) return false;
    if (this.getAge() != other.getAge()) return false;
    if (Double.compare(this.getScore(), other.getScore()) != 0) return false;
    if (!Arrays.deepEquals(this.getTags(), other.getTags())) return false;
    return true;
  
  
  @Override public int hashCode() 
    final int PRIME = 59;
    int result = 1;
    final long temp1 = Double.doubleToLongBits(this.getScore());
    result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
    result = (result*PRIME) + this.getAge();
    result = (result*PRIME) + (int)(temp1 ^ (temp1 >>> 32));
    result = (result*PRIME) + Arrays.deepHashCode(this.getTags());
    return result;
  
  
  public static class Exercise<T> 
    private final String name;
    private final T value;
    
    private Exercise(String name, T value) 
      this.name = name;
      this.value = value;
    
    
    public static <T> Exercise<T> of(String name, T value) 
      return new Exercise<T>(name, value);
    
    
    public String getName() 
      return this.name;
    
    
    public T getValue() 
      return this.value;
    
    
    @Override public String toString() 
      return "Exercise(name=" + this.getName() + ", value=" + this.getValue() + ")";
    
    
    protected boolean canEqual(Object other) 
      return other instanceof Exercise;
    
    
    @Override public boolean equals(Object o) 
      if (o == this) return true;
      if (!(o instanceof Exercise)) return false;
      Exercise<?> other = (Exercise<?>) o;
      if (!other.canEqual((Object)this)) return false;
      if (this.getName() == null ? other.getValue() != null : !this.getName().equals(other.getName())) return false;
      if (this.getValue() == null ? other.getValue() != null : !this.getValue().equals(other.getValue())) return false;
      return true;
    
    
    @Override public int hashCode() 
      final int PRIME = 59;
      int result = 1;
      result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
      result = (result*PRIME) + (this.getValue() == null ? 43 : this.getValue().hashCode());
      return result;
View Code

2.2 @Getter/@Setter

如果觉得@Data太过残暴（因为@Data集合了@ToString、@EqualsAndHashCode、@Getter/@Setter、@RequiredArgsConstructor的所有特性）不够精细，可以使用@Getter/@Setter注解，此注解在属性上，可以为相应的属性自动生成Getter/Setter方法，示例如下：

import lombok.AccessLevel;
import lombok.Getter;
import lombok.Setter;

public class GetterSetterExample 

  @Getter @Setter private int age = 10;
  
  @Setter(AccessLevel.PROTECTED) private String name;
  
  @Override public String toString() 
    return String.format("%s (age: %d)", name, age);

如果不使用Lombok：

技术图片 
public class GetterSetterExample 

  private int age = 10;

  private String name;
  
  @Override public String toString() 
    return String.format("%s (age: %d)", name, age);
  
  
  public int getAge() 
    return age;
  
  
  public void setAge(int age) 
    this.age = age;
  
  
  protected void setName(String name) 
    this.name = name;
View Code

2.3 @NonNull

该注解用在属性或构造器上，Lombok会生成一个非空的声明，可用于校验参数，能帮助避免空指针。

import lombok.NonNull;

public class NonNullExample extends Something 
  private String name;
  
  public NonNullExample(@NonNull Person person) 
    super("Hello");
    this.name = person.getName();

不使用Lombok：

技术图片 
import lombok.NonNull;

public class NonNullExample extends Something 
  private String name;
  
  public NonNullExample(@NonNull Person person) 
    super("Hello");
    if (person == null) 
      throw new NullPointerException("person");
    
    this.name = person.getName();
View Code

2.4 @Cleanup

该注解能帮助我们自动调用close()方法，很大的简化了代码。

import lombok.Cleanup;
import java.io.*;

public class CleanupExample 
  public static void main(String[] args) throws IOException 
    @Cleanup InputStream in = new FileInputStream(args[0]);
    @Cleanup OutputStream out = new FileOutputStream(args[1]);
    byte[] b = new byte[10000];
    while (true) 
      int r = in.read(b);
      if (r == -1) break;
      out.write(b, 0, r);

如不使用Lombok，则需如下：

技术图片 
import java.io.*;

public class CleanupExample 
  public static void main(String[] args) throws IOException 
    InputStream in = new FileInputStream(args[0]);
    try 
      OutputStream out = new FileOutputStream(args[1]);
      try 
        byte[] b = new byte[10000];
        while (true) 
          int r = in.read(b);
          if (r == -1) break;
          out.write(b, 0, r);
        
       finally 
        if (out != null) 
          out.close();
        
      
     finally 
      if (in != null) 
        in.close();
View Code

2.5 @EqualsAndHashCode

官方文档：@EqualsAndHashCode

原文中提到的大致有以下几点：
1. 此注解会生成equals(Object other) 和 hashCode()方法。
2. 它默认使用非静态，非瞬态的属性
3. 可通过参数exclude排除一些属性
4. 可通过参数of指定仅使用哪些属性
5. 它默认仅使用该类中定义的属性且不调用父类的方法
6. 可通过callSuper=true解决上一点问题。让其生成的方法中调用父类的方法。

另：@Data相当于@Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode这5个注解的合集。

通过官方文档，可以得知，当使用@Data注解时，则有了@EqualsAndHashCode注解，那么就会在此类中存在equals(Object other) 和 hashCode()方法，且不会使用父类的属性，这就导致了可能的问题。
比如，有多个类有相同的部分属性，把它们定义到父类中，恰好id（数据库主键）也在父类中，那么就会存在部分对象在比较时，它们并不相等，却因为lombok自动生成的equals(Object other) 和 hashCode()方法判定为相等，从而导致出错。

修复此问题的方法很简单：
1. 使用@Getter @Setter @ToString代替@Data并且自定义equals(Object other) 和 hashCode()方法，比如有些类只需要判断主键id是否相等即足矣。
2. 或者使用在使用@Data时同时加上@EqualsAndHashCode(callSuper=true)注解。

import lombok.EqualsAndHashCode;

@EqualsAndHashCode(exclude="id", "shape")
public class EqualsAndHashCodeExample 
  private transient int transientVar = 10;
  private String name;
  private double score;
  private Shape shape = new Square(5, 10);
  private String[] tags;
  private int id;
  
  public String getName() 
    return this.name;
  
  
  @EqualsAndHashCode(callSuper=true)
  public static class Square extends Shape 
    private final int width, height;
    
    public Square(int width, int height) 
      this.width = width;
      this.height = height;

2.6 @ToString

类使用@ToString注解，Lombok会生成一个toString()方法，默认情况下，会输出类名、所有属性（会按照属性定义顺序），用逗号来分割。

import lombok.ToString;

@ToString(exclude="id")
public class ToStringExample 
  private static final int STATIC_VAR = 10;
  private String name;
  private Shape shape = new Square(5, 10);
  private String[] tags;
  private int id;
  
  public String getName() 
    return this.getName();
  
  
  @ToString(callSuper=true, includeFieldNames=true)
  public static class Square extends Shape 
    private final int width, height;
    
    public Square(int width, int height) 
      this.width = width;
      this.height = height;

2.7 @NoArgsConstructor, @RequiredArgsConstructor and @AllArgsConstructor

无参构造器、部分参数构造器、全参构造器。Lombok没法实现多种参数构造器的重载。

import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;
import lombok.AllArgsConstructor;
import lombok.NonNull;

@RequiredArgsConstructor(staticName = "of")
@AllArgsConstructor(access = AccessLevel.PROTECTED)
public class ConstructorExample<T> 
  private int x, y;
  @NonNull private T description;
  
  @NoArgsConstructor
  public static class NoArgsExample 
    @NonNull private String field;

3 Lombok工作原理分析

会发现在Lombok使用的过程中，只需要添加相应的注解，无需再为此写任何代码。自动生成的代码到底是如何产生的呢？

核心之处就是对于注解的解析上。JDK5引入了注解的同时，也提供了两种解析方式。

  • 运行时解析

运行时能够解析的注解，必须将@Retention设置为RUNTIME，这样就可以通过反射拿到该注解。java.lang,reflect反射包中提供了一个接口AnnotatedElement，该接口定义了获取注解信息的几个方法，Class、Constructor、Field、Method、Package等都实现了该接口，对反射熟悉的朋友应该都会很熟悉这种解析方式。

  • 编译时解析

编译时解析有两种机制，分别简单描述下：

1）Annotation Processing Tool

apt自JDK5产生，JDK7已标记为过期，不推荐使用，JDK8中已彻底删除，自JDK6开始，可以使用Pluggable Annotation Processing API来替换它，apt被替换主要有2点原因：

  • api都在com.sun.mirror非标准包下
  • 没有集成到javac中，需要额外运行

2）Pluggable Annotation Processing API

JSR 269自JDK6加入，作为apt的替代方案，它解决了apt的两个问题，javac在执行的时候会调用实现了该API的程序，这样我们就可以对编译器做一些增强，这时javac执行的过程如下： 
技术图片

Lombok本质上就是一个实现了“JSR 269 API”的程序。在使用javac的过程中，它产生作用的具体流程如下：

  1. javac对源代码进行分析，生成了一棵抽象语法树（AST）
  2. 运行过程中调用实现了“JSR 269 API”的Lombok程序
  3. 此时Lombok就对第一步骤得到的AST进行处理，找到@Data注解所在类对应的语法树（AST），然后修改该语法树（AST），增加getter和setter方法定义的相应树节点
  4. javac使用修改后的抽象语法树（AST）生成字节码文件，即给class增加新的节点（代码块）

拜读了Lombok源码，对应注解的实现都在HandleXXX中，比如@Getter注解的实现时HandleGetter.handle()。还有一些其它类库使用这种方式实现，比如Google Auto、Dagger等等。

4. Lombok的优缺点

优点：

  1. 能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，提高了一定的开发效率
  2. 让代码变得简洁，不用过多的去关注相应的方法
  3. 属性做修改时，也简化了维护为这些属性所生成的getter/setter方法等

缺点：

    1. 不支持多种参数构造器的重载
    2. 虽然省去了手动创建getter/setter方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度

 

以上是关于@Data注解简化代码的主要内容，如果未能解决你的问题，请参考以下文章

Spring学习笔记：尝试Lombok简化实体类代码

ssh搭建过程加入jpa+注解（简化代码量）

SSH项目（struts+spring+hibernate）搭建_代码简化

使用Lombok @Builder注解导致默认值无效

Android开发学习之路-让注解帮你简化代码，彻底抛弃findViewById

使用 SpringCache 简化缓存代码实现