SpirngCloud

---

SpringCloud笔记

SpringCloud共分为五大组件

服务注册中心：Eureka、Zookeeper、Consul、Nacos

负载均衡：Ribbon、Feign、OpenFeign

路由网关：zuul、SpringCloudGateway

配置中心：SpringCloudConfig、Nacos

熔断降级：Hystrix、Sentinel

CAP定理：CAP定理又称CAP原则，指的是在一个分布式系统中，一致性（Consistency）、可用性（Availability）、分区容错性（Partition tolerance）。CAP 原则指的是，这三个要素最多只能同时实现两点，不可能三者兼顾。 一致性（C）：在分布式系统中的所有数据备份，在同一时刻是否同样的值。（等同于所有节点访问同一份最新的数据副本） 可用性（A）：在集群中一部分节点故障后，集群整体是否还能响应客户端的读写请求。（对数据更新具备高可用性） 分区容忍性（P），就是高可用性，一个节点崩了，并不影响其它的节点

安装Nacos

1.Windows安装

1. 在 Github 下载 Nacos 安装包，并将这个安装包解压到任意非中文目录下

2. Nacos的默认端口是8848。也可以进入nacos的conf目录，修改application.properties配置文件中的端口

3. 进入bin目录，执行命令启动

   // windows命令
   startup.cmd -m standalone

4. 在浏览器输入地址：http://127.0.0.1:8848/nacos访问，默认的账号和密码都是nacos

2.Linux安装

1. 安装JDK。Nacos依赖于JDK运行，上传到Linux服务器的某个目录，例如：/usr/local/，然后解压缩重命名为java

   tar -xvf jdk-8u144-linux-x64.tar.gz
   // 配置环境变量
   export JAVA_HOME=/usr/local/java
   export PATH=$PATH:$JAVA_HOME/bin
   // 设置环境变量
   source /etc/profile

2. 上传nacos安装包并解压。上传到Linux服务器的某个目录，例如/usr/local/src目录下

   // 解压缩安装包
   tar -xvf nacos-server-1.4.1.tar.gz
   // 然后删除安装包
   rm -rf nacos-server-1.4.1.tar.gz

3. 配置端口，启动。端口配置同windows，在nacos/bin目录中，输入命令启动Nacos

   sh startup.sh -m standalone

---

注册中心——Nacos

配置Nacos

• 引依赖

<!-- 父工程： --> 
<dependencyManagement>
    <dependency>
        <groupId>com.alibaba.cloud</groupId>   
        <artifactId>spring-cloud-alibaba-dependencies</artifactId>    
        <version>2.2.5.RELEASE</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>
</dependencyManagement>

<!-- nacos客户端依赖包 -->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

• 配置nacos地址

在每个微服务的 application.yml 中添加nacos地址，然后重启微服务

spring:
  cloud:
    nacos:
      server-addr: localhost:8848

配置Nacos集群

修改微服务的 application.yml 文件，添加集群配置

spring:
  cloud:
    nacos:
      server-addr: localhost:8848 #nacos地址
      discovery:
        cluster-name: HZ # 集群名称

同集群优先的负载均衡

默认的ZoneAvoidanceRule并不能实现根据同集群优先来实现负载均衡。

因此Nacos中提供了一个NacosRule的实现，可以优先从同集群中挑选实例。

1）给order-service配置集群信息

修改order-service的application.yml文件，添加集群配置：

spring:
  cloud:
    nacos:
      server-addr: localhost:8848
      discovery:
        cluster-name: HZ # 集群名称

2）修改负载均衡规则

修改order-service的application.yml文件，修改负载均衡规则：

userservice:
  ribbon:
    NFLoadBalancerRuleClassName: com.alibaba.cloud.nacos.ribbon.NacosRule # 负载均衡规则 

权重配置

实际部署中会出现这样的场景：

服务器设备性能有差异，部分实例所在机器性能较好，另一些较差，我们希望性能好的机器承担更多的用户请求。

但默认情况下 NacosRule 是同集群内随机挑选，不会考虑机器的性能问题。

因此，Nacos提供了权重配置来控制访问频率，权重越大则访问频率越高。

在nacos控制台，找到微服务的实例列表，点击编辑，即可修改权重

注意：如果权重修改为0，则该实例永远不会被访问

环境隔离

Nacos提供了 namespace来实现环境隔离功能。

• nacos中可以有多个namespace
• namespace下可以有group、service等
• 不同namespace之间相互隔离，例如不同namespace的服务互相不可见

1）创建namespace

默认情况下，所有service、data、group都在同一个namespace，名为public：

我们可以点击页面新增按钮，添加一个namespace，然后，填写表单就能在页面看到一个新的namespace：

2）给微服务配置namespace

给微服务配置namespace只能通过修改配置来实现。

例如，修改order-service的application.yml文件：

spring:
  cloud:
    nacos:
      server-addr: localhost:8848
      discovery:
        cluster-name: HZ
        namespace: 492a7d5d-237b-46a1-a99a-fa8e98e4b0f9 # 命名空间，填ID

Nacos与Eureka的区别

Nacos的服务实例分为两种类型：

• 临时实例：如果实例宕机超过一定时间，会从服务列表剔除，默认的类型。

• 非临时实例：如果实例宕机，不会从服务列表剔除，也可以叫永久实例。

配置一个服务实例为永久实例：

spring:
  cloud:
    nacos:
      discovery:
        ephemeral: false # 设置为非临时实例

Nacos和Eureka整体结构类似，服务注册、服务拉取、心跳等待，但是也存在一些差异：

• Nacos与eureka的共同点

  • 都支持服务注册和服务拉取
  • 都支持服务提供者心跳方式做健康检测

• Nacos与Eureka的区别

  • Nacos支持服务端主动检测提供者状态：临时实例采用心跳模式，非临时实例采用主动检测模式
  • 临时实例心跳不正常会被剔除，非临时实例则不会被剔除
  • Nacos支持服务列表变更的消息推送模式，服务列表更新更及时
  • Nacos集群默认采用AP方式，当集群中存在非临时实例时，采用CP模式；Eureka采用AP方式

---

配置中心——Nacos

配置管理

• 添加配置文件

  选择配置列表，然后在弹出的表单中，填写配置信息：

注意：项目的核心配置，需要热更新的配置才有放到nacos管理的必要。基本不变的一些配置还是保存在微服务本地比较好。

• 从微服务拉取配置

  微服务要拉取nacos中管理的配置，并且与本地的application.yml配置合并，才能完成项目启动。

  因此spring引入了一种新的配置文件：bootstrap.yaml 文件，会在 application.yml 之前被读取，流程如下：

1）引入nacos-config依赖

首先，在user-service服务中，引入nacos-config的客户端依赖：

<!--nacos配置管理依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>

2）添加bootstrap.yaml

然后，在user-service中添加一个bootstrap.yaml文件，内容如下：

spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev #开发环境，这里是dev 
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地址
      config:
        file-extension: yaml # 文件后缀名

这里会根据spring.cloud.nacos.server-addr 获取nacos地址，再根据id来读取配置，文件id：

${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}

3）读取nacos配置

配置热更新

我们最终的目的，是修改nacos中的配置后，微服务中无需重启即可让配置生效，也就是配置热更新。

要实现配置热更新，可以使用两种方式：

• 方式一

  在@Value注入的变量所在类上添加注解@RefreshScope：

• 方式二

  使用@ConfigurationProperties注解代替@Value注解。

  在user-service服务中，添加一个类，读取 patterrn.dateformat 属性：

@Component
@Data
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
    private String dateformat;
}

在 UserController 中使用这个类代替 @Value：

配置共享

其实微服务启动时，会去nacos读取多个配置文件，例如：

• [spring.application.name]-[spring.profiles.active].yaml，例如：userservice-dev.yaml

• [spring.application.name].yaml，例如：userservice.yaml

而[spring.application.name].yaml不包含环境，因此可以被多个环境共享。

1）添加一个环境共享配置

我们在nacos中添加一个 userservice.yaml 文件：

2）配置共享的优先级

当nacos、服务本地同时出现相同属性时，优先级有高低之分：

Nacos集群

搭建集群的基本步骤：

• 搭建数据库，初始化数据库表结构
• 下载并配置nacos
• 启动nacos集群
• nginx反向代理

1. 初始化数据库

   Nacos默认数据存储在内嵌数据库Derby中，不属于生产可用的数据库。

   官方推荐的最佳实践是使用带有主从的高可用数据库集群

2. 配置Nacos

   将这个包解压到任意非中文目录下，进入nacos的conf目录，修改配置文件cluster.conf.example，重命名为cluster.conf，然后添加内容，修改application.properties文件，添加数据库配置。修改每个nacos节点的配置文件

3. 启动

分别启动三个nacos节点：

startup.cmd

4. nginx反向代理

   修改conf/nginx.conf文件，而后在浏览器访问：http://localhost/nacos即可。

   upstream nacos-cluster {
       server 127.0.0.1:8845;
   	server 127.0.0.1:8846;
   	server 127.0.0.1:8847;
   }
   
   server {
       listen       80;
       server_name  localhost;
   
       location /nacos {
           proxy_pass http://nacos-cluster;
       }
   }

5. 优化

• 实际部署时，需要给做反向代理的nginx服务器设置一个域名，这样后续如果有服务器迁移nacos的客户端也无需更改配置.

• Nacos的各个节点应该部署到多个不同服务器，做好容灾和隔离

负载均衡——LoadBalance

Ribbon实现负载均衡

LoadBalance实现负载均衡

基于 RestTemplate和 @LoadBalanced 注解

RestTemplate 是 spring-web 包提供的, 用来调用 HTTP 接口的工具类, 它提供了 GET、POST 等常用的请求方法

1. 添加到 spring 容器

   @Bean
   public RestTemplate restTemplate() {
     return new RestTemplate();
   }

2. 使用前注入依赖

   @Autowired
   private RestTemplate restTemplate;

3. 常用 API

   // 发送 GET 请求
   restTemplate.getForObject(...)
   
   // 发送 POST 请求
   restTemplate.postForObject(...)
     
   // 自定义
   restTemplate.execute(...)

按照上面那种简单的写法, 我们只能调用有明确 IP 和 端口 的接口, 要想实现我们的需求, 至少要做两件事情:

1. 根据服务名拿到服务实例的信息
2. 负载均衡算法

RestTemplate 提供了拦截器的功能 ClientHttpRequestInterceptor, 开发者可以 手动编码 实现上面两个功能.

Spring Cloud 使用方式如下:

1. 在原有基础上加上 @LoadBalanced 注解

   @Bean
   @LoadBalanced
   public RestTemplate restTemplate() {
     return new RestTemplate();
   }

2. 调用接口时,传入服务名称

   User user = restTemplate.getForObject("http://user-service/getUser", User.class);

一个注解就帮我们完成了负载均衡

基于 DiscoveryClient

org.springframework.cloud.client.discovery.DiscoveryClient 可以帮我们实现服务发现的功能, 只要我们拿到服务对应的实例信息, 后面 负载均衡 可以手动编码实现

1. 注入依赖

   @Autowired
   private DiscoveryClient discoveryClient;

2. 获取注册中心服务实例列表

   List<ServiceInstance> instances = discoveryClient.getInstances("user-service");

3. 选取一个实例的地址信息, 发送请求

基于 Feign 的声明式调用

feign作为远程调用框架集成了ribbon实现的负载均衡，故feign的介绍在远程服务调用。

---

远程服务调用——Feign

类比Spring和Feign

Spring的声明式事务，只需要简单的在配置文件中告诉Spring要对谁加事务，把规则定义清楚就好了，剩下的交给spring

Feign的声明式Http客户端，将发请求所需要的信息声明出来，剩下的事交给Feign来做

使用Feign的步骤

① 引入依赖

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

② 添加@EnableFeignClients注解

③ 编写FeignClient接口

@FeignClient("userservice")
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息，比如：

• 服务名称：userservice
• 请求方式：GET
• 请求路径：/user/{id}
• 请求参数：Long id
• 返回值类型：User

这样，Feign就可以帮助我们发送http请求，无需自己使用RestTemplate来发送了

自定义配置

Feign使用优化

• 日志级别尽量用basic
• 使用HttpClient或OKHttp代替URLConnection

Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：

• URLConnection：默认实现，不支持连接池

• Apache HttpClient ：支持连接池

• OKHttp：支持连接池

因此提高Feign的性能主要手段就是使用连接池代替默认的 URLConnection。

① 引入Apache的HttpClient依赖

<!--httpClient的依赖 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

② 配置连接池

feign:
  client:
    config:
      default: # default全局的配置
        loggerLevel: BASIC # 日志级别，BASIC就是基本的请求和响应信息
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

---

路由网关——Gateway

搭建步骤：

1. 引入nacos服务发现和gateway依赖

   <!--gateway网关-->
   <dependency>
     <groupId>org.springframework.cloud</groupId>
       <artifactId>spring-cloud-starter-gateway</artifactId>
   </dependency>
   <!--nacos服务发现-->
   <dependency>
       <groupId>com.alibaba.cloud</groupId>
       <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
   </dependency>

2. 配置application.yml，包括服务基本信息、nacos地址、路由

   server:
     port: 10010 # 网关端口
   spring:
     application:
       name: gateway # 服务名称
     cloud:
       nacos:
         server-addr: localhost:8848 # nacos地址
       gateway:
         routes: # 网关路由配置
           - id: user-service # 路由id，自定义，只要唯一即可
             # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址
             uri: lb://userservice # 路由的目标地址 lb就是负载均衡，后面跟服务名称
             predicates: # 路由断言，也就是判断请求是否符合路由规则的条件
               - Path=/user/** # 这个是按照路径匹配，只要以/user/开头就符合要求

路由配置包括：

1. 路由id：路由的唯一标示

2. 路由目标（uri）：路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡

3. 路由断言（predicates）：判断路由的规则，主要为Path这种路由工程

4. 路由过滤器（filters）：对请求或响应做处理

过滤器

① 路由过滤器

当前过滤器写在userservice路由下，因此仅仅对访问userservice的请求有效。

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 过滤器
        - AddRequestHeader=xxx # 添加请求头

② 默认过滤器

如果要对所有的路由都生效，则可以将过滤器工厂写到default下。格式如下：

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默认过滤项
      - AddRequestHeader=Truth, Itcast is freaking awesome! 

③ 全局过滤器

作用：处理一切进入网关的请求和微服务响应，同GatewayFilter

区别：GatewayFilter通过配置定义，处理逻辑是固定的；而GlobalFilter的定义方式是实现GlobalFilter接口

public interface GlobalFilter {
    /**
     *  处理当前请求，有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理
     *
     * @param exchange 请求上下文，里面可以获取Request、Response等信息
     * @param chain 用来把请求委托给下一个过滤器 
     * @return {@code Mono<Void>} 返回标示当前过滤器业务结束
     */
    Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
}

在filter中编写自定义逻辑，可以实现下列功能：

• 登录状态判断
• 权限校验
• 请求限流等

自定义全局过滤器：

需求：定义全局过滤器，拦截请求，判断请求的参数是否满足下面条件：

• 参数中是否有authorization，

• authorization参数值是否为admin

如果同时满足则放行，否则拦截

@Order(-1)
@Component
public class AuthorizeFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1.获取请求参数
        MultiValueMap<String, String> params = exchange.getRequest().getQueryParams();
        // 2.获取authorization参数
        String auth = params.getFirst("authorization");
        // 3.校验
        if ("admin".equals(auth)) {
            // 放行
            return chain.filter(exchange);
        }
        // 4.拦截
        // 4.1.禁止访问，设置状态码
        exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN);
        // 4.2.结束处理
        return exchange.getResponse().setComplete();
    }
}

④ 过滤器执行顺序

排序的规则：

• 每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前。
• GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值
• 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。
• 当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。

详细内容，可以查看源码：

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters，然后再加载某个route的filters，然后合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器，与前面的过滤器合并后根据order排序，组织过滤器链。

跨域问题

跨域：域名不一致就是跨域，主要包括：

• 域名不同： www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com

• 域名相同，端口不同：localhost : 8090和localhost : 10010

跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题

解决方案：CORS

在gateway服务的application.yml文件中，添加下面的配置：

spring:
  cloud:
    gateway:
      # 。。。
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求 
              - "http://localhost:8090"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期

---

熔断降级——Sentinel

分布式事务——Seata