spring-microservices-in-action

This repository contains the source code of the book "Spring Microservices in Action (John Carnell)" and the personal summary of technical essentials about Spring Boot for microservices.

Overview

This source code was re-organized by the original source code of the book and I make sure each module is runnable.

Structure

• Servers
  • Config: Provide the configuration parameters for other services.
  • Eureka: Service discovery.
  • Zipkin: API gateway.
  • Zuul: Collect tracing data.
• Services
  • Licensing: Manage (CRUD) license records.
  • Organization: Manage (CRUD) organization records.
  • Authentication: Issue and validate access tokens, manage clients' and users' credentials and roles.
  • Special Routes: Provide an alternate endpoint for a certain service.
• Database: Store license and organization records, clients' and users' credentials, alternate routes of any service.
• Message Queue (Kafka): Notify the licensing service about any organization record modification.
• Cache (Redis): Cache any organization record which has been loaded before.
• Log Server
  • Splunk: Collect log information in local.
  • Papertrail: Collect log information in cloud.

Technology Stack

• Core
  • Spring
    • Spring Boot
    • Spring Data
      • Spring Data JPA
      • Spring Data Redis
    • Spring Cloud
      • Spring Cloud Config
      • Spring Cloud Stream
      • Spring Cloud Sleuth
    • Spring Security
      • Spring Security OAuth2
      • Spring Security JWT
      • Spring Security RSA
  • Netflix OSS
    • Netflix Eureka (service discovery)
    • Netflix Zuul (service gateway)
    • Netflix Hystrix (resiliency patterns)
    • Netflix Feign (HTTP API client)
    • Netflix Ribbon (service communication, load balancing)
• Message Queue
  • Apache Kafka with Apache ZooKeeper
• Cache
  • Redis
• Database
  • MySQL
• Security
  • OAuth2
• Log
  • Splunk
  • Papertrail
• Trace
  • Apache Zipkin
• Cluster Coordination
  • Apache ZooKeeper

Differences to The Original Source Code

• Use Gradle as Java build automation tool rather than Maven.
• Use MySQL as database rather than PostgreSQL.
• Change the port of the organization service to 8060 to avoid the address conflict with the licensing service.
• Change the port of the special routes service to 8040 to avoid the address conflict with the licensing service.
• Change the port of the authentication service to 8901 to make it same with the example in the book.
• Add the integration of Splunk for log aggregation locally (use both local Splunk and remote Papertrail).
• Use the original functionality in Logback for sending the log to the log servers (Splunk & Papertrail) rather than the solution in the Book (use Logspout to direct the docker output to the log servers).
• Replace the user_roles table by the authorities table for storing users' credentials to DB.
• Change the column name from user_name to username for the user_orgs table and the users table.
• Add comments to make the code easy to read.

Getting Started

• Gradle (Version >= 4.4)
• ZooKeeper
• Kafka
• Redis
• Splunk
• Command Memo

Technical Essentials

• Spring Basics
  • Autowired
• Data Model
  • SpringData JPA
• Configuration
  • Configuration File Auto-loading
  • Configuration Encryption
• Service Discovery
  • Service Discovery with Eureka
• Resiliency
  • Resiliency Patterns with Hystrix
  • Configure Hystrix
• API Gateway
  • Service Gateway with Zuul
  • Zuul Filters
• Security
  • Protect Service with Spring Security and OAuth2
  • Use JWT as Access Token
  • Store Clients and Users' Credentials to DB
• Stream
  • Integrate with Message Queue (Kafka)
• Cache
  • Integrate with Redis
• Logging
  • Tune Logging
  • Log Aggregation
• Tracing
  • Send Trace to Zipkin
• Deployment
  • Build Runnable Jar

Study Notes

• Google Doc