Introduction à AutoValue

1. Vue d'ensemble

AutoValue est un générateur de code source pour Java, et plus précisément une bibliothèque pour générer du code source pour des objets valeur ou des objets de type valeur .

Pour générer un objet de type valeur, tout ce que vous avez à faire est d' annoter une classe abstraite avec l' annotation @AutoValue et de compiler votre classe. Ce qui est généré est un objet de valeur avec des méthodes d'accesseur, un constructeur paramétré, correctement substitué les méthodes toString (), equals (Object) et hashCode () .

L'extrait de code suivant est un exemple rapide d'une classe abstraite qui, une fois compilée, produira un objet de valeur nommé AutoValue_Person .

@AutoValue abstract class Person { static Person create(String name, int age) { return new AutoValue_Person(name, age); } abstract String name(); abstract int age(); } 

Continuons et découvrons plus sur les objets de valeur, pourquoi nous en avons besoin et comment AutoValue peut aider à rendre la tâche de génération et de refactorisation du code beaucoup moins longue.

2. Configuration de Maven

Pour utiliser AutoValue dans un projet Maven, vous devez inclure la dépendance suivante dans le pom.xml :

 com.google.auto.value auto-value 1.2 

La dernière version peut être trouvée en suivant ce lien.

3. Objets de type valeur

Les types de valeur sont le produit final de la bibliothèque, donc pour apprécier sa place dans nos tâches de développement, nous devons bien comprendre les types de valeur, ce qu'ils sont, ce qu'ils ne sont pas et pourquoi nous en avons besoin.

3.1. Que sont les types de valeur?

Les objets de type valeur sont des objets dont l'égalité entre eux n'est pas déterminée par l'identité mais plutôt par leur état interne. Cela signifie que deux instances d'un objet de type valeur sont considérées comme égales tant qu'elles ont des valeurs de champ égales.

En règle générale, les types valeur sont immuables . Leurs champs doivent être rendus définitifs et ils ne doivent pas avoir de méthodes setter car cela les rendra modifiables après instanciation.

Ils doivent consommer toutes les valeurs de champ via un constructeur ou une méthode de fabrique.

Les types de valeur ne sont pas des JavaBeans car ils n'ont pas de constructeur d'argument par défaut ou zéro et ils n'ont pas non plus de méthodes de définition, de même, ils ne sont pas des objets de transfert de données ni des objets Java simples .

De plus, une classe de type valeur doit être finale, de sorte qu'elle ne soit pas extensible, au moins que quelqu'un remplace les méthodes. Les JavaBeans, DTO et POJO n'ont pas besoin d'être définitifs.

3.2. Création d'un type de valeur

En supposant que nous voulons créer un type valeur appelé Foo avec des champs appelés texte et nombre. Comment procéderions-nous?

Nous ferions une classe finale et marquerions tous ses champs comme finaux. Ensuite, nous utiliserions l'EDI pour générer le constructeur, la méthode hashCode () , la méthode equals (Object) , les getters comme méthodes obligatoires et une méthode toString () , et nous aurions une classe comme celle-ci:

public final class Foo { private final String text; private final int number; public Foo(String text, int number) { this.text = text; this.number = number; } // standard getters @Override public int hashCode() { return Objects.hash(text, number); } @Override public String toString() { return "Foo [text=" + text + ", number=" + number + "]"; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (getClass() != obj.getClass()) return false; Foo other = (Foo) obj; if (number != other.number) return false; if (text == null) { if (other.text != null) return false; } else if (!text.equals(other.text)) { return false; } return true; } }

Après avoir créé une instance de Foo , nous nous attendons à ce que son état interne reste le même pendant tout son cycle de vie.

Comme nous le verrons dans la sous - section suivante, le hashCode d'un objet doit changer d'instance en instance , mais pour les types valeur, nous devons le lier aux champs qui définissent l'état interne de l'objet valeur.

Par conséquent, même la modification d'un champ du même objet modifierait la valeur de hashCode .

3.3. Comment fonctionnent les types de valeur

La raison pour laquelle les types de valeurs doivent être immuables est d'empêcher toute modification de leur état interne par l'application après leur instanciation.

Chaque fois que nous voulons comparer deux objets de type valeur, nous devons par conséquent utiliser la méthode equals (Object) de la classe Object .

Cela signifie que nous devons toujours remplacer cette méthode dans nos propres types de valeur et ne retourner true que si les champs des objets de valeur que nous comparons ont des valeurs égales.

De plus, pour nous d'utiliser nos objets de valeur dans des collections basées sur le hachage comme HashSet s et HashMap s sans casser, il faut bien mettre en œuvre le hashCode () méthode .

3.4. Pourquoi nous avons besoin de types de valeur

Le besoin de types de valeur revient assez souvent. Ce sont des cas où nous voudrions remplacer le comportement par défaut de la classe Object d' origine .

Comme nous le savons déjà, l'implémentation par défaut de la classe Object considère deux objets égaux lorsqu'ils ont la même identité, mais pour nos besoins, nous considérons deux objets égaux lorsqu'ils ont le même état interne .

En supposant que nous souhaitons créer un objet monétaire comme suit:

public class MutableMoney { private long amount; private String currency; public MutableMoney(long amount, String currency) { this.amount = amount; this.currency = currency; } // standard getters and setters }

Nous pouvons exécuter le test suivant dessus pour tester son égalité:

@Test public void givenTwoSameValueMoneyObjects_whenEqualityTestFails_thenCorrect() { MutableMoney m1 = new MutableMoney(10000, "USD"); MutableMoney m2 = new MutableMoney(10000, "USD"); assertFalse(m1.equals(m2)); }

Notez la sémantique du test.

Nous considérons qu'il est passé lorsque les deux objets monétaires ne sont pas égaux. C'est parce que nous n'avons pas remplacé la méthode equals , donc l'égalité est mesurée en comparant les références mémoire des objets, qui bien sûr ne seront pas différentes car ce sont des objets différents occupant des emplacements mémoire différents.

Each object represents 10,000 USD but Java tells us our money objects are not equal. We want the two objects to test unequal only when either the currency amounts are different or the currency types are different.

Now let us create an equivalent value object and this time we will let the IDE generate most of the code:

public final class ImmutableMoney { private final long amount; private final String currency; public ImmutableMoney(long amount, String currency) { this.amount = amount; this.currency = currency; } @Override public int hashCode() { final int prime = 31; int result = 1; result = prime * result + (int) (amount ^ (amount >>> 32)); result = prime * result + ((currency == null) ? 0 : currency.hashCode()); return result; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (getClass() != obj.getClass()) return false; ImmutableMoney other = (ImmutableMoney) obj; if (amount != other.amount) return false; if (currency == null) { if (other.currency != null) return false; } else if (!currency.equals(other.currency)) return false; return true; } }

The only difference is that we overrode the equals(Object) and hashCode() methods, now we have control over how we want Java to compare our money objects. Let's run its equivalent test:

@Test public void givenTwoSameValueMoneyValueObjects_whenEqualityTestPasses_thenCorrect() { ImmutableMoney m1 = new ImmutableMoney(10000, "USD"); ImmutableMoney m2 = new ImmutableMoney(10000, "USD"); assertTrue(m1.equals(m2)); }

Notice the semantics of this test, we expect it to pass when both money objects test equal via the equals method.

4. Why AutoValue?

Now that we thoroughly understand value-types and why we need them, we can look at AutoValue and how it comes into the equation.

4.1. Issues With Hand-Coding

When we create value-types like we have done in the preceding section, we will run into a number of issues related to bad design and a lot of boilerplate code.

A two field class will have 9 lines of code: one for package declaration, two for the class signature and its closing brace, two for field declarations, two for constructors and its closing brace and two for initializing the fields, but then we need getters for the fields, each taking three more lines of code, making six extra lines.

Overriding the hashCode() and equalTo(Object) methods require about 9 lines and 18 lines respectively and overriding the toString() method adds another five lines.

That means a well-formatted code base for our two field class would take about 50 lines of code.

4.2 IDEs to The Rescue?

This is is easy with an IDE like Eclipse or IntilliJ and with only one or two value-typed classes to create. Think about a multitude of such classes to create, would it still be as easy even if the IDE helps us?

Fast forward, some months down the road, assume we have to revisit our code and make amendments to our Money classes and perhaps convert the currency field from the String type to another value-type called Currency.

4.3 IDEs Not Really so Helpful

An IDE like Eclipse can't simply edit for us our accessor methods nor the toString(), hashCode() or equals(Object) methods.

This refactoring would have to be done by hand. Editing code increases the potential for bugs and with every new field we add to the Money class, the number of lines increases exponentially.

Recognizing the fact that this scenario happens, that it happens often and in large volumes will make us really appreciate the role of AutoValue.

5. AutoValue Example

The problem AutoValue solves is to take all the boilerplate code that we talked about in the preceding section, out of our way so that we never have to write it, edit it or even read it.

We will look at the very same Money example, but this time with AutoValue. We will call this class AutoValueMoney for the sake of consistency:

@AutoValue public abstract class AutoValueMoney { public abstract String getCurrency(); public abstract long getAmount(); public static AutoValueMoney create(String currency, long amount) { return new AutoValue_AutoValueMoney(currency, amount); } }

What has happened is that we write an abstract class, define abstract accessors for it but no fields, we annotate the class with @AutoValue all totalling to only 8 lines of code, and javac generates a concrete subclass for us which looks like this:

public final class AutoValue_AutoValueMoney extends AutoValueMoney { private final String currency; private final long amount; AutoValue_AutoValueMoney(String currency, long amount) { if (currency == null) throw new NullPointerException(currency); this.currency = currency; this.amount = amount; } // standard getters @Override public int hashCode() { int h = 1; h *= 1000003; h ^= currency.hashCode(); h *= 1000003; h ^= amount; return h; } @Override public boolean equals(Object o) { if (o == this) { return true; } if (o instanceof AutoValueMoney) { AutoValueMoney that = (AutoValueMoney) o; return (this.currency.equals(that.getCurrency())) && (this.amount == that.getAmount()); } return false; } }

We never have to deal with this class directly at all, neither do we have to edit it when we need to add more fields or make changes to our fields like the currency scenario in the previous section.

Javac will always regenerate updated code for us.

While using this new value-type, all callers see is only the parent type as we will see in the following unit tests.

Here is a test that verifies that our fields are being set correctly:

@Test public void givenValueTypeWithAutoValue_whenFieldsCorrectlySet_thenCorrect() { AutoValueMoney m = AutoValueMoney.create("USD", 10000); assertEquals(m.getAmount(), 10000); assertEquals(m.getCurrency(), "USD"); }

A test to verify that two AutoValueMoney objects with the same currency and same amount test equal follow:

@Test public void given2EqualValueTypesWithAutoValue_whenEqual_thenCorrect() { AutoValueMoney m1 = AutoValueMoney.create("USD", 5000); AutoValueMoney m2 = AutoValueMoney.create("USD", 5000); assertTrue(m1.equals(m2)); }

When we change the currency type of one money object to GBP, the test: 5000 GBP == 5000 USD is no longer true:

@Test public void given2DifferentValueTypesWithAutoValue_whenNotEqual_thenCorrect() { AutoValueMoney m1 = AutoValueMoney.create("GBP", 5000); AutoValueMoney m2 = AutoValueMoney.create("USD", 5000); assertFalse(m1.equals(m2)); }

6. AutoValue With Builders

The initial example we have looked at covers the basic usage of AutoValue using a static factory method as our public creation API.

Notice that if all our fields were Strings, it would be easy to interchange them as we passed them to the static factory method, like placing the amount in the place of currency and vice versa.

This is especially likely to happen if we have many fields and all are of String type. This problem is made worse by the fact that with AutoValue, all fields are initialized through the constructor.

To solve this problem we should use the builder pattern. Fortunately. this can be generated by AutoValue.

Our AutoValue class does not really change much, except that the static factory method is replaced by a builder:

@AutoValue public abstract class AutoValueMoneyWithBuilder { public abstract String getCurrency(); public abstract long getAmount(); static Builder builder() { return new AutoValue_AutoValueMoneyWithBuilder.Builder(); } @AutoValue.Builder abstract static class Builder { abstract Builder setCurrency(String currency); abstract Builder setAmount(long amount); abstract AutoValueMoneyWithBuilder build(); } }

The generated class is just the same as the first one but a concrete inner class for the builder is generated as well implementing the abstract methods in the builder:

static final class Builder extends AutoValueMoneyWithBuilder.Builder { private String currency; private long amount; Builder() { } Builder(AutoValueMoneyWithBuilder source) { this.currency = source.getCurrency(); this.amount = source.getAmount(); } @Override public AutoValueMoneyWithBuilder.Builder setCurrency(String currency) { this.currency = currency; return this; } @Override public AutoValueMoneyWithBuilder.Builder setAmount(long amount) { this.amount = amount; return this; } @Override public AutoValueMoneyWithBuilder build() { String missing = ""; if (currency == null) { missing += " currency"; } if (amount == 0) { missing += " amount"; } if (!missing.isEmpty()) { throw new IllegalStateException("Missing required properties:" + missing); } return new AutoValue_AutoValueMoneyWithBuilder(this.currency,this.amount); } }

Notice also how the test results don't change.

If we want to know that the field values are actually correctly set through the builder, we can execute this test:

@Test public void givenValueTypeWithBuilder_whenFieldsCorrectlySet_thenCorrect() { AutoValueMoneyWithBuilder m = AutoValueMoneyWithBuilder.builder(). setAmount(5000).setCurrency("USD").build(); assertEquals(m.getAmount(), 5000); assertEquals(m.getCurrency(), "USD"); }

To test that equality depends on internal state:

@Test public void given2EqualValueTypesWithBuilder_whenEqual_thenCorrect() { AutoValueMoneyWithBuilder m1 = AutoValueMoneyWithBuilder.builder() .setAmount(5000).setCurrency("USD").build(); AutoValueMoneyWithBuilder m2 = AutoValueMoneyWithBuilder.builder() .setAmount(5000).setCurrency("USD").build(); assertTrue(m1.equals(m2)); }

And when the field values are different:

@Test public void given2DifferentValueTypesBuilder_whenNotEqual_thenCorrect() { AutoValueMoneyWithBuilder m1 = AutoValueMoneyWithBuilder.builder() .setAmount(5000).setCurrency("USD").build(); AutoValueMoneyWithBuilder m2 = AutoValueMoneyWithBuilder.builder() .setAmount(5000).setCurrency("GBP").build(); assertFalse(m1.equals(m2)); }

7. Conclusion

In this tutorial, we have introduced most of the basics of Google's AutoValue library and how to use it to create value-types with a very little code on our part.

An alternative to Google's AutoValue is the Lombok project – you can have a look at the introductory article about using Lombok here.

L'implémentation complète de tous ces exemples et extraits de code se trouve dans le projet AutoValue GitHub.