今天就和伙伴们一起在Spring Cloud微服务中整合Gateway组件。
首先我们聊聊,Gateway组件的一个基本功能:添加Gateway后,无论有多少个服务或者模块,无论每个服务或者模块的端口号是多少,我们只需要用gateway的端口号访问就可以了,不需要记住每个每个服务或者模块的地址和端口号。简而言之,Gateway的基本作用就是可以对所有的接口访问,在进入controller之前进行拦截、处理。好,我们开始吧。
首先,我们创建一个项目
需要注意的是,选择依赖时只选下面这两个。
pom.xml
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.micro</groupId>
<artifactId>service-gateway</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>ims-gateway</name>
<description>Gateway project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>2020.0.3</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
application.yml
server:
port: 9999
eureka:
instance:
hostname: 127.0.0.1
client:
service-url:
defaultZone: http://${eureka.instance.hostname}:9000/eureka
register-with-eureka: true
fetch-registry: true
spring:
application:
name: service-gateway
cloud:
gateway:
routes:
- id: service-test #路由的id,没有规定规则,但要求唯一,建议配合服务名
# uri: http://localhost:9001 #匹配后提供服务的路由地址,想要隐藏起来,被gateway转发的地址前缀
uri: lb://service-test #代表从注册中心获取服务,且以lb(load-balance)负载均衡方式转发
predicates: #9001端口中,只允许/api开头的路径
- Path=/api/** #断言,路径相匹配的进行路由(注意**为通配符---后缀)
在启动类中添加注解
@EnableEurekaClient
在服务中添加如下接口:
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @Author: Max
* @Date: 2021/8/6
* @Function:
*/
@RestController
@RequestMapping("/api")
public class TestController {
@PostMapping("/hello")
public String hello(){
return "hello, girl...";
}
}
依次启动service-eureka、service-gateway、service-test三个服务。
输入访问地址:
http://localhost:9999/api/hello
结果如下:
可以发现,Gateway的路由功能已经实现。