spring-guides/gs-service-registration-and-discovery

You will set up a Netflix Eureka service registry and then build a client that both registers itself with the registry and uses it to resolve its own host. A service registry is useful because it enables client-side load-balancing and decouples service providers from consumers without the need for DNS.

https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/prereq_editor_jdk_buildtools.adoc

https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/how_to_complete_this_guide.adoc

For all Spring applications, you should start with the Spring Initializr. The Initializr offers a fast way to pull in all the dependencies you need for an application and does a lot of the set up for you.

This guide needs two applications. The first application (the service application) needs only the Eureka Server dependency.

The second application (the client application) needs the Eureka Server and Eureka Discovery Client dependencies.

You can use this pre-initialized project (for the service application) or this pre-initialized project (for the client application) and click Generate to download a ZIP file. This project is configured to fit the examples in this tutorial.

To manually initialize the project:

1. Navigate to https://start.spring.io. This service pulls in all the dependencies you need for an application and does most of the setup for you.

2. Choose either Gradle or Maven and the language you want to use. This guide assumes that you chose Java.

3. Click Dependencies and select Eureka Server for the service application and Eureka Server and Eureka Discovery Client for the client application.

4. Click Generate.

5. Download the resulting ZIP file, which is an archive of a web application that is configured with your choices.

You first need a Eureka Service registry. You can use Spring Cloud’s @EnableEurekaServer to stand up a registry with which other applications can communicate. This is a regular Spring Boot application with one annotation (@EnableEurekaServer) added to enable the service registry. The following listing (from eureka-service/src/main/java/com.example.serviceregistrationanddiscoveryservice/ServiceRegistrationAndDiscoveryServiceApplication.java) shows the service application:

When the registry starts, it will complain (with a stacktrace) that there are no replica nodes to which the registry can connect. In a production environment, you will want more than one instance of the registry. For our simple purposes, however, it suffices to disable the relevant logging.

By default, the registry also tries to register itself, so you need to disable that behavior as well.

It is a good convention to put this registry on a separate port when using it locally.

Add some properties to eureka-service/src/main/resources/application.properties to handle all of these requirements, as the following listing shows:

Now that you have started a service registry, you can stand up a client that both registers itself with the registry and uses the Spring Cloud DiscoveryClient abstraction to interrogate the registry for its own host and port. The @EnableDiscoveryClient activates the Netflix Eureka DiscoveryClient implementation. (There are other implementations for other service registries, such as Hashicorp’s Consul or Apache Zookeeper). The following listing (from eureka-client/src/main/java/example/serviceregistrationanddiscoveryclient/ServiceRegistrationAndDiscoveryClientApplication.java) shows the client application:

Whatever implementation you choose, you should soon see eureka-client registered under whatever name you specify in the spring.application.name property. This property is used a lot in Spring Cloud, often in the earliest phases of a service’s configuration. This property is used in service bootstrap and, so, by convention lives in eureka-client/src/main/resources/bootstrap.properties where it is found before src/main/resources/application.properties. The following listing shows the bootstrap.properties file:

The eureka-client defines a Spring MVC REST endpoint (ServiceInstanceRestController) that returns an enumeration of all the registered ServiceInstance instances at http://localhost:8080/service-instances/a-bootiful-client. See the Building a RESTful Web Service guide to learn more about building REST services with Spring MVC and Spring Boot.

Test the end-to-end result by starting the eureka-service first and then, once that has loaded, starting the eureka-client.

To run the Eureka service with Maven, run the following command in a terminal window (in the /complete directory):

To run the Eureka client with Maven, run the following command in a terminal window (in the /complete directory):

To run the Eureka service with Gradle, run the following command in a terminal window (in the /complete directory):

To run the Eureka client with Gradle, run the following command in a terminal window (in the /complete directory):

The eureka-client will take about a minute to register itself in the registry and to refresh its own list of registered instances from the registry. Visit the eureka-client in the browser, at http://localhost:8080/service-instances/a-bootiful-client. There, you should see the ServiceInstance for the eureka-client reflected in the response. If you see an empty <List> element, wait a bit and refresh the page.

Congratulations! You have just used Spring to stand up a Netflix Eureka service registry and to use that registry in a client application.

The following guides may also be helpful:

• Building a RESTful Web Service

• Serving Web Content with Spring MVC

• Building an Application with Spring Boot

https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/footer.adoc