Méthodologie à douze facteurs dans un microservice Spring Boot

1. Vue d'ensemble

Dans ce didacticiel, nous allons comprendre la méthodologie d'application à douze facteurs.

Nous allons également comprendre comment développer un microservice à l'aide de Spring Boot. Dans le processus, nous verrons comment appliquer la méthodologie à douze facteurs pour développer un tel microservice.

2. Quelle est la méthodologie à douze facteurs?

La méthodologie à douze facteurs est un ensemble de douze meilleures pratiques pour développer des applications développées pour fonctionner en tant que service . Cela a été initialement rédigé par Heroku pour les applications déployées en tant que services sur leur plate-forme cloud, en 2011. Au fil du temps, cela s'est avéré suffisamment générique pour tout développement de logiciel en tant que service (SaaS).

Alors, qu'entendons-nous par logiciel en tant que service? Traditionnellement, nous concevons, développons, déployons et maintenons des solutions logicielles pour en tirer une valeur commerciale. Mais nous n'avons pas à nous engager dans ce processus pour obtenir nécessairement le même résultat. Par exemple, le calcul de la taxe applicable est une fonction générique dans de nombreux domaines.

Désormais, nous pouvons décider de créer et de gérer ce service nous-mêmes ou de souscrire à une offre de services commerciaux . Ces offres de services sont ce que nous appelons des logiciels en tant que service .

Alors que le logiciel en tant que service n'impose aucune restriction sur l'architecture sur laquelle il est développé; il est très utile d'adopter quelques bonnes pratiques.

Si nous concevons nos logiciels pour qu'ils soient modulaires, portables et évolutifs sur les plates-formes cloud modernes, ils se prêtent parfaitement à nos offres de services. C'est là que la méthodologie à douze facteurs aide. Nous les verrons en action plus tard dans le didacticiel.

3. Microservice avec Spring Boot

Microservice est un style architectural permettant de développer des logiciels sous forme de services faiblement couplés. La condition clé ici est que les services doivent être organisés autour des limites du domaine commercial . C'est souvent la partie la plus difficile à identifier.

De plus, un service a ici la seule autorité sur ses données et expose les opérations à d'autres services. La communication entre les services s'effectue généralement via des protocoles légers tels que HTTP. Il en résulte des services déployables et évolutifs indépendamment.

Désormais, l'architecture des microservices et les logiciels en tant que service ne dépendent pas l'un de l'autre. Mais il n'est pas difficile de comprendre que, lors du développement de logiciels en tant que service, tirer parti de l'architecture des microservices est très bénéfique . Cela aide à atteindre de nombreux objectifs dont nous avons discuté précédemment, comme la modularité et l'évolutivité.

Spring Boot est un cadre d'application basé sur Spring qui enlève beaucoup de passe-partout associé au développement d'une application d'entreprise. Cela nous donne une plate-forme hautement avisée mais flexible pour développer des microservices. Pour ce didacticiel, nous utiliserons Spring Boot pour fournir un microservice à l'aide de la méthodologie à douze facteurs.

4. Application de la méthodologie à douze facteurs

Définissons maintenant une application simple que nous allons essayer de développer avec les outils et les pratiques dont nous venons de parler. Nous aimons tous regarder des films, mais il est difficile de suivre les films que nous avons déjà regardés.

Maintenant, qui voudrait commencer un film et l'abandonner plus tard? Ce dont nous avons besoin, c'est d'un service simple pour enregistrer et interroger les films que nous avons regardés:

Il s'agit d'un microservice assez simple et standard avec un magasin de données et des points de terminaison REST. Nous devons définir un modèle qui correspondra également à la persistance:

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

Nous avons défini une entité JPA avec un identifiant et quelques autres attributs. Voyons maintenant à quoi ressemble le contrôleur REST:

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

Cela couvre la base de notre service simple. Nous allons parcourir le reste de l'application tout en discutant de la manière dont nous implémentons la méthodologie à douze facteurs dans les sous-sections suivantes.

4.1. Base de code

La première meilleure pratique des applications à douze facteurs consiste à les suivre dans un système de contrôle de version. Git est le système de contrôle de version le plus populaire utilisé aujourd'hui et il est presque omniprésent. Le principe stipule qu'une application doit être suivie dans un référentiel de code unique et ne doit pas partager ce référentiel avec d'autres applications .

Spring Boot offre de nombreux moyens pratiques pour démarrer une application, y compris un outil de ligne de commande et une interface Web. Une fois que nous générons l'application d'amorçage, nous pouvons la convertir en un référentiel git:

git init

Cette commande doit être exécutée à partir de la racine de l'application. À ce stade, l'application contient déjà un fichier .gitignore qui empêche effectivement les fichiers générés d'être contrôlés par version. Ainsi, nous pouvons tout de suite créer un commit initial:

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

Enfin, nous pouvons ajouter une télécommande et pousser nos commits vers la télécommande si nous le souhaitons (ce n'est pas une exigence stricte):

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

4.2. Dépendances

Ensuite, l'application à douze facteurs doit toujours déclarer explicitement toutes ses dépendances . Nous devons le faire en utilisant un manifeste de déclaration de dépendance. Java dispose de plusieurs outils de gestion des dépendances tels que Maven et Gradle. Nous pouvons utiliser l'un d'entre eux pour atteindre cet objectif.

Ainsi, notre application simple dépend de quelques bibliothèques externes, comme une bibliothèque pour faciliter les API REST et pour se connecter à une base de données. Voyons comment pouvons-nous les définir de manière déclarative à l'aide de Maven.

Maven nous oblige à décrire les dépendances d'un projet dans un fichier XML, généralement appelé Project Object Model (POM):

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

Bien que cela semble clair et simple, ces dépendances ont généralement d'autres dépendances transitives. Cela le complique dans une certaine mesure mais nous aide à atteindre notre objectif. Maintenant, notre application n'a pas de dépendance directe qui n'est pas explicitement décrite.

4.3. Configurations

Une application a généralement beaucoup de configuration, dont certaines peuvent varier d'un déploiement à l'autre, tandis que d'autres restent les mêmes.

Dans notre exemple, nous avons une base de données persistante. Nous aurons besoin de l'adresse et des informations d'identification de la base de données pour nous connecter. Ceci est le plus susceptible de changer entre les déploiements.

Une application à douze facteurs doit externaliser toutes ces configurations qui varient entre les déploiements . La recommandation ici est d'utiliser des variables d'environnement pour de telles configurations. Cela conduit à une séparation nette de la configuration et du 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

Dans ce didacticiel, nous avons passé en revue les concepts de la méthodologie à douze facteurs. Nous avons expliqué comment tirer parti d'une architecture de microservice avec Spring Boot pour les fournir efficacement. De plus, nous avons exploré chaque facteur en détail et comment les appliquer à notre application. Nous avons également exploré plusieurs outils pour appliquer efficacement ces facteurs individuels avec succès.