springcloud gateway動態路由實現，mysql存儲配置

本文轉載自查看原文 2021-02-05 14:23 971 springcloud gateway/ springcloud

1、mysql數據庫表結構

2、pom.xml依賴

<dependency>
<groupId>org.springframework.boot </groupId>
<artifactId>spring-boot-starter-actuator </artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud </groupId>
<artifactId>spring-cloud-starter-gateway </artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud </groupId>
<artifactId>spring-cloud-gateway-webflux </artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot </groupId>
<artifactId>spring-boot-starter-data-redis </artifactId>
</dependency>

3、application.yml添加

#開啟端點
management:
endpoints:
web:
exposure:
include: '*'
security:
enabled: false

4、核心配置類，加載路由配置到redis，官網核心包從redis獲取路由配置，提高效率

import com.alibaba.fastjson.JSON;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.gateway.route.RouteDefinition;
import org.springframework.cloud.gateway.route.RouteDefinitionRepository;
import org.springframework.cloud.gateway.support.NotFoundException;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import java.util.ArrayList;
import java.util.List;
/**
*將定義好的路由表信息通過此類讀寫到redis中
*/
@Component
public class RedisRouteDefinitionRepository implements RouteDefinitionRepository {
public static final String GATEWAY_ROUTES = "gateway:routes";
@Autowired
private RedisTemplate< String, Object> redisTemplate;
//請注意，此方法很重要，從redis取路由信息的方法，官方核心包要用，核心路由功能都是從redis取的
@Override
public Flux<RouteDefinition> getRouteDefinitions() {
List<RouteDefinition> routeDefinitions = new ArrayList<>();
redisTemplate.opsForHash().values(GATEWAY_ROUTES).stream().forEach(routeDefinition -> {
routeDefinitions.add( JSON.parseObject(routeDefinition.toString(), RouteDefinition.class));
});
return Flux.fromIterable(routeDefinitions);
}
@Override
public Mono<Void> save(Mono<RouteDefinition> route) {
return route
.flatMap(routeDefinition -> {
redisTemplate.opsForHash().put(GATEWAY_ROUTES, routeDefinition.getId(),
JSON.toJSONString(routeDefinition));
return Mono.empty();
});
}
@Override
public Mono<Void> delete(Mono< String> routeId) {
return routeId.flatMap(id -> {
if (redisTemplate.opsForHash().hasKey(GATEWAY_ROUTES, id)) {
redisTemplate.opsForHash().delete(GATEWAY_ROUTES, id);
return Mono.empty();
}
return Mono.defer(() -> Mono.error( new NotFoundException( "路由文件沒有找到: " + routeId)));
});
}
}

5、核心配置類，項目初始化加載數據庫的路由配置到redis

import java.net.URI;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.cloud.gateway.event.RefreshRoutesEvent;
import org.springframework.cloud.gateway.filter.FilterDefinition;
import org.springframework.cloud.gateway.handler.predicate.PredicateDefinition;
import org.springframework.cloud.gateway.route.RouteDefinition;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationEventPublisherAware;
import org.springframework.stereotype.Service;
import org.springframework.web.util.UriComponentsBuilder;
import com.alibaba.fastjson.JSON;
import com.smc.gateway.dao.GatewayRouteMapper;
import com.smc.gateway.entity.GatewayRoute;
import com.smc.gateway.repository.RedisRouteDefinitionRepository;
import lombok.extern.slf4j.Slf4j;
import reactor.core.publisher.Mono;
@Slf4j
@Service
public class GatewayServiceHandler implements ApplicationEventPublisherAware, CommandLineRunner {
@Autowired
private RedisRouteDefinitionRepository routeDefinitionWriter;
private ApplicationEventPublisher publisher;
@Override
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
this.publisher = applicationEventPublisher;
}
//自己的獲取數據dao
@Autowired
private GatewayRouteMapper gatewayRouteMapper;
@Override
public void run(String... args){
this.loadRouteConfig();
}
public String loadRouteConfig() {
log.info( "====開始加載=====網關配置信息=========");
//刪除redis里面的路由配置信息
redisTemplate.delete(RedisRouteDefinitionRepository.GATEWAY_ROUTES);
//從數據庫拿到基本路由配置
List<GatewayRoute> gatewayRouteList = gatewayRouteMapper.queryAllRoutes();
gatewayRouteList.forEach(gatewayRoute -> {
RouteDefinition definition=handleData(gatewayRoute);
routeDefinitionWriter.save(Mono.just(definition)).subscribe();
});
this.publisher.publishEvent( new RefreshRoutesEvent( this));
log.info( "=======網關配置信息===加載完成======");
return "success";
}
public void saveRoute(GatewayRoute gatewayRoute){
RouteDefinition definition=handleData(gatewayRoute);
routeDefinitionWriter.save(Mono.just(definition)).subscribe();
this.publisher.publishEvent( new RefreshRoutesEvent( this));
}
public void update(GatewayRoute gatewayRoute) {
RouteDefinition definition=handleData(gatewayRoute);
try {
this.routeDefinitionWriter.delete(Mono.just(definition.getId()));
routeDefinitionWriter.save(Mono.just(definition)).subscribe();
this.publisher.publishEvent( new RefreshRoutesEvent( this));
} catch (Exception e) {
e.printStackTrace();
}
}
public void deleteRoute(String routeId){
routeDefinitionWriter.delete(Mono.just(routeId)).subscribe();
this.publisher.publishEvent( new RefreshRoutesEvent( this));
}
/**
* 路由數據轉換公共方法
* @param gatewayRoute
* @return
*/
private RouteDefinition handleData(GatewayRoute gatewayRoute){
RouteDefinition definition = new RouteDefinition();
Map<String, String> predicateParams = new HashMap<>( 8);
PredicateDefinition predicate = new PredicateDefinition();
FilterDefinition filterDefinition = new FilterDefinition();
Map<String, String> filterParams = new HashMap<>( 8);
URI uri = null;
if(gatewayRoute.getUri().startsWith( "http")){
//http地址
uri = UriComponentsBuilder.fromHttpUrl(gatewayRoute.getUri()).build().toUri();
} else{
//注冊中心
uri = UriComponentsBuilder.fromUriString( "lb://"+gatewayRoute.getUri()).build().toUri();
}
definition.setId(gatewayRoute.getServiceId());
// 名稱是固定的，spring gateway會根據名稱找對應的PredicateFactory
predicate.setName( "Path");
predicateParams.put( "pattern",gatewayRoute.getPredicates());
predicate.setArgs(predicateParams);
// 名稱是固定的, 路徑去前綴
filterDefinition.setName( "StripPrefix");
filterParams.put( "_genkey_0", gatewayRoute.getFilters().toString());
filterDefinition.setArgs(filterParams);
definition.setPredicates(Arrays.asList(predicate));
definition.setFilters(Arrays.asList(filterDefinition));
definition.setUri(uri);
definition.setOrder(Integer.parseInt(gatewayRoute.getGOrder()));
return definition;
}
}

6、自定義controller層；

直接在數據庫添加路由配置信息；

前端頁面增、刪、改路由配置信息，並刷新redis使配置信息立即生效；

import org.springframework.beans.factory. annotation.Autowired;
import org.springframework.web.bind. annotation.GetMapping;
import org.springframework.web.bind. annotation.PathVariable;
import org.springframework.web.bind. annotation.PostMapping;
import org.springframework.web.bind. annotation.RequestBody;
import org.springframework.web.bind. annotation.RequestMapping;
import org.springframework.web.bind. annotation.RestController;
import org.springframework.beans.BeanUtils;
import com.smc.gateway.dto.GatewayRouteDto;
import com.smc.gateway.route.GatewayRouteService;
import com.smc.gateway.route.GatewayServiceHandler;
@RestController
@RequestMapping("/route")
public class RouteController {
@Autowired
private GatewayServiceHandler gatewayServiceHandler;
@Autowired
private GatewayRouteService gatewayRouteService;
/**
* 刷新路由配置
*
* @param gwdefinition
* @return
*/
@GetMapping("/refresh")
public String refresh() throws Exception {
return this.gatewayServiceHandler.loadRouteConfig();
}
/**
* 增加路由記錄
*
* @param gwdefinition
* @return
*/
@PostMapping("/add")
public String add( @RequestBody GatewayRouteDto gatewayRouteDto) throws Exception {
gatewayRouteService.add(gatewayRouteDto);
GatewayRoute gatewayRoute=new GatewayRoute();
BeanUtils.copyProperties(gatewayRouteDto, gatewayRoute);
gatewayServiceHandler.saveRoute(gatewayRoute);
return "success";
}
@PostMapping("/update")
public String update( @RequestBody GatewayRouteDto gatewayRouteDto) throws Exception {
gatewayRouteService.update(gatewayRouteDto);
GatewayRoute gatewayRoute=new GatewayRoute();
BeanUtils.copyProperties(gatewayRouteDto, gatewayRoute);
gatewayServiceHandler.update(gatewayRoute);
return "success";
}
@GetMapping("/delete")
public String delete( @PathVariable String id) throws Exception {
gatewayRouteService.delete(id);
gatewayServiceHandler.deleteRoute(id);
return "success";
}
}

7、自定義service層，增、刪、改、查數據庫路由配置信息

import java.util.Date;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.smc.gateway.dao.GatewayRouteMapper;
import com.smc.gateway.dto.GatewayRouteDto;
import com.smc.gateway.entity.GatewayRoute;
@Service
public class GatewayRouteService {
@Autowired
private GatewayRouteMapper gatewayRouteMapper;
public Integer add(GatewayRouteDto gatewayRouteDto) {
GatewayRoute gatewayRoute = new GatewayRoute();
BeanUtils.copyProperties(gatewayRouteDto, gatewayRoute);
gatewayRoute.setCreateDate( new Date());
gatewayRoute.setCreatorId( "");
return gatewayRouteMapper.insertSelective(gatewayRoute);
}
public Integer update(GatewayRouteDto gatewayRouteDto) {
GatewayRoute gatewayRoute = new GatewayRoute();
BeanUtils.copyProperties(gatewayRouteDto, gatewayRoute);
gatewayRoute.setUpdateDate( new Date());
gatewayRoute.setUpdateId( "");
return gatewayRouteMapper.updateByPrimaryKeySelective(gatewayRoute);
}
public Integer delete( String id) {
return gatewayRouteMapper.deleteByPrimaryKey(Long.parseLong(id));
}
}

8、前端參數dto

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class GatewayRouteDto {
private Long id;
private String serviceId;
private String uri;
private String predicates;
private String filters;
private String order;
private String remarks;
}

9、數據庫實體

import java.util.Date;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
/**
* Created by Mybatis Generator on 2019/06/17
*/
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class GatewayRoute {
private Long id;
private String serviceId;
private String uri;
private String predicates;
private String filters;
private String order;
private String creatorId;
private Date createDate;
private String updateId;
private Date updateDate;
private String remarks;
private String delFlag;
}

10、訪問地址

查看路由配置信息 http://localhost:18080/actuator/gateway/routes

手動刷新路由配置信息 http://localhost:18080/route/refresh