Zwölf-Faktoren-Methode in einem Spring Boot Microservice

1. Übersicht

In diesem Tutorial werden wir die 12-Faktor-App-Methodik verstehen.

Wir werden auch verstehen, wie man mit Hilfe von Spring Boot einen Microservice entwickelt. Dabei werden wir sehen, wie die Zwölf-Faktoren-Methode zur Entwicklung eines solchen Mikrodienstes angewendet wird.

2. Was ist die Zwölf-Faktoren-Methodik?

Die Zwölf-Faktoren-Methode besteht aus zwölf Best Practices für die Entwicklung von Anwendungen, die für die Ausführung als Service entwickelt wurden . Dies wurde ursprünglich von Heroku für Anwendungen entworfen, die 2011 als Dienste auf ihrer Cloud-Plattform bereitgestellt wurden. Im Laufe der Zeit hat sich dies als allgemein genug für jede Software-as-a-Service-Entwicklung (SaaS) erwiesen.

Was verstehen wir unter Software-as-a-Service? Traditionell entwerfen, entwickeln, implementieren und warten wir Softwarelösungen, um daraus geschäftlichen Nutzen zu ziehen. Wir müssen uns jedoch nicht auf diesen Prozess einlassen, um notwendigerweise das gleiche Ergebnis zu erzielen. Beispielsweise ist die Berechnung der anwendbaren Steuer in vielen Bereichen eine allgemeine Funktion.

Jetzt können wir uns entscheiden, diesen Service selbst aufzubauen und zu verwalten oder ein kommerzielles Serviceangebot zu abonnieren . Solche Serviceangebote kennen wir als Software-as-a-Service .

Während Software-as-a-Service die Architektur, auf der es entwickelt wurde, nicht einschränkt. Es ist sehr nützlich, einige Best Practices zu übernehmen.

Wenn wir unsere Software so modular, portabel und skalierbar auf modernen Cloud-Plattformen gestalten, ist sie für unser Serviceangebot durchaus zugänglich. Hier hilft die Zwölf-Faktoren-Methode. Wir werden sie später im Tutorial in Aktion sehen.

3. Microservice mit Spring Boot

Microservice ist ein Architekturstil zur Entwicklung von Software als lose gekoppelte Dienste. Die Hauptanforderung hierbei ist, dass die Dienste um Geschäftsdomänengrenzen herum organisiert werden . Dies ist oft der am schwierigsten zu identifizierende Teil.

Darüber hinaus hat ein Dienst hier die alleinige Autorität über seine Daten und setzt Operationen anderen Diensten aus. Die Kommunikation zwischen Diensten erfolgt normalerweise über einfache Protokolle wie HTTP. Dies führt zu unabhängig bereitstellbaren und skalierbaren Diensten.

Jetzt sind Microservice-Architektur und Software-as-a-Service nicht voneinander abhängig. Es ist jedoch nicht schwer zu verstehen, dass bei der Entwicklung von Software-as-a-Service die Nutzung der Microservice-Architektur von großem Vorteil ist . Es hilft, viele Ziele zu erreichen, die wir zuvor besprochen haben, wie Modularität und Skalierbarkeit.

Spring Boot ist ein auf Spring basierendes Anwendungsframework, das viel Boilerplate für die Entwicklung einer Unternehmensanwendung wegnimmt. Es gibt uns eine hochmeinende, aber flexible Plattform für die Entwicklung von Microservices. In diesem Tutorial nutzen wir Spring Boot, um einen Microservice mit der Zwölf-Faktoren-Methode bereitzustellen.

4. Anwendung der Zwölf-Faktoren-Methodik

Definieren wir nun eine einfache Anwendung, die wir mit den gerade besprochenen Tools und Praktiken entwickeln möchten. Wir alle lieben es, Filme zu schauen, aber es ist schwierig, den Überblick über die Filme zu behalten, die wir bereits gesehen haben.

Wer möchte einen Film starten und später wieder aufgeben? Was wir brauchen, ist ein einfacher Dienst zum Aufzeichnen und Abfragen von Filmen, die wir gesehen haben:

Dies ist ein recht einfacher und standardmäßiger Mikroservice mit einem Datenspeicher und REST-Endpunkten. Wir müssen ein Modell definieren, das auch der Persistenz entspricht:

@Entity public class Movie { @Id private Long id; private String title; private String year; private String rating; // getters and setters }

Wir haben eine JPA-Entität mit einer ID und einigen anderen Attributen definiert. Lassen Sie uns nun sehen, wie der REST-Controller aussieht:

@RestController public class MovieController { @Autowired private MovieRepository movieRepository; @GetMapping("/movies") public List retrieveAllStudents() { return movieRepository.findAll(); } @GetMapping("/movies/{id}") public Movie retrieveStudent(@PathVariable Long id) { return movieRepository.findById(id).get(); } @PostMapping("/movies") public Long createStudent(@RequestBody Movie movie) { return movieRepository.save(movie).getId(); } }

Dies deckt die Basis unseres einfachen Service ab. Wir werden den Rest der Anwendung durchgehen, während wir in den folgenden Unterabschnitten diskutieren, wie wir die Zwölf-Faktoren-Methodik implementieren.

4.1. Codebasis

Die erste bewährte Methode für Zwölf-Faktor-Apps besteht darin, sie in einem Versionskontrollsystem zu verfolgen. Git ist das derzeit beliebteste Versionskontrollsystem und fast allgegenwärtig. Das Prinzip besagt, dass eine App in einem einzelnen Code-Repository verfolgt werden sollte und dieses Repository nicht mit anderen Apps teilen darf .

Spring Boot bietet viele bequeme Möglichkeiten zum Booten einer Anwendung, einschließlich eines Befehlszeilentools und einer Weboberfläche. Sobald wir die Bootstrap-Anwendung generiert haben, können wir diese in ein Git-Repository konvertieren:

git init

Dieser Befehl sollte im Stammverzeichnis der Anwendung ausgeführt werden. Die Anwendung enthält zu diesem Zeitpunkt bereits eine Gitignore-Datei, die die Versionskontrolle generierter Dateien effektiv einschränkt. So können wir sofort ein erstes Commit erstellen:

git add . git commit -m "Adding the bootstrap of the application."

Schließlich können wir eine Fernbedienung hinzufügen und unsere Commits auf die Fernbedienung übertragen, wenn wir möchten (dies ist keine strenge Anforderung):

git remote add origin //github.com//12-factor-app.git git push -u origin master

4.2. Abhängigkeiten

Als nächstes sollte die Zwölf-Faktor-App immer explizit alle ihre Abhängigkeiten deklarieren . Wir sollten dies mithilfe eines Abhängigkeitsdeklarationsmanifests tun. Java verfügt über mehrere Tools zur Abhängigkeitsverwaltung wie Maven und Gradle. Wir können einen von ihnen verwenden, um dieses Ziel zu erreichen.

Daher hängt unsere einfache Anwendung von einigen externen Bibliotheken ab, z. B. einer Bibliothek, um REST-APIs zu vereinfachen und eine Verbindung zu einer Datenbank herzustellen. Mal sehen, wie wir sie mit Maven deklarativ definieren können.

Maven verlangt von uns, die Abhängigkeiten eines Projekts in einer XML-Datei zu beschreiben, die normalerweise als Project Object Model (POM) bezeichnet wird:

  org.springframework.boot spring-boot-starter-web   com.h2database h2 runtime  

Obwohl dies schlicht und einfach aussieht, weisen diese Abhängigkeiten normalerweise andere transitive Abhängigkeiten auf. Dies erschwert es in gewissem Maße, hilft uns jedoch, unser Ziel zu erreichen. Jetzt hat unsere Anwendung keine direkte Abhängigkeit, die nicht explizit beschrieben wird.

4.3. Konfigurationen

Eine Anwendung verfügt normalerweise über zahlreiche Konfigurationen, von denen einige zwischen den Bereitstellungen variieren können, während andere gleich bleiben.

In unserem Beispiel haben wir eine persistente Datenbank. Wir benötigen die Adresse und die Anmeldeinformationen der Datenbank, um eine Verbindung herzustellen. Dies ändert sich höchstwahrscheinlich zwischen den Bereitstellungen.

Eine Zwölf-Faktor-App sollte alle derartigen Konfigurationen auslagern, die zwischen den Bereitstellungen variieren . Hier wird empfohlen, Umgebungsvariablen für solche Konfigurationen zu verwenden. Dies führt zu einer sauberen Trennung von Konfiguration und Code.

Spring provides a configuration file where we can declare such configurations and attach it to environment variables:

spring.datasource.url=jdbc:mysql://${MYSQL_HOST}:${MYSQL_PORT}/movies spring.datasource.username=${MYSQL_USER} spring.datasource.password=${MYSQL_PASSWORD}

Here, we've defined the database URL and credentials as configurations and have mapped the actual values to be picked from the environment variable.

On Windows, we can set the environment variable before starting the application:

set MYSQL_HOST=localhost set MYSQL_PORT=3306 set MYSQL_USER=movies set MYSQL_PASSWORD=password

We can use a configuration management tool like Ansible or Chef to automate this process.

4.4. Backing Services

Backing services are services that the application depends on for operation. For instance a database or a message broker. A twelve-factor app should treat all such backing services as attached resources. What this effectively means is that it shouldn't require any code change to swap a compatible backing service. The only change should be in configurations.

In our application, we've used MySQL as the backing service to provide persistence.

Spring JPA makes the code quite agnostic to the actual database provider. We only need to define a repository which provides all standard operations:

@Repository public interface MovieRepository extends JpaRepository { }

As we can see, this is not dependent on MySQL directly. Spring detects the MySQL driver on the classpath and provides a MySQL-specific implementation of this interface dynamically. Moreover, it pulls other details from configurations directly.

So, if we've to change from MySQL to Oracle, all we've to do is replace the driver in our dependencies and replace the configurations.

4.5. Build, Release and Run

The twelve-factor methodology strictly separates the process of converting codebase into a running application as three distinct stages:

  • Build Stage: This is where we take the codebase, perform static and dynamic checks, and then generate an executable bundle like a JAR. Using a tool like Maven, this is quite trivial:
 mvn clean compile test package
  • Release Stage: This is the stage where we take the executable bundle and combine this with the right configurations. Here, we can use Packer with a provisioner like Ansible to create Docker images:
 packer build application.json
  • Run Stage: Finally, this is the stage where we run the application in a target execution environment. If we use Docker as the container to release our application, running the application can be simple enough:
 docker run --name  -it 

Finally, we don't necessarily have to perform these stages manually. This is where Jenkins comes in as pretty handy with their declarative pipeline.

4.6. Processes

A twelve-factor app is expected to run in an execution environment as stateless processes. In other words, they can not store persistent state locally between requests. They may generate persistent data which is required to be stored in one or more stateful backing services.

In the case of our example, we've got multiple endpoints exposed. A request on any of these endpoints is entirely independent of any request made before it. For instance, if we keep track of user requests in-memory and use that information to serve future requests, it violates a twelve-factor app.

Hence, a twelve-factor app imposes no such restriction like sticky sessions. This makes such an app highly portable and scalable. In a cloud execution environment offering automated scaling, it's quite a desirable behavior from applications.

4.7. Port Binding

A traditional web application in Java is developed as a WAR or web archive. This is typically a collection of Servlets with dependencies, and it expects a conformant container runtime like Tomcat. A twelve-factor app, on the contrary, expects no such runtime dependency. It's completely self-contained and only requires an execution runtime like Java.

In our case, we've developed an application using Spring Boot. Spring Boot, apart from many other benefits, provides us with a default embedded application server. Hence, the JAR we generated earlier using Maven is fully capable of executing in any environment just by having a compatible Java runtime:

java -jar application.jar

Here, our simple application exposes its endpoints over an HTTP binding to a specific port like 8080. Upon starting the application as we did above, it should be possible to access the exported services like HTTP.

An application may export multiple services like FTP or WebSocket by binding to multiple ports.

4.8. Concurrency

Java offers Thread as a classical model to handle concurrency in an application. Threads are like lightweight processes and represent multiple paths of execution in a program. Threads are powerful but have limitations in terms of how much it can help an application scale.

The twelve-factor methodology suggests apps to rely on processes for scaling. What this effectively means is that applications should be designed to distribute workload across multiple processes. Individual processes are, however, free to leverage a concurrency model like Thread internally.

A Java application, when launched gets a single process which is bound to the underlying JVM. What we effectively need is a way to launch multiple instances of the application with intelligent load distribution between them. Since we've already packaged our application as a Docker container, Kubernetes is a natural choice for such orchestration.

4.9. Disposability

Application processes can be shut down on purpose or through an unexpected event. In either case, a twelve-factor app is supposed to handle it gracefully. In other words, an application process should be completely disposable without any unwanted side-effects. Moreover, processes should start quickly

For instance, in our application, one of the endpoints is to create a new database record for a movie. Now, an application handling such a request may crash unexpectedly. This should, however, not impact the state of the application. When a client sends the same request again, it shouldn't result in duplicate records.

In summary, the application should expose idempotent services. This is another very desirable attribute of a service destined for cloud deployments. This gives the flexibility to stop, move, or spin new services at any time without any other considerations.

4.10. Dev/Prod Parity

It's typical for applications to be developed on local machines, tested on some other environments and finally deployed to production. It's often the case where these environments are different. For instance, the development team works on Windows machines whereas production deployment happens on Linux machines.

The twelve-factor methodology suggests keeping the gap between development and production environment as minimal as possible. These gaps can result from long development cycles, different teams involved, or different technology stack in use.

Now, technology like Spring Boot and Docker automatically bridge this gap to a great extent. A containerized application is expected to behave the same, no matter where we run it. We must use the same backing services – like the database – as well.

Moreover, we should have the right processes like continuous integration and delivery to facilitate bridging this gap further.

4.11. Logs

Logs are essential data that an application generates during its lifetime. They provide invaluable insights into the working of the application. Typically an application can generate logs at multiple levels with varying details and output ii in multiple different formats.

A twelve-factor app, however, separates itself from log generation and its processing. For such an app, logs are nothing but a time-ordered stream of events. It merely writes these events to the standard output of the execution environment. The capture, storage, curation, and archival of such stream should be handled by the execution environment.

There are quite several tools available to us for this purpose. To begin with, we can use SLF4J to handle logging abstractly within our application. Moreover, we can use a tool like Fluentd to collect the stream of logs from applications and backing services.

This we can feed into Elasticsearch for storage and indexing. Finally, we can generate meaningful dashboards for visualization in Kibana.

4.12. Admin Processes

Often we need to perform some one-off tasks or routine procedure with our application state. For instance, fixing bad records. Now, there are various ways in which we can achieve this. Since we may not often require it, we can write a small script to run it separately from another environment.

Now, the twelve-factor methodology strongly suggests keeping such admin scripts together with the application codebase. In doing so, it should follow the same principles as we apply to the main application codebase. It's also advisable to use a built-in REPL tool of the execution environment to run such scripts on production servers.

In our example, how do we seed our application with the already watched movies so far? While we can use our sweet little endpoint, but that may seem to be impractical. What we need is a script to perform a one-time load. We can write a small Java function to read a list of movies from a file and save them in batch into the database.

Moreover, we can use Groovy integrated with Java runtime to start such processes.

5. Practical Applications

So, now we've seen all the factors suggested by the twelve-factor methodology. Developing an application to be a twelve-factor app certainly has its benefits, especially when we wish to deploy them as services on the cloud. But, like all other guidelines, framework, patterns, we must ask, is this a silver bullet?

Honestly, no single methodology in software design and development claim to be a silver bullet. The twelve-factor methodology is no exception. While some of these factors are quite intuitive, and most likely we're already doing them, others may not apply to us. It's essential to evaluate these factors in the backdrop of our objectives and then choose wisely.

It's important to note that all these factors are there to help us develop an application which is modular, independent, portable, scalable, and observable. Depending upon the application, we may be able to achieve them through other means better. It's also not necessary to adopt all the factors together, adopting even some of these may make us better than we were.

Finally, these factors are quite simple and elegant. They hold greater importance in an age where we demand our applications to have higher throughput and lower latency with virtually no downtime and failure. Adopting these factors gives us the right start from the beginning. Combined with microservice architecture and containerization of applications, they just seem to hit the right spot.

6. Conclusion

In diesem Tutorial haben wir die Konzepte der Zwölf-Faktoren-Methodik durchgearbeitet. Wir haben besprochen, wie eine Microservice-Architektur mit Spring Boot genutzt werden kann, um sie effektiv bereitzustellen. Außerdem haben wir jeden Faktor im Detail untersucht und untersucht, wie er auf unsere Anwendung angewendet werden kann. Wir haben auch verschiedene Tools untersucht, um diese einzelnen Faktoren effektiv und effektiv anzuwenden.