Zuul to Proxy your Microservices
A common challenge when building microservices is providing a unified interface to the consumers of your system. The fact that your services are split into small composable appsshouldn’t be visible to users or result in substantial development effort.
To solve this problem, Netflix created and open-sourced its Zuul proxy server. Zuul is an edge service that proxies requests to multiple backing services. It is “front door” to your system, which allows a browser, mobile app, or other user interface to consume services from multiple hosts without managing cross-origin resource sharing (CORS) and authentication for each one.
Spring Cloud has created an embedded Zuul proxy to ease the development of a very common use case where a UI application wants to proxy calls to one or more back end services. This feature is useful for a user interface to proxy to the backend services it requires, avoiding the need to manage CORS and authentication concerns independently for all the backends.
To enable it, annotate a Spring Boot main class with @EnableZuulProxy, and this forwards local calls to the appropriate service based on configuration defined in config files. For e.g /api/authservice/… request is forwarded to auth-service.
Zuul has different types of filters that enables us to quickly apply functionality to our edge service. These filters help us perform the following functions:
- Authentication and Security.
- Insights and Monitoring.
- Dynamic Routing.
- Stress Testing.
- Load Shedding.
- Static Response handling.
In our example we have defined routing rules (based of URL it forwards request to client-service), filter for logging request url, method and time of request.
We will be referring to two application which we have posted on different application.
Dependencies
Application.properties
Java Code:
Config class annotated with @EnableZuulProxy
Logging filter
Config for Zuul routing rules & eureka service discovery. In config we have defined prefix as /api, routes for authclientservice.
In post Ribbon, Hysterix using spring feign we have defined authclientservice using ribbon and hysterix, which communicates to authservice service application.
We have prefix url as “/api”, then “/authclientservice” for authclientservice service application.
RESTful endpoint for authentication defined in authclientservice application is “/auth/login/authenticate”. Now for end client to access authentication end-point through endge-server will be “/api/authclientservice/auth/login/authenicate.
Start application
Application will get started at 6061 port.
Use below curl commands for authentication.
Request getting logged using ZuulFilter which we have defined.
Request routed to authclientservice application
And at last request is served by authservice application.
Cheers – Happy learning 🙂
Ketan Gote
Comments
Post a Comment