Introduction à Vavr

1. Vue d'ensemble

Dans cet article, nous allons explorer exactement ce qu'est Vavr, pourquoi nous en avons besoin et comment l'utiliser dans nos projets.

Vavr est une bibliothèque fonctionnelle pour Java 8+ qui fournit des types de données immuables et des structures de contrôle fonctionnelles.

1.1. Dépendance de Maven

Pour utiliser Vavr, vous devez ajouter la dépendance:

 io.vavr vavr 0.9.0 

Il est recommandé de toujours utiliser la dernière version. Vous pouvez l'obtenir en suivant ce lien.

2. Option

L'objectif principal d'Option est d'éliminer les vérifications nulles dans notre code en exploitant le système de type Java.

Option est un conteneur d'objets dans Vavr avec un objectif final similaire à celui de Optional dans Java 8. L' option de Vavr implémente Serializable, Iterable et possède une API plus riche .

Étant donné que toute référence d'objet en Java peut avoir une valeur nulle , nous devons généralement vérifier la nullité avec des instructions if avant de l'utiliser. Ces vérifications rendent le code robuste et stable:

@Test public void givenValue_whenNullCheckNeeded_thenCorrect() { Object possibleNullObj = null; if (possibleNullObj == null) { possibleNullObj = "someDefaultValue"; } assertNotNull(possibleNullObj); }

Sans contrôles, l'application peut planter en raison d'un simple NPE:

@Test(expected = NullPointerException.class) public void givenValue_whenNullCheckNeeded_thenCorrect2() { Object possibleNullObj = null; assertEquals("somevalue", possibleNullObj.toString()); }

Cependant, les vérifications rendent le code détaillé et moins lisible , en particulier lorsque les instructions if finissent par être imbriquées plusieurs fois.

Option résout ce problème en éliminant totalement les valeurs nulles et en les remplaçant par une référence d'objet valide pour chaque scénario possible.

Avec Option, une valeur nulle évaluera à une instance de None , tandis qu'une valeur non nulle évaluera à une instance de Some :

@Test public void givenValue_whenCreatesOption_thenCorrect() { Option noneOption = Option.of(null); Option someOption = Option.of("val"); assertEquals("None", noneOption.toString()); assertEquals("Some(val)", someOption.toString()); }

Par conséquent, au lieu d'utiliser directement les valeurs d'objet, il est conseillé de les envelopper dans une instance Option comme indiqué ci-dessus.

Notez que nous n'avons pas eu à faire de vérification avant d'appeler toString mais que nous n'avons pas eu à gérer une exception NullPointerException comme nous l'avions fait auparavant. L'option toString nous renvoie des valeurs significatives dans chaque appel.

Dans le deuxième extrait de cette section, nous avions besoin d'une vérification nulle , dans laquelle nous attribuerions une valeur par défaut à la variable, avant d'essayer de l'utiliser. Option peut traiter cela en une seule ligne, même s'il y a un null:

@Test public void givenNull_whenCreatesOption_thenCorrect() { String name = null; Option nameOption = Option.of(name); assertEquals("baeldung", nameOption.getOrElse("baeldung")); }

Ou un non-nul:

@Test public void givenNonNull_whenCreatesOption_thenCorrect() { String name = "baeldung"; Option nameOption = Option.of(name); assertEquals("baeldung", nameOption.getOrElse("notbaeldung")); }

Remarquez comment, sans vérification nulle , nous pouvons obtenir une valeur ou renvoyer une valeur par défaut sur une seule ligne.

3. Tuple

Il n'y a pas d'équivalent direct d'une structure de données tuple en Java. Un tuple est un concept courant dans les langages de programmation fonctionnels. Les tuples sont immuables et peuvent contenir plusieurs objets de types différents de manière sécurisée.

Vavr apporte des tuples à Java 8. Les tuples sont de type Tuple1, Tuple2 à Tuple8 selon le nombre d'éléments qu'ils doivent prendre.

Il existe actuellement une limite supérieure de huit éléments. On accède aux éléments d'un tuple comme tuple ._nn est similaire à la notion d'index dans les tableaux:

public void whenCreatesTuple_thenCorrect1() { Tuple2 java8 = Tuple.of("Java", 8); String element1 = java8._1; int element2 = java8._2(); assertEquals("Java", element1); assertEquals(8, element2); }

Notez que le premier élément est récupéré avec n == 1 . Ainsi, un tuple n'utilise pas de base zéro comme un tableau. Les types des éléments qui seront stockés dans le tuple doivent être déclarés dans sa déclaration de type comme indiqué ci-dessus et ci-dessous:

@Test public void whenCreatesTuple_thenCorrect2() { Tuple3 java8 = Tuple.of("Java", 8, 1.8); String element1 = java8._1; int element2 = java8._2(); double element3 = java8._3(); assertEquals("Java", element1); assertEquals(8, element2); assertEquals(1.8, element3, 0.1); }

La place d'un tuple est de stocker un groupe fixe d'objets de tout type qui sont mieux traités comme une unité et peuvent être transmis. Un cas d'utilisation plus évident est le retour de plusieurs objets à partir d'une fonction ou d'une méthode en Java.

4. Essayez

Dans Vavr, Try est un conteneur pour un calcul qui peut entraîner une exception.

Comme Option encapsule un objet Nullable afin que nous n'ayons pas à nous occuper explicitement des NULL avec if checks, Try encapsule un calcul afin que nous n'ayons pas à prendre en charge explicitement les exceptions avec des blocs try-catch .

Prenez le code suivant par exemple:

@Test(expected = ArithmeticException.class) public void givenBadCode_whenThrowsException_thenCorrect() { int i = 1 / 0; }

Sans blocs try-catch , l'application planterait. Pour éviter cela, vous devez envelopper l'instruction dans un bloc try-catch . Avec Vavr, nous pouvons envelopper le même code dans une instance Try et obtenir un résultat:

@Test public void givenBadCode_whenTryHandles_thenCorrect() { Try result = Try.of(() -> 1 / 0); assertTrue(result.isFailure()); }

Si le calcul a réussi ou non peut alors être inspecté par choix à tout moment dans le code.

Dans l'extrait ci-dessus, nous avons choisi de simplement vérifier le succès ou l'échec. Nous pouvons également choisir de renvoyer une valeur par défaut:

@Test public void givenBadCode_whenTryHandles_thenCorrect2() { Try computation = Try.of(() -> 1 / 0); int errorSentinel = result.getOrElse(-1); assertEquals(-1, errorSentinel); }

Ou même pour lancer explicitement une exception de notre choix:

@Test(expected = ArithmeticException.class) public void givenBadCode_whenTryHandles_thenCorrect3() { Try result = Try.of(() -> 1 / 0); result.getOrElseThrow(ArithmeticException::new); }

Dans tous les cas ci - dessus, nous avons le contrôle sur ce qui se passe après le calcul, grâce à de Vavr Essai avant .

5. Interfaces fonctionnelles

Avec l'arrivée de Java 8, les interfaces fonctionnelles sont intégrées et plus faciles à utiliser, surtout lorsqu'elles sont combinées avec des lambdas.

Cependant, Java 8 ne fournit que deux fonctions de base. On ne prend qu'un seul paramètre et produit un résultat:

@Test public void givenJava8Function_whenWorks_thenCorrect() { Function square = (num) -> num * num; int result = square.apply(2); assertEquals(4, result); }

Le second ne prend que deux paramètres et produit un résultat:

@Test public void givenJava8BiFunction_whenWorks_thenCorrect() { BiFunction sum = (num1, num2) -> num1 + num2; int result = sum.apply(5, 7); assertEquals(12, result); }

On the flip side, Vavr extends the idea of functional interfaces in Java further by supporting up to a maximum of eight parameters and spicing up the API with methods for memoization, composition, and currying.

Just like tuples, these functional interfaces are named according to the number of parameters they take: Function0, Function1, Function2 etc. With Vavr, we would have written the above two functions like this:

@Test public void givenVavrFunction_whenWorks_thenCorrect() { Function1 square = (num) -> num * num; int result = square.apply(2); assertEquals(4, result); }

and this:

@Test public void givenVavrBiFunction_whenWorks_thenCorrect() { Function2 sum = (num1, num2) -> num1 + num2; int result = sum.apply(5, 7); assertEquals(12, result); }

When there is no parameter but we still need an output, in Java 8 we would need to use a Consumer type, in Vavr Function0 is there to help:

@Test public void whenCreatesFunction_thenCorrect0() { Function0 getClazzName = () -> this.getClass().getName(); String clazzName = getClazzName.apply(); assertEquals("com.baeldung.vavr.VavrTest", clazzName); }

How about a five parameter function, it's just a matter of using Function5:

@Test public void whenCreatesFunction_thenCorrect5() { Function5 concat = (a, b, c, d, e) -> a + b + c + d + e; String finalString = concat.apply( "Hello ", "world", "! ", "Learn ", "Vavr"); assertEquals("Hello world! Learn Vavr", finalString); }

We can also combine the static factory method FunctionN.of for any of the functions to create a Vavr function from a method reference. Like if we have the following sum method:

public int sum(int a, int b) { return a + b; }

We can create a function out of it like this:

@Test public void whenCreatesFunctionFromMethodRef_thenCorrect() { Function2 sum = Function2.of(this::sum); int summed = sum.apply(5, 6); assertEquals(11, summed); }

6. Collections

The Vavr team has put a lot of effort in designing a new collections API that meets the requirements of functional programming i.e. persistence, immutability.

Java collections are mutable, making them a great source of program failure, especially in the presence of concurrency. The Collection interface provides methods such as this:

interface Collection { void clear(); }

This method removes all elements in a collection(producing a side-effect) and returns nothing. Classes such as ConcurrentHashMap were created to deal with the already created problems.

Such a class does not only add zero marginal benefits but also degrades the performance of the class whose loopholes it is trying to fill.

With immutability, we get thread-safety for free: no need to write new classes to deal with a problem that should not be there in the first place.

Other existing tactics to add immutability to collections in Java still create more problems, namely, exceptions:

@Test(expected = UnsupportedOperationException.class) public void whenImmutableCollectionThrows_thenCorrect() { java.util.List wordList = Arrays.asList("abracadabra"); java.util.List list = Collections.unmodifiableList(wordList); list.add("boom"); }

All the above problems are non-existent in Vavr collections.

To create a list in Vavr:

@Test public void whenCreatesVavrList_thenCorrect() { List intList = List.of(1, 2, 3); assertEquals(3, intList.length()); assertEquals(new Integer(1), intList.get(0)); assertEquals(new Integer(2), intList.get(1)); assertEquals(new Integer(3), intList.get(2)); }

APIs are also available to perform computations on the list in place:

@Test public void whenSumsVavrList_thenCorrect() { int sum = List.of(1, 2, 3).sum().intValue(); assertEquals(6, sum); }

Vavr collections offer most of the common classes found in the Java Collections Framework and actually, all features are implemented.

The takeaway is immutability, removal of void return types and side-effect producing APIs, a richer set of functions to operate on the underlying elements, very short, robust and compact code compared to Java's collection operations.

A full coverage of Vavr collections is beyond the scope of this article.

7. Validation

Vavr brings the concept of Applicative Functor to Java from the functional programming world. In the simplest of terms, an Applicative Functor enables us to perform a sequence of actions while accumulating the results.

The class vavr.control.Validation facilitates the accumulation of errors. Remember that, usually, a program terminates as soon as an error is encountered.

However, Validation continues processing and accumulating the errors for the program to act on them as a batch.

Consider that we are registering users by name and age and we want to take all input first and decide whether to create a Person instance or return a list of errors. Here is our Person class:

public class Person { private String name; private int age; // standard constructors, setters and getters, toString }

Next, we create a class called PersonValidator. Each field will be validated by one method and another method can be used to combine all the results into one Validation instance:

class PersonValidator { String NAME_ERR = "Invalid characters in name: "; String AGE_ERR = "Age must be at least 0"; public Validation
    
      validatePerson( String name, int age) { return Validation.combine( validateName(name), validateAge(age)).ap(Person::new); } private Validation validateName(String name) { String invalidChars = name.replaceAll("[a-zA-Z ]", ""); return invalidChars.isEmpty() ? Validation.valid(name) : Validation.invalid(NAME_ERR + invalidChars); } private Validation validateAge(int age) { return age < 0 ? Validation.invalid(AGE_ERR) : Validation.valid(age); } }
    

The rule for age is that it should be an integer greater than 0 and the rule for name is that it should contain no special characters:

@Test public void whenValidationWorks_thenCorrect() { PersonValidator personValidator = new PersonValidator(); Validation
    
      valid = personValidator.validatePerson("John Doe", 30); Validation
     
       invalid = personValidator.validatePerson("John? Doe!4", -1); assertEquals( "Valid(Person [name=John Doe, age=30])", valid.toString()); assertEquals( "Invalid(List(Invalid characters in name: ?!4, Age must be at least 0))", invalid.toString()); }
     
    

A valid value is contained in a Validation.Valid instance, a list of validation errors is contained in a Validation.Invalid instance. So any validation method must return one of the two.

Inside Validation.Valid is an instance of Person while inside Validation.Invalid is a list of errors.

8. Lazy

Lazy is a container which represents a value computed lazily i.e. computation is deferred until the result is required. Furthermore, the evaluated value is cached or memoized and returned again and again each time it is needed without repeating the computation:

@Test public void givenFunction_whenEvaluatesWithLazy_thenCorrect() { Lazy lazy = Lazy.of(Math::random); assertFalse(lazy.isEvaluated()); double val1 = lazy.get(); assertTrue(lazy.isEvaluated()); double val2 = lazy.get(); assertEquals(val1, val2, 0.1); }

In the above example, the function we are evaluating is Math.random. Notice that, in the second line, we check the value and realize that the function has not yet been executed. This is because we still haven't shown interest in the return value.

In the third line of code, we show interest in the computation value by calling Lazy.get. At this point, the function executes and Lazy.evaluated returns true.

We also go ahead and confirm the memoization bit of Lazy by attempting to get the value again. If the function we provided was executed again, we would definitely receive a different random number.

However, Lazy again lazily returns the initially computed value as the final assertion confirms.

9. Pattern Matching

Pattern matching is a native concept in almost all functional programming languages. There is no such thing in Java for now.

Instead, whenever we want to perform a computation or return a value based on the input we receive, we use multiple if statements to resolve the right code to execute:

@Test public void whenIfWorksAsMatcher_thenCorrect() { int input = 3; String output; if (input == 0) { output = "zero"; } if (input == 1) { output = "one"; } if (input == 2) { output = "two"; } if (input == 3) { output = "three"; } else { output = "unknown"; } assertEquals("three", output); }

We can suddenly see the code spanning multiple lines while just checking three cases. Each check is taking up three lines of code. What if we had to check up to a hundred cases, those would be about 300 lines, not nice!

Another alternative is using a switch statement:

@Test public void whenSwitchWorksAsMatcher_thenCorrect() { int input = 2; String output; switch (input) { case 0: output = "zero"; break; case 1: output = "one"; break; case 2: output = "two"; break; case 3: output = "three"; break; default: output = "unknown"; break; } assertEquals("two", output); }

Not any better. We are still averaging 3 lines per check. A lot of confusion and potential for bugs. Forgetting a break clause is not an issue at compile time but can result in hard-to-detect bugs later on.

In Vavr, we replace the entire switch block with a Match method. Each case or if statement is replaced by a Case method invocation.

Finally, atomic patterns like $() replace the condition which then evaluates an expression or value. We also provide this as the second parameter to Case:

@Test public void whenMatchworks_thenCorrect() { int input = 2; String output = Match(input).of( Case($(1), "one"), Case($(2), "two"), Case($(3), "three"), Case($(), "?")); assertEquals("two", output); }

Notice how compact the code is, averaging only one line per check. The pattern matching API is way more powerful than this and can do more complex stuff.

For example, we can replace the atomic expressions with a predicate. Imagine we are parsing a console command for help and version flags:

Match(arg).of( Case($(isIn("-h", "--help")), o -> run(this::displayHelp)), Case($(isIn("-v", "--version")), o -> run(this::displayVersion)), Case($(), o -> run(() -> { throw new IllegalArgumentException(arg); })) );

Some users may be more familiar with the shorthand version (-v) while others, with the full version (–version). A good designer must consider all these cases.

Without the need for several if statements, we have taken care of multiple conditions. We will learn more about predicates, multiple conditions, and side-effects in pattern matching in a separate article.

10. Conclusion

In this article, we have introduced Vavr, the popular functional programming library for Java 8. We have tackled the major features that we can quickly adapt to improve our code.

The full source code for this article is available in the Github project.