SpringCloudAlibaba整合Gateway

发布时间 2023-09-21 12:22:06作者: xclyydss

在微服务架构中,加入网关(Gateway)是一种常见的模式,其作用是为了更好地管理和控制微服务的访问和通信。网关可以看作是微服务架构的入口,它位于客户端和内部微服务之间,充当了一个中间层的角色。
以下是加入网关的作用:
统一访问点:通过网关,客户端只需要与一个统一的访问点进行通信,而不用直接和各个微服务进行交互。这样可以简化客户端的代码,并且减少对各个微服务的直接依赖。
路由和负载均衡:网关可以根据请求的不同参数,将请求路由到相应的微服务实例。同时,网关还能实现负载均衡,确保请求被合理地分发到各个微服务实例,从而实现高可用和高性能。
安全性:网关可以充当安全层,负责认证和授权,以保护后端微服务免受未经授权的访问。通过网关,可以集中处理安全问题,避免在每个微服务中都实现一遍安全措施。
协议转换:网关可以支持不同的协议,将外部请求转换为内部微服务所支持的协议。这样,各个微服务可以使用不同的协议,而客户端只需要按照网关所支持的协议进行通信。
监控和日志记录:网关可以在请求和响应阶段进行监控和日志记录,收集有关请求的统计信息和故障排查数据。这有助于发现潜在的问题并进行性能优化。
缓存:网关可以实现请求的缓存,将常用的请求结果缓存起来,以减少对后端微服务的重复请求,提高系统性能和响应速度。
总的来说,加入网关在微服务架构中起到了简化客户端代码、提供安全层、实现负载均衡和统一访问点等重要作用。它帮助开发人员更好地管理微服务的通信和访问,从而增强了系统的可靠性、可维护性和性能。

好了,我们开始在项目中集成gateway,这个集成很简单
我们先添加一个新的模块,结构如下:

 

首先是pom文件
我们不仅加入了gateway还加入了sentinel

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.sakura.springcloud</groupId>
<artifactId>springcloudalibaba</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>

<artifactId>gateway</artifactId>
<packaging>jar</packaging>


<dependencies>
<!-- nacos服务注册发现 -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- loadbalancer启动器 新版本的springcloud去掉了ribbon自带的负载均衡器 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>
<!-- 新版本已不再默认开启bootstrap -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>
<!-- gateway启动器 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!-- sentinel启动器 -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
</dependency>
<!-- sentinel整合gateway -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
</dependency>
</dependencies>
</project>


然后是application.yml文件
gateway支持很多种断言工厂和自定义拦截器,这个大家自己了解一下
这里还加入了前端跨域配置

server:
port: 8000

spring:
profiles:
active: dev
cloud:
sentinel:
transport:
dashboard: 192.168.43.128:9100
gateway:
# 全局跨域配置
globalcors:
cors-configurations:
'[/**]':
allowedOrigins: "*"
allowedMethods:
- GET
- POST
- DELETE
- PUT
- OPTION
# 路由规则配置
routes:
- id: order-route # 规则ID
uri: lb://order-service # lb表示启用loadbalancer负载均衡器
predicates:
- Path=/api-order/** # 页面请求gateway的ip+端口/api-order就会进入这个断言规则里面,然后转发到上面的order-service服务
filters:
- StripPrefix=1 # 这里是去掉上面路径中的/api-order这一层,完整的转发路径是127.0.0.1:8000/api-order/add/order
- id: product-route
uri: lb://product-service
predicates:
- Path=/api-product/**
filters:
- StripPrefix=1
- id: stock-route
uri: lb://stock-service
predicates:
- Path=/api-stock/**
filters:
- StripPrefix=1

 

bootstrap.yml

spring:
# 配置中心地址
application:
# 服务名称
name: gateway-service
cloud:
nacos:
discovery:
# 开启nacos作为服务注册中心,默认值:true
enabled: true
# nacos集群服务注册地址
server-addr: 192.168.43.128:8848
# nacos注册地址命名空间
namespace: dev
# nacos用户名
username: nacos
# nacos密码
password: nacos
# 命名空间,默认 public,可设置dev,pro等,相同特征的服务分类,先去nacos命名空间创建
# namespace: public
# 分组,默认 DEFAULT_GROUP 相同特征的服务划分的更细
group: DEFAULT_GROUP
# 临时实例,默认true,false永久实例,即使宕机也不会从nacos服务中删除,可应对雪崩保护,避免服务被删除
ephemeral: true
# 权重 1-100 数值越大权重越大分配的流量就越大,通常结合权重负载均衡策略
# weight: 100
config:
server-addr: ${spring.cloud.nacos.discovery.server-addr}
username: ${spring.cloud.nacos.discovery.username}
password: ${spring.cloud.nacos.discovery.password}
# dataid为yaml的文件扩展名配置方式 ${spring.application.name}.${file‐extension:properties}
# 如果nacos上的配置文件后缀不是.properties,那么这里一定要指定文件后缀类型,否则读取不到文件
file-extension: yaml
namespace: dev
group: DEFAULT_GROUP
context-path: /nacos
# 共享配置
shared-configs:
- data-id: sakura.yaml
group: DEFAULT_GROUP


GatewayApplication 启动器

package com.sakura.gateway;

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

/**
* @author Sakura
* @date 2023/7/31 11:43
*/
@SpringBootApplication
public class GatewayApplication {

public static void main(String[] args) {
// 如果sentinel控制台不显示API管理菜单
// 添加参数,让sentinel知道这个是网关然后在控制台展示相关功能
//System.setProperty("csp.sentinel.app.type", "1");
SpringApplication.run(GatewayApplication.class, args);
}

}

这里加入了一个全局过滤器

package com.sakura.gateway.filters;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

/**
* @author Sakura
* @date 2023/7/31 15:22
*/
@Component
public class LogFilter implements GlobalFilter {

Logger log = LoggerFactory.getLogger(this.getClass());

@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("Gateway全局过滤器:");
log.info(exchange.getRequest().getPath().value());
return chain.filter(exchange);
}
}


还有为了测试跨域加了个页面user.html

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
<script src="http://apps.bdimg.com/libs/jquery/1.9.1/jquery.min.js"></script>
</head>
<body>
<input type="button" value="点击确认" onclick="checkOn()">

<script>
function checkOn() {
$.get('http://localhost:8000/api-order/order/add', function (data) {
alert(data)
});
}
</script>
</body>
</html>


我们启动这些服务
然后在浏览器输入http://localhost:8000/api-order/order/add
可以看到通过api-order正常的请求到了order服务

 

同样的我们也可以通过http://localhost:8000/api-product/product/get/1请求到product服务
这样外部服务对接后端就不需要对接一堆的ip加端口,只需要通过gateway的ip端口加配置好的断言规则就可以请求到所有的后端服务
我们也可以在gateway里面接入身份认证,权限校验等内容,而不需要在所有服务中添加这些


下面这个是里面配置的全局过滤器效果

 

我们注释掉跨域配置

 

重启服务后我们打开user.html

 

点击确认按钮
可以看到跨域拦截了

 

我们再放开跨域配置

 

重启服务,再次点击确认按钮
请求成功了

 

还有就是刚才接入了sentinel
可以看到gateway的菜单栏有些不一样

 

它这里可以根据api分组来添加流控熔断规则

 

还有它的请求链路里面配置页面是这样的
使用都很简单,看字面意思就能理解

 

里面的那个api名称就是我们在application.yml里面配置的routes.id

 

当然这里也支持和之前整合sentinel一样的全局异常配置和自定义流控规则熔断降级规则等,方法都一样,不记得的自己回去看下 5-SpringCloudAlibaba整合Sentinel