本文介绍spring gateway的使用,包括配置文件的使用和调试跟踪,让大家了解spring gateway的基本用法。如果不了解什么是微服务网关,就先查查资料,网关相对来说是比较重要的微服务组件。
0、环境
- springboot 2.4.2
- springcloud gateway 3.0.1
- jdk 1.8
1、创建微服务网关
两个服务,一个是网关,另一个是普通服务。网关用来转发请求,普通服务用来处理对应的请求。项目结构如下图:
下面咱们一起构造这个项目。先创建gateway项目,就是普通maven项目。
1.1、添加依赖
<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-gateway</artifactId><version>3.0.1</version>
</dependency>
1.2、添加配置文件
创建application.yml文件,并添加如下配置:
server:port: 9080spring:application:name: gateway-samplecloud:gateway:discovery:locator:enabled: trueroutes:- id: gateway-02uri: http://localhost:9081 #匹配后提供服务的路由地址predicates:- Path=/sample/service1/say/** # 断言,路径相匹配的进行路由filters:- StripPrefix=2
说明:
- uri:说明要跳转的uri地址
- StripPrefix:指定要从源地址截取的个数,以“/“为分隔符。以地址栏输入“http://localhost:8080/sample/service1/say/** ”为例,域名部分不计,那就是从sample/service1/say/** 计算,StripPrefix=2,表示从前截取两个”/”,那么结构就是:/say/**,你的服务必须对应这个uri,否则会出现404。
- id:随便写,保持和其他服务不同就是了
1.3、启动
springboot启动类就不多说了吧,启动只要没有出错就算是正常。这里唯一要注意的是pom文件里不能引入springboot web依赖,一旦引入启动时就报错。大家注意观察,我们启动gateway时,是netty而不是tomcat。
2、service1 服务编写
service1服务属于普通服务,按照普通springboot服务创建就行。这里注意端口保持和gateway不一样,我这里用9081。注意pom.xml要引入springboot web的依赖。在这里贴出controller的代码:
@RestController
@RequestMapping("/say")
public class SomethingToSay {@GetMapping("/hello")public String sayHello() {return "hello";}@GetMapping("/hi")public String sayHi() {return "hi";}@GetMapping("/ohh")public String sayOhh() {return "ohh";}
}
好了,一个带网关的微服务就开发完成了。通关网关uri做一下测试。
http://localhost:9080/sample/service1/say/hello,看结果若是返回了hello表示正常。
3、排错
在通过网关调用后端服务时,出现404,大部分情况都是手抖了,输错了uri,但是大部分同学又排查不细心,认为是gateway的问题,在这里我带大家写个全局Filter,首先确认请求已经到了gateway,如果请求连gateway都没到,那肯定是uri输入错误。这个Filter写在gateway模块里,代码如下:
@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {System.out.println("服务调用请求:" + exchange.getRequest().getURI());return chain.filter(exchange).then(Mono.fromRunnable(() ->System.out.println("服务调用返回了," + exchange.getResponse().getStatusCode())));}@Overridepublic int getOrder() {return 0;}
}
效果如图:
OK,一个简单的网关就开发完成了。