Springy Store μServices
- This project is a development of a small set of Spring Boot and Cloud based Microservices projects that implement cloud-native intuitive, Reactive Programming, Event-driven, Microservices design patterns, and coding best practices.
- The project follows CloudNative recommendations and The twelve-factor app methodology for building software-as-a-service apps to show how μServices should be developed and deployed.
- This project uses cutting edge technologies like Docker, Kubernetes, Elasticsearch Stack for
logging and monitoring, Java SE 14, MySQL, and MongoDB databases, all components developed with TDD in mind, covering integration & performance testing, and many more.
For example, in the first stage (1st release), I just created project structure, essential services' skeleton, integration between them, and finally write integration testing as well as semi-automated testing for the complete services' functionality.
At the 1st stage, the Recommendation and Review microservices generate local in-memory data, and Store Service calls the other three services (Product, Recommendation, and Review) statically to generate client aggregate response for a specific product. Therefore, in:
- The second stage I will introduce database integration, then in (done)
- The third stage I will add Dockerization of our services and docker-compose, and in (done)
- In the fourth stage, I will introduce service discovery, and so on.
System components Structure
Let's explain first the system structure to understand its components:
Springy Store μService --> Parent folder.
|- config --> All system configuration files
|- docs --> All docs and diagrams.
|- store-base
|- store-build-chassis --> Super Parent POM, contains all build information
|- store-cloud-chassis --> Cloud services Parent POM, inherit from build contains all cloud libraries
|- store-service-chassis --> Parent POM, inherits from cloud contains all microservices common libraries
|-store-cloud-infra
|- authorization-server --> Authorization server
|- edge-server --> API Gateway server
|- eureka-server --> Service discovery server
|-store-common
|- store-api --> API Endpoint and services definitions for all microservices
|- store-utils --> Common utilities shared between all components
|-store-services
|- product-service --> Product Microservice
|- recommendation-service --> Recommendation Microservice
|- review-service --> Review Microservice
|- store-service --> Store Microservice
|- docker-compose.yml --> contains all services landscape with RabbitMQ
|- docker-compose-kafka.yml --> contains all services landscape with more instances working with Kafka with partitions
|- docker-compose-partitions.yml --> contains all services landscape with more instances working with RabbitMQ with partitions
|- run-em-all.sh --> Run all microservices in separate mode.
|- setup.sh --> Install all shared POMs and shared libraries.
|- stop-em-all.sh --> Stop all services runs in standalone mode.
|- test-em-all.sh --> This will start all docker compose landscape and test them, then shutdown docker compose containers with test finishes (use switch start stop)
Now, as we have learned about different system components, then let's start.
Getting started
The first stage, aka (Release v1.0), is about creating and implementing a set of project Microservices.
Creating a Set of Cooperating Microservices (Release v1.0)
The following topics are going to be covered in this 1st stage (other stages topics will be documented in the project wiki pages):
- Introducing the microservice landscape.
- Generating skeleton microservices.
- Adding RESTful APIs.
- Adding a Store, Product, Recommendation, and Review microservices.
- Adding error handling.
- Testing the APIs manually.
- Adding automated tests of microservices in isolation.
- Adding semi-automated tests to a microservice landscape.
System Boundary - μServices Landscape (Release 5.0-Latest)
Required software
The following are the initially required software pieces:
-
Git: it can be downloaded and installed from https://git-scm.com/downloads.
-
Java 14: it can be downloaded and installed from https://www.oracle.com/technetwork/java/javase/downloads/index.html.
-
curl: this command-line tool for testing HTTP-based APIs can be downloaded and installed from https://curl.haxx.se/download.html.
-
jq: This command-line JSON processor can be downloaded and installed from https://stedolan.github.io/jq/download/.
-
Spring Boot Initializer: This Initializer generates spring boot project with just what you need to start quickly! Start from here https://start.spring.io/.
-
Docker Desktop: The fastest way to containerize applications on your desktop, and you can download it from here https://www.docker.com/products/docker-desktop
For each future stage, I will list the newly required software.
Follow the installation guide for each software website link and check your software versions from the command line to verify that they are all installed correctly.
Using an IDE
I recommend that you work with your Java code using an IDE that supports the development of Spring Boot applications such as Spring Tool Suite or IntelliJ IDEA Ultimate Edition. So you can use the Spring Boot Dashboard to run the services, run each microservice test case, and many more.
All that you want to do is just fire up your IDE -> open or import the parent folder springy-store-microservices, and everything will be ready for you.
Playing With Springy Store Project
Cloning It
The first thing to do is to open git bash command line, and then simply you can clone the project under any of your favorite places as the following:
> git clone https://github.com/meghnadsaha/Spring-Store-Microservices.git
Build & Test Them In Isolation
To build and run the test cases for each service & shared modules in the project, we need to do the following:
First: Build & Install Shared Dependencies
This done only for the first time or any new changes or versions of shared modules and POMs.
To build and install store-build-chassis, store-utils, store-api, store-chassis libraries, from the root folder springy-store-microservices run the following commands:
meghnadsaha ~/springy-store-microservices
λ ./setup.sh
Now you should expect output like this:
Installing all Springy store core shared modules & Parent POMs
...............................................................
1- Installing [Parent Build Chassis] module...
Done successfully.
2- Installing [Parent Cloud Chassis] module...
Done successfully.
3- Installing shared [Services Utilities] module...
Done successfully.
4- Installing shared [Services APIs] module...
Done successfully.
5- Installing [Services Parent Chassis] module...
Done successfully.
Woohoo, building & installing all project modules are finished successfully.
The project is ready for the next step. :)
Second: Build & Test Microservices
Now it is time to build our 4 microservices and run each service integration test in
isolation by running the following commands:
meghnad.saha ~/springy-store-microservices
λ ./mvnw clean verify -Ddockerfile.skip
All build commands and test suite for each microservice should run successfully, and the final output should be like this:
---------------< com.siriusxi.ms.store:store-aggregator >---------------
[INFO] Building Springy Store Aggregator 1.0-SNAPSHOT [13/13]
[INFO] --------------------------------[ pom ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ store-aggregator ---
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for Springy Store Aggregator 1.0-SNAPSHOT:
[INFO]
[INFO] Springy Store Build Chassis ........................ SUCCESS [ 0.228 s]
[INFO] Springy Store Cloud Chassis ........................ SUCCESS [ 1.257 s]
[INFO] Store APIs ......................................... SUCCESS [ 4.279 s]
[INFO] Store Utils ........................................ SUCCESS [ 1.809 s]
[INFO] Springy Store Chassis .............................. SUCCESS [ 0.857 s]
[INFO] Product Service .................................... SUCCESS [ 13.079 s]
[INFO] Review Service ..................................... SUCCESS [ 9.332 s]
[INFO] Recommendation Service ............................. SUCCESS [ 8.463 s]
[INFO] Store Service ...................................... SUCCESS [ 8.927 s]
[INFO] Eureka Discovery Server ............................ SUCCESS [ 6.536 s]
[INFO] Edge Server ........................................ SUCCESS [ 32.108 s]
[INFO] Authorization Server ............................... SUCCESS [ 1.616 s]
[INFO] Springy Store Aggregator ........................... SUCCESS [ 0.100 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 57.663 s
[INFO] Finished at: 2020-05-08T03:38:34+02:00
[INFO] ------------------------------------------------------------------------
Running Them All
Using RabbitMQ without the use of partitions
Now it's the time to run all of our reactive Microservices, and it's straightforward just run the following docker-compose commands:
meghnad.saha ~/springy-store-microservices
λ docker-compose -p ssm up -d
All the services, databases, and messaging service will run in parallel in detach mode (option -d), and command output will print to the console the following:
Creating network "ssm_default" with the default driver
Creating ssm_eureka_1 ... done
Creating ssm_gateway_1 ... done
Creating ssm_auth-server_1 ... done
Creating ssm_mysql_1 ... done
Creating ssm_mongodb_1 ... done
Creating ssm_rabbitmq_1 ... done
Creating ssm_store_1 ... done
Creating ssm_review_1 ... done
Creating ssm_product_1 ... done
Creating ssm_recommendation_1 ... done
Access Store APIs
You can manually test Store Service APIs throughout its Swagger interface at the following
URL https://localhost:8443/swagger-ui.html.
Access Service Discovery Server (Eureka)
If you would like to access the Eureka service discovery point to this URL http://localhosts:8443/eureka/web to see all the services registered inside it.
Note that it is accessed through API Gateway and is secured. Therefore the browser will ask you for username:mt and password:p, write them to the dialog, and you will access it. This type of security is a basic form security.
The API Gateway and Store Service both act as a resource server. To know more about calling Store API in a secure way you can check the test-em-all.sh script on how I have changed the calling of the services using OAuth2 security.
Access RabbitMQ
In browser point to this URL http://localhost:5672/ username: guest and password: guest, and you can see all topics, DLQs, partitions, and payload.
- For running two instances of each service and using RabbitMQ with two partitions per topic, use the following
docker-compose command:
meghnad.saha ~/spring-store-microservices
λ docker-compose -p ssm -f docker-compose-partitions.yml up -d
- To use _Kafka and Zookeeper with two parti