Spring Cloud Gateway配置记录1

2021-02-26

× 文章目录

1. 简介
2. 环境
3. 简单搭建
4. 配置记录
5. 效果
6. 结束语

简介

本人在工作中用到Spring Cloud Gateway作为网关服务为公司提供服务，它具体的优点有：集成了Netty,实现了非阻塞式的请求转发处理，采用WebFlux架构风格，有完善的各类内置filter，方便扩展和动态配置。以后会记录常用的一些配置，这一期记录的是简单的搭建和一个集转发、重写、限流、熔断的路由配置规则示例：

环境

Idea2019
Jdk1.8
Maven3.6.3

简单搭建

首先要搭建一个Spring Cloud Gateway服务。

pom依赖配置

因为我的Gateway配置是在redis中的所以引入了Gateway和Redis如下依赖：

<!--gateway 网关依赖,内置webflux 依赖-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--redis依赖，为了读取路由配置-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
</dependency>

application.yml配置

指定对外端口号，并加上了Hystrix超时配置

server:
  port: 8090
hystrix:
  command:
    default:
      execution:
        isolation:
          strategy: SEMAPHORE
          thread:
            timeoutInMilliseconds: 10000

启动类代码

启动类中加入@EnableCircuitBreaker注解以启用Hystrix

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

}

改为Redis读取路由规则

/**
 *
 * redis 保存路由信息，优先级比配置文件高
 */
@Slf4j
@Component
@AllArgsConstructor
public class RedisRouteDefinitionWriter implements RouteDefinitionRepository {
	private final RedisTemplate redisTemplate;

	/**
	 * 动态路由入口
	 *
	 * @return
	 */
	@Override
	public Flux<RouteDefinition> getRouteDefinitions() {
		redisTemplate.setKeySerializer(new StringRedisSerializer());
		redisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer<>(RouteDefinitionVo.class));
		List<RouteDefinitionVo> values = redisTemplate.opsForHash().values(CommonConstants.ROUTE_KEY_TOBASE);
		List<RouteDefinition> definitionList = new ArrayList<>();
		values.forEach(vo -> {
			RouteDefinition routeDefinition = new RouteDefinition();
			BeanUtils.copyProperties(vo, routeDefinition);
			definitionList.add(vo);
		});
		log.debug("redis 中路由定义条数： {}， {}", definitionList.size(), definitionList);
		return Flux.fromIterable(definitionList);
	}
}

配置记录

如下是一个带有转发、限流、熔断、重写路径的配置，将网关的/xxx-api/Account/Login2路径转发的下游服务的/xxx-api/Account/Login路径去，并实现了限流和熔断。
url:

1 2	// 转发到的子服务 http://子服务名:端口

predicates:

[
    {
        "args": {
            "_genkey_0": "/xxx-api/Account/Login2/**"
        },
        "name": "Path"
    }
]

filters:

[
    {// 限流配置
        "args": {
            "key-resolver": "#{@remoteAddrKeyResolver}",
            "redis-rate-limiter.burstCapacity": "3",
            "redis-rate-limiter.replenishRate": "3"
        },
        "name": "RequestRateLimiter"
    },
    {// 重写路径配置
        "args": {
            "regexp": "/Account/Login2",
            "replacement": "/Account/Login"
        },
        "name": "RewritePath"
    },
    {// 熔断处理配置
        "args": {
            "name": "default",
            "fallbackUri": "forward:/fallback"
        },
        "name": "Hystrix"
    }
]