SpringCloud实现一个微服务系统

r囧r小猫 2021-09-08 13:42 334阅读 0赞

Spring Cloud 是一系列框架的有序集合。它利用 Spring Boot 的开发便利性巧妙地简化了分布式系统基础设施的开发，如服务发现注册、配置中心、消息总线、负载均衡、断路器、数据监控等，都可以用 Spring Boot 的开发风格做到一键启动和部署。

# 1、服务中心 #

一个完整的微服务系统需要用“服务中心”来统一治理服务。“服务中心”又称作“注册中心”或“服务治理框架”，其主要功能包括服务的注册、服务的发现等。本实例使用 Consul 框架来实现服务治理。

Consul 是由 HashiCorp 公司推出的一款开源工具，是实现服务治理的杰出项目，用于实现分布式系统的服务发现与服务配置。它内置了服务注册与发现框架、分布一致性协议实现、健康检查、Key-Value 存储、多数据中心方案。Consul 使用 GO 语言编写，因此天然具有可移植性（支持 Linux、Windows 和 Mac OS X）。其安装包仅包含一个可执行文件，方便部署，可与 Docker 等轻量级容器无缝配合。

> **Consul 的安装与启动：**[《Consul在Windows系统下的安装与启动》][Consul_Windows]

# 2、服务提供者 #

创建“服务提供者”并将其注册到“服务中心”以便“服务消费者”调用。

> **创建SpringCloud项目步骤：**[《IDEA创建SpringCloud项目》][IDEA_SpringCloud]

## 2.1 使用 Consul 实现“服务提供者” ##

**（1）创建项目**

创建 Spring Cloud 项目“服务提供者”，项目名称：Provider，项目结构如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70][]

**（2）添加依赖**

使用Maven添加依赖文件，在 pom.xml 文件中，添加需要的依赖：

<dependency>
    	<groupId>org.springframework.cloud</groupId>
    	<artifactId>spring-cloud-starter-consul-discovery</artifactId>
    </dependency>
    
    
    <dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    
    
    <dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-web</artifactId>
    </dependency>

完整的 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>
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>2.5.1</version>
    		<relativePath/> 
    	</parent>
    	<groupId>com.pjb</groupId>
    	<artifactId>provider</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>Provider</name>
    	<description>Demo project for Spring Boot</description>
    	<properties>
    		<java.version>11</java.version>
    		<spring-cloud.version>2020.0.3</spring-cloud.version>
    	</properties>
    	<dependencies>
    
    		
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-consul-discovery</artifactId>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-actuator</artifactId>
    		</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>

**（3）添加配置**

实现“服务提供者”集群，创建多环境配置。

创建 application-provider1.properties 配置文件：

spring.application.name=Provider
    server.port=8504
    #Consul 的地址和端口号默认是：localhost:8500
    spring.cloud.consul.host=localhost
    spring.cloud.consul.port=8500
    #注册到 Consul 的服务名称
    spring.cloud.consul.discovery.service-name=service-provider
    provider.name=p1

创建 application-provider2.properties 配置文件：

spring.application.name=Provider
    server.port=8505
    #Consul 的地址和端口号默认是：localhost:8500
    spring.cloud.consul.host=localhost
    spring.cloud.consul.port=8500
    #注册到 Consul 的服务名称
    spring.cloud.consul.discovery.service-name=service-provider
    provider.name=p2

**（4）启动注册和发现**

在启动类中添加注解 @EnableDiscoveryClient，以启用服务的注册和发现功能。

package com.pjb;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    
    //SpringBoot应用程序的入口类
    @SpringBootApplication
    //启用客户端的服务注册和发现功能
    @EnableDiscoveryClient
    public class ProviderApplication
    {
    	public static void main(String[] args)
    	{
    		SpringApplication.run(ProviderApplication.class, args);
    	}
    }

## 2.2 打包和部署“服务提供者” ##

**（1）打包成可执行的 JAR 包**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 1][]

**（2）部署“服务提供者”集群**

开启2个“cmd”命令窗口，并输入命令，进入 JAR 包目录，如：

# 进入E盘
    e:
    
    # 进入 JAR 包目录
    cd E:\MyTempProj06\SpringCloudDemo\Provider\target\

启动“服务提供者”客户端1，命令如下：

# 以 provider1 的配置信息启动“服务提供者”客户端
    java -jar  provider-0.0.1-SNAPSHOT.jar --spring.profiles.active=provider1

启动“服务提供者”客户端2，命令如下：

# 以 provider2 的配置信息启动“服务提供者”客户端
    java -jar  provider-0.0.1-SNAPSHOT.jar --spring.profiles.active=provider2

**启动结果：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 2][]

访问 [http://127.0.0.1:8500][http_127.0.0.1_8500] 即可进入 Consul 的管理界面，查看服务注册与发现结果。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 3][]

# 3、服务消费者 #

Spring Cloud 的“服务消费者”功能可以用 RestTemplate 客户端实现外，还可以用 Feign 客户端实现。Feign 是一个声明式的 Web Service 客户端，它使得编写 Web Service 客户端变的容易。

## 3.1 使用 Feign 实现“服务消费者”的客户端 ##

**（1）创建项目**

创建 Spring Cloud 项目“服务消费者”，项目名称：Consumer，项目结构如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 4][]

**（2）添加依赖**

使用Maven添加依赖文件，在 pom.xml 文件中，添加需要的依赖：

<dependency>
    	<groupId>org.springframework.cloud</groupId>
    	<artifactId>spring-cloud-starter-consul-discovery</artifactId>
    </dependency>
    
    
    <dependency>
    	<groupId>org.springframework.cloud</groupId>
    	<artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
    
    
    <dependency>
    	<groupId>org.springframework.boot</groupId>
    	<artifactId>spring-boot-starter-web</artifactId>
    </dependency>

完整的 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>
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>2.5.1</version>
    		<relativePath/> 
    	</parent>
    	<groupId>com.pjb</groupId>
    	<artifactId>consumer</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>Consumer</name>
    	<description>Demo project for Spring Boot</description>
    	<properties>
    		<java.version>11</java.version>
    		<spring-cloud.version>2020.0.3</spring-cloud.version>
    	</properties>
    	<dependencies>
    
    		
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-consul-discovery</artifactId>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>org.springframework.cloud</groupId>
    			<artifactId>spring-cloud-starter-openfeign</artifactId>
    		</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>

**（3）添加配置**

项目中的 application.properties 文件，添加配置：

spring.application.name=consul-consumer
    server.port=8506
    #Consul 的地址和端口号默认是：localhost:8500
    spring.cloud.consul.host=localhost
    spring.cloud.consul.port=8500
    #因为不提供服务，所以不需要注册到 Consul 中
    spring.cloud.consul.discovery.register=false

## 3.2 调用“服务提供者”的接口 ##

**（1）启用客户端的发现和远程调用**

在启动类中，添加注解 @EnableDiscoveryClient 以启用客户端的服务注册和发现功能，添加注解 @EnableFeignClients 以启用 Feign 的远程服务调用。

package com.pjb;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    import org.springframework.cloud.openfeign.EnableFeignClients;
    
    //SpringBoot应用程序的入口类
    @SpringBootApplication
    //启用客户端的服务注册和发现功能
    @EnableDiscoveryClient
    //启用Feign的远程服务调用
    @EnableFeignClients
    public class ConsumerApplication
    {
    	public static void main(String[] args)
    	{
    		SpringApplication.run(ConsumerApplication.class, args);
    	}
    }

**（2）调用“服务提供者”的接口**

在 com.pjb.service 包中，创建 MyFeignService 接口，实现调用“服务提供者”的接口。

package com.pjb.service;
    
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.stereotype.Service;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    /**
     * Feign服务
     * @author pan_junbiao
     **/
    @Service
    @FeignClient(contextId = "feignService",name = "service-provider")
    public interface MyFeignService
    {
        @RequestMapping(value = "/hello")
        public String hello();
    }

> **注意：**注解 @FeignClient 中的 name 属性值是远程“服务提供者”的名字。

**（3）实现客户端接口**

接下来将实现的 MyFeignService 接口注入 Controller 层，以实现对该接口的调用。

package com.pjb.controller;
    
    import com.pjb.service.MyFeignService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * 消费者控制器
     * @author pan_junbiao
     **/
    @RestController
    @RequestMapping("consumer")
    public class HelloController
    {
        @Autowired
        MyFeignService myFeignService;
    
        @GetMapping("/hello")
        public String index()
        {
            return myFeignService.hello();
        }
    }

## 3.3 测试微服务系统 ##

（1）启动 Consul 服务，启动“服务提供者”集群，启动“服务消费者”客户端。

（2）在浏览器中输入地址：[http://127.0.0.1:8506/consumer/hello][http_127.0.0.1_8506_consumer_hello]

页面信息1：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 5][]

页面信息2：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 6][]

当我们多次访问上述地址，则会交替出现上面两个信息。因为 Feign 框架提供了“服务消费者”客户端的负载均衡功能。

[Consul_Windows]: https://blog.csdn.net/pan_junbiao/article/details/117587533
[IDEA_SpringCloud]: https://blog.csdn.net/pan_junbiao/article/details/118153674
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70]: /images/20210724/6e13a2a7e1914efcaa91cd0dbe4572b3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 1]: /images/20210724/58f94f7ffe6344f58509b270d58e7e7d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 2]: /images/20210724/1358a669188647b6a1592bfbe15e0316.png
[http_127.0.0.1_8500]: http://127.0.0.1:8500/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 3]: /images/20210724/7389878925c84de78ea85af43ce1f64d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 4]: /images/20210724/364809929e7c49bd9a1784ed86c638cd.png
[http_127.0.0.1_8506_consumer_hello]: http://127.0.0.1:8506/consumer/hello
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 5]: /images/20210724/3d9b3c3b9efe4d6d921d682fb53884ce.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 6]: /images/20210724/b438b31c0d6b4b5087a028da21864602.png