一文入门Spring Cloud (Greenwich版本)_spring-cloud greenmich

github: https://github.com/ZhangDi-d/SpringCloudSample

本文包含springcloud 服务注册发现Eureka Consul,服务调用Feign Ribbon,限流熔断Hystrix,分布式配置中心Config,服务网关Zuul,消息驱动 Stream,服务追踪Sleuth 等

SpringCloudSample

A simple project of springcloud self-learning.

一.服务注册与发现

Eureka server

1. 引入依赖

<!--加入的 spring-cloud-starter-eureka-server 会自动引入 spring-boot-starter-web -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
    </dependency>

1
2
3
4
5
6

2. 注解 @EnableEurekaServer

3. application.yml配置问题

如果euraka是单机部署,可使用以下配置:

server:
  port: 8761
eureka:
  instance:
    hostname: localhost
  client:
    registerWithEureka: false #是否将自己注册到Eureka服务器,(因为自己是服务器:false)
    fetchRegistry: false #是否到Eureka服务器中拉取注册信息,(因为自己是服务器:false,这两项如果不写,启动会报错)
    serviceUrl:
      defaultZone: http://${
   eureka.instance.hostname}:${
   server.port}/eureka/

spring:
  application:
    name: eureka-server

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

如果是集群部署,需要将自己注册到其他的eurakaserver 上,所以配置为:
(假设三台eureka server 的ip分别为 127.0.0.1 ,127.0.0.2 ,127.0.0.3,端口为 8761,其他两台同理)

server:
  port: 8761
eureka:
  instance:
    prefer-ip-address: true
    instance-id: eureka-127.0.0.1
  client:
    registerWithEureka: true #是否将自己注册到Eureka服务器
    fetchRegistry: true #是否到Eureka服务器中拉取注册信息
    serviceUrl:
      defaultZone: http://127.0.0.2:8761/eureka/,http://127.0.0.3:8761/eureka/

spring:
  application:
    name: eureka-server
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

服务提供者 ,以service-hello为例

1. pom.xml配置

<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-web</artifactId>
        </dependency>
    </dependencies>
1
2
3
4
5
6
7
8
9
10

2. @EnableEurekaClient 或者 @EnableDiscoveryClient

3. application.yzmdl

server:
  port: 8762

spring:
  application:
    name: service-hello #服务与服务之间相互调用一般都是根据这个name

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
1
2
3
4
5
6
7
8
9
10
11

3.2 添加 以下注解属性的好处是 服务以ip:port展示,

instance:
    prefer-ip-address: true
    instance-id: ${
   spring.cloud.client.ipAddress}:${
   server.port}
1
2
3
4
5

未添加:

添加 instance: 注解:

3.3 集群 配置:

server:
  port: 8762

spring:
  application:
    name: service-hello #服务与服务之间相互调用一般都是根据这个name

eureka:
  client:
    serviceUrl:
      defaultZone: http://127.0.0.1:8761/eureka/,http://127.0.0.2:8761/eureka/,http://127.0.0.3:8761/eureka/
  instance:
    prefer-ip-address: true
    instance-id: {
   spring.cloud.client.ipAddress}:${
   server.port}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

Consul

配合consul 注册中心使用,consul 下载和使用: https://blog.csdn.net/ShelleyLittlehero/article/details/104391744

二.服务消费的两种方式

1.RestTemplate+Ribbon
2.Feign去消费服务

Ribbon 客户端负载均衡

1. pom.xml

<dependencies>
        <!--作为服务被euraka发现-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!--spring mvc-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--客户端负载均衡组件依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
        </dependency>
        <!--在ribbon使用断路器的依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
        </dependency>

    </dependencies>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

2. application.yml

spring:
  application:
    name: service-ribbon
server:
  port: 8764
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
1
2
3
4
5
6
7
8
9

3.注解

@EnableDiscoveryClient -> 通过@EnableDiscoveryClient向服务中心注册

@EnableHystrix -> 开启Hystrix

@LoadBalanced ->开启客户端负载均衡功能

4. 测试

1.启动 euraka-server -> EurekaServerApplication;

2.启动 service-ribbon -> ServiceRibbonApplication;

3.以 8762 端口 启动 service-hello -> ServiceHelloApplication;

4.以 8763 端口 启动 service-hello -> ServiceHelloApplication;

5.调用service-ribbon 的 接口 http://localhost:8764/hello?name=zhangsan, service-ribbon会使用restTemplate调用 service-hello

Spring Cloud Feign 声明式服务调用

Feign是一个声明式的伪Http客户端，它使得写Http客户端变得更简单。使用Feign，只需要创建一个接口并注解。它具有可插拔的注解特性，可使用Feign 注解和JAX-RS注解。Feign支持可插拔的编码器和解码器。Feign默认集成了Ribbon，并和Eureka结合，默认实现了负载均衡的效果。

简而言之：
1.Feign 采用的是基于接口的注解
2.Feign 整合了ribbon，具有负载均衡的能力
3.整合了Hystrix，具有熔断的能力
1
2
3
4

1. pom.xml

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
</dependencies>
1
2
3
4
5
6
7
8
9
10
11
12
13
14

2. application.yml

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
server:
  port: 8765
spring:
  application:
    name: service-feign

#Feign是自带断路器的，在D版本的Spring Cloud之后，它没有默认打开
# feign.hystrix.enabled: true  或者下面的写法
feign:
  hystrix:
    enabled: true

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

3.注解

@EnableDiscoveryClient ->作为服务被发现

@EnableFeignClients -> 开启Feign的功能

@FeignClient(value = “service-hello”,fallback = SchedualServiceHelloHystric.class) ->指定调用哪个服务下的接口,并加上 fallback 容错

4. 测试

1.启动 euraka-server -> EurekaServerApplication;

2.启动 service-feign -> ServiceFeignApplication;

3. 启动 service-hello -> ServiceHelloApplication;

4.调用 http://localhost:8765/hello?name=zhangsan, 查看是否可以调通service-hello

Feign 文件上传

在Spring Cloud封装的Feign中并不直接支持传文件，但可以通过引入Feign的扩展包来实现

1.service-hello 作为上传服务的提供方,只需添加上传文件的接口即可

UploadProviderController.java
1

2. service-feign 作为服务的消费方,调用service-hello接口到达上传文件的目的

注意 : pom.xml中要新增feign-form 和feign-form-spring 的依赖,并且他们的版本和Feign的版本一定要对应,不然会报错

<dependency>
            <groupId>io.github.openfeign.form</groupId>
            <artifactId>feign-form</artifactId>
            <version>3.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.github.openfeign.form</groupId>
            <artifactId>feign-form-spring</artifactId>
            <version>3.8.0</version>
        </dependency>
        <dependency>
            <groupId>commons-fileupload</groupId>
            <artifactId>commons-fileupload</artifactId>
            <version>1.3.3</version>
        </dependency>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

版本对应问题:

The feign-form extension depend on OpenFeign and its concrete versions:

1. all feign-form releases before 3.5.0 works with OpenFeign 9.* versions;
2. starting from feign-form's version 3.5.0, the module works with OpenFeign 10.1.0 versions and greater.

IMPORTANT: there is no backward compatibility and no any gurantee that the feign-form's versions after 3.5.0work with OpenFeign before 10.*. OpenFeign was refactored in 10th release, so the best approach - use the freshest OpenFeign and feign-form versions.
1
2
3
4
5
6

3. 增加@Configuration 配置

@Configuration
public class FeignSupportConfig {
   
    @Bean
    public Encoder feignFormEncoder() {
   
        return new SpringFormEncoder();
    }
}
1
2
3
4
5
6
7
8
9

4. 在@FeignClient 注解中指定

@FeignClient(value = "service-hello", fallback = FeignServiceHelloHystric.class,configuration = FeignSupportConfig.class)
1

5. 启动eureka-server ,service-hello ,service-feign ,使用postman测试即可

6. 使用idea 自带的接口测试工具 测试

更多可以参考:https://blog.csdn.net/u012954706/article/details/89383076

POST http://localhost:8765/uploadFile
Accept: */*
Cache-Control: no-cache
Content-Type: multipart/form-data; boundary=WebAppBoundary

--WebAppBoundary
Content-Disposition: form-data; name="file"; filename="D:\back\1.txt"

1
2
3
4
5
6
7
8
9

四.Spring Cloud Config 分布式配置中心

Spring Cloud Config 分布式配置中心 由两部分组成 config-server 和config-client.

config-server 基于Git仓库的配置中心

1. config-server

访问配置信息的URL与配置文件的映射关系如下：

• /{application}/{profile}[/{label}]

• /{application}-{profile}.yml

• /{label}/{application}-{profile}.yml

• /{application}-{profile}.properties

• /{label}/{application}-{profile}.properties

2. config-server pom.xml

 <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-config-server</artifactId>
</dependency>
1
2
3
4

3. config-server application.yml

https://gitee.com/xuelaiLittleHero/config-repo-demo 是远程配置文件仓库的地址.

spring:
  application:
    name: config-server
  cloud:
    config:
      server:
        git:
          uri: https://gitee.com/xuelaiLittleHero/config-repo-demo
          searchPaths: config
#          username:
#          password:
server:
  port: 8766
1
2
3
4
5
6
7
8
9
10
11
12
13

4. 配置server 的启动类 ,并加注解 @EnableConfigServer, 开启Spring Cloud Config的服务端功能

config-client 使用配置中心的客户端

1.pom.xml

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>
1
2
3
4
5
6
7
8
9

2. bootstrap.yml (使用配置服务的客户端,配置文件应为 bootstrap.xml或者 bootstrap.properties ,他的加载早于 application.yml)

spring:
  application:
    name: config-client
  cloud:
    config:
      uri: http://localhost:8766/
      profile: dev
      label: master
1
2
3
4
5
6
7
8

涉及到使用配置服务的配置要存放于bootstrap.xml或者 bootstrap.properties,这样才能保证config-server中的配置信息才能被正确加载

3. 测试 ,使用接口 http://localhost:8767/getInfo 测试配置是否能被拿到 .

分布式配置中心（加密解密,以对称加密为例）

1.下载配置JCE

地址 :http://download.oracle.com/otn-pub/java/jce/8/jce_policy-8.zip
配置到 jdk 目录中 .

2. 配置 加密 key

config-server bootstrap.yml 配置对称加密的key

encrypt:
  key: ryze
1
2

3. 加密

启动config-server, 访问 http://localhost:8766/encrypt/status ，显示状态OK。
使用 curl 访问 /encrypt 端点进行加密, 获得属性 pa2sW0rd 加密后的值 ,配置在 远程git 仓库的配置文件中

C:\Users\张 迪>curl http://localhost:8766/encrypt/ -d pa2sW0rd

9ae2d08f248ab77561cbea8fe88566b7665f8ad65527e7757dcf1cd3bffe1aae
1
2
3

git 仓库配置文件 config-client-dev.yml
**一定注意 当配置文件是yml格式的时候 ,使用 {cipher}要加单引号,因为yml格式严格,不加’'无法解析 **

info:
  profile: dev
  from: config/dev
  secretValue: '{cipher}9ae2d08f248ab77561cbea8fe88566b7665f8ad65527e7757dcf1cd3bffe1aae'
1
2
3
4

4. 测试

验证config client 是否可以获取到正确的加密值:
http://localhost:8767/getInfo -> 输出 InfoController getInfo===============>profile=dev,from=config/dev,secretValue=pa2sW0rd,ok.

spring cloud config 高可用与动态刷新

高可用

config server 的高可用,可以使用集群部署 config server ,让他们指向同一个 git配置文件库, 然后使用 负载均衡 ,config client 动态的去 指定 config server.
另一种更为简单的做法是,将集群部署的config server 也注册为服务,供eureka 发现. 这样config client可以 以服务的方式去访问 config server.

1. config server pom.xml

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

1
2
3
4
5

2. config server application.yml

增加 eureka 地址 :

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
1
2
3
4

eureka 的配置最好放在最后,不要放在 git 和 spring 之间 ,不要想下面这样: 这样 spring会认为git 是配置在 eureka下的,启动会报错

spring:
  application:
    name: config-server
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
  cloud:
    config:
      server:
        git:
          uri: https://gitee.com/xuelaiLittleHero/config-repo-demo
          searchPaths: config
#          username:
#          password:

server:
  port: 8766



1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

3. config server @EnableDiscoveryClient

在启动类上 增加注解 @EnableDiscoveryClient ->注册为服务 ,供euraka发现

4. config client pom.xml

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

1
2
3
4
5

5. config client bootstrap.yml

bootstrap.yml 做以下修改 : 注释 之前config-client 直连 config-server 的配置 ;

增加 config-client 通过 服务注册与发现 调用 config-server 的配置.

  ## 注意 :  当 config client 不直接访问 config server 时 ,这段配置就需要注释掉了
#  cloud:
#    config:
#      uri: http://localhost:8766/
#      profile: dev
#      label: master
 ## 注意  config client 以服务的方式 访问 config server 时 ,要增加 eureka 的配置 和 config 的相关配置
  cloud:
1
2
3
4
5
6
7