Skip to content

Latest commit

 

History

History
346 lines (302 loc) · 14.1 KB

README.md

File metadata and controls

346 lines (302 loc) · 14.1 KB
Raw

Welcome to Micoservices by Coding Saint!

The new buzzword in industry is microservices. This repository is the source code for the step by step tutorial at online course Spring REST API and Microserivces . You can follow above link and can get the step by step video reference at 90% discount. https://www.udemy.com/course/spring-boot-and-rest-api/?referralCode=61F8139662DFDFE6DB67

Table of Content

  • Introduction
  • Advantages and Drawbacks of Microservices
  • User Service
  • ToDo Service
  • Feign Declarative REST Client
  • Ribbon Load Balancer
  • Service Discovery in Microservices using Eureka
  • Use of Config Server
  • Zuul API gateway
  • Distributed Tracing
  • Zipkins UI to view traces
  • Hystrix Fault tolerance

Introduction

From inception of software design what needed to be improved which brought this new concept . We need to understand a work “Monolith”

Monolith Monolith refers a kind of software which keeps all the component required by it within itself. Say we have to create a E Commerce we need to have User authentication, product services, cart management, payment integration ,recommendation service etc. A monolith is one application which has all of them embedded to it.

Microservices

Microservices as certainly a buzz word all around. We have been in an era where distributed and scaleable systems have need of the hour. As the business grows the number the pressure on systems also increases. In order to keep up with increased load we scale our application. In this process we end up scaling entire monolith. In monolith we have all modules added to single application. While our load will be for certain modules ,we still end up scaling entire application.

Scaling Monolith

enter image description here

In above example , if we have a E commerce service as monolith, it is expected to have more hits at product and search modules rather cart and delivery tracking modules but when we scale up we will end up scaling all of the modules. This will increase memory and heap size and will require unnecessary resources.
Microservices solves exact same problem. In microservices we have well defined modules as a separate service all of them talking independently via HTTP/MQ or any protocol. Now once we notice increase in product services and search module, we will scale only that component.

Microservices scaling

enter image description here

Advantages and Drawbacks of Microservice

Advantages of Microservices

  1. Improved fault tolerance
  2. Easy to understand
  3. No vendor or technology lock in
  4. Easy to add new modules
Improved fault tolerance

Microservices helps you to be highly available. Since once we adopt microservices , we move towards distributed systems , In case of a monolith if a the system or network is down typically entire system is down. In Monolith as we know services are tightly coupled , error at one service will impact other one too. In Microservices , we design in a way that even if one component is down , entire service will not be impacted. We can use fault tolerance and write code for fallbacks. For example if we have fallback for some critical modules , in case of the service being down fallbacks will be invoked , say in a e-commerce microservice recommendation-service is down, we can have fallbacks with static recommendations. It improves our fault tolerance.

Easy to understand

Each module is granular. It has it’s own domain, All it has to do is to take care of itself. Obviously it is easy to understand a smaller piece than entire monolith system4

No vendor or technology lock in

The is no vendor lock in , Each module can have it’s own database, a different programming language and still communicate via HTTP REST protocol , or messaging queues etc.

Easy to add new modules

Once a new feature is required we don’t have to write in same monolith with a fear of breaking changes. We can easily spin up a new microservices and it doesn’t have to break existing system.

All your files and folders are presented as a tree in the file explorer. You can switch from one to another by clicking a file in the tree.

Drawbacks of Microservices

  1. Distributed systems are complex to understand
  2. Multiple database make it complex to maintain transactional consistency.
  3. Tough to test
  4. Could be tough to deploy
Distributed systems are complex to understand

Distributed system are complex. Tough a individual module could be very easy to understand but how it fit in entire big microservice landscape ,interacting with each other could be tough to understand.

Multiple database make it complex to maintain transactional consistency.

This is one of the most talked about problem of a microservice architecture . In a monolith , it is one database where all modules related tables are there . It is easy to maintain transactional consistency . For example , if one the operation fails we can easily rollback entire transaction. In microservices , all services have different databases. Many a times one operation requires interaction with multiple services. To guarantee a transaction in all databases over different servers it not possible. To avoid it we use eventual consistency but still transaction consistency is complex.We need to design fail over scenarios well in advance.

Tough to test

One single database , one application , single source to to test is obviously easy than to test one operation where multiple miroservices with multiple database are interacting.

Could be tough to deploy

So many microservices , and over that one depending on another , with so many different technology stack is challenging for sure.

Now after reading above , if you are designing microservices you must ask is it required. Do I have to deal with so many transaction and incming requests that we need to decompose monolith. Will I have infrastructure ready at will to scale microservices or new one. If your answer is yes, please go ahead but always remember MICROSERVICES are not silver bullet.

User Service

This microservice will help us to create user and call another microservice i.e. TODO microservice to get all the todos assigned to user and return user along with its todos.

  • A simple microservice .
  • Manages users
    • Create /Update/Delete User

User service in this tutorial runs on port 8082.

Important APIs of User Service

Create User

URL : http://localhost:8082/v1/user METHOD TYPE: POST Request Body :

  "firstName":"Ray",
  "lastName":"mcfallen",	
   "userName":"ray",
  "email":"[email protected]"
}

Response Body:

{
'id':2,
"firstName":"Ray",
"lastName":"mcfallen",	
"userName":"ray",
"email":"[email protected]"
}

Get User With tasks

URL : http://localhost:8082/v1/user/2/tasks METHOD TYPE: GET Response Body

TODO Service

ToDo Service will be used to create task for users, It create task and assign it to particular user based on user id.

Important APIs of User Service

Create Task

URL : http://localhost:8083/task METHOD TYPE: POST Request Body :

{ 
"name":"Create Micoservice Couse : Config Server", 
"description":"Create Video tutorial task service",   
"isDone":false, 
  "targetDate":"2019-08-05", 
    "userId":2, 
      "categories":[   
         {"name":"Microservice Tutorial"
         }
         ]
}

Response Body:

{ 
"id":2,
"name":"Create Micoservice Couse : Config Server", 
"description":"Create Video tutorial task service",   
"isDone":false, 
  "targetDate":"2019-08-05", 
    "userId":2, 
      "categories":[   
         {"name":"Microservice Tutorial"
         }
         ]
}

Get tasks of a User

URL : http://localhost:8083/user/2/tasks METHOD TYPE: GET

Feign Declarative REST Client

Feign Declarative REST client helps us to remove boilerplate code of REST API. We will use it in User Service to remove rest call to task service where we had been using rest template. In order to do that

  • add openfeign at pom.xml
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
  • Add annotation at User application main class
@EnableFeignClients
  • Create a Service class with annotation @FeignClient and method for Feign as below
@Service
@FeignClient(name="task-service" ,url="http://localhost:8083/")
public interface TaskService {
@RequestMapping("user/{id}/tasks")
ResponseEntity<List<Task> > userTasks(@PathVariable ("id") Long userId);
}
  • Remove Rest call at Controller and user TaskService method
ResponseEntity<List<Task>> tasks =taskService.userTasks(id);

Ribbon Load Balancer

Load balancing is important factor when communicating between multiple microservices. In our example We will be running 2 instances of Todo Service and 1 User Service , We will add ribbon at user service toload balance Todo service calls. Steps to add Ribbon load balancer.

  • Add Ribbon dependency
<dependency>
   		<groupId>org.springframework.cloud</groupId>
   		<artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
</dependency>
  • Modify TaskService as below. Notice that FeignClient with URL is commented , its just for your reference ,it can be removed
@Service
//@FeignClient(name="task-service" ,url="http://localhost:8083/")
@FeignClient(name="task-service" )
@RibbonClient(name="task-service")
public interface TaskService {
	@RequestMapping("user/{id}/tasks")
	ResponseEntity<List<Task> > userTasks(@PathVariable ("id") Long userId);
}
  • Now add List of servers for Task Service at application.yml
task-service:
  ribbon:
    listOfServers: http://localhost:8083/,http://localhost:8085/

This will enable the task service instances to be picked from yaml file.

Service Discovery in Microservices using Eureka

The problem with above approach is to define list of servers with every new instances coming up and down. We would certainly not want to do it as it will require to restart services after change in application.yml We can use Eureka Service discovery to avoid it.

Steps to create Eureka Service Discovery Server

  • Go to https://start.spring.io
  • Select Eureka as dependency and download the project
  • Import project to IDE
  • At Main class add @EnableEurekaServer annotation.
  • Add server.port =8761 to start at different port.

Connecting clients to Eureka for discovery

At User service and Task service pom

  • Add dependency for Eureka client
<dependency>
   		<groupId>org.springframework.cloud</groupId>
   		<artifactId>
   			spring-cloud-starter-netflix-eureka-client
   		</artifactId>
</dependency>
  • Add Eureka server location to connect at application.yml
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/

Use of Config Server

To manage configuration of different services effectively we use config server. Config server is a separate microservice which keeps track of configurations.

Steps to create config server

  • Go to https://start.spring.io
  • Select config server as dependency and download the project
  • Import project to IDE
  • At Main class add @EnableConfigServer annotation.
  • Add server.port =9000 to start at different port.
  • Create another git project and add configuration files to it. For example user service should have a file names user-service.yml and task-service should have a file named task-service.yml
  • Add location of git in application.yml of config-server
spring:
  cloud:
    config:
      server:
        git:
          uri: https://github.com/CODINGSAINT/config.git
  application:
    name: config-server

Connecting clients to Config server

At User service and Task service pom

  • Add dependency for config client
<dependency>
   		<groupId>org.springframework.cloud</groupId>
   		<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
  • Create a file bootstrap.yml and add config server location to connect at bootstrap.yml
spring:
  application:
    name: user-service
  cloud:
    config:
      uri: 
        - http://localhost:9000

Now at start up services will connect to config server to get there configurations.

Zuul API gateway

Different microservices will have different ports and many times we require to perform operations (filters) before these incoming requests even hit our services. To perform better operations for incoming request we will add a gateway . We call it Zuul API gateway in our case.

Create API gateway

  • Go to https://start.spring.io
  • Select Zuul API gateway as dependency and download the project
  • Import project to IDE
  • At Main class add @@EnableZuulProxy annotation.
  • create file bootstrap.yml and delete application.yml
  • Add below configuration for it
spring:
 application:
   name: api-gateway
 cloud:
   config:
     uri: 
       - http://localhost:9000
  • Create file named api-gateway.yml and commit at config git project created above
  • Below are content for api-gateway.yml
spring:
application:
  name: api-gateway
cloud:
  config:
    uri: 
      - http://localhost:9000
      
zuul:
prefix: /api
routes:
  user-service:
    path: /user-service/**
    service-id: user-service
  task-service:
    path: /task-service/**
    service-id: task-service
    
#Eureka
eureka:
client:
  service-url:
    defaultZone: http://localhost:8761/eureka

In above configuration routes configurations will help us to add routes for different services. To access URL of any service we can add service-name and hit postman for example to access user-service url for getting user-service and its respective task we can use http://localhost:8080/user-service/v1/user/2/tasks Where user service URL was http://localhost:8082/v1/user/2/tasks