基于
微服务02.pptx整理的 Markdown 讲义版笔记。本文对原始 PPT 内容做了结构化重组与适度润色,便于系统学习、复习与二次修改。
在微服务架构中,系统通常包含多个后端服务,例如:
如果前端直接访问这些服务,会遇到很多问题:
因此需要一个统一入口:网关(Gateway)。
网关就是网络的关口,负责:
网关是所有客户端访问微服务集群的统一入口。
在 Spring Cloud 生态中,网关主要有两种实现:
| 组件 | 特点 |
|---|---|
| Spring Cloud Gateway | Spring 官方出品,基于 WebFlux,响应式编程,性能好 |
| Netflix Zuul | Netflix 出品,基于 Servlet,阻塞式编程,需要更多性能调优 |
课程中重点使用的是:
因为它:
flowchart LR
A[前端请求] --> B[Gateway 网关]
B --> C[Nacos 注册中心]
C --> B
B --> D[item-service]
B --> E[user-service]
B --> F[trade-service]
网关接收到请求后会:
PPT 中给出的网关搭建步骤可以总结为:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
spring:
cloud:
gateway:
routes:
- id: item
uri: lb://item-service
predicates:
- Path=/items/**
- id: user
uri: lb://user-service
predicates:
- Path=/users/**
| 字段 | 说明 |
|---|---|
id | 路由唯一标识 |
uri | 路由目标地址,lb:// 表示基于服务名负载均衡 |
predicates | 路由断言,用于判断请求是否符合当前路由 |
filters | 路由过滤器,用于对请求或响应做进一步处理 |
当访问:
http://127.0.0.1:8080/items/list
如果命中:
- Path=/items/**
则网关会将请求转发到:
lb://item-service
然后结合 Nacos 拉取实例列表并选择一个实例完成调用。
Spring Cloud Gateway 中,路由的核心是:
Spring 提供了多种 RoutePredicateFactory 实现,常见如下:
| 名称 | 说明 | 示例 |
|---|---|---|
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=t1,t2 |
Cookie | 必须包含指定 Cookie | Cookie=chocolate,ch.p |
Header | 必须包含指定请求头 | Header=X-Request-Id, \d+ |
Host | 匹配指定域名 | Host=**.somehost.org |
Method | 匹配请求方式 | Method=GET,POST |
Path | 匹配请求路径 | Path=/items/** |
Query | 匹配查询参数 | Query=name,Jack |
RemoteAddr | 匹配来源 IP | RemoteAddr=192.168.1.1/24 |
Weight | 权重路由 | Weight=group1,2 |
XForwardedRemoteAddr | 根据转发来源 IP 匹配 | XForwardedRemoteAddr=192.168.1.1/24 |
网关内置了大量过滤器,常用如下:
| 名称 | 说明 | 示例 |
|---|---|---|
AddRequestHeader | 添加请求头 | AddRequestHeader=name,value |
RemoveRequestHeader | 删除请求头 | RemoveRequestHeader=name |
AddResponseHeader | 添加响应头 | AddResponseHeader=name,value |
RemoveResponseHeader | 删除响应头 | RemoveResponseHeader=name |
RewritePath | 重写请求路径 | RewritePath=/red/?(?<segment>.*), /${segment} |
StripPrefix | 去除路径前缀 | StripPrefix=1 |
如果每个微服务都单独处理登录校验:
因此更合理的方式是:
在网关转发前统一做 JWT 登录校验。
Spring Cloud Gateway 的请求处理流程可以概括为:
HandlerMapping 根据请求匹配路由WebHandlerFilteringWebHandler 组织过滤器链pre 逻辑post 逻辑pre 逻辑通过,请求才会被转发post 逻辑flowchart TD
A[客户端请求] --> B[RoutePredicateHandlerMapping]
B --> C[FilteringWebHandler]
C --> D[Filter 1 pre]
D --> E[Filter 2 pre]
E --> F[NettyRoutingFilter 转发请求]
F --> G[微服务]
G --> H[Filter 2 post]
H --> I[Filter 1 post]
I --> J[响应客户端]
网关中有两类过滤器:
| 类型 | 说明 |
|---|---|
GatewayFilter | 路由过滤器,只作用于指定路由,需要配置后才生效 |
GlobalFilter | 全局过滤器,对所有路由生效,声明后自动生效 |
它们的核心过滤方法签名一致:
Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain);
其中:
exchange:请求上下文,包含 request、response 等共享数据chain:过滤器链,用于放行到下一个过滤器如果要作用于所有请求,最简单的方式是实现 GlobalFilter。
@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
System.out.println("GlobalFilter pre阶段 执行了。");
return chain.filter(exchange)
.then(Mono.fromRunnable(() -> {
System.out.println("post阶段 执行了。");
}));
}
@Override
public int getOrder() {
return 0;
}
}
pre 按顺序执行post 按倒序执行如果只想对某一类路由生效,则通常实现:
AbstractGatewayFilterFactory示意结构如下:
@Component
public class PrintAnyGatewayFilterFactory
extends AbstractGatewayFilterFactory<PrintAnyGatewayFilterFactory.Config> {
public PrintAnyGatewayFilterFactory() {
super(Config.class);
}
@Override
public GatewayFilter apply(Config config) {
return (exchange, chain) -> {
System.out.println("PrintAny filter 执行了");
return chain.filter(exchange);
};
}
@Data
public static class Config {
private String a;
private String b;
private String c;
}
@Override
public List<String> shortcutFieldOrder() {
return List.of("a", "b", "c");
}
}
对应配置示例:
spring:
cloud:
gateway:
default-filters:
- PrintAny=1,2,3
登录校验只发生在网关还不够,因为:
例如:
在网关登录校验成功后,将用户信息写入请求头,再转发给下游微服务。
exchange.mutate()
.request(builder -> builder.header("user-info", userInfo))
.build();
每个微服务可以通过 Spring MVC 拦截器:
user-infoThreadLocalPPT 中建议把这类拦截器统一写到 hm-common 中,这样:
微服务之间也会通过 OpenFeign 相互调用。
例如:
如果此时用户信息不继续往下传,就会造成调用链丢失用户上下文。
OpenFeign 提供了 RequestInterceptor,所有由 Feign 发起的请求都会先经过它。
public interface RequestInterceptor {
void apply(RequestTemplate template);
}
ThreadLocal 中取出当前用户信息这样就实现了:
整个登录方案可以总结为下面这条链路:
flowchart LR
A[浏览器携带 JWT 请求] --> B[Gateway GlobalFilter]
B --> C[校验 JWT]
C --> D[写入 user-info 请求头]
D --> E[下游微服务 HandlerInterceptor]
E --> F[保存用户到 ThreadLocal]
F --> G[业务处理]
G --> H[OpenFeign RequestInterceptor]
H --> I[继续透传用户信息到其他微服务]
| 层级 | 组件 | 职责 |
|---|---|---|
| 网关层 | GlobalFilter | 登录校验、用户透传 |
| 微服务入口 | HandlerInterceptor | 读取请求头中的用户信息并保存上下文 |
| 服务间调用 | RequestInterceptor | Feign 调用时继续传递用户信息 |
| 业务层 | ThreadLocal | 随时获取当前登录用户 |
在微服务系统中,配置会越来越多,常见问题包括:
因此需要引入统一配置中心。
使用 Nacos 同时承担:
把多个服务共用的配置抽取到 Nacos 中统一管理,例如:
这样每个微服务就不需要重复维护这些内容。
<!-- nacos 配置管理 -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
<!-- 读取 bootstrap 文件 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>
因为 Spring Cloud 上下文初始化比普通 application.yml 更早,
要在应用启动早期就从 Nacos 拉配置,因此需要使用 bootstrap.yml。
spring:
application:
name: cart-service
profiles:
active: dev
cloud:
nacos:
server-addr: 192.168.150.101:8848
config:
file-extension: yaml
shared-configs:
- dataId: shared-jdbc.yaml
- dataId: shared-log.yaml
- dataId: shared-swagger.yaml
可以概括为:
bootstrap.yml配置热更新指的是:
修改配置后,无需重启微服务,新的配置即可生效。
PPT 中的示例是:
要实现热更新,需要满足两个条件:
配置文件 dataId 的命名通常与以下信息有关:
spring.application.namespring.profiles.active(可选)file-extension常见方式有两种。
@ConfigurationProperties@Data
@ConfigurationProperties(prefix = "hm.cart")
public class CartProperties {
private int maxItems;
}
@RefreshScope + @Value@Data
@RefreshScope
public class CartProperties {
@Value("${hm.cart.maxItems}")
private int maxItems;
}
@ConfigurationProperties@Value 也可用如果网关路由写死在本地配置文件中,那么:
因此更好的做法是:
把路由配置存储到 Nacos 中,并在配置变化时实时更新网关路由表。
PPT 中总结得很清楚,需要完成两件事:
可以通过 NacosConfigManager 注册监听器:
private final NacosConfigManager nacosConfigManager;
public void initRouteConfigListener() throws NacosException {
String configInfo = nacosConfigManager
.getConfigService()
.getConfigAndSignListener(dataId, group, 5000, new Listener() {
@Override
public Executor getExecutor() {
return null;
}
@Override
public void receiveConfigInfo(String configInfo) {
// 监听到配置变化后,更新路由
}
});
// 首次启动时,也要主动加载一次配置
}
网关中可以使用 RouteDefinitionWriter 更新路由:
public interface RouteDefinitionWriter {
Mono<Void> save(Mono<RouteDefinition> route);
Mono<Void> delete(Mono<String> routeId);
}
save(...):新增或覆盖路由delete(...):根据路由 id 删除路由PPT 推荐在 Nacos 中使用 json 格式保存动态路由,因为更方便解析。
示例:
{
"id": "item",
"uri": "lb://item-service",
"predicates": [
{
"name": "Path",
"args": {
"_genkey_0": "/items/**",
"_genkey_1": "/search/**"
}
}
],
"filters": []
}
对应的 YAML 写法大致是:
spring:
cloud:
gateway:
routes:
- id: item
uri: lb://item-service
predicates:
- Path=/items/**,/search/**
flowchart TD
A[Nacos 中维护路由配置] --> B[Gateway 启动时首次加载]
A --> C[Nacos 配置变更通知]
C --> D[监听器收到新配置]
D --> E[解析为 RouteDefinition]
E --> F[RouteDefinitionWriter 更新路由表]
F --> G[网关立即使用新路由]
因为它让前端不必直接面对多个微服务,并把公共逻辑统一收口处理。
iduripredicatesfiltersThreadLocalRequestInterceptor 继续透传用户信息flowchart LR
A[Gateway 网关] --> B[路由]
A --> C[过滤器]
C --> D[JWT 登录校验]
D --> E[用户信息透传]
E --> F[OpenFeign 透传]
A --> G[Nacos 配置中心]
G --> H[配置共享]
G --> I[配置热更新]
G --> J[动态路由]
正在加载评论...