SpringCloud入门 —— Eureka服务注册与发现

àì夳堔傛蜴生んèń 2023-10-05 21:54 57阅读 0赞

## 前言 ##

前面简单说了SpringBoot的模块划分，现在简单搭建一个分布式项目，首先整合Eureka Server服务注册，用于管理分布式环境下的各个Spring Boot微服务。

## 一、Eureka是什么？ ##

### 1.简介 ###

Eureka是Netflix开发的服务发现框架，本身是一个基于REST(具像状态传输)的服务，主要用于定位运行在AWS域中的中间层服务，以达到负载均衡和中间层服务故障转移的目的。

简单来说，Eureka就是一个注册服务中心，负责管理、记录服务提供者的信息，服务调用者无需自己寻找服务，而是把自己的需求告诉Eureka，然后Eureka会把符合你需求的服务告诉你。

### 2.基本概念 ###

Eureka由多个instance(服务实例)组成，分为**Eureka Server**和**Eureka Client**，Eureka Client包括两个服务模块**Service Provider**（服务提供方）和**Service Consumer**（服务消费方）。

*  Eureka Server 提供服务注册和发现
 *  Service Provider 服务提供方，将自身服务注册到Eureka，从而使服务消费方能够找到
 *  Service Consumer服务消费方，从Eureka获取注册服务列表，从而能够消费服务

从下图很好理解Eureka的工作流程：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16_pic_left]

## 二、代码示例 ##

### 1.部署Eureka Server ###

代码目录结构直接沿用之前springboot，稍作修改（[新建模块参考][Link 1]）

模块eureka-server  
![在这里插入图片描述][71563dc1d34d44d08bae959a364a3a76.png]  
1.pom.xml

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <groupId>com.local.springboot.eureka</groupId>
        <artifactId>eureka-server</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>eureka-server</name>
        <description>eureka 注册中心</description>
    
        
        <parent>
            <groupId>com.local.springboot</groupId>
            <artifactId>springcloud-parent</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </parent>
    
        <dependencies>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
            </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>
    
    </project>

父模块中统一管理版本

这里需要注意SpringBoot 和 SpringCloud 的版本对应，参考[官网][Link 2]  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16]  
2.配置文件有两种: .properties和 .yml 两种文件，可以任务选一种，这里使用properties文件。

server.port=8080
    eureka.instance.hostname=localhost
    eureka.client.register-with-eureka=false
    eureka.client.fetch-registry=false
    eureka.client.serviceUrl.defaultZone=http://${eureka.instance.hostname}:${server.port}/eureka/

3.启动类  
通过@EnableEurekaServer来标识该服务为Eureka Server。

@EnableDiscoveryClient
    @SpringBootApplication
    public class EurekaServerApplication {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(EurekaServerApplication.class, args);
        }
    
    }

启动程序，访问http://localhost:8080/  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16 1]

注册中心启动成功，可以看到此时并没有服务

### 2.部署Eureka Client ###

Eureka Client和Eureka Server目录类似，不同的是：

*  启动类，使用@EnableDiscoveryClient 标识该服务为Euraka Client
 *  Euraka Client配置文件，需要指定Euraka Server地址和当前服务注册时的名称。

#### 2.1部署 Servcie Provider ####

1.pom.xml

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <groupId>com.local.springboot.client</groupId>
        <artifactId>client-provider</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>client-provider</name>
        <description>Demo project for Spring Boot</description>
    
        
        <parent>
            <groupId>com.local.springboot</groupId>
            <artifactId>springcloud-parent</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </parent>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </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>
    
    </project>

2.配置文件

server.port=8081
    #服务名
    spring.application.name=client-provider-server
    #Euraka Server地址
    eureka.client.serviceUrl.defaultZone=http://localhost:8080/eureka/

3.启动类

@EnableDiscoveryClient
    @SpringBootApplication
    public class ClientProviderApplication {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(ClientProviderApplication.class, args);
        }
    
    }

4.代码示例

package com.local.springboot.client.clientprovider.controller;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class ProviderController {
        
    
        @RequestMapping("/provider")
        public String provider() {
        
            return "我是服务提供者";
        }
    }

启动服务，成功在注册中心注册成功，可以对外提供服务。  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16 2]

#### 2.2部署 Servcie Customer ####

工程目录和Servie Provider一样的。这里就不多写了  
Service Customer只是从Eureka Serve中获取注册服务的地址信息

通过RestTemplate来实现对CLIENT-PROVIDER-SERVER服务提供的/provider 接口调用

@Configuration
    public class RestTemplateConfig {
        
        @Bean
        @LoadBalanced
        public RestTemplate restTemplate(RestTemplateBuilder builder) {
        
            return builder.build();
        }
    }

package com.local.springboot.client.clientcustomer.controller;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.cloud.client.ServiceInstance;
    import org.springframework.cloud.client.discovery.DiscoveryClient;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.web.client.RestTemplate;
    
    import javax.annotation.Resource;
    import java.util.List;
    
    @RestController
    @SuppressWarnings("all")
    public class CustomerController {
        
        @Autowired
        private DiscoveryClient discoveryClient;
    
        @Resource
        private RestTemplate restTemplate;
    
        @RequestMapping("/query")
        public String query() {
        
            List<ServiceInstance> instances = discoveryClient.getInstances("client-provider-server");
            StringBuilder urls = new StringBuilder();
    //        for (ServiceInstance instance : instances) {
        
    //            urls.append(instance.getHost() + ":" + instance.getPort()).append(",");
    //        }
            // 没有集群，只有一个
            ServiceInstance instance = instances.get(0);
            // 使用restTemplate发起请求
            String result = restTemplate.getForEntity("http://CLIENT-PROVIDER-SERVER/provider", String.class).getBody();
            return result;
        }
    
        @RequestMapping("/queryService")
        public String queryService() {
        
            List<ServiceInstance> instances = discoveryClient.getInstances("client-provider-server");
            StringBuilder urls = new StringBuilder();
            for (ServiceInstance instance : instances) {
        
                urls.append(instance.getHost() + ":" + instance.getPort()).append(",");
            }
            return urls.toString();
        }
    }

**注意：这里访问的地址是服务名：CLIENT-PROVIDER-SERVER，而不是一个IP地址。**

通过访问http://localhost:8082/query发起GET请求，成功返回信息  
![在这里插入图片描述][3f9caf2fd5394f2babee62c26e67dea2.png]

## 三、Eureka部署服务 ##

### 1.健康检查——自我保护机制 ###

1、自我保护模式  
保护模式，是Eureka 提供的一个特性，在默认的情况下，这个属性是打开的，而且也建议线上都使用这个特性。

如果Eureka Server在一定时间内没有接收到某个微服务实例的心跳，Eureka Server将会注销该实例（默认90秒）。但是当网络分区故障发生时，微服务与Eureka Server之间无法正常通信，此时会触发Eureka Server进入保护模式，进入自我保护模式后，将会保护服务注册表中的信息，不再删除服务注册表中的数据。

比如，现在将CLIENT-PROVIDER-SERVER服务停掉，Eureka Client进入了保护模式，就会出现下图警告信息，但实例依旧显示为UP  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16 3]  
4、相关属性设置  
(1) Eureka Server端  
默认情况下自我保护机制是打开的，线上建议都是打开的，即不需要设置。如果在测试环境需要设置为关闭，可以通过如下配置：

#设为false，关闭自我保护
    eureka.server.enable-self-preservation=false
    #清理间隔（单位毫秒，默认是60*1000）
    eureka.server.eviction-interval-timer-in-ms=10000

(2) Eureka Client端

#健康检查（需要spring-boot-starter-actuator依赖）
    eureka.client.healthcheck.enabled=true
    # 单位是秒，默认30秒。此客户端发送心跳的频率
    eureka.instance.lease-renewal-interval-in-seconds=30
    # 单位是秒，默认90秒，表示eureka server在收到此client上次心跳之后，间隔多久没有收到，就摘除此服务。
    eureka.instance.lease-expiration-duration-in-seconds=10

启动测试，注册中心将死去的服务剔除  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16 4]

### 2.actuator ###

**1、下线**  
使用actuator由客户端发起下线。调用客户端actuator提供的/shutdown/接口。执行完此操作之后，不仅停止了服务，还从eureka下线了。

actuator依赖

<dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

配置文件

#启用shutdown
    management.endpoint.shutdown.enabled=true
    #禁用密码验证
    management.endpoint.shutdown.sensitive=false
    #开启所有的端点
    management.endpoints.web.exposure.include=*

![在这里插入图片描述][8f4e649ad5224de58d54d205dced90fa.png]  
通过POST方式执行实例的http://localhost:8081/actuator/shutdown。在postman执行结果如下：  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_19_color_FFFFFF_t_70_g_se_x_16]  
![在这里插入图片描述][0f9a3e55cf8e40edb161ba27b9b00777.png]  
**2、 恢复上线**  
此种方式下对应上线操作，就是重新部署。

[»][Link 3] 下一章：[SpringCloud入门 ——Feign服务调用][Link 3]

[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16_pic_left]: https://img-blog.csdnimg.cn/925c38a0d1964cfcbf7ca3834cac2c7c.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBALueMq-eahOagkQ==,size_20,color_FFFFFF,t_70,g_se,x_16#pic_left
[Link 1]: https://blog.csdn.net/qq_34383510/article/details/120790064
[71563dc1d34d44d08bae959a364a3a76.png]: https://img-blog.csdnimg.cn/71563dc1d34d44d08bae959a364a3a76.png
[Link 2]: https://spring.io/projects/spring-cloud
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/9ae69fccd3214ea18e6fcbbe6506f0e6.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBALueMq-eahOagkQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/e9bf2d254e2240ebba41ef4325cd6141.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBALueMq-eahOagkQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16 2]: https://img-blog.csdnimg.cn/317a9884f3dd4c00bb84733de65f5e18.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBALueMq-eahOagkQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[3f9caf2fd5394f2babee62c26e67dea2.png]: https://img-blog.csdnimg.cn/3f9caf2fd5394f2babee62c26e67dea2.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16 3]: https://img-blog.csdnimg.cn/0b922434d04e4604a6b35ed3cf7afc3c.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBALueMq-eahOagkQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_20_color_FFFFFF_t_70_g_se_x_16 4]: https://img-blog.csdnimg.cn/d63f3f638a844e5d9d92253e49095166.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBALueMq-eahOagkQ==,size_20,color_FFFFFF,t_70,g_se,x_16
[8f4e649ad5224de58d54d205dced90fa.png]: https://img-blog.csdnimg.cn/8f4e649ad5224de58d54d205dced90fa.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBALueMq-eahOagkQ_size_19_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/971659b2c2434d31ade51a7f0283dc8b.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBALueMq-eahOagkQ==,size_19,color_FFFFFF,t_70,g_se,x_16
[0f9a3e55cf8e40edb161ba27b9b00777.png]: https://img-blog.csdnimg.cn/0f9a3e55cf8e40edb161ba27b9b00777.png
[Link 3]: https://blog.csdn.net/qq_34383510/article/details/120889091