SpringCloud升级之路2020.0.x版-6.微服务特性相关的依赖说明

这是我参与8月更文挑战的第8天

本系列代码地址：github.com/HashZhang/s…

spring-cloud-common 不再是一个纯依赖的项目，这个模块包括：

spring-framework-common 的依赖
同步与异步微服务公共的依赖
同步与异步微服务公共的框架代码改造，这个我们后面分析框架以及我们设计的修改的时候，会详细分析，这里先跳过

同步与异步微服务公共的依赖包括：

代码请参考：github.com/HashZhang/s…

1.启用 Spring Cloud 的 Bootstrap Context：在 Spring Cloud 2020.0.x 版本开始，Bootstrap Context 默认不再启用。我们的项目，某些模块使用了 spring-cloud-config，这个是需要启用 Bootstrap Context 的。同时，我们的配置，还通过 bootstrap.yml 与 application.yml 区分了不同配置，如果多环境中配置是一样并且基本不会动态更改的则放入 bootstrap.yml，不同环境不同或者可能动态修改则放入 application.yml。所以通过加入如下依赖来启用：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>

这个底层实现非常简单，是否启用 Bootstrap Context 是通过检查这个依赖中的 Marker 类是否存在而决定的。参考代码：

PropertyUtils.java：

/**
 * Property name for bootstrap marker class name.
 */
public static final String MARKER_CLASS = "org.springframework.cloud.bootstrap.marker.Marker";

/**
 * Boolean if bootstrap marker class exists.
 */
public static final boolean MARKER_CLASS_EXISTS = ClassUtils.isPresent(MARKER_CLASS, null);

2.使用 Eureka 作为注册中心，我们需要添加 Eureka 的客户端依赖：

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

3.不使用 Ribbon，使用 Spring Cloud LoadBalancer 作为我们的负载均衡器：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-loadbalancer</artifactId>
</dependency>

4.使用 resilience4j 作为重试、断路、限并发、限流的组件基础：

<dependency>
    <groupId>io.github.resilience4j</groupId>
    <artifactId>resilience4j-spring-cloud2</artifactId>
</dependency>

5.暴露 actuator 相关端口

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

6.使用 prometheus 进行指标监控采集

<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
</dependency>

spring-cloud-webmvc 是针对基于同步 spring-mvc 的微服务的依赖，同样的，spring-cloud-webmvc 也包含同步微服务公共的框架代码改造，这个我们后面分析框架以及我们设计的修改的时候，会详细分析，这里先跳过。我们这里先只说明依赖：

代码请参考：github.com/HashZhang/s…

1.spring-cloud-common 的依赖：之前提到过 spring-cloud-common 是 spring-cloud-webmvc 与 spring-cloud-webflux 的公共依赖。

2.使用 undertow 作为我们的 web 容器：web-mvc 默认的容器是 tomcat，需要排除这个依赖，并添加 undertow 相关依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-undertow</artifactId>
</dependency>

3.使用 webflux 相关异步接口，某些微服务主要基于同步接口，但有一些特殊的接口使用的异步响应式实现，这个并不会发生冲突，所以在这里我们也添加了 web-flux 依赖。

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

4.使用 OpenFeign 作为同步微服务调用客户端，OpenFeign 目前主要还是作为同步客户端使用，虽然目前也有异步实现，但是功能与粘合代码还不完整，异步的我们还是会使用 WebClient。

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

5.粘合 OpenFeign 与 resilience4j 的代码依赖，官方提供了 OpenFeign 与 resilience4j 粘合代码，请参考：resilience4j-feign。我们会在此基础上做一些个性化改造，后面我们会详细分析。

<dependency>
    <groupId>io.github.resilience4j</groupId>
    <artifactId>resilience4j-feign</artifactId>
</dependency>

spring-cloud-webmvc 是针对基于异步响应式 spring-webflux 的微服务的依赖，同样的，spring-cloud-webflux 也包含异步微服务公共的框架代码改造，这个我们后面分析框架以及我们设计的修改的时候，会详细分析，这里先跳过。我们这里先只说明依赖：

代码请参考：github.com/HashZhang/s…

1.spring-cloud-common 的依赖：之前提到过 spring-cloud-common 是 spring-cloud-webmvc 与 spring-cloud-webflux 的公共依赖。

2.使用 webflux 作为我们的 web 容器，这里我们不需要额外 web 容器。

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

3.粘合 project-reactor 与 resilience4j，这个在异步场景经常会用到，请参考：resilience4j-reactor

<dependency>
    <groupId>io.github.resilience4j</groupId>
    <artifactId>resilience4j-reactor</artifactId>
</dependency>

本小节我们分析了我们项目中的微服务公共依赖以及基于 web-mvc 同步的微服务依赖和基于 web-flux 异步的微服务依赖。下一节我们将从一些 Spring 基础开始，逐步深入分析我们的 Spring Cloud 框架。

微信搜索“我的编程喵”关注公众号，每日一刷，轻松提升技术，斩获各种offer：