AutoValue 是 Google 的一个开源库,可以用来简化 Java 开发中的一些繁琐重复劳动,例如 getter/setter
、toString()
和 equals()
等方法。
如何使用AutoValue
AutoValue 的概念非常简单:由你来写一个抽象实体类,交给AutoValue来实现它。
创建抽象类
首先创建一个抽象类,为每个属性添加一个get方法,加上 @AutoValue
注解。其中,AutoValue_Animal
是根据AutoValue的命名格式AutoValue_类名
来命名的,接下配置 IDE 来生成AutoValue_Animal
。
import com.google.auto.value.AutoValue;
@AutoValue
abstract class Animal {
static Animal create(String name, int numberOfLegs) {
return new AutoValue_Animal(name, numberOfLegs);
}
//get方法
abstract String name();
abstract int numberOfLegs();
}
引入AutoValue
Maven
<dependency>
<groupId>com.google.auto.value</groupId>
<artifactId>auto-value-annotations</artifactId>
<version>1.6.2</version>
</dependency>
<dependency>
<groupId>com.google.auto.value</groupId>
<artifactId>auto-value</artifactId>
<version>1.6.2</version>
<scope>provided</scope>
</dependency>
Gradle
dependencies {
compile "com.google.auto.value:auto-value-annotations:1.6.2"
annotationProcessor "com.google.auto.value:auto-value:1.6.2"
}
配置 IntelliJ IDEA
-
设置 Preferences -> Build, Execution, Deployment -> Compiler -> Annotation Processors
按照下图进行设置:允许注解处理器
运行菜单栏 Build -> Build Project
-
找到所有 generated 目录,右键菜单选择 Mark Directory as -> Generated Sources Root
测试 AutoValue
这时 Cannot resolve symbol 'AutoValue_Animal'
的错误提示已经消失,测试一下Animal类:
public void testAnimal() {
Animal dog = Animal.create("dog", 4);
assertEquals("dog", dog.name());
assertEquals(4, dog.numberOfLegs());
assertTrue(Animal.create("dog", 4).equals(dog));
assertFalse(Animal.create("cat", 4).equals(dog));
assertFalse(Animal.create("dog", 2).equals(dog));
assertEquals("Animal{name=dog, numberOfLegs=4}", dog.toString());
}