Migration auf Spring Boot 2.0

Keine Zeit? Hier die Kurzversion in 30 Sekunden.
- Spring Boot 2.0 (GA am 1. März 2018) baut auf Spring Framework 5 auf, verlangt mindestens Java 8 und unterstützt Java 9.
- Am meisten Arbeit machten Properties (Umbenennungen, strengeres Relaxed Binding), Actuator (neue Pfade unter /actuator, Micrometer) und Spring Security 5.
- Das Modul spring-boot-properties-migrator zeigt umbenannte Properties beim Start an und hilft beim Umstellen.
- Passwörter brauchen jetzt ein Format mit {id}-Präfix (DelegatingPasswordEncoder); im Gradle-Plugin heißt der Task bootJar statt bootRepackage.
- Mein Rat: erst auf die letzte 1.5.x, dann in kleinen Schritten migrieren und nach jedem Schritt die Tests laufen lassen.
Seit ein paar Wochen ist Spring Boot 2.0 draußen, und ich habe bei zwei kleineren Anwendungen die Umstellung von 1.5 ausprobiert. Es war keine Hexerei, aber auch kein Versionsupdate, bei dem man nur die Zahl im Build-Skript ändert und die Pause genießt. Ich schreibe auf, was bei mir gestolpert ist, in der Reihenfolge, in der ich es erlebt habe. Vollständig ist das nicht: Wer andere Module nutzt, trifft andere Stellen.
Vorbereitung
Der erste Schritt passiert vor der Migration. Ich bringe die Anwendung auf den letzten Stand der 1.5er-Linie, räume Warnungen auf und sorge dafür, dass die Tests grün sind. Das klingt langweilig, spart aber Zeit, weil man später nicht raten muss, ob ein Fehler vom Update oder vom Altbestand kommt. Ebenfalls sinnvoll: Bei den Tests nachsehen, ob wirklich das wichtige Verhalten abgedeckt ist, etwa Login, Konfiguration und die ersten Endpunkte. Wo nichts getestet ist, bemerkt man Probleme erst in Produktion.
Dann Voraussetzungen. Spring Boot 2.0 braucht mindestens Java 8 und setzt auf Spring Framework 5. Java 9 wird unterstützt, ich bleibe vorerst trotzdem bei Java 8, denn zwei Umstellungen gleichzeitig verwischen die Fehlerursache. Wer noch auf Java 7 sitzt, muss zuerst dort herauskommen.
Properties: der größte Posten
Die meiste Arbeit steckte in der Konfiguration. Etliche Properties haben neue Namen bekommen, ein bekanntes Beispiel sind die Servereinstellungen: Aus server.context-path wurde server.servlet.context-path, aus management.port wurde management.server.port. Bei der Suche hilft das Modul spring-boot-properties-migrator. Man nimmt es vorübergehend als Abhängigkeit auf, und beim Start meldet es umbenannte oder entfallene Properties, bildet die alten Namen sogar noch auf die neuen ab. In Maven sieht das so aus:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-properties-migrator</artifactId>
<scope>runtime</scope>
</dependency>Wichtig: Das Modul ist eine Krücke für den Übergang. Ich arbeite die Meldungen ab und nehme es danach wieder heraus, sonst bleibt es unbemerkt im Projekt.
Eine zweite Stelle war das Relaxed Binding. Das Abbilden von Umgebungsvariablen und Properties auf Konfigurationsklassen wurde überarbeitet und ist an einigen Ecken strenger geworden. Bei mir betraf das vor allem Schreibweisen in @ConfigurationProperties und Umgebungsvariablen mit Unterstrichen. Nichts Dramatisches, aber es lohnt sich, die Konfigurationsklassen anzusehen und einen Test zu haben, der prüft, dass die Werte wirklich ankommen. Ein stillschweigend ignorierter Wert ist unangenehmer als ein Fehler beim Start.
Actuator und Metriken
Der Actuator hat sich spürbar verändert. Die Endpunkte liegen jetzt standardmäßig unter /actuator, also etwa /actuator/health. Über HTTP sind zunächst nur wenige Endpunkte freigegeben, alle anderen muss man ausdrücklich einschalten, zum Beispiel mit management.endpoints.web.exposure.include. Das finde ich richtig, weil es die Voreinstellung sicherer macht, aber es heißt, dass Überwachung und Skripte, die auf die alten Pfade zeigen, angepasst werden müssen. Wer Health-Checks im Load Balancer eingetragen hat, sollte das vor dem Rollout prüfen, nicht danach.
Bei Metriken kommt Micrometer ins Spiel. Es ist eine eigene Schicht, über die sich Messwerte an verschiedene Monitoring-Systeme weiterreichen lassen, und es ersetzt die bisherigen Zähler und Messuhren des Actuators. Wer eigene Metriken geschrieben hat, muss hier meist Code anfassen. In meinen Anwendungen waren es wenige Stellen, ich habe sie bei der Gelegenheit gleich aufgeräumt.
Security und Passwörter
An dieser Stelle hat es am deutlichsten geknirscht. Spring Security 5 hat die Autokonfiguration vereinfacht, und Properties wie security.basic.* gibt es nicht mehr. Wer bisher mit diesen Schaltern gearbeitet hat, muss eine eigene Konfiguration schreiben, die ausdrücklich sagt, was geschützt werden soll. Das ist am Ende übersichtlicher, kostet aber zunächst einen Nachmittag.
Die zweite Neuerung betrifft Passwörter. Spring Security 5 erwartet standardmäßig den DelegatingPasswordEncoder. Gespeicherte Hashes tragen ein Präfix in geschweiften Klammern, das den Algorithmus nennt, etwa {bcrypt}. Hat man bisher BCrypt ohne Präfix gespeichert, bekommt man zur Laufzeit die Meldung, dass es keine Zuordnung für die Kennung „null“ gibt. Bei den ersten Tests war das die Stelle, an der ich einen Moment gesucht habe. Lösungen gibt es zwei: die gespeicherten Werte mit {bcrypt} versehen oder einen festen Encoder als Bean festlegen. Auf lange Sicht gefällt mir das Präfix, weil sich damit später Algorithmen wechseln lassen, ohne alle Passwörter auf einmal umzustellen.
Build und Datenbank
Beim Gradle-Plugin wurden Tasks umbenannt. Statt bootRepackage gibt es jetzt bootJar (und bootWar), und das Plugin braucht eine neue Version in den buildscript-Abhängigkeiten. Wer CI-Skripte mit dem alten Task-Namen hat, merkt es spätestens dort. Bei Maven fiel mir nichts Besonderes auf.
Bei der Datenbank wechselt der Standard-Connection-Pool zu HikariCP, sofern nichts anderes im Klassenpfad liegt. Wer bisher den Tomcat-Pool nutzte, sollte sich ansehen, welche Properties dafür galten, denn sie heißen jetzt spring.datasource.hikari.*. Außerdem kommt Hibernate in Version 5.2. In meinem Fall gab es nur kleinere Hinweise, aber wer mit eigenen Naming-Strategien oder Besonderheiten bei der Schema-Erzeugung arbeitet, sollte hier den Bericht der Tests genau lesen.
Was optional ist
WebFlux und das reaktive Modell sind neu und optional. Ich habe sie nicht eingesetzt. Die klassische Servlet-Variante läuft weiter wie bisher, und für meine Anwendungen gibt es keinen Grund, die Architektur nur wegen eines neuen Moduls umzukrempeln. Spannend finde ich es trotzdem, vor allem bei Diensten, die viele langsame Aufrufe bündeln. Das ist aber ein eigenes Projekt, kein Teil der Migration.
Mein Vorgehen im Rückblick
Wenn ich es noch einmal machen müsste, würde ich es wieder in kleinen Schritten tun:
- Auf die aktuelle 1.5.x gehen, Warnungen beheben.
- Auf 2.0 umstellen, Migrator-Modul einbinden, nur kompilieren und starten.
- Properties und Konfigurationsklassen anpassen, bis der Start sauber durchläuft.
- Security und Passwörter einzeln angehen und mit eigenen Tests absichern.
- Actuator, Metriken und Monitoring anpassen.
- Migrator wieder entfernen, Build- und Deployment-Skripte prüfen.
Gebraucht hat es nicht lange, aber ohne Tests wäre es riskant gewesen. Die größte Lehre war für mich, dass ein Major-Update weniger ein technisches als ein organisatorisches Vorhaben ist: Man muss wissen, wo die Anwendung sich auf Voreinstellungen verlässt, die sich jetzt geändert haben. Wer das sauber aufschreibt, hat nach dem ersten Projekt eine Checkliste für alle weiteren.
Beitragsbild: Spring-Boot-Logo von Pivotal Software, Inc., CC BY-SA 2.0 (via Wikimedia Commons; unverändert auf eigenem Hintergrund). Spring ist eine Marke von Pivotal Software.
Christian Ackermann
Softwareentwickler (C++, C, Java, C#) aus der Oberpfalz, bloggt seit 2001 über Linux, Technik und Kochen.