@Value 在Lombok v0.11.4中作为实验特性被引入。

@Value 到Lombok v0.11.8时不再必须包含@Wither注解。

@Value 到Lombok v0.12.0时被提升为Lombok主要特性(移动到顶层包内)。

引言

@Value 是具有不可变特性的 @Data变异体;所有字段默认声明成private final类型,另外不再生成set方法。由于不可变特性不允许被继承,所以这个类也会被声明为final。如同@Data一样会生成toString(), equals()hashCode()这些比较有用的方法,每个字段生成get方法以及一个覆盖所有字段(排除已经在字段声明上初始化的字段)的构造方法。

在实践中,除非显式声明某些方法不会生成(不会发出任何警告),否则@Value和以下声明是等价的:

final 
@ToString 
@EqualsAndHashCode 
@AllArgsConstructor 
@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE) 
@Getter

比如你自定义了toString方法,这样也不会有错误出现,但是Lombok将不会在生成toString方法了。同样,只要你显式声明了构造器,不管时候包含参数列表,Lombok都不会再生成构造器。如果你想生成覆盖所有字段的构造器,在类声明上添加@AllArgsConstructor注解即可。如果你需要对Lombok隐藏一些构造器和方法,可以在对应的方法上使用@lombok.experimental.Tolerate注解。

可以在字段声明上进行显式声明进行覆盖默认final和默认private两种控制级别,另外也可以使用@NonFinal 或者 @PackagePrivate注解进行标记。

@Value标记的类中也可以显示的使用其他注解进行覆盖默认的行为。

使用Lombok

import lombok.AccessLevel;
import lombok.experimental.NonFinal;
import lombok.experimental.Value;
import lombok.experimental.Wither;
import lombok.ToString;

@Value public class ValueExample {
  String name;
  @Wither(AccessLevel.PACKAGE) @NonFinal int age;
  double score;
  protected String[] tags;
  
  @ToString(includeFieldNames=true)
  @Value(staticConstructor="of")
  public static class Exercise<T> {
    String name;
    T value;
  }
}

普通Java代码

import java.util.Arrays;

public final class ValueExample {
  private final String name;
  private int age;
  private final double score;
  protected final String[] tags;
  
  @java.beans.ConstructorProperties({"name", "age", "score", "tags"})
  public ValueExample(String name, int age, double score, String[] tags) {
    this.name = name;
    this.age = age;
    this.score = score;
    this.tags = tags;
  }
  
  public String getName() {
    return this.name;
  }
  
  public int getAge() {
    return this.age;
  }
  
  public double getScore() {
    return this.score;
  }
  
  public String[] getTags() {
    return this.tags;
  }
  
  @java.lang.Override
  public boolean equals(Object o) {
    if (o == this) return true;
    if (!(o instanceof ValueExample)) return false;
    final ValueExample other = (ValueExample)o;
    final Object this$name = this.getName();
    final Object other$name = other.getName();
    if (this$name == null ? other$name != null : !this$name.equals(other$name)) 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;
  }
  
  @java.lang.Override
  public int hashCode() {
    final int PRIME = 59;
    int result = 1;
    final Object $name = this.getName();
    result = result * PRIME + ($name == null ? 43 : $name.hashCode());
    result = result * PRIME + this.getAge();
    final long $score = Double.doubleToLongBits(this.getScore());
    result = result * PRIME + (int)($score >>> 32 ^ $score);
    result = result * PRIME + Arrays.deepHashCode(this.getTags());
    return result;
  }
  
  @java.lang.Override
  public String toString() {
    return "ValueExample(name=" + getName() + ", age=" + getAge() + ", score=" + getScore() + ", tags=" + Arrays.deepToString(getTags()) + ")";
  }
  
  ValueExample withAge(int age) {
    return this.age == age ? this : new ValueExample(name, age, score, tags);
  }
  
  public static final 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;
    }
    
    @java.lang.Override
    public boolean equals(Object o) {
      if (o == this) return true;
      if (!(o instanceof ValueExample.Exercise)) return false;
      final Exercise<?> other = (Exercise<?>)o;
      final Object this$name = this.getName();
      final Object other$name = other.getName();
      if (this$name == null ? other$name != null : !this$name.equals(other$name)) return false;
      final Object this$value = this.getValue();
      final Object other$value = other.getValue();
      if (this$value == null ? other$value != null : !this$value.equals(other$value)) return false;
      return true;
    }
    
    @java.lang.Override
    public int hashCode() {
      final int PRIME = 59;
      int result = 1;
      final Object $name = this.getName();
      result = result * PRIME + ($name == null ? 43 : $name.hashCode());
      final Object $value = this.getValue();
      result = result * PRIME + ($value == null ? 43 : $value.hashCode());
      return result;
    }
    
    @java.lang.Override
    public String toString() {
      return "ValueExample.Exercise(name=" + getName() + ", value=" + getValue() + ")";
    }
  }
}

支持的配置项

lombok.value.flagUsage = [warning | error] (default: not set)
默认不进行设置,配置后Lombok将会把使用@Value的类标记为错误或者警告。

lombok.val.flagUsage = [warning | error] (default: not set)
默认不进行设置,配置后Lombok将会把使用val的类标记为错误或者警告。

小提示

参见@Value组成部分的文档:@ToString, @EqualsAndHashCode, @AllArgsConstructor, @FieldDefaults, 和 @Getter.

由于在java6中静态方法的泛型参数会进行类型推导,所以针对类的反省使用静态方法作为构造器是很有用的,而且还避免使用了使用砖石操作符‘<>’。可以显式得使用@AllArgsConstructor(staticConstructor="of") 注解或者@Value(staticConstructor="of")来进行构造覆盖所有字段名为of静态构造器,在注解会将类的构造器声明成私有(private),然后对其进行包装。

一些总所周知由NULL导致的无效性检测注解将会复制到相关的位置(比如getter、setter的参数和构造方法等)。更多内容可以在 @getter@setter文档的小提示中查看。

在v0.11.4到v0.11.6.9中@Value是实验特性(@lombok.experimental.Value),之后它被转移到核心包中,旧的注解依旧存在。不过在最终的版本中将会被删除。

使用@FieldDefaults无法将默认final替换成默认private,需要使用@NonFinal或者@PackagePrivate来重载这个操作。

原文地址:https://projectlombok.org/features/Value

——————————————————————————
行路不知花开处,蓦然回首芷兰香。