© DrHitch/Shutterstock.com
Vue.js für alle

4 Spring Boot und Vue.js


Mit Vue.js gibt es schon wieder einen neuen Stern am JavaScript-Himmel? Aber wie lässt sich der denn nun wieder in den eigenen Toolstack integrieren? Am Beispiel von Spring Boot als populärem Vertreter moderner Java-Frameworks lässt sich sehr gut zeigen, wie das geht. Eine Einführung in alles, was man zum Leben mit Spring Boot und Vue.js braucht.

Das JavaScript-Framework Vue.js ist gerade in aller Munde. Das kommt natürlich nicht von ungefähr, bietet es doch einen schnellen Einstieg in die Welt der modernen, komponentenbasierten Webframeworks. So hat sich Vue.js schon einen Platz in der Riege der ganz Großen erarbeitet und bietet damit eine Alternative zu Angular und React [1]. Speziell die flachere Lernkurve sowie die höhere Entwicklungsgeschwindigkeit im Vergleich zu den bekannten Vertretern scheint die Entscheidung für Vue.js in vielen Projekten zu begünstigen [2].

Doch in der Praxis stellt sich natürlich die Frage, wie sich der neue Stern am JavaScript-Himmel in bereits vorhandene Stacks integrieren lässt – allen voran mit dem beliebten Java-Microservices-Framework Spring Boot. Außerdem muss ein vernünftiger (lokaler) Entwicklungsprozess her, damit das Entwickeln flott von der Hand geht. Nicht zuletzt sollten sich beide Frameworks nahtlos in bestehende Continuous-Integration- und -Delivery-Pipelines integrieren und entsprechend automatisiert deployed werden können.

Projekt-Set-up

Um dem Leser möglichst umfassend die Nachvollziehbarkeit jedes beschriebenen Punkts zu ermöglichen, findet sich auf GitHub ein vollständiges Beispielprojekt [3]. Es kann auch als Vorlage für erste eigene Projekte auf Basis von Spring Boot und Vue.js dienen. Den Erstkontakt mit den Frameworks hat man als Entwickler meist mit dem Projekt-Set-up. Eine klare Struktur kann hier den Einstieg erleichtern. Das Beispielprojekt bildet eine gewohnte Maven-Projektstruktur ab (Abb. 4.1).

image

Abbildung 4.1: Eine klare Projektstruktur kann beim Einstieg helfen

Die pom.xml [4] im Hauptordner der Beispielanwendung spring-boot-vuejs enthält somit im Wesentlichen die beiden Maven-Module backend und frontend:

<modules>
<module>frontend</module>
<module>backend</module>
</modules>

Die Build-Reihenfolge der beiden Module ist dabei wichtig und sollte nicht geändert werden. Zuerst wird das frontend-Modul gebaut, danach das backend-Modul.

Vue.js Frontend

Um die nächsten Schritte nachvollziehen zu können, wird eine funktionierende Node.js-Installation [5] vorausgesetzt. Mithilfe eines Paketmanagers ist das schnell erledigt. So installiert beispielsweise ein brew install node alles Nötige auf einem Mac. Zusätzlich wird das Vue.js Command Line Interface (CLI) vue-cli (Abb. 4.2) benötigt, das einfach mit dem Node.js-Paketmanager npm [6] installiert wird: npm install --global vue-cli. Nun kann im frontend-Verzeichnis der Rumpf eines Vue.js-Projekts angelegt werden: vue init webpack frontend. Auf den Befehl folgt eine Reihe an Fragen, die interaktiv beantwortet werden wollen. Das generierte Rumpfprojekt hält alles bereit, um mit den ersten eigenen Vue.js-Experimenten zu starten.

image

Abbildung 4.2: Das Vue.js CLI hilft beim Erstellen neuer Vue.js-Projekte

Betrachtet man die Welt der Webframeworks sonst eher aus gemessenem Abstand, kann einem ob der dort vorherrschenden Entwicklungsgeschwindigkeit schon etwas flau im Magen werden. Begriffe wie npm Builds [6], ESLint [7], webpack [8] usw. hören sich dann im ersten Moment vielleicht nach Raketentechnik an. Und ein wenig ist das ja auch so.

Aber es gibt Abhilfe, insbesondere wenn man eher der Riege der Backend-Entwickler entstammt. Denn dann ist Maven [9] eines der täglich genutzten Werkzeuge. Mithilfe des Frontend-Maven-Plug-ins [10] behält man den gesamten Zoo der Web-Frontend-Build-Tools im Griff. Alles, was dazu nötig ist, findet sich beispielhaft in der Konfiguration der pom.xml im frontend-Verzeichnis des Beispielprojekts [11] (Listing 4.1).

<build>
<plugins>
<plugin>
<groupId>com.github.eirslett</groupId>
<artifactId>frontend-maven-plugin</artifactId>
<version>${frontend-maven-plugin.version}</version>
<executions>
<execution>
<id>install node and npm</id>
<goals>
<goal>install-node-and-npm</goal>
</goals>
<configuration>
<nodeVersion>v9.11.1</nodeVersion>
</configuration>
</execution>
<execution>
<id>npm install</id>
<goals>
<goal>npm</goal>
</goals>
<configuration>
<arguments>install</arguments>
</configuration>
</execution>
<execution>
<id>npm run build</id>
<goals>
<goal>npm</goal>
</goals>
<configuration>
<arguments>run build</arguments>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

Listing 4.1: „pom.xml“

Die Konfiguration von frontend-maven-plugin gliedert sich dabei in drei Abschnitte. Zuerst wird mithilfe des Maven Goals install-node-and-npm sichergestellt, dass die korrekte Version von Node.js installiert wird. Ist die Version von Node.js dabei höher als die (abgekündigte) 4.0.0, installiert frontend-maven-plugin praktischerweise auch gleich die korrespondierende npm-Version.

Das zweite Maven Goal npm mit dem optionalen Argument install kümmert sich dann um die Installation aller im Vue.js Frontend benötigten Dependencies. Vom Prinzip her ähnlich einer pom.xml, werden diese Abhängigkeiten in der package.json [12] beschrieben – inklusive der expliziten Angabe aller verwendeten Versionen. Die inital durch den Befehl vue init webpack frontend angelegte package.json enthält schon eine recht umfangreiche Liste an Abhängigkeiten. Werden zusätzliche Dependencies mithilfe des Befehls npm install dependency-name installiert, wird die package.json automatisch erweitert.

Im dritten und letzten Maven Goal npm mit den Argumenten run build wird schließlich der vollständige Frontend-Build-Prozess ausgeführt. Alle drei Schritte bleiben dabei für den Entwickler transparent. Im Grunde wird dabei für die Nutzung des Projekts ausschließlich Maven-Know-how für den Einstieg benötigt. Mit steigender Erfahrung kann sich dann Schritt für Schritt dem vollständigen Frontend-Build-Prozess genähert und einzelne oder alle Teile können den Projektanforderungen entsprechend angepasst werden.

Spring Boot Backend

Einer der einfachsten Wege, eine neue Spring-Boot-Anwendung zu erstellen, ist die Nutzung der Seite https://start.spring.io/. Dabei vergibt man Maven-typisch Namen für Group und Artifact, wählt die Web-Dependency aus und klickt auf Generate Project. Die generierte .zip-Datei kann dann einfach im backend-Verzeichnis entpackt werden. Für die Integration mit Vue.js sind hier nur zwei Dinge anzupassen: Zuerst wandert der spring-boot-starter-parent in die pom.xml [4] des Hauptverzeichnisses, denn diese ist ja die Parent-POM für das backend-Modul.

Der zweite Punkt hat es dann in sich. Denn hier wird das maven-resources-plugin [13] genutzt...

headline from sands settings