SpringCloud实用篇02

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

SpringCloud实用篇02

课程内容

  1. nacos
    1. 能利用nacos实现统一配置管理和热更新 ✏️ ❤️
    2. 能搭建nacos集群 🍐
  2. Feign
    1. 能利用Feign发起远程调用 ✏️ ❤️
    2. 知道Feign性能优化要点 🍐
  3. 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-20210714164742924
image-20210714164742924
  1. 然后在弹出的表单中,填写配置信息:
  1. DataID:服务名称-环境名.yaml
  2. Group:默认即可
  3. 配置格式:Yaml
image-20210714164856664
image-20210714164856664
  • 热更新: 不停机更新
  • 注意:项目的核心配置,需要热更新的配置才有放到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

课堂作业

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

在实际开发中一般会涉及到多个微服务之间共享配置;点击查看open in new window

1.4.搭建Nacos集群

搭建Nacos集群

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

image-20210714174728042
image-20210714174728042

课堂作业

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

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

2.Feign远程调用

2.1.Feign替代RestTemplate ❤️ ✏️

Feign替代RestTemplate

以前利用RestTemplate发起远程调用的代码:

image-20210714174814204
image-20210714174814204

存在下面的问题:👇

  • 代码可读性差 ,编程体验不统一
  • 参数复杂URL难以维护

Feign一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feignopen in new window

让http请求跟家简单和优雅
让http请求跟家简单和优雅

其作用就是帮助我们优雅的实现http请求的发送 🎯,解决上面提到的问题。

使用Feign的步骤:

  • ① 引入依赖
  • ② 添加@EnableFeignClients注解
  • ③ 编写FeignClient接口
  • ④ 使用FeignClient中定义的方法代替RestTemplate

在引入Feign之前,先保证RrestTemplate能够正常使用,orderservice调用userservice正常 ⚠️

1)引入依赖

我们在order-service服务的pom文件中引入feign的依赖:

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

课堂作业

  1. Feign比RestTemplate牛逼🐃多了,对吗? 🎤

2.2.Feign自定义配置 🍐

Feign自定义配置

Feign可以支持很多的自定义配置,如下表所示:

类型作用说明
feign.Logger.Level修改日志级别 🎯包含四种不同的级别:NONE、BASIC、HEADERS、FULL
feign.codec.Decoder响应结果的解析器http远程调用的结果做解析,例如解析json字符串为java对象
feign.codec.Encoder请求参数编码将请求参数编码,便于通过http请求发送
feign. Contract支持的注解格式默认是SpringMVC的注解
feign. Retryer失败重试机制请求失败的重试机制,默认是没有,不过会使用Ribbon的重试

一般情况下,默认值就能满足我们使用 🍻,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。

Feign接口的远程服务调用,相当于RestTemplate发送请求。Feign会借助Spring容器的HttpMessageConverter对消息进行转换,源码:FeignClientsConfiguration.java

代码操作(日志例子来演示如何自定义配置):👇

2.2.1.配置文件方式

基于配置文件修改feign的日志级别可以针对单个服务

feign:  
  client:
    config: 
      userservice: # 针对某个微服务的配置
        loggerLevel: FULL #  日志级别  NONE、BASIC、HEADERS、FULL



 

也可以针对所有服务

feign:  
  client:
    config: 
      default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
        loggerLevel: FULL #  日志级别 



 

而日志的级别分为四种: 👇

  • NONE:不记录任何日志信息,这是默认值。
  • BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
  • HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
  • FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据

此处缺一张效果的截图

课堂作业

  1. 如果要调试查看请求的详细信息,请问需要配置什么什么级别的日志?🎤

2.3.Feign使用优化 🍐

Feign使用优化

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

  • URLConnection:默认实现,不支持连接池
  • Apache HttpClient :支持连接池
  • OKHttp:支持连接池

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

这里我们用Apache的HttpClient来演示: 👇

核心步骤

  1. 引入依赖
  2. 配置连接池
  3. debug观察结果

1)引入依赖

order-service的pom文件中引入Apache的HttpClient依赖:

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

Feign的优化:

  1. 日志级别尽量用basic
  2. 使用HttpClient或OKHttp代替URLConnection
    • ① 引入feign-httpClient依赖
    • ② 配置文件开启httpClient功能,设置连接池参数

BASIC:仅记录请求的方法,URL以及响应状态码和执行时间

2.4.Feign最佳实践 ✏️🍐

Feign最佳实践

所谓最近实践,就是使用过程中总结的经验,最好的一种使用方式。🎯

仔细观察可以发现,Feign的客户端与服务提供者的controller代码非常相似

feign客户端:

image-20210714190542730
image-20210714190542730

UserController:

image-20210714190528450
image-20210714190528450

简化操作: 👇👇

2.4.1.继承方式

一样的代码可以通过继承来共享:

  1. 定义一个API接口,利用定义方法,并基于SpringMVC注解做声明。
  2. Feign客户端和Controller都集成改接口
image-20210714190640857
image-20210714190640857

优点:

  • 简单
  • 实现了代码共享

缺点:

  • 服务提供方、服务消费方紧耦合
  • 参数列表中的注解映射并不会继承,因此Controller中必须再次声明 方法、参数列表、注解

实现基于抽取的最佳实践 👇

1)抽取
  1. 首先创建一个module,命名为feign-api
image-20210714204557771
image-20210714204557771

项目结构:

image-20210714204656214
image-20210714204656214
  1. feign-api中然后引入feign的starter依赖
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
  1. 然后,order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目
image-20210714205221970
image-20210714205221970

课堂作业

  1. 练习下抽取方式的最佳实践✏️

至此,Feign的学习完成了 🎉

3.Gateway服务网关

3.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-20210714210919458
image-20210714210919458

引入依赖:

<!--网关-->
<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>

总结

网关搭建步骤:

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

路由配置包括:

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

3.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断言

课堂作业

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

3.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=Truth, Itcast is freaking awesome! # 添加请求头








 
 

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

总结

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

3.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. gateway模块中定义一个过滤器:
package cn.itcast.gateway.filters;

@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();
    }
}

课堂作业

  1. 之前学过的知识中,什么知识和全局过滤器很类似?🎤

3.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时优化性能或提高可用性的实际业务案例
    • 在网关层面,如何处理身份验证、鉴权和安全性方面的问题?