初学SpringCloud02(Nacos配置管理,Feign远程调用,GateWay服务网关)_springcloud(本地调试)+nacos(远程)+gateway

48 阅读19分钟

收集整理了一份《2024年最新物联网嵌入式全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升的朋友。 img img

如果你需要这些资料,可以戳这里获取

一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人

都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!

@Slf4j @RestController @RequestMapping("/user") public class UserController {

@Autowired
private UserService userService;

@Value("${pattern.dateformat}")
private String dateformat;

@GetMapping("now")
public String now(){
    return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
}
// ...略

}


在页面访问,可以看到效果:


![image-20210714170449612](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/151f78f9d4f54540a77934c5c7ee84c9~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=ZretVNqo5sxTJqSyT7yl%2BfVsjAU%3D)


### 1.2.配置热更新


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


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


#### 1.2.1.方式一


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


![image-20210714171036335](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/f0c6ea49d16f4817ac1c7000539fd235~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=yukfV8e%2Bor%2FF1nnl53ZMDxsrpwU%3D)


#### 1.2.2.方式二


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


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



package cn.itcast.user.config;

import lombok.Data; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component;

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


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


![image-20210714171316124](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/4182b98cd24547c6ba706548d23a71a5~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=otYVxTLGx4opExWQz7pUHpiu%2F8M%3D)


完整代码:



package cn.itcast.user.web;

import cn.itcast.user.config.PatternProperties; import cn.itcast.user.pojo.User; import cn.itcast.user.service.UserService; import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController;

import java.time.LocalDateTime; import java.time.format.DateTimeFormatter;

@Slf4j @RestController @RequestMapping("/user") public class UserController {

@Autowired
private UserService userService;

@Autowired
private PatternProperties patternProperties;

@GetMapping("now")
public String now(){
    return LocalDateTime.now().format(DateTimeFormatter.ofPattern(patternProperties.getDateformat()));
}

// 略

}


### 1.3.配置共享


其实微服务启动时,会去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文件:


![image-20210714173233650](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/6e53cda5659a47218381d96f9a1dbd77~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=nYagZHTmPxJKsPn3D%2FcoxPCDlGQ%3D)


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


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


![image-20210714173324231](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/7273e5b73b454ddf881f2b252c9840b8~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=3DROJf3Y6zakGV3EviCA57rkfWA%3D)


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


![image-20210714173721309](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/9772553c809f452d9f7e1072b5cc84e3~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=L3SIcY%2BT24QaV8SAgM6c9l24JoQ%3D)


#### 3)运行两个UserApplication,使用不同的profile


修改UserApplication2这个启动项,改变其profile值:


![image-20210714173538538](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/d7b8cf8c195d4fb9b66ee1a7175c8b5e~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=NkX2IRBw8flWTvt%2BSOIdDinIGFw%3D)


![image-20210714173519963](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/3a56bd4c260541e9ab22e50d7dfe8805~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=8hM06wI6uhfuVoVEr%2FZVNNIFijc%3D)


这样,UserApplication(8081)使用的profile是dev,UserApplication2(8082)使用的profile是test。


启动UserApplication和UserApplication2


访问http://localhost:8081/user/prop,结果:


![image-20210714174313344](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/c18cc5c2970d482d8a2c39bbd733b23c~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=Tp3etkOxItnvDVORb068lLsgmdo%3D)


访问http://localhost:8082/user/prop,结果:


![image-20210714174424818](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/a8855857918b4426bb8db508fd93df0d~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=W%2BVdgxY8t%2FyeRKkl61xzZo9%2BRUY%3D)


可以看出来,不管是dev,还是test环境,都读取到了envSharedValue这个属性的值。


#### 4)配置共享的优先级


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


![image-20210714174623557](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/8051a586f4fd459197dff62e6f7c0dae~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=ZJRwdvHmE7fXBk0L6ooJSW1aXeg%3D)


### 1.4.搭建Nacos集群


Nacos生产环境下一定要部署为集群状态,部署方式参考课前资料中的文档:


![image-20210714174728042](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/d64b4c91245e458583b09eaaede9f2ba~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=Y3lSrqtortmE4iLHFK1b3uZzvKg%3D)


## 2.Feign远程调用


先来看我们以前利用RestTemplate发起远程调用的代码:


![image-20210714174814204](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/e1b115351cb94bf3bc940e7d0d619792~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=gXOxzdppNQADHBcF21397b%2BQvw0%3D)


存在下面的问题:


•代码可读性差,编程体验不统一


•参数复杂URL难以维护


Feign是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign


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


![image-20210714174918088](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/4500539d70f148d0920eb38714acba02~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=vUkcw6DK9ZT37HMwCS0mmTSMqs0%3D)


### 2.1.Feign替代RestTemplate


Fegin的使用步骤如下:


#### 1)引入依赖


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



org.springframework.cloud spring-cloud-starter-openfeign

#### 2)添加注解


在order-service的启动类添加注解开启Feign的功能:


![image-20210714175102524](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/e5f575d7a274406b9018997b6d0114f3~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=Kz0OlfP3zJQ7V57xgmwtb6bw%2Bqk%3D)


#### 3)编写Feign的客户端


在order-service中新建一个接口,内容如下:



package cn.itcast.order.client;

import cn.itcast.order.pojo.User; import org.springframework.cloud.openfeign.FeignClient; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable;

@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来发送了。


#### 4)测试


修改order-service中的OrderService类中的queryOrderById方法,使用Feign客户端代替RestTemplate:


![image-20210714175415087](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/a54b9d8442474cd79bf6a2407ff23ff7~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=dZpPVFznA6TD3ggzf%2FRbb1GzJ%2FY%3D)


是不是看起来优雅多了。


#### 5)总结


使用Feign的步骤:


① 引入依赖


② 添加@EnableFeignClients注解


③ 编写FeignClient接口


④ 使用FeignClient中定义的方法代替RestTemplate


### 2.2.自定义配置


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即可。


下面以日志为例来演示如何自定义配置。


#### 2.2.1.配置文件方式


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



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


也可以针对所有服务:



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


而日志的级别分为四种:


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


#### 2.2.2.Java代码方式


也可以基于Java代码来修改日志级别,先声明一个类,然后声明一个Logger.Level的对象:



public class DefaultFeignConfiguration { @Bean public Logger.Level feignLogLevel(){ return Logger.Level.BASIC; // 日志级别为BASIC } }


如果要**全局生效**,将其放到启动类的@EnableFeignClients这个注解中:



@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)


如果是**局部生效**,则把它放到对应的@FeignClient这个注解中:



@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)


### 2.3.Feign使用优化


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


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


•Apache HttpClient :支持连接池


•OKHttp:支持连接池


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


这里我们用Apache的HttpClient来演示。


1)引入依赖


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



io.github.openfeign feign-httpclient

2)配置连接池


在order-service的application.yml中添加配置:



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


接下来,在FeignClientFactoryBean中的loadBalance方法中打断点:


![image-20210714185925910](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/b790cfc3acc4498ba732fadad7783205~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=kYDkS9bFhVWa7P0bfVEM1C9PsiA%3D)


Debug方式启动order-service服务,可以看到这里的client,底层就是Apache HttpClient:


![image-20210714190041542](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/8c89f9107cca423ba6957704838c60b5~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=KBxz7PnMIaUncVtHlHYhfRoTutE%3D)


总结,Feign的优化:


1.日志级别尽量用basic


2.使用HttpClient或OKHttp代替URLConnection


① 引入feign-httpClient依赖


② 配置文件开启httpClient功能,设置连接池参数


### 2.4.最佳实践


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


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


feign客户端:


![image-20210714190542730](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/6953009e9db04880aeef6b8927539239~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=1KT%2B%2Bcs3cV19Nkdj0vf1gQF7VBU%3D)


UserController:


![image-20210714190528450](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/0fb6b666f090492da8e451f087114ff1~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=6gTVxfppzRQKfSaahCANpuUEAUk%3D)


有没有一种办法简化这种重复的代码编写呢?


#### 2.4.1.继承方式


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


1)定义一个API接口,利用定义方法,并基于SpringMVC注解做声明。


2)Feign客户端和Controller都集成改接口


![image-20210714190640857](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/93ef474d7e8846b087501fcc667e6464~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=%2BUpoj5y%2FKu%2B9Mkvl74tF9Ygi1Jc%3D)


优点:


* 简单
* 实现了代码共享


缺点:


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


#### 2.4.2.抽取方式


将Feign的Client抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用。


例如,将UserClient、User、Feign的默认配置都抽取到一个feign-api包中,所有微服务引用该依赖包,即可直接使用。


![image-20210714214041796](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/368122976a9b4fff9a496a2b3a508073~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=4AYh67GmLyOrSNR3OVYXAv3vzjU%3D)


#### 2.4.3.实现基于抽取的最佳实践


##### 1)抽取


首先创建一个module,命名为feign-api:


![image-20210714204557771](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/cc101918d43446bf95c6da677a113b39~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=wgtGWQBHeZDm4l9HLnCVFYUuqJQ%3D)


项目结构:


![image-20210714204656214](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/2f845f30a1b247c194e2bcf80fb58126~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=uoDMmXTJXHZISSbXrTkRkkyuxII%3D)


在feign-api中然后引入feign的starter依赖



org.springframework.cloud spring-cloud-starter-openfeign

然后,order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中


![image-20210714205221970](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/ba2df5b1b4864cdcb3ec0a5c3233ee0a~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=kw4XG3tAIrGfoF3ahAQEqgojrnk%3D)


##### 2)在order-service中使用feign-api


首先,删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。


在order-service的pom文件中中引入feign-api的依赖:



cn.itcast.demo feign-api 1.0

修改order-service中的所有与上述三个组件有关的导包部分,改成导入feign-api中的包


##### 3)重启测试


重启后,发现服务报错了:


![image-20210714205623048](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/664b0148687340439bec8caed3e4c8b1~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=e%2Fuc8hEFWiKVMiG%2FAOtu0VPRChM%3D)


这是因为UserClient现在在cn.itcast.feign.clients包下,


而order-service的@EnableFeignClients注解是在cn.itcast.order包下,不在同一个包,无法扫描到UserClient。


##### 4)解决扫描包问题


方式一:


指定Feign应该扫描的包:



@EnableFeignClients(basePackages = "cn.itcast.feign.clients")


方式二:


指定需要加载的Client接口:



@EnableFeignClients(clients = {UserClient.class})


## 3.Gateway服务网关


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


### 3.1.为什么需要网关


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


网关的**核心功能特性*** 请求路由
* 权限控制
* 限流


架构图:


![image-20210714210131152](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/d946263cc9c6478e87d9b42c676fba13~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=n5W%2FxjfFsnGUfo3ERgRBlqOo67I%3D)


**权限控制**:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。


**路由和负载均衡**:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。


**限流**:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。


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


* gateway
* zuul


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


### 3.2.gateway快速入门


下面,我们就演示下网关的基本路由功能。基本步骤如下:


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


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


创建服务:


![image-20210714210919458](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/baea32d8fbbe4b4eba2390255b96fce0~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=oHq7lFyA%2FHVfuK329dQMrr5SwS0%3D)


引入依赖:



org.springframework.cloud spring-cloud-starter-gateway com.alibaba.cloud spring-cloud-starter-alibaba-nacos-discovery

#### 2)编写启动类



package cn.itcast.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](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/9d04901082bd44b4a1f936035c2b9d21~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=oKxsY2P47MF7zfgfVsU2xFG2nFQ%3D)


#### 5)网关路由的流程图


整个访问的流程如下:


![image-20210714211742956](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/a51bac26d8914b8088111a9c38b3c632~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=fzbI18pO3Re6TXfznNuKEWyD4HY%3D)


总结:


网关搭建步骤:


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


路由配置包括:


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


接下来,就重点来学习路由断言和路由过滤器的详细知识


### 3.3.断言工厂


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


例如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这种路由工程就可以了。


### 3.4.过滤器工厂


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


![image-20210714212312871](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/a41755ed941545548d37a9369d7f2645~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=c%2F9l6WszsuTH1Uhbst9atH%2FCyB0%3D)


#### 3.4.1.路由过滤器的种类


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




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


#### 3.4.2.请求头过滤器


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



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


只需要修改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的请求有效。


#### 3.4.3.默认过滤器


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



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


#### 3.4.4.总结


过滤器的作用是什么?


① 对路由的请求或响应做加工处理,比如添加请求头


② 配置在路由下的过滤器只对当前路由的请求生效


defaultFilters的作用是什么?


① 对所有路由都生效的过滤器



### 3.5.全局过滤器


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



#### 3.5.1.全局过滤器作用


全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。


定义方式是实现GlobalFilter接口。



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


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


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




![img](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/caa53e7ccab941b7b18072e7d3ac46b0~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=fTtJAuvBf62Ad70NWaMoHkz6sr8%3D)
![img](https://p3-xtjj-sign.byteimg.com/tos-cn-i-73owjymdk6/6ad7838e68ed4338a27479a9674f276e~tplv-73owjymdk6-jj-mark-v1:0:0:0:0:5o6Y6YeR5oqA5pyv56S-5Yy6IEAg55So5oi3MzM5MTQ5MjgwNjA=:q75.awebp?rk3s=f64ab15b&x-expires=1771312850&x-signature=aAuZUQ%2FgKWantxx8UoyxZMbcqwk%3D)

**既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,涵盖了95%以上物联网嵌入式知识点,真正体系化!**

**由于文件比较多,这里只是将部分目录截图出来,全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、电子书籍、讲解视频,并且后续会持续更新**

**[如果你需要这些资料,可以戳这里获取](https://gitee.com/vip204888)**