metaphori/vertx-blueprint-microservice

Vert.x Blueprint Project - Micro-Shop microservice application

Vert.x Microservice Blueprint (forked)

Vert.x blueprint application - A micro-shop microservice application developed with Vert.x. This repo is intended to be an illustration on how to design microservice architecture and develop microservice applications using Vert.x.

This blueprint works with Vert.x 3.4.1.

Note: We are refactoring the whole architecture of the microservice blueprint. This can take a long time and the improved new version is expected to be released by the end of May. See here for details.

Content

• Microservice with Vert.x
• Asynchronous development model
• Reactive and functional patterns
• Event sourcing patterns
• Asynchronous RPC on the clustered event bus
• Various type of services (e.g. REST, message source, event bus service)
• Configuration retriever
• Service discovery
• Circuit breaker
• Polyglot persistence support
• API gateway
• Global authentication (Local/OAuth 2)
• Centralized logging using ELK stack
• Monitoring

Documentation

Detailed tutorials are available here!

• Vert.x Blueprint - Micro Shop microservice practice (Development)
• Vert.x Blueprint - Micro Shop microservice practice (API Gateway)

Architecture

Build/Run

First, for api-gateway and monitor-dashboard component, you have to enter the src/main/resources/webroot directory and install the frontend dependencies with bower:

bower install

Then build the code:

mvn clean install -Dmaven.test.skip=true

To run the microservice with Docker Compose, please refer to the running instruction.

Contributing

Contributions are definitely welcome !

Notes

• Every high-level component contains at least 2 verticles
• (1) REST verticle: provides a REST endpoint of the service and publishes it to the service discovery infrastructure
• (2) Service verticle: responsible for publishing event bus services, message sources to the service discovery infrastructure and then deploy REST verticles
• The app uses multiple kinds of services:
• (A) HTTP endpoint (e.g. REST endpoint and gateway): the service is located using an HTTP URL
• (B) Event bus service: we can do async RPC to consume event bus services (aka. service proxies) via the (clustered) event bus. The service is located using an event bus address.
• (C) Message source: this kind of service publishes messages to specific addresses on event bus. The service is located using an event bus address.

---

• microservice-blueprint-common
  • BaseMicroserviceVerticle: configures discovery, circuit breaker etc.
  • RestAPIVerticle: includes common code for creating REST HTTP servers
• Event bus services: account, store and product service
  • By @ProxyGen, Vert.x can automatically generate service proxies
  • Registration of service on event bus: ProxyHelper.registerService
  • Publication of a EventBusService record to the discovery infrastructure: discovery.publish()
• Inventory service: async API (Future-based), so only HTTP endpoint is published
  • Use of ConfigRetriever (see configurationRetriever and ConfigRetrieverHelper enum in microservice-blueprint-common)
• API Gateway
  • Use of circuit breaker (see dispatchRequests)