Spring Cloud Gateway 简介及使用_springcloud gateway作用

Gateway是什么

Spring Cloud Gateway是Spring Cloud官方推出的第二代网关框架，取代Zuul网关。网关作为流量的，在微服务系统中有着非常作用，网关常见的功能有路由转发、权限校验、限流控制等作用。

特性

• 基于Spring 5，Reactor(模式) 和 SpringBoot 2.0
• 能够在任何请求属性上匹配路由
• 断言和过滤器是特定于路由的
• Hystrix断路器集成
• SpringCloud DiscoveryClient集成
• 易于编写断言和过滤器
• 请求速率限制
• 路径重写

使用

首先搭建一个服务的注册中心，用来发现服务的

eureka-server项目

pom.xml引入内容如下：

		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
		</dependency>
1
2
3
4

启动类如下：

@SpringBootApplication
@EnableEurekaServer
public class EurekaServerApplication {

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

}
1
2
3
4
5
6
7
8
9

application.yml配置如下：

spring:
  application:
    name: eureka-server

server:
  port: 8761
eureka:
  instance:
    hostname: localhostname
  client:
    fetch-registry: false
    register-with-eureka: false
    service-url:
      defaultZone: http://localhost:8761/eureka/
1
2
3
4
5
6
7
8
9
10
11
12
13
14

然后搭建一个服务项目，注册到注册中心

service-one 项目

pom.xml引入内容如下：

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
		</dependency>
1
2
3
4
5
6
7
8

启动类如下：

@SpringBootApplication
@EnableEurekaClient
public class ServiceOneApplication {

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

}
1
2
3
4
5
6
7
8
9

application.yml配置如下：

spring:
  application:
    name: service-one
server:
  port: 8081

eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/
1
2
3
4
5
6
7
8
9
10

分别创建两个controller类：

OrderController内容如下：
http://localhost:8081/order/info

@RequestMapping("/order")
@RestController
public class OrderController {

    @RequestMapping("/info")
    public String orderInfo() {
        return "order info date : " + new Date().toString();
    }

}
1
2
3
4
5
6
7
8
9
10

UserController内容如下：
http://localhost:8081/user/user

@RequestMapping("/user")
@RestController
public class UserController {

    @RequestMapping("user")
    public String getUser() {
        return "I am the most handsome";
    }

}
1
2
3
4
5
6
7
8
9
10

最后创建一个网关项目，也注册到注册中心

gateway-client项目

pom.xml引入内容如下：

		<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>
1
2
3
4
5
6
7
8

使用RouteLocator的Bean进行路由转发，将请求进行处理，最后转发到目标的下游服务。
启动类内容如下：

@SpringBootApplication
public class GatewayClientApplication {

    @Value("${test.uri}")
    private String uri;

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                //basic proxy
                .route(r -> r.path("/order/**")
                        .uri(uri)
                ).build();
    }

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

这段代码是在访问 http://localhost:8080/order/ 的时候，
经过网关将请求转发到 http://service-one:8081/order/ ，
service-one服务在eureka中有注册，最终会对应服务的ip:port
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

application.yml配置如下：

test:
  uri: lb://service-one
spring:
  application:
    name: gateway-client
  cloud:
    gateway:
      routes:
      - id: route_service_one
        uri: ${test.uri} # uri以lb://开头（lb代表从注册中心获取服务），后面接的就是你需要转发到的服务名称
        predicates:
        - Path=/user/**

server:
  port: 8080

logging:
  level:
    org.springframework.cloud.gateway: TRACE
    org.springframework.http.server.reactive: DEBUG
    org.springframework.web.reactive: DEBUG
    reactor.ipc.netty: DEBUG
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/
  instance:
    prefer-ip-address: true
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

其中test.uri是自定义的属性，uri以lb://开头（lb代表从注册中心获取服务），后面接的就是你需要转发到的服务名称，按照上面的配置是http://localhost:8080/user/** >> http://service-one:8081/user/** 到此项目搭建完成。

依次启动三个项目，eureka-server、service-one、gateway-client
访问：http://localhost:8080/order/info

访问：http://localhost:8080/user/user

输出页面之后就代表成功了！！！

StripPrefix属性的使用

按照上面的配置，每一个路由只能对应一个控制器的转发，不够灵活，假如我想让userapi的请求都转到service-one服务。
比如：

• http://localhost:8080/userapi/user/user >>http://localhost:8081/user/user
• http://localhost:8080/userapi/order/info >> http://localhost:8081/order/info

修改一下gateway-client项目的配置文件如下：

test:
  uri: lb://service-one
spring:
  application:
    name: gateway-client
  cloud:
    gateway:
      routes:
      - id: route_service_one
        uri: ${test.uri} # uri以lb://开头（lb代表从注册中心获取服务），后面接的就是你需要转发到的服务名称
        predicates:
        - Path=/userapi/**
        filters:
        - StripPrefix=1 # 表示在转发时去掉userapi


server:
  port: 8080

logging:
  level:
    org.springframework.cloud.gateway: TRACE
    org.springframework.http.server.reactive: DEBUG
    org.springframework.web.reactive: DEBUG
    reactor.ipc.netty: DEBUG
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/
  instance:
    prefer-ip-address: true
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

重启项目gateway-client：
访问：http://localhost:8080/userapi/order/info

访问：http://localhost:8080/userapi/user/user

集成Hystrix

在gateway-client项目中引入依赖：

		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
		</dependency>
1
2
3
4

在spring cloud gateway中可以使用Hystrix。Hystrix是 spring cloud中一个服务熔断降级的组件，在微服务系统有着十分重要的作用。
Hystrix是 spring cloud gateway中是以filter的形式使用的。
启动类代码改成如下：

@SpringBootApplication
public class GatewayClientApplication {

    @Value("${test.uri}")
    private String uri;

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                //basic proxy
                .route(r -> r.path("/order/**")
                        .uri(uri)
                )
                .route(r -> r.path("/user/**")
                        .filters(f -> f
                                .hystrix(config -> config
                                        .setName("myserviceOne")
                                        .setFallbackUri("forward:/user/fallback")))
                        .uri(uri)).build();
    }

    public static void main(String[] args) {
        SpringApplication.run(GatewayClientApplication.class, args);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

上面代码中添加了一个路由并配置了hystrix的fallbackUri，新添加一个FallBackController控制器类。

FallBackController类内容如下：

@RestController
public class FallBackController {
    @RequestMapping("/user/fallback")
    public Mono<String> fallback() {
        return Mono.just("service error, jump fallback");
    }
}
1
2
3
4
5
6
7

重启gateway-client项目，并关闭service-one服务。
在浏览器访问: http://localhost:8080/user/user

如果你访问：http://localhost:8080/order/info，肯定会报一下错误

不要急，我们还需要在applicatio.yml配置Hystrix。
application.yml内容如下：

test:
  uri: lb://service-one
spring:
  application:
    name: gateway-client
  cloud:
    gateway:
      routes:
      - id: route_service_one
        uri: ${test.uri} # uri以lb://开头（lb代表从注册中心获取服务），后面接的就是你需要转发到的服务名称
        predicates:
        - Path=/userapi/**
        filters:
        - StripPrefix=1 # 表示在转发时去掉userapi

      - id: userapitwo_route
        uri: ${test.uri}
        predicates:
        - Path=/userapitwo/**
        filters:
        - StripPrefix=1
        - name: Hystrix
          args:
            name: myfallbackcmd
            fallbackUri: forward:/user/fallback

server:
  port: 8080

logging:
  level:
    org.springframework.cloud.gateway: TRACE
    org.springframework.http.server.reactive: DEBUG
    org.springframework.web.reactive: DEBUG
    reactor.ipc.netty: DEBUG
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/
  instance:
    prefer-ip-address: true
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

在配置中新增加了一个新的路由userapitwo_route，还配置了Hystrix，当发生错误时会转发到fallbackUri。
访问： http://localhost:8080/userapitwo/order/info

到此，集成Hystrix就结束了。