SpringCloud教程 | 一.服务的注册与发现（Eureka）

短命女 2021-09-26 10:52 357阅读 0赞

# 前言 #

之前用过SpringBoot之后，楼主有种虎穴一震的感觉，不禁感叹天下居然有这么好用的框架，虽然最近公司依旧比较忙，好在自己任务完成了，就忙里偷闲开始学习一下SpringCloud（SpringCloud是建立在SpringBoot的基础之上的），趁此机会和大家分享一下，希望大家能够给予宝贵的建议。

# 正文 #

## SpringCloud简介 ##

“微服务架构”在这几年非常的火热，以至于关于微服务架构相关的开源产品被反复的提及（比如：netflix、dubbo），Spring Cloud也因Spring社区的强大知名度和影响力也被广大架构师与开发者备受关注。  
那么什么是“微服务架构”呢？简单的说，微服务架构就是将一个完整的应用从数据存储开始垂直拆分成多个不同的服务，每个服务都能独立部署、独立维护、独立扩展，服务与服务间通过诸如RESTful API的方式互相调用。

## 微服务架构 ##

## 服务治理 ##

由于Spring Cloud为服务治理做了一层抽象接口，所以在Spring Cloud应用中可以支持多种不同的服务治理框架，比如：Netflix Eureka、Consul、Zookeeper。在Spring Cloud服务治理抽象层的作用下，我们可以无缝地切换服务治理实现，并且不影响任何其他的服务注册、服务发现、服务调用等逻辑。  
所以，下面我们通过介绍两种服务治理的实现来体会Spring Cloud这一层抽象所带来的好处。

## Spring Cloud Eureka ##

Spring Cloud Eureka是Spring Cloud Netflix项目下的服务治理模块。而Spring Cloud Netflix项目是Spring Cloud的子项目之一，主要内容是对Netflix公司一系列开源产品的包装，它为Spring Boot应用提供了自配置的Netflix OSS整合。通过一些简单的注解，开发者就可以快速的在应用中配置一下常用模块并构建庞大的分布式系统。它主要提供的模块包括：服务发现（Eureka），断路器（Hystrix），智能路由（Zuul），客户端负载均衡（Ribbon）等。

![SouthEast][]

region和zone（或者Availability Zone）均是AWS的概念。在非AWS环境下，我们可以简单地将region理解为Eureka集群，zone理解成机房。这样图4-2就很好理解了——一个Eureka集群被部署在了zone1机房和zone2机房中。  
  
对region和zone感兴趣的读者可前往[http://blog.csdn.net/awschina/article/details/17639191][http_blog.csdn.net_awschina_article_details_17639191]扩展阅读。Spring Cloud中默认的region是us-east-1。

## 实战 ##

### 注册中心 ###

1.创建一个SpringBoot工程，名称为spring-cloud-eureka

在创建的过程中选择Dependencies的时候选择Eureka Server,如下图所示

![SouthEast 1][]

2.pom.xml配置如下

<name>spring-cloud-eureka</name>
    	<description>Demo project for Spring Boot</description>
    
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>1.5.9.RELEASE</version>
    		<relativePath/> 
    	</parent>
    
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    		<java.version>1.8</java.version>
    		<spring-cloud.version>Edgware.RELEASE</spring-cloud.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-eureka-server</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-tomcat</artifactId>
    			<scope>provided</scope>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    	</dependencies>
    
    	<dependencyManagement>
    		<dependencies>
    			<dependency>
    				<groupId>org.springframework.cloud</groupId>
    				<artifactId>spring-cloud-dependencies</artifactId>
    				<version>${spring-cloud.version}</version>
    				<type>pom</type>
    				<scope>import</scope>
    			</dependency>
    		</dependencies>
    	</dependencyManagement>
    
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>

3.@EnableEurekaServer注解

通过@EnableEurekaServer注解启动一个服务注册中心提供给其他应用进行对话。这一步非常的简单，只需要在一个普通的Spring Boot应用中添加这个注解就能开启此功能，比如下面的例子：

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
    
    @EnableEurekaServer
    @SpringBootApplication
    public class SpringCloudEurekaApplication {
    	public static void main(String[] args) {
    		SpringApplication.run(SpringCloudEurekaApplication.class, args);
    	}
    }

4.application.properties

在默认设置下，该服务注册中心也会将自己作为客户端来尝试注册它自己，所以我们需要禁用它的客户端注册行为，只需要在application.properties配置文件中增加如下信息：

spring.application.name=eureka-server
    server.port=1001
    eureka.instance.hostname=localhost
    eureka.client.register-with-eureka=false
    eureka.client.fetch-registry=false
    eureka.client.serviceUrl.defaultZone=http://localhost:1001/eureka/

eureka.client.registerWithEureka ：表示是否将自己注册到Eureka Server，默认为true。由于当前这个应用就是Eureka Server，故而设为false。  
eureka.client.fetchRegistry ：表示是否从Eureka Server获取注册信息，默认为true。因为这是一个单点的Eureka Server，不需要同步其他的Eureka Server节点的数据，故而设为false。  
eureka.client.serviceUrl.defaultZone ：设置与Eureka Server交互的地址，查询服务和注册服务都需要依赖这个地址。默认是http://localhost:8761/eureka ；多个地址可使用 , 分隔。

5.访问页面

为了与后续要进行注册的服务区分，这里将服务注册中心的端口通过server.port属性设置为1001。启动工程后，访问：http://localhost:1001/，可以看到下面的页面，其中还没有发现任何服务。

![SouthEast 2][]

### 创建服务提供方 ###

1.创建一个SpringBoot工程，名称为spring-cloud-eureka-client  
在创建的过程中选择Dependencies的时候选择Eureka Discovery

2.pom.xml

<name>spring-cloud-eureka-client</name>
    	<description>Demo project for Spring Boot</description>
    
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>1.5.9.RELEASE</version>
    		<relativePath/> 
    	</parent>
    
    	<properties>
    		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    		<java.version>1.8</java.version>
    		<spring-cloud.version>Edgware.RELEASE</spring-cloud.version>
    	</properties>
    
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-eureka</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-tomcat</artifactId>
    			<scope>provided</scope>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    	</dependencies>
    
    	<dependencyManagement>
    		<dependencies>
    			<dependency>
    				<groupId>org.springframework.cloud</groupId>
    				<artifactId>spring-cloud-dependencies</artifactId>
    				<version>${spring-cloud.version}</version>
    				<type>pom</type>
    				<scope>import</scope>
    			</dependency>
    		</dependencies>
    	</dependencyManagement>
    
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>

实现/dc请求处理接口，通过DiscoveryClient对象，在日志中打印出服务实例的相关内容

package com.aikucun.controller;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.cloud.client.discovery.DiscoveryClient;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** 
    * @FileName DisController.java
    * @Description:TODO
    * @author JackHisen(gu.weidong)
    * @version V1.0
    * @createtime 2018年1月16日 下午5:42:13 
    * 修改历史：
    * 时间           作者          版本        描述
    *====================================================  
    *
    */
    @RestController
    public class DisController {
    	@Autowired
        DiscoveryClient discoveryClient;
    	@Value("${server.port}")
    	String port;
    
        @GetMapping("/dc")
        public String dc() {
        	System.out.println("port:"+port);
            String services =port+ ",Services: " + discoveryClient.getServices();
            System.out.println(services);
            return services;
        }
    }

4.在应用主类中通过加上@EnableDiscoveryClient注解，该注解能激活Eureka中的DiscoveryClient实现，这样才能实现Controller中对服务信息的输出。

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    
    @EnableDiscoveryClient
    @SpringBootApplication
    public class SpringCloudEurekaClientApplication {
    	public static void main(String[] args) {
    		SpringApplication.run(SpringCloudEurekaClientApplication.class, args);
    	}
    }

5.application.properties

spring.application.name=eureka-client
    server.port=2001
    eureka.client.serviceUrl.defaultZone=http://localhost:1001/eureka/

通过spring.application.name属性，我们可以指定微服务的名称后续在调用的时候只需要使用该名称就可以进行服务的访问。eureka.client.serviceUrl.defaultZone属性对应服务注册中心的配置内容，指定服务注册中心的位置。为了在本机上测试区分服务提供方和服务注册中心，使用server.port属性设置不同的端口。

启动该工程后，再次访问：[http://localhost:1001/。可以如下图内容，我们定义的服务被成功注册了。][http_localhost_1001]

![SouthEast 3][]

当然，我们也可以通过直接访问`eureka-client`服务提供的`/dc`接口来获取当前的服务清单，只需要访问：[http://localhost:2001/dc，我们可以得到如下输出返回：][http_localhost_2001_dc]

<table style="border-collapse:collapse; border-spacing:0px; margin:0px; padding:0px; border:0px; outline:0px; font-weight:inherit; font-style:inherit; font-family:inherit; font-size:16px; vertical-align:middle; line-height:1.6em; width:auto"> 
 <tbody style="margin:0px; padding:0px; border:0px; outline:0px; font-weight:inherit; font-style:inherit; font-family:inherit; vertical-align:baseline"> 
  <tr style="margin:0px; padding:0px; border:0px; outline:0px; font-weight:inherit; font-style:inherit; font-family:inherit; vertical-align:baseline"> 
   <td style="padding:10px 20px 10px 0px; margin:0px; border:none; outline:0px; font-style:inherit; font-family:inherit; font-size:16px; vertical-align:middle"> <pre style="overflow:auto; font-family:inherit; margin-top:0px; margin-bottom:0px; padding:0px; border:0px; outline:0px; font-weight:inherit; font-style:inherit; vertical-align:baseline"><span style="margin:0px; padding:0px; border:0px; outline:0px; font-weight:inherit; font-style:inherit; font-family:inherit; vertical-align:baseline; height:1.6em">Services: [eureka-client]</span><br style=""></pre> </td> 
  </tr> 
 </tbody> 
</table>

其中，方括号中的`eureka-client`就是通过Spring Cloud定义的`DiscoveryClient`接口在eureka的实现中获取到的所有服务清单。由于Spring Cloud在服务发现这一层做了非常好的抽象，所以，对于上面的程序，我们可以无缝的从eureka的服务治理体系切换到consul的服务治理体系中区。

本文主要参考于翟永超的[springcloud构建微服务][springcloud]，但该篇博客存在一处错误（也有可能是我没搞懂），在创建注册中心中未设置eureka.client.serviceUrl.defaultZone，创建服务提供方的时候却在配置文件中直接引用非默认值了。

[SouthEast]: /images/20210923/607cba0713c141349d7ba887b62839b2.png
[http_blog.csdn.net_awschina_article_details_17639191]: http://blog.csdn.net/awschina/article/details/17639191
[SouthEast 1]: /images/20210923/4596f58ea5f148cdb417be3d3d82b55a.png
[SouthEast 2]: /images/20210923/c9a8272724d54f3e9e5bd501677943ce.png
[http_localhost_1001]: http://localhost:1001/%E3%80%82%E5%8F%AF%E4%BB%A5%E5%A6%82%E4%B8%8B%E5%9B%BE%E5%86%85%E5%AE%B9%EF%BC%8C%E6%88%91%E4%BB%AC%E5%AE%9A%E4%B9%89%E7%9A%84%E6%9C%8D%E5%8A%A1%E8%A2%AB%E6%88%90%E5%8A%9F%E6%B3%A8%E5%86%8C%E4%BA%86%E3%80%82
[SouthEast 3]: /images/20210923/6a4513548bfe4e0796da36466a95357c.png
[http_localhost_2001_dc]: http://localhost:2001/dc%EF%BC%8C%E6%88%91%E4%BB%AC%E5%8F%AF%E4%BB%A5%E5%BE%97%E5%88%B0%E5%A6%82%E4%B8%8B%E8%BE%93%E5%87%BA%E8%BF%94%E5%9B%9E%EF%BC%9A
[springcloud]: http://blog.didispace.com/spring-cloud-starter-dalston-1/