spring cloud gateway+consul单机示例

Spring cloud gateway 下一代服务网关，用来替代Zuul，不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控/指标和限流。

Consul是google开源的一个使用go语言开发的服务发现、配置管理中心服务。

本文的目的：测试验证客户端请求发送到gateway，gateway通过注册发现中心将请求转发到相应服务并返回服务响应消息。

实施步骤为：启动服务发现注册中心Consul、实现并注册服务提供者、配置gateway网关，客服端下发测试请求验证请求是否按预期转发。

1.启动服务发现注册中心Consul

        下载consul安装包，下载地址https://www.consul.io/downloads。我的运行环境是windows10,下载的是consul_1.10.1_windows_amd64.zip，

 

解压consul.exe到相应目录

启动开发环境，在cmd执行：consul agent -dev

 打开浏览器，访问consul控制台http://localhost:8500, 我是部署在本机的所有用的是localhost

 

2.实现并注册服务提供者

创建springboot项目，pom.xml文件关键内容如下：

<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.0.3.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
		<spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-actuator</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-consul-discovery</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</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>

主入口程序如下：

@SpringBootApplication
@EnableDiscoveryClient
public class App {

	public static void main(String[] args) {
		SpringApplication.run(App .class, args);
	}
}

提供服务的rest接口类如下：

@RestController
public class HelloController {

    @RequestMapping("/hello")
    public String hello() {
        return "hello consul";
    }
    
    @RequestMapping("/time")
    public String time() {
        return "consul server time:"+new Date();
    }
}

springboot配置文件application.yml：

server:
  port: 8501
spring:
  application:
    name: spring-cloud-consul-producer
  cloud:
    consul:
      discovery:
        serviceName: service-producer
      host: localhost
      port: 8500

由于consul运行在本机，所有host指向的是localhost

在IDE中启动App：

此时可以在consul管理台看到service-producer服务已注册成功：

 

 

3.gateway网关

创建springboot项目，pom.xml文件关键内容如下：

<parent>
	    <groupId>org.springframework.boot</groupId>
	    <artifactId>spring-boot-starter-parent</artifactId>
	    <version>2.5.3</version>
	    <relativePath/> <!-- lookup parent from repository -->
	  </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <start-class>com.study.gateway.App</start-class>
        <java.version>1.8</java.version>
        <maven-jar-plugin.version>3.0.0</maven-jar-plugin.version>
        <log4jdbc.log4j2.version>1.16</log4jdbc.log4j2.version>
        <rest.assured.version>2.3.3</rest.assured.version>
         <spring-cloud.version>2020.0.3</spring-cloud.version>
    </properties>
    <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>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>
         
         <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

主入口程序如下：

@SpringBootApplication
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

springboot配置文件application.yml：

server:
  #运行端口
  port: 9527
spring:
  application:
    name: service-gateway
  cloud:
    consul:
      host: localhost
      port: 8500
    gateway:
      discovery:
        locator:
          enabled: true
      routes:
        - id: service-provider-hello
          uri: lb://service-producer
          predicates:
            - Path=/hello
        - id: service-provider-time
          uri: lb://service-producer
          predicates:
            - Path=/time

关键配置：

        监听端口：9527

        服务发现的地址：localhost及端口8500

        路由的规则：配置了两条路由规则/hello及/time 

在IDE启动App：

4.客户端发送请求验证

直接访问网关地址端口+请求路径，http://localhost:9527/hello

 http://localhost:9527/time

 

 gateway转发路由成功！