SpringCloud实用篇02

YangeIT大约 25 分钟基础服务框架SpringCloudNacosFeignRestTemplateGateway跨域网关

SpringCloud实用篇02

课程内容

  1. nacos
    1. 能利用nacos实现统一配置管理和热更新 ✏️ ❤️
    2. 能搭建nacos集群 🍐
  2. Gateway
    1. 能利用Gateway实现服务路由 ✏️ ❤️
    2. 能利用GatewayFilter实现添加请求头 🍐
    3. 能自定义全局过滤器 ✏️🍐
    4. 能利用Gateway解决跨域问题🍐

知识储备

  1. 理解什么是微服务以及微服务的组成部分
  2. 已经完成Nacos安装和服务的注册和拉取
  3. 心中有此图open in new window 👈

1.Nacos配置管理

Nacos除了可以做注册中心,同样可以做配置管理来使用。知悉配置中心在下图的位置

微服务技术
微服务技术

1.1.统一配置管理 🍐

统一配置管理

微服务部署的实例越来越多,达到数十、数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错 ⚠️。我们需要一种统一配置管理方案,🎯可以集中管理所有实例的配置🎯。

配置中心图解
配置中心图解

Nacos作为配置中心的特点:👇

  • 将配置集中管理
  • 配置变更时,及时通知微服务,实现配置的热更新

代码操作步骤:👇

核心步骤

  1. nacos网页版中添加配置文件
  2. 微服务拉取配置
    • 引入nacos-config依赖
    • 添加bootstrap.yaml
    • 读取nacos配置
  3. 测试

1️⃣ 在nacos中添加配置文件

  1. 如何在nacos中管理配置呢?
image
image
  1. 然后在弹出的表单中,填写配置信息:
  1. DataID:服务名称-环境名.yaml
  2. Group:默认即可
  3. 配置格式:Yaml
image-20210714164856664
image-20210714164856664
image
image
  • 热更新: 不停机更新
  • 注意:项目的核心配置,需要热更新的配置才有放到nacos管理的必要注意。基本不会变更的一些配置还是保存在微服务本地比较好如:数据库信息

课堂作业

  1. 是不是任何配置都可以加入到配置中心,这样岂不是非常灵活?🎤
  2. 微服务的配置文件本地的:application.yml、bootstrap.yml、nacos配置中心配置,加载顺序是什么?🎤

1.2.配置热更新

配置热更新

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

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

  1. @Value注入的变量所在类上添加注解@RefreshScope
  2. 使用@ConfigurationProperties注解代替@Value注解。

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

image-20210714171036335
image-20210714171036335

课堂作业

🚩 1. 练习一下方式1热更新配置

1.3.配置共享

配置共享

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

  • [spring.application.name]-[spring.profiles.active].yaml如:userservice-dev.yaml

  • [spring.application.name].yaml如:userservice.yaml

[spring.application.name].yaml不包含环境如:userservice.yaml,因此可以被多个环境共享🎯。

配置共享的优先级 👇

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

案例代码验证操作:👇👇

核心步骤

  1. nacos配置中心添加一个环境共享配置
  2. user-service中读取共享配置
  3. 运行两个UserApplication,使用不同的profile

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

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

image-20210714173233650
image-20210714173233650
pattern:
    envSharedValue: 多环境共享值

2)在user-service中读取共享配置

user-service服务中,修改PatternProperties类,读取新添加的属性:

image-20210714173324231
image-20210714173324231

user-service服务中,修改UserController,添加一个方法:

image-20210714173721309
image-20210714173721309

课堂作业

  1. 当nacos、服务本地同时出现相同属性时,优先级是怎样的? 🎤
  2. 什么样的配置会是共享配置?🎤

1.4.搭建Nacos集群

搭建Nacos集群

Nacos生产环境下一定要部署为集群状态高可用要求,部署方式参考课前资料中的文档下图可点击

image-20210714174728042
image-20210714174728042

课堂作业

  1. 此图open in new window的每个环节的作用说出来 🎤

1.5.服务分级存储模型

服务分级存储模型

一个服务可以有多个实例,例如我们的user-service,可以有:

  • 127.0.0.1:8081
  • 127.0.0.1:8082
  • 127.0.0.1:8083

假如这些实例分布于全国各地的不同机房,例如:

  • 127.0.0.1:8081,在上海机房
  • 127.0.0.1:8082,在上海机房
  • 127.0.0.1:8083,在杭州机房

Nacos就将同一机房内的实例 划分为一个集群

容灾系统是指在相隔较远的异地,建立两套或多套功能相同的IT系统,互相之间可以进行健康状态监视和功能切换,当一处系统因意外(如火灾、地震等)停止工作时,整个应用系统可以切换到另一处,使得该系统功能可以继续正常工作。容灾技术是系统的高可用性技术

也就是说,user-service是服务,一个服务可以包含多个集群,如杭州、上海,每个集群下可以有多个实例,形成分级模型,如图:

image-20210713232522531
image-20210713232522531

微服务互相访问时,应该尽可能访问同集群实例,因为本地访问速度更快。当本集群内不可用时,才访问其它集群。例如:

image-20210713232658928
image-20210713232658928

杭州机房内的order-service应该优先访问同机房的user-service。 👈

修改user-service的application.yml文件,添加集群配置:

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

重启两个user-service实例后,我们可以在nacos控制台看到下面结果:

image
image

我们再次复制一个user-service启动配置,添加属性:

-Dserver.port=8083 -Dspring.cloud.nacos.discovery.cluster-name=SH

配置如图所示:

image-20210713233528982
image-20210713233528982

启动UserApplication3后再次查看nacos控制台:

image
image

如果停掉一个就会出现不可用现象:

image
image

至此:完了nacos配置中心的学习 🎉

2.Gateway服务网关

2.1.网关简介和入门程序 ❤️🍐✏️

网关简介和入门程序

Spring Cloud GatewaySpring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

Gateway网关是我们服务的守门神image,所有微服务的统一入口

网关的核心功能特性

  • 请求路由
  • 权限控制
  • 限流

架构图:

image
image
  • 权限控制:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。
  • 路由和负载均衡:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。
  • 限流:当请求流量过高时,在网关中按照微服务能够接受的速度来放行请求,避免服务压力过大。

限流情况如下难预知:用户增长速度快,业务高峰时间段保证业务可用性,应对网络爬虫,防止恶意刷单、非法访问系统

在SpringCloud中网关的实现包括两种:

  • gateway
  • zuul

Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。

网关的基本路由功能核心步骤:

  1. 创建SpringBoot工程gateway,引入网关依赖
  2. 编写启动类
  3. 编写基础配置和路由规则
  4. 启动网关服务进行测试

1)创建gateway服务,引入依赖

创建服务:

image
image

引入依赖:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-parent</artifactId>
    <version>3.0.2</version>
    <relativePath/>
</parent>
<dependencies>
    <!--网关-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
        <version>4.1.0</version>
    </dependency>
    <!--nacos服务发现依赖-->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        <version>2022.0.0.0-RC2</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        <version>4.0.4</version>
    </dependency>

</dependencies>

2)编写启动类

package cn.zx.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class GatewayApplication {

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

3)编写基础配置和路由规则

创建application.yml文件,内容如下:

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/开头就符合要求








 
 
 
 
 
 
 

我们将符合Path 规则的一切请求,都代理到 uri参数指定的地址。

本例中,我们将 /user/**开头的请求,代理到lb://userservice,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。

4)重启测试

重启网关,访问http://localhost:10010/user/1时,符合/user/**规则,请求转发到uri:http://userservice/user/1,得到了结果:

image-20210714211908341
image-20210714211908341

5)网关路由的流程图

整个访问的流程如下:

image-20210714211742956
image-20210714211742956

总结

网关搭建步骤:

  1. 创建项目,引入nacos服务发现和gateway依赖
  2. 配置application.yml,包括服务基本信息、nacos地址、路由

路由配置包括:

  1. 路由id:路由的唯一标示
  2. 路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡
  3. 路由断言(predicates):判断路由的规则,
  4. 路由过滤器(filters):对请求或响应做处理

2.2 Gateway路由断言工厂

Gateway路由断言工厂

我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件

image
image

例如Path=/user/**是按照路径匹配,这个规则是由

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的,像这样的断言工厂在SpringCloudGateway还有十几个:

名称说明示例
After是某个时间点后的请求- After=2037-01-20T17:42:47.789-07:00[America/Denver]
Before是某个时间点之前的请求- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]
Between是某两个时间点之前的请求- Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]
Cookie请求必须包含某些cookie- Cookie=chocolate, ch.p
Header请求必须包含某些header- Header=X-Request-Id, \d+
Host请求必须是访问某个host(域名)- Host=**.somehost.org,**.anotherhost.org
Method请求方式必须是指定方式- Method=GET,POST
Path请求路径必须符合指定规则- Path=/red/{segment},/blue/**
Query请求参数必须包含指定参数- Query=name, Jack或者- Query=name
RemoteAddr请求者的ip必须是指定范围- RemoteAddr=192.168.1.1/24
Weight权重处理

我们只需要掌握Path这种路由工程就可以了。

Before断言
Before断言
    gateway:
      routes: # 网关路由配置
        - id: user-service # 路由id,自定义,只要唯一即可
          uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称
          predicates: # 路由断言,也就是判断请求是否符合路由规则的条件
            - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求
            # 在2026年6月30日,12点之前可以访问
            - Before=2026-05-30T12:00:00.000+08:00[Asia/Shanghai]







 

课堂作业

  1. 自行配置下After断言工厂,验证下,某个时间点之后的才可以请求。✏️

2.3.Gateway过滤器工厂 🍐

Gateway过滤器工厂

GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:

image-20210714212312871
image-20210714212312871

Spring提供了31种不同的路由过滤器工厂。例如:

名称说明
AddRequestHeader给当前请求添加一个请求头 ✏️
RemoveRequestHeader移除请求中的一个请求头
AddResponseHeader给响应结果中添加一个响应头
RemoveResponseHeader从响应结果中移除有一个响应头
RequestRateLimiter限制请求的流量

代码验证:- 请求头过滤器

下面我们以AddRequestHeader 为例来讲解。

需求:给所有进入userservice的请求添加一个请求头:Truth=itcast is freaking awesome!🎯

  1. 修改gateway服务的application.yml文件,添加路由过滤即可:
spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/** 
        filters: # 过滤器
        - AddRequestHeader=hello,yangeit! # 添加请求头








 
 

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


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

spring:
  cloud:
    gateway:
      routes:
      - id: user-service 
        uri: lb://userservice 
        predicates: 
        - Path=/user/**
      default-filters: # 默认过滤项
      - AddRequestHeader=hello,yangeit








 
 

总结

  1. 过滤器的作用是什么?
    • ① 对路由的请求或响应做加工处理,比如添加请求头
    • ② 配置在路由下的过滤器只对当前路由的请求生效
  2. defaultFilters的作用是什么?
    • ① 对所有路由都生效的过滤器

2.4.Gateway全局过滤器 🍐

Gateway全局过滤器

上一节学习的过滤器,网关提供了31种,但每一种过滤器的作用都是固定的 。如果我们希望拦截请求,做自己的业务逻辑则没办法实现。 image

全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与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
    • 如果同时满足则放行,否则拦截

自定义全局过滤器

1️⃣ 1. 在gateway模块中定义一个过滤器:

package cn.zx.gateway.filters;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.util.MultiValueMap;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

@Order(-1) //定义Spring IOC容器中Bean的执行顺序的优先级,默认是最低优先级,值越小优先级越高
@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();
    }
}

2️⃣ 2. 过滤器执行顺序

请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter

请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:

image-20210714214228409
image-20210714214228409

排序的规则:

  • 每一个过滤器都必须指定一个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排序,组织过滤器链

http://localhost:10010/user/1?authorization=adminopen in new window

效果图
效果图

2.5.跨域问题 🍐

跨域问题

跨域:域名不一致就是跨域,主要包括:

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

解决方案: 👇

CORS,这个以前应该学习过,这里不再赘述了。不知道的小伙伴可以点击查看open in new window

代码操作

  1. 模拟跨域问题

找到课前资料的页面文件:

image-20210714215713563
image-20210714215713563

放入tomcat或者nginx这样的web服务器中,启动并访问。

可以在浏览器控制台看到下面的错误:

image-20210714215832675
image-20210714215832675

从localhost:8090访问localhost:10010,端口不同,显然是跨域的请求。

面试题

  • Nacos:

    • 请解释什么是Nacos配置中心,以及为什么它在微服务架构中很重要?
    • Nacos的共享配置如何配置?
    • 可以分享一个在Nacos配置中心中使用动态配置的实际业务案例吗?
    • Nacos支持哪些配置数据格式,例如JSON、YAML等?在实际项目中,你更倾向于使用哪种格式?
  • Feign:

    • 请解释Feign是什么,以及它的主要作用是什么?
    • 在微服务之间进行服务调用时,Feign与传统的HTTP客户端(如RestTemplate)相比有哪些优势?
    • 如何在Spring Cloud应用程序中使用Feign来进行服务之间的通信?
    • Feign支持哪些负载均衡策略,你是否有在实际项目中使用过?
    • 请分享一个使用Feign解决性能或可维护性问题的实际业务场景。
  • Gateway:

    • 请解释什么是Spring Cloud Gateway,以及它的主要功能和用途是什么?
    • 与传统的反向代理服务器(如Nginx)相比,Spring Cloud Gateway有什么不同之处?
    • 如何配置路由规则和过滤器来定制网关行为?
    • 请分享一个在使用Spring Cloud Gateway时优化性能或提高可用性的实际业务案例
    • 在网关层面,如何处理身份验证、鉴权和安全性方面的问题?