Metodologia a dodici fattori in un microservizio Spring Boot

1. Panoramica

In questo tutorial capiremo la metodologia delle app a dodici fattori.

Capiremo anche come sviluppare un microservizio con l'aiuto di Spring Boot. Nel processo, vedremo come applicare la metodologia a dodici fattori per lo sviluppo di un tale microservizio.

2. Qual è la metodologia dei dodici fattori?

La metodologia a dodici fattori è un insieme di dodici best practice per sviluppare applicazioni sviluppate per essere eseguite come servizio . Questo è stato originariamente redatto da Heroku per le applicazioni distribuite come servizi sulla loro piattaforma cloud, nel 2011. Nel tempo, questo si è dimostrato abbastanza generico per qualsiasi sviluppo SaaS (Software-as-a-Service).

Allora, cosa si intende per software-as-a-service? Tradizionalmente progettiamo, sviluppiamo, distribuiamo e gestiamo soluzioni software per trarne valore aziendale. Ma non dobbiamo necessariamente impegnarci in questo processo per ottenere lo stesso risultato. Ad esempio, il calcolo dell'imposta applicabile è una funzione generica in molti domini.

Ora, possiamo decidere di creare e gestire questo servizio da soli o di sottoscrivere un'offerta di servizi commerciali . Tali offerte di servizi sono ciò che conosciamo come software-as-a-service .

Mentre il software-as-a-service non impone alcuna restrizione all'architettura su cui è sviluppato; è abbastanza utile adottare alcune best practice.

Se progettiamo il nostro software in modo che sia modulare, portatile e scalabile su moderne piattaforme cloud, è abbastanza adatto alla nostra offerta di servizi. È qui che aiuta la metodologia a dodici fattori. Li vedremo in azione più avanti nel tutorial.

3. Microservizio con Spring Boot

Il microservizio è uno stile di architettura per sviluppare software come servizi ad accoppiamento debole. Il requisito chiave qui è che i servizi dovrebbero essere organizzati attorno ai confini del dominio aziendale . Questa è spesso la parte più difficile da identificare.

Inoltre, un servizio qui ha la sola autorità sui suoi dati ed espone le operazioni ad altri servizi. La comunicazione tra i servizi avviene in genere tramite protocolli leggeri come HTTP. Ciò si traduce in servizi distribuibili e scalabili in modo indipendente.

Ora, l'architettura dei microservizi e il software-as-a-service non dipendono l'uno dall'altro. Tuttavia, non è difficile capire che, quando si sviluppa software-as-a-service, sfruttare l'architettura dei microservizi è piuttosto vantaggioso . Aiuta a raggiungere molti degli obiettivi di cui abbiamo discusso in precedenza, come la modularità e la scalabilità.

Spring Boot è un framework applicativo basato su Spring che porta via molti standard associati allo sviluppo di un'applicazione aziendale. Ci offre una piattaforma altamente motivata ma flessibile per sviluppare microservizi. Per questo tutorial, sfrutteremo Spring Boot per fornire un microservizio utilizzando la metodologia a dodici fattori.

4. Applicazione della metodologia dei dodici fattori

Definiamo ora una semplice applicazione che proveremo a sviluppare con gli strumenti e le pratiche che abbiamo appena discusso. Tutti noi amiamo guardare i film, ma è difficile tenere traccia dei film che abbiamo già visto.

Ora, chi vorrebbe iniziare un film e poi abbandonarlo in seguito? Ciò di cui abbiamo bisogno è un semplice servizio per registrare e interrogare i film che abbiamo visto:

Si tratta di un microservizio abbastanza semplice e standard con un archivio dati e endpoint REST. Dobbiamo definire un modello che verrà mappato anche alla persistenza:

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

Abbiamo definito un'entità JPA con un ID e alcuni altri attributi. Vediamo ora come appare il controller 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(); } }

Questo copre la base del nostro semplice servizio. Esamineremo il resto dell'applicazione mentre discutiamo di come implementare la metodologia a dodici fattori nelle seguenti sottosezioni.

4.1. Codebase

La prima best practice per le app a dodici fattori è di tenerne traccia in un sistema di controllo della versione. Git è il sistema di controllo delle versioni più popolare in uso oggi ed è quasi onnipresente. Il principio afferma che un'app deve essere monitorata in un singolo repository di codice e non deve condividere tale repository con altre app .

Spring Boot offre molti modi convenienti per eseguire il bootstrap di un'applicazione, inclusi uno strumento della riga di comando e un'interfaccia web. Una volta generata l'applicazione bootstrap, possiamo convertirla in un repository git:

git init

Questo comando dovrebbe essere eseguito dalla radice dell'applicazione. L'applicazione in questa fase contiene già un file .gitignore che limita in modo efficace il controllo della versione dei file generati. Quindi, possiamo creare subito un commit iniziale:

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

Infine, possiamo aggiungere un telecomando e inviare i nostri commit al telecomando se lo desideriamo (questo non è un requisito rigoroso):

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

4.2. Dipendenze

Successivamente, l' app a dodici fattori dovrebbe sempre dichiarare in modo esplicito tutte le sue dipendenze . Dovremmo farlo usando un manifesto della dichiarazione di dipendenza. Java ha più strumenti di gestione delle dipendenze come Maven e Gradle. Possiamo usarne uno per raggiungere questo obiettivo.

Quindi, la nostra semplice applicazione dipende da poche librerie esterne, come una libreria per facilitare le API REST e per connettersi a un database. Vediamo come possiamo definirli in modo dichiarativo usando Maven.

Maven ci richiede di descrivere le dipendenze di un progetto in un file XML, generalmente noto come Project Object Model (POM):

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

Sebbene ciò sembri chiaro e semplice, queste dipendenze di solito hanno altre dipendenze transitive. Questo lo complica in una certa misura, ma ci aiuta a raggiungere il nostro obiettivo. Ora, la nostra applicazione non ha una dipendenza diretta che non è esplicitamente descritta.

4.3. Configurazioni

Un'applicazione in genere ha molte configurazioni, alcune delle quali possono variare tra le distribuzioni mentre altre rimangono le stesse.

Nel nostro esempio, abbiamo un database persistente. Avremo bisogno dell'indirizzo e delle credenziali del database a cui connetterci. È molto probabile che questo cambi tra le distribuzioni.

Un'app a dodici fattori dovrebbe esternalizzare tutte queste configurazioni che variano tra le distribuzioni . La raccomandazione qui è di utilizzare le variabili di ambiente per tali configurazioni. Ciò porta a una netta separazione tra configurazione e codice.

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 questo tutorial, abbiamo esaminato i concetti della metodologia a dodici fattori. Abbiamo discusso di come sfruttare un'architettura di microservizi con Spring Boot per distribuirli in modo efficace. Inoltre, abbiamo esplorato in dettaglio ogni fattore e come applicarli alla nostra applicazione. Abbiamo anche esplorato diversi strumenti per applicare con successo questi fattori individuali in modo efficace.