在 IntelliJ IDEA 中配置和使用 AutoValue

最新推荐文章于 2024-06-16 09:41:00 发布

P01son

最新推荐文章于 2024-06-16 09:41:00 发布

阅读量2.1k

点赞数

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/qq_34832393/article/details/88187635

AutoValue是Google的开源库，简化Java开发中的繁琐任务，如生成getter/setter、toString()和equals()方法。通过创建抽象类并使用@AutoValue注解，自动实现这些方法，提高开发效率。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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
按照下图进行设置：允许注解处理器

Annotation Processors

运行菜单栏 Build -> Build Project
找到所有 generated 目录，右键菜单选择 Mark Directory as -> Generated Sources Root

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());
}