SpringCloud Alibaba 简介与微服务组件记录_springcloudalibaba框架

一， SpringCloud Alibaba 简介

1.1 简介

SpringCloud Alibaba 致力于提供微服务开发的一站式解决方案。此项目包含开发分布式应用微服务的必需组件，方便开发者通过 SpringCloud 编程模型轻松使用这些组件来开发分布式应用服务。 基于 SpringCloud Alibaba，你只需要添加一些注解和少量配置，就可以将 SpringCloud 应用接入阿里微服务解决方案，通过阿里中间件来迅速搭建分布式应用系统。网站：https://github.com/alibaba/spring-cloud-alibaba

1.2 为什么使用 ？

SpringCloud 的几大痛点：

1. SpringCloud 部分组件停止维护和更新，给开发带来不便。
2. SpringCloud 部分环境搭建复杂，没有完善的可视化界面，我们需要大量的二次开发和定制 。
3. SpringCloud 配置复杂，难以上手，部分配置差别难以区分和合理应用 。

SpringCloud Alibaba 的优势：
阿里使用过的组件经历了考验，性能强悍，设计合理，现在开源出来大家用 成套的产品搭配完善的可视化界面给开发运维带来极大的便利搭建简单，学习曲线低。

结合 SpringCloud Alibaba 我们最终的技术搭配方案：
SpringCloud Alibaba - Nacos：注册中心（服务发现/注册）
SpringCloud Alibaba - Nacos：配置中心（动态配置管理）
SpringCloud - Ribbon：负载均衡
SpringCloud - Feign：声明式 HTTP 客户端（调用远程服务）
SpringCloud Alibaba - Sentinel：服务容错（限流、降级、熔断）
SpringCloud - Gateway：API 网关（webflux 编程模式）
SpringCloud - Sleuth：调用链监控
SpringCloud Alibaba - Seata：原 Fescar，即分布式事务解决方案

1.3 版本选择 ( 建议参考官网 SpringBoot 和 SpringCloud)，避免后续因版本产生的问题

由于 Spring Boot 1 和 Spring Boot 2 在 Actuator 模块的接口和注解有很大的变更，且 spring-cloud-commons 从 1.x.x 版本升级到 2.0.0 版本也有较大的变更，因此我们采取跟 SpringBoot 版本号一致的版本:

1. 1.5.x 版本适用于 Spring Boot 1.5.x
2. 2.0.x 版本适用于 Spring Boot 2.0.x
3. 2.1.x 版本适用于 Spring Boot 2.1.x

二，SpringCloud Alibaba-Nacos 作为注册中心

Nacos 是阿里巴巴开源的一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。它是使用 Java 语言编写，需要依赖 Java 环境。Nacos 文档地址： https://nacos.io/zh-cn/docs/quick-start.htm

2.1 项目中的依赖

在 common 项目中引入如下依赖，进行统一管理

<!--服务注册/发现-->
<dependency>
   <groupId>com.alibaba.cloud</groupId>
   <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<dependencyManagement>
   <dependencies>
       <dependency>
           <groupId>com.alibaba.cloud</groupId>
           <artifactId>spring-cloud-alibaba-dependencies</artifactId>
           <version>2.1.1.RELEASE</version>
           <type>pom</type>
           <scope>import</scope>
      </dependency>
  </dependencies>
</dependencyManagement>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

2.2 下载 nacos-server

地址：https://github.com/alibaba/nacos/releases

2.3 启动 nacos-server

双击 bin 中的 startup.cmd 文件 -> 访问 http://localhost:8848/nacos/ ->使用默认的 nacos/nacos 进行登录。

2.4 将微服务注册到 nacos 中

1、首先修改 pom.xml 文件，引入 Nacos Discovery Starter

<dependency> 
   <groupId>com.alibaba.cloud</groupId> 
   <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> 
</dependency>
1
2
3
4

2、在应用的 /src/main/resources/application.properties 配置文件中配置 Nacos Server 地址

spring.application.name=gulimall-coupon
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
1
2

3、使用 @EnableDiscoveryClient 开启服务注册发现功能

@SpringBootApplication
@EnableDiscoveryClient
@MapperScan("com.atguigu.gulimall.coupon.dao")
public class GulimallCouponApplication {

    public static void main(String[] args) {
        SpringApplication.run(GulimallCouponApplication.class, args);
    }

}
1
2
3
4
5
6
7
8
9
10

4、启动应用，观察 nacos 服务列表是否已经注册上服务
注意：每一个应用都应该有名字，这样才能注册上去。修改 application.yml 文件

spring:
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848   
  application:
    name: gulimall-coupon        
1
2
3
4
5
6
7

同理将 gulimall-member 微服务也注册到 nacos 注册中心去。访问 nacos 地址后如下：

2.5 Nacos 作为注册中心总结

1、导包 nacos-discovery
2、写配置，指定 nacos 地址和应用的名字
3、开启服务注册发现功能 @EnableDiscoveryClient

三，SpringCloud Alibaba-OpenFeign 服务调用

3.1 OpenFeign简介

Feign 是一个声明式的 HTTP 客户端，它的目的就是让远程调用更加简单。Feign 提供了 HTTP 请求的模板，通过编写简单的接口和注解，就可以定义好 HTTP 请求的参数、格式、地址等信息。 Feign 整合了 Ribbon(负载均衡) 和 Hystrix(服务熔断)，可以让我们不再需要显式地使用这两个组件。 SpringCloud Feign 在 NetflixFeign 的基础上扩展了对 SpringMVC 注解的支持，在其实现下，我们只需创建一个接口并用注解的方式来配置它，即可完成对服务提供方的接口绑定。简化了SpringCloud Ribbon 自行封装服务调用客户端的开发量。

微服务众多，每个微服务相互隔离。但是微服务之间难免存在调用和通信，例如会员服务享有优惠卷服务，会员服务就会去调用优惠卷服务。基于这种现象使用 openfeign 组件可以解决微服务间远程调用的痛点。

3.2 注册更多的服务上去，测试使用 feign 远程调用

3.3 演示 gulimall-member 会员服务调用 gulimall-coupon 优惠卷服务

1、编写 gulimall-coupon 优惠卷服务的 CouponController

/**
 * @author huang.bx
 * @date 2021-11-23 11:09:11
 */
@RefreshScope
@RestController
@RequestMapping("coupon/coupon")
public class CouponController {
    @Autowired
    private CouponService couponService;

    @RequestMapping("/member/list")
    public R membercoupon(){
        CouponEntity coupon = new CouponEntity();
        coupon.setCouponName("满100减10");
        return R.ok().put("coupons",Arrays.asList(coupon));
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

2，新建一个包 feign，远程调用服务都放在这个包下

/*
 * 这是个声明式的远程调用
 * 指定服务名
 */
@FeignClient("gulimall-coupon")
public interface CouponFeignService {
    //完整请求路径
    @RequestMapping("/coupon/coupon/member/list")
    public R membercoupon();
}
1
2
3
4
5
6
7
8
9
10

/**
 * 1想要远程调用别的服务步骤
 *   1.1引入open-feign依赖包
 *   2.1编写一个接口,告诉spring-cloud这个接口需要调用远程服务
 *   2.2声明接口的每一个方法都是调用哪那个远程服务的哪个请求
 *   3.开启远程调用功能
*/
@EnableFeignClients(basePackages = "com.atguigu.gulimall.member.feign")
@SpringBootApplication
@EnableDiscoveryClient
public class GulimallMemberApplication {

    public static void main(String[] args) {
        SpringApplication.run(GulimallMemberApplication.class, args);
    }

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

3，测试

@RestController
@RequestMapping("member/member")
public class MemberController {
    @Autowired
    private MemberService memberService;

    @Autowired
    CouponFeignService couponFeignService;

    @RequestMapping("/coupons")
    public R test(){
        MemberEntity memberEntity = new MemberEntity();
        memberEntity.setNickname("张三");
        R membercoupons = couponFeignService.membercoupon();
        return R.ok().put("member",memberEntity).put("coupons",membercoupons.get("coupons"));
    }
}    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

4，测试结果

访问地址：http://localhost:8000/member/member/coupons 返回如下数据：

{
    "msg": "success",
    "code": 0,
    "coupons": [
        {
            "id": null,
            "couponType": null,
            "couponImg": null,
            "couponName": "满100减10",
            "num": null,
            "amount": null,
            "perLimit": null,
            "minPoint": null,
            "startTime": null,
            "endTime": null,
            "useType": null,
            "note": null,
            "publishCount": null,
            "useCount": null,
            "receiveCount": null,
            "enableStartTime": null,
            "enableEndTime": null,
            "code": null,
            "memberLevel": null,
            "publish": null
        }
    ],
    "member": {
        "id": null,
        "levelId": null,
        "username": null,
        "password": null,
        "nickname": "张三",
        "mobile": null,
        "email": null,
        "header": null,
        "gender": null,
        "birth": null,
        "city": null,
        "job": null,
        "sign": null,
        "sourceType": null,
        "integration": null,
        "growth": null,
        "status": null,
        "createTime": null
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

若 gulimall-coupon 没有启动则 nacos 注册中心找不到该服务就会调用失败，所以说微服务之间的相互调用前提是微服务都需要先注册到 nacos 注册中心。

四，SpringCloud Alibaba-Nacos 作为配置中心

4.1 背景

大项目拆分成多个微服务，各个微服务配置众多若每次都从代码中该则效率低下且开发环境，测试环境，生产环境用的配置可能不相同。基于这个痛点 Nacos 作为配置中心，方便管理配置，提高效率。

4.2 开发步骤

1、pom.xml 引入 Nacos Config Starter

 <!-- 配置中心来做配置管理-->
<dependency>
   <groupId>com.alibaba.cloud</groupId>
   <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
1
2
3
4
5

2、在应用的 /src/main/resources/bootstrap.properties 配置文件中配置 Nacos Config 元数据（配置信息写在bootstrap.properties 优先加载）

#nacos服务配置中心
spring.application.name=gulimall-member
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
1
2
3

3、在 nacos 中添加配置
在 nacos 中创建一个 应用名.properties 配置文件并编写配置。
Nacos Config 主要通过 dataId 和 group 来唯一确定一条配置。
Nacos Client 从 Nacos Server 端获取数据时，调用的是此接口 ConfigService.getConfig(String dataId, String group, long timeoutMs)。

Spring Cloud 应用获取数据 dataID： 在 Nacos Config Starter 中，dataId 的拼接格式如下：

 ${prefix} - ${spring.profiles.active} . ${file-extension} prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix 来配置。

 spring.profiles.active 即为当前环境对应的 profile 注意，当 activeprofile 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 $prefix.${file-extension}

file-extension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。 目前只支持 properties 类型。

Group： Group 默认为 DEFAULT_GROUP，可以通过 spring.cloud.nacos.config.group 配置。

4、在应用中使用 @Value 和 @RefreshScope
application.properties 下：

coupon.user.name=prod
coupon.user.age=20
1
2

@RefreshScope
@RestController
@RequestMapping("coupon/coupon")
public class CouponController {
    @Autowired
    private CouponService couponService;

    @Value("${coupon.user.name}")
    private String name;

    @Value("${coupon.user.age}")
    private Integer age;

    @RequestMapping("/test")
    public R test(){
       return R.ok().put("name",name).put("age",age);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

5，测试结果

6，Nacos 配置中心来管理配置

后点击发布，项目在运行期间可以动态修改配置信息（CouponController.java 上加@RefreshScope注解动态刷新配置），方便管理。

7，修改配置，点击发布

8，测试结果

4.3 Nacos 作为配置中心总结

1、如何使用 Nacos 作为配置中心统一管理配置
1)、引入依赖

  <!-- 配置中心来做配置管理-->
<dependency>
   <groupId>com.alibaba.cloud</groupId>
   <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
1
2
3
4
5

2)、创建一个bootstrap.properties

spring.application.name=gulimall-coupon
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
1
2

3)、需要给配置中心默认添加一个叫数据集(Data Id) gulimall-coupon.properties。默认规则，应用名.properties
4)、给应用名.properties 添加任何配置
5)、动态获取配置
@RefreshScope：动态获取并刷新配置
@Value(“${配置项的名}”)：获取到配置
如果配置中心和当前应用的配置文件中都配置了相同的项，优先使用配置中心的配置。

4.4 Nacos 配置中心 - 命名空间与配置分组

1、命名空间： 用于进行租户粒度的配置隔离。不同的命名空间下，可以存在相同的 Group 或 Data ID 的配置。Namespace 的常用场景之一是不同环境的配置的区分隔离，例如开发测试环境和生产环境的资源（如配置、服务）隔离等。

2、细节
默认：public(保留空间)，默认新增的所有配置都在 public 空间。
1、开发，测试，生产：利用命名空间来做环境隔离。
注意：在 bootstrap.properties 配置上，需要使用哪个命名空间下的配置。
spring.cloud.nacos.config.namespace=1e2fee9e-6112-4f9f-b338-8a5e5b9aaa6f
2、每一个微服务之间互相隔离配置，每一个微服务都创建自己的命名空间，只加载自己命名空间下的所有配置。

3、具体演示

1)、在 nacos 配置列表的生产环境 (prod) 配置如下信息

点击发布后如下

2)、在 gulimall-coupon 项目的 bootstrap.properties 配置如下信息

#nacos服务配置中心
spring.application.name=gulimall-coupon
spring.cloud.nacos.config.server-addr=127.0.0.1:8848

spring.cloud.nacos.config.namespace=1e2fee9e-6112-4f9f-b338-8a5e5b9aaa6f
1
2
3
4
5

3)、开启 gulimall-coupon 服务，查看原始配置信息

测试结果

4)、不重启 gulimall-coupon 服务情况下，查看更新配置信息，点击发布

测试结果

4、配置集，配置集，ID 配置分组相关概念

1)、配置集：所有的配置的集合，比如 yml 文件下的数据库配置，redis 配置

2)、配置集 ID：类似文件名。比如 application.yml

3)、配置分组：默认所有的配置集都属于：DEFAULT_GROUP

比如双十一使用 1111 配置，六一八使用 618 配置，如下使用双十一配置

添加 group 名到 gulimall-coupon 的 bootstrap.properties 配置文件，重新启动gulimall-coupon 微服务。

#nacos服务配置中心
spring.application.name=gulimall-coupon
spring.cloud.nacos.config.server-addr=127.0.0.1:8848

spring.cloud.nacos.config.namespace=1e2fee9e-6112-4f9f-b338-8a5e5b9aaa6f
spring.cloud.nacos.config.group=1111
1
2
3
4
5
6

测试结果

项目中的使用：每个微服务创建自己的命名空间 (namespace)，使用配置分组 (group)区分环境，dev，test，prod。

5、同时加载多个配置集
1)、微服务任何配置信息，任何配置文件都可以放在配置中心中。
2)、只需要在bootstrap.properties说明加载配置中心中哪些配置文件即可。
3)、@Value，@ConfigurationProperties 以前 SpringBoot 任何方法从配置文件中获取值，都能使用。 配置中心有的优先使用配置中心的。

#nacos服务配置中心
spring.application.name=gulimall-coupon
spring.cloud.nacos.config.server-addr=127.0.0.1:8848

spring.cloud.nacos.config.namespace=1e2fee9e-6112-4f9f-b338-8a5e5b9aaa6f
spring.cloud.nacos.config.group=1111
spring.cloud.nacos.config.ext-config[0].data-id=datasource.yml
spring.cloud.nacos.config.ext-config[0].group=dev
spring.cloud.nacos.config.ext-config[0].refresh=true

spring.cloud.nacos.config.ext-config[1].data-id=mybatis.yml
spring.cloud.nacos.config.ext-config[1].group=dev
spring.cloud.nacos.config.ext-config[1].refresh=true

spring.cloud.nacos.config.ext-config[2].data-id=other.yml
spring.cloud.nacos.config.ext-config[2].group=dev
spring.cloud.nacos.config.ext-config[2].refresh=true
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

五，SpringCloud Alibaba-Gateway API 网关

5.1 SpringCloud Gateway 简介

SpringCloud Gateway 是 SpringCloud 的一个全新项目，目标是取代 Netflix 公司的 Zuul 网关，它基于 spring 5 + SpringBoot 2.0+ webFlux(基于高性能的 Reactor 模式响应式通信框架 Netty，异步非阻塞模型)等技术构建，性能高于 Zuul 网关，官方测试 Gateway 是 Zuul 性能的 1.6 倍，旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

SpringCloud Gateway 不仅提供统一的路由方式 (反向代理)并且基于 Filter (定义过滤器对请求过滤，完成些功能)链的方式提供了网关基本的功能。例如：路由转发、权限校验、流量控制、熔断、路径重写、日志监控等。

未使用网关的项目访问后端服务方式：

使用网关的项目访问后端服务方式：

网关提供 API 全托管服务，丰富的 API 管理功能，辅助企业管理大规模的 API，以降低管理成本和安全风险，包括协议适配、协议转发、安全策略、防刷、流量、监控日志等功能。 Spring Cloud Gateway 旨在提供一种简单而有效的方式来对 API 进行路由，并为他们提供切面，例如：安全性，监控/指标和弹性等。 官方文档地址：https://spring.io/projects/spring-cloud-gateway/

5.2 SpringCloud Gateway 特点

1. 基于 Spring5，支持响应式编程和 SpringBoot2.0
2. 支持使用任何请求属性进行路由匹配
3. 特定于路由的断言和过滤器
4. 集成 Hystrix 进行断路保护
5. 集成服务发现功能
6. 易于编写 Predicates 和 Filters
7. 支持请求速率限制
8. 支持路径重写

5.3 为什么使用 API 网关？

API 网关出现的原因是微服务架构的出现，不同的微服务一般会有不同的网络地址，而外部客户端可能需要调用多个服务的接口才能完成一个业务需求，如果让客户端直接与各个微服务通信，会有以下的问题：
 客户端会多次请求不同的微服务，增加了客户端的复杂性。
 存在跨域请求，在一定场景下处理相对复杂。
 认证复杂，每个服务都需要独立认证。
 难以重构，随着项目的迭代，可能需要重新划分微服务。例如，可能将多个服务合并成一个或者将一个服务拆分成多个。如果客户端直接与微服务通信，那么重构将会很难实施。
 某些微服务可能使用了防火墙 / 浏览器不友好的协议，直接访问会有一定的困难。

以上这些问题可以借助 API 网关解决。API 网关是介于客户端和服务器端之间的中间层， 所有的外部请求都会先经过 API 网关这一层。也就是说，API 的实现方面更多的考虑业务逻辑，而安全、性能、监控可以交由 API 网关来做，这样既提高业务灵活性又不缺安全性。 使用 API 网关后的优点如下：
 易于监控。可以在网关收集监控数据并将其推送到外部系统进行分析。
 减少了客户端与各个微服务之间的交互次数。
 易于认证。可以在网关上进行认证，然后再将请求转发到后端的微服务，而无须在每个微服务中进行认证。

5.4 核心概念与工作原理

 路由： 路由是网关最基础的部分，路由信息有一个 ID、一个目的 URL、一组断言和一组 Filter 组成。如果断言路由为真，则说明请求的 URL 和配置匹配 。

 断言： Java8 中的断言函数。SpringCloud Gateway 中的断言函数输入类型是 Spring5.0 框架中的 ServerWebExchange。SpringCloud Gateway 中的断言函数允许开发者去定义匹配来自于 http request 中的任何信息，比如请求头和参数等。

 过滤器： 一个标准的 Spring webFilter。SpringCloud gateway 中的 filter 分为两种类型的 Filter，分别是 Gateway Filter 和 Global Filter。过滤器 Filter 将会对请求和响应进行修改处理。

 工作原理：

客户端发送请求给网关，网关 HandlerMapping 判断是否请求满足某个路由，满足就发给网关的 WebHandler。这个 WebHandler 将请求交给一个过滤器链，请求到达目标服务之前，会执行所有过滤器的 pre 方法。请求到达目标服务处理之后再依次执行所有过滤器的 post 方法。一句话：满足某些断言（predicates）就路由到指定的地址（uri），使用指定的过滤器（filter）。

5.5 使用步骤

1，创建微服务项目 gulimall-gateway 将其归为 gulimall 的子项目并且导入 common 依赖让其享有公共依赖。

2，common 依赖里有 nacos 服务注册中心和配置中心的依赖，那么要在配置文件中配置服务信息。启动类加上 @EnableDiscoveryClient 服务发现注解。

3，为 gulimall-gateway 服务创建一个命名空间。

4，gulimall-gateway 服务的 application.properties 文件

spring.application.name=gulimall-gateway
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
server.port=88
1
2
3

gulimall-gateway 服务的 bootstrap.properties 文件

spring.application.name=gulimall-gateway
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
spring.cloud.nacos.config.namespace=b2d24fbe-70b7-4d5c-a464-07d089d04f4b
1
2
3

5，启动项目，报错因为 common 有数据库相关的依赖，在启动类上加上的注解：
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class}) 表示排除数据源。

6，gulimall-gateway 服务的 application.yml 文件

spring:
  cloud:
    gateway:
      routes:
        - id: test_route
          uri: https://www.baidu.com
          predicates:
            - Query=url,baidu
        - id: qq_route
          uri: https://www.qq.com
          predicates:
            - Query=url,qq
1
2
3
4
5
6
7
8
9
10
11
12

7，gulimall-gateway 服务的 pom.xml 文件添加依赖

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

8，启动项目