1,什么是服务网关
# 1.说明
- 网关统一服务入口,可方便实现对平台众多服务接口进行管控,对访问服务的身份认证、防报文重放与防数据篡改、功能调用的业务鉴权、响应数据的脱敏、流量与并发控制,甚至基于API调用的计量或者计费等等。
- 网关 = 路由转发 + 过滤器
`路由转发:接收一切外界请求,转发到后端的微服务上去;
`在服务网关中可以完成一系列的横切功能,例如权限校验、限流以及监控等,这些都可以通过过滤器完成
# 2.为什么需要网关
- 1.网关可以实现服务的统一管理
- 2.网关可以解决微服务中通用代码的冗余问题(如权限控制,流量监控,限流等)
# 3.网关组件在微服务中架构
2,服务网关组件
2.1 zuul 1.x 2.x(netflix 组件)
zul是从设备和网站到Netflix流媒体应用程序后端的所有请求的前门。作为一个边缘服务应用程序,zul被构建为支持动态路由、监视、弹性和安全性。目前zuul组件已经从1.0更新到2.0,但是作为springcloud官方不再推荐使用zuul2.0,但是依然支持zuul2.
springcloud 官方集成zuul文档: https://cloud.spring.io/spring-cloud-netflix/2.2.x/reference/html/#netflix-zuul-starter
2.2 gateway (spring)
文档地址: https://spring.io/projects/spring-cloud-gateway
这个项目提供了一个在springmvc之上构建API网关的库。springcloudgateway旨在提供一种简单而有效的方法来路由到api,并为api提供横切关注点,比如:安全性、监控/度量和弹性。
特性:
- 基于springboot2.x 和 spring webFlux 和 Reactor 构建 响应式异步非阻塞IO模型
- 动态路由
- 请求过滤
3,开发网关动态路由
3.1 新建 user工程
springcloud_05_gateway_users_9983
3.1.1 pom文件
<?xml version="1.0" encoding="UTF-8"?>
<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">
<parent>
<artifactId>springcloud_2023</artifactId>
<groupId>com.study</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>springcloud_05_gateway_users_9983</artifactId>
<dependencies>
<!-- 引入springboot的外部依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--引入eureka client-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
</dependency>
</dependencies>
</project>
3.1.2 配置文件
#服务端口号
server.port=9983
#服务名称唯一标识
spring.application.name=gateway_users
#eureka注册中心地址
eureka.client.service-url.defaultZone=http://localhost:8761/eureka
3.1.3 启动类
package com.study;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
@SpringBootApplication
@EnableEurekaClient
public class Users9983Application {
public static void main(String[] args) {
SpringApplication.run(Users9983Application.class, args);
}
}
3.1.4 对外接口
package com.study.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UsersController {
@GetMapping("/user/findAll")
public String findAll(){
return "user 调用成功";
}
}
3.2 新建 product工程
springcloud_05_gateway_products_9984
3.2.1 pom文件
<?xml version="1.0" encoding="UTF-8"?>
<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">
<parent>
<artifactId>springcloud_2023</artifactId>
<groupId>com.study</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>springcloud_05_gateway_products_9984</artifactId>
<dependencies>
<!-- 引入springboot的外部依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--引入eureka client-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
</dependency>
</dependencies>
</project>
3.2.2 配置文件
#服务端口号
server.port=9984
#服务名称唯一标识
spring.application.name=gateway_products
#eureka注册中心地址
eureka.client.service-url.defaultZone=http://localhost:8761/eureka
3.2.3 启动类
package com.study;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
@SpringBootApplication
@EnableEurekaClient
public class Product9984Application {
public static void main(String[] args) {
SpringApplication.run(Product9984Application.class, args);
}
}
3.2.4 对外接口
package com.study.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ProductsController {
@GetMapping("/product/findAll")
public String findAll(){
return "products 调用成功";
}
}
3.3 新建gateway工程
springcloud_05_gateway_9982
3.3.1 引入pom文件
<?xml version="1.0" encoding="UTF-8"?>
<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">
<parent>
<artifactId>springcloud_2023</artifactId>
<groupId>com.study</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>springcloud_05_gateway_9982</artifactId>
<dependencies>
<!-- 引入springboot的外部依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--引入eureka client-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!--引入gateway网关依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
</dependency>
</dependencies>
</project>
3.3.2 配置文件
spring:
application:
name: gateway
cloud:
gateway:
routes:
- id: user_route # 指定路由唯一标识
uri: http://localhost:9983/ # 指定路由服务的地址
predicates:
- Path=/user/** # 指定路由规则
- id: product_route
uri: http://localhost:9984/
predicates:
- Path=/product/**
#eureka注册中心地址
eureka:
client:
service-url:
defaultZone: http://localhost:8761/eureka
server:
port: 9982
3.3.3 启动类
package com.study;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
@SpringBootApplication
@EnableEurekaClient
public class Gateway9982Application {
public static void main(String[] args) {
SpringApplication.run(Gateway9982Application.class, args);
}
}
3.3.4 启动报错
在启动日志中发现,gateway为了效率使用webflux进行异步非阻塞模型的实现,因此和原来的web包冲突,去掉原来的web即可
3.3.5 解决报错
删除依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
3.3.6 测试
http://192.168.60.14:9982/product/findAll
http://192.168.60.14:9982/user/findAll
4,配置路由服务负载均衡
现有路由配置方式,都是基于服务地址写死的路由转发,能不能根据服务名称进行路由转发同时实现负载均衡的呢?
4.1 新建 user工程用于演示负载均衡
springcloud_05_gateway_users_9985 和
springcloud_05_gateway_users_9983保持一致端口改为9985
并且修改UserController
package com.study.controller;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UsersController {
@Value("${server.port}")
private int port;
@GetMapping("/user/findAll")
public String findAll(){
return "user 调用成功,端口为"+port;
}
}
4.2 修改网关服务配置文件
spring:
application:
name: gateway
cloud:
gateway:
routes:
- id: user_route # 指定路由唯一标识
# uri: http://localhost:9983/ # 指定路由服务的地址
uri: lb://GATEWAY-USERS # lb代表转发后台服务使用负载均衡,users代表服务注册中心上的服务名
predicates:
- Path=/user/** # 指定路由规则
- id: product_route
# uri: http://localhost:9984/
uri: lb://GATEWAY-PRODUCTS # lb代表转发后台服务使用负载均衡,users代表服务注册中心上的服务名
predicates:
- Path=/product/**
discovery:
locator:
enabled: true #开启根据服务名动态获取路由
#eureka注册中心地址
eureka:
client:
service-url:
defaultZone: http://localhost:8761/eureka
server:
port: 9982
4.3 测试
5,常用的Filter以及自定义filter
5.1 说明
路由过滤器允许以某种方式修改传入的HTTP请求或传出的HTTP响应。路由筛选器的作用域是特定路由。springcloudgateway包括许多内置的GatewayFilter工厂。
5.2 作用
当我们有很多个服务时,比如下图中的user-service、order-service、product-service等服务,客户端请求各个服务的Api时,每个服务都需要做相同的事情,比如鉴权、限流、日志输出等。
5.3 使用自定义filter
package com.study.filete;
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.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
@Configuration
public class CustomGlobalFilter implements GlobalFilter, Ordered {
public static final Logger LOGGER = LoggerFactory.getLogger(CustomGlobalFilter.class);
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
LOGGER.info("进入自定义的filter");
if(exchange.getRequest().getQueryParams().get("username")!=null){
LOGGER.info("用户身份信息合法,放行请求继续执行!!!");
return chain.filter(exchange);
}
LOGGER.info("非法用户,拒绝访问!!!");
return exchange.getResponse().setComplete();
}
@Override
public int getOrder() {
return -1;
}
}
5.4 测试
http://192.168.60.14:9982/user/findAll
http://192.168.60.14:9982/user/findAll?username=123