Einführung in Vavr

1. Übersicht

In diesem Artikel werden wir genau untersuchen, was Vavr ist, warum wir es brauchen und wie wir es in unseren Projekten verwenden können.

Vavr ist eine Funktionsbibliothek für Java 8+, die unveränderliche Datentypen und Funktionskontrollstrukturen bereitstellt.

1.1. Maven-Abhängigkeit

Um Vavr verwenden zu können, müssen Sie die Abhängigkeit hinzufügen:

 io.vavr vavr 0.9.0 

Es wird empfohlen, immer die neueste Version zu verwenden. Sie können es erhalten, indem Sie diesem Link folgen.

2. Option

Das Hauptziel von Option ist es, Nullprüfungen in unserem Code durch Nutzung des Java-Typsystems zu eliminieren.

Option ist ein Objektcontainer in Vavr mit einem ähnlichen Endziel wie Optional in Java 8. Die Option von Vavr implementiert Serializable, Iterable und verfügt über eine umfangreichere API .

Da jede Objektreferenz in Java einen Nullwert haben kann, müssen wir normalerweise mit if- Anweisungen auf Null prüfen, bevor wir sie verwenden. Diese Überprüfungen machen den Code robust und stabil:

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

Ohne Überprüfung kann die Anwendung aufgrund einer einfachen NPE abstürzen :

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

Die Überprüfungen machen den Code jedoch ausführlich und nicht so lesbar , insbesondere wenn die if- Anweisungen mehrmals verschachtelt werden.

Option löst dieses Problem, indem Nullen vollständig entfernt und durch eine gültige Objektreferenz für jedes mögliche Szenario ersetzt werden.

Mit Option wird ein Nullwert für eine Instanz von None ausgewertet , während ein Nicht-Nullwert für eine Instanz von Some ausgewertet wird :

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

Anstatt Objektwerte direkt zu verwenden, ist es daher ratsam, sie wie oben gezeigt in eine Option- Instanz einzuschließen.

Beachten Sie, dass wir vor dem Aufruf von toString keine Überprüfung durchführen mussten, jedoch nicht wie zuvor mit einer NullPointerException umgehen mussten. Der toString der Option gibt bei jedem Aufruf aussagekräftige Werte zurück.

Im zweiten Ausschnitt dieses Abschnitts benötigten wir eine Nullprüfung , bei der wir der Variablen einen Standardwert zuweisen würden, bevor wir versuchen, sie zu verwenden. Option kann dies in einer einzelnen Zeile behandeln, auch wenn es eine Null gibt:

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

Oder eine Nicht-Null:

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

Beachten Sie , dass wir ohne Nullprüfungen einen Wert erhalten oder einen Standard in einer einzelnen Zeile zurückgeben können.

3. Tupel

In Java gibt es kein direktes Äquivalent zu einer Tupeldatenstruktur. Ein Tupel ist ein gängiges Konzept in funktionalen Programmiersprachen. Tupel sind unveränderlich und können typsicher mehrere Objekte unterschiedlichen Typs aufnehmen.

Vavr bringt Tupel nach Java 8. Tupel sind vom Typ Tuple1, Tuple2 bis Tuple8, abhängig von der Anzahl der Elemente, die sie aufnehmen sollen.

Derzeit gibt es eine Obergrenze von acht Elementen. Wir greifen auf Elemente eines Tupels wie Tupel ._n zu, wobei n dem Begriff eines Index in Arrays ähnlich ist:

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

Beachten Sie, dass das erste Element mit n == 1 abgerufen wird . Ein Tupel verwendet also keine Nullbasis wie ein Array. Die Typen der Elemente, die im Tupel gespeichert werden, müssen in der Typdeklaration wie oben und unten gezeigt deklariert werden:

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

Der Platz eines Tupels besteht darin, eine feste Gruppe von Objekten jeglichen Typs zu speichern, die besser als Einheit verarbeitet werden und herumgereicht werden können. Ein offensichtlicherer Anwendungsfall ist die Rückgabe mehrerer Objekte von einer Funktion oder Methode in Java.

4. Versuchen Sie es

In Vavr ist Try ein Container für eine Berechnung, die zu einer Ausnahme führen kann.

Da Option ein nullbares Objekt umschließt , damit wir uns nicht explizit um Nullen mit if- Prüfungen kümmern müssen , schließt Try eine Berechnung um, damit wir Ausnahmen mit try-catch- Blöcken nicht explizit behandeln müssen .

Nehmen Sie zum Beispiel den folgenden Code:

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

Ohne Try-Catch- Blöcke würde die Anwendung abstürzen. Um dies zu vermeiden, müssten Sie die Anweisung in einen Try-Catch- Block einschließen. Mit Vavr können wir denselben Code in eine Try- Instanz einschließen und ein Ergebnis erhalten:

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

Ob die Berechnung erfolgreich war oder nicht, kann dann an jedem Punkt im Code nach Wahl überprüft werden.

Im obigen Ausschnitt haben wir uns entschieden, einfach auf Erfolg oder Misserfolg zu prüfen. Wir können auch einen Standardwert zurückgeben:

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

Oder sogar explizit eine Ausnahme unserer Wahl zu werfen:

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

In allen oben genannten Fällen haben wir dank Vavrs Versuch die Kontrolle darüber, was nach der Berechnung passiert .

5. Funktionale Schnittstellen

Mit der Einführung von Java 8 sind funktionale Schnittstellen eingebaut und einfacher zu verwenden, insbesondere in Kombination mit Lambdas.

Java 8 bietet jedoch nur zwei Grundfunktionen. Man nimmt nur einen einzigen Parameter und erzeugt ein Ergebnis:

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

Der zweite nimmt nur zwei Parameter und erzeugt ein Ergebnis:

@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.