0. 前言
结合上一篇观看
使用Feign进行远程调用
搭建Spring Cloud Gateway网关服务
配置Spring Cloud Gateway路由过滤器
配置Spring Cloud Gateway全局过滤器
搭建Spring Cloud Confifig配置中心服务
使用Spring Cloud Bus实时更新配置
1. Feign
1.1 简介
在前面的学习中,使用了Ribbon的负载均衡功能,大大简化了远程调用时的代码:
String url = "http://user-service/user/" + id;
User user = this.restTemplate.getForObject(url, User.class)
如果就学到这里,你可能以后需要编写类似的大量重复代码,格式基本相同,无非参数不一样。有没有更优雅的方
式,来对这些代码再次优化呢?
Feign也叫伪装:
Feign可以把Rest的请求进行隐藏,伪装成类似SpringMVC的Controller一样。你不用再自己拼接url,拼接参数等等操作,一切都交给Feign去做。
项目主页:https://github.com/OpenFeign/feign
1.2 快速入门
导入依赖
在在 consumer-demo 项目的 pom.xml 文件中添加如下依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
Feign的客户端
在 consumer-demo 中编写如下Feign客户端接口类:
@FeignClient("user-service")
public interface UserClient {
// http://user-service/user/123
@GetMapping("/user/{id}")
User queryByid(@PathVariable("id") Long id);
}
首先这是一个接口,Feign会通过动态代理,帮我们生成实现类。这点跟mybatis的mapper很像
@FeignClient ,声明这是一个Feign客户端,同时通过 value 属性指定服务名称
接口中的定义方法,完全采用SpringMVC的注解,Feign会根据注解帮我们生成URL,并访问获取结果
@GetMapping中的/user,请不要忘记;因为Feign需要拼接可访问的地址
编写新的控制器类 ConsumerFeignController ,使用UserClient访问:这里注入了刚才编写的UserClient,它会自动去请求编写好的url去查询
@RestController
@RequestMapping("/cf")
public class ConsumerFeignController {
@Autowired
private UserClient userClient;
@GetMapping("/{id}")
public User queryById(@PathVariable Long id){
return userClient.queryByid(id);
}
}
开启功能
在 ConsumerApplication 启动类上,添加注解,开启Feign功能
@SpringCloudApplication
@EnableFeignClients //开启Feign功能
public class ConsumerApplication {
public static void main(String[] args) {
SpringApplication.run(ConsumerApplication.class, args);
}
@LoadBalanced
@Bean
public RestTemplate restTemplate(){
return new RestTemplate();
}
}
Feign中已经自动集成了Ribbon负载均衡,因此不需要自己定义RestTemplate进行负载均衡的配置。
启动测试
浏览器访问地址地址��:http://localhost:8080/cf/1
1.3 负载均衡
Feign中本身已经集成了Ribbon依赖和自动配置:点击右边maven栏查看依赖
因此不需要额外引入依赖,也不需要再注册 RestTemplate 对象。只需要添加配置项即可
Fegin内置的ribbon默认设置了请求超时时长,默认是1000,我们可以通过手动配置来修改这个超时时长:
ribbon: ReadTimeout: 2000 # 读取超时时长
ConnectTimeout: 1000 # 建立链接的超时时长
因为ribbon内部有重试机制,一旦超时,会自动重新发起请求。如果不希望重试,可以修改 consumer-demo的application.yml 添加如下配置:
ribbon:
ConnectTimeout: 1000 # 连接超时时长
ReadTimeout: 2000 # 数据通信超时时长
MaxAutoRetries: 0 # 当前服务器的重试次数
MaxAutoRetriesNextServer: 0 # 重试多少次服务
OkToRetryOnAllOperations: false # 是否对所有的请求方式都重试
此时在启动类和之前的ConsumerController类注释掉Resttemplate,再启动consumer-demo,输入地址http://localhost:8080/cf/1,能成功获取
重新给UserService的方法设置上线程沉睡时间2秒可以测试上述配置
1.4 Hystrix支持
Feign默认也有对Hystrix的集成:
只不过,默认情况下是关闭的。需要通过下面的参数来开启;
修改 consumer-demo的application.yml 添加如下配置:
feign:
hystrix:
enabled: true # 开启Feign的熔断功能
但是,Feign中的Fallback配置不像Ribbon中那样简单了。
1)首先,要定义一个类,实现刚才编写的UserFeignClient,作为fallback的处理类
package org.example.fallback;
import org.example.client.UserClient;
import org.example.pojo.User;
import org.springframework.stereotype.Component;
/**
* @ClassName UserClientFallback
* @Description TODO
* @Author Patrick Star
* @Date 2020/12/18 11:06 下午
*/
@Component
public class UserClientFallback implements UserClient {
@Override
public User queryByid(Long id) {
User user = new User();
user.setId(id);
user.setName("用户异常");
return user;
}
}
2)然后在UserClient中,指定刚才编写的实现类
package org.example.client;
import org.example.fallback.UserClientFallback;
import org.example.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
/**
* @ClassName UserClient
* @Description TODO
* @Author Patrick Star
* @Date 2020/12/18 10:00 下午
*/
@FeignClient(value="user-service",fallback= UserClientFallback.class)
public interface UserClient {
// http://user-service/user/123
@GetMapping("/user/{id}")
User queryByid(@PathVariable("id") Long id);
}
3)重启测试
重启启动 consumer-demo 并关闭 user-service 服务,然后在页面访问:http://localhost:8080/cf/1
1.5 请求压缩
Spring Cloud Feign 支持对请求和响应进行GZIP压缩,以减少通信过程中的性能损耗。通过下面的参数即可开启请求与响应的压缩功能:
feign:
hystrix:
enabled: true # 开启Feign的熔断功能
compression:
request:
enabled: true # 开启请求压缩
response:
enabled: true
同时,我们也可以对请求的数据类型,以及触发压缩的大小下限进行设置:
feign:
hystrix:
enabled: true # 开启Feign的熔断功能
compression:
request:
enabled: true # 开启请求压缩
response:
enabled: true
mime-types: text/html,application/xml,application/json # 设置压缩的数据类型
min-request-size: 2048 # 设置触发压缩的大小下限
注:上面的数据类型、压缩大小下限均为默认值。
1.6 日志级别
前面讲过,通过 logging.level.xx=debug
来设置日志级别。然而这个对Fegin客户端而言不会产生效果。因为
@FeignClient
注解修改的客户端在被代理时,都会创建一个新的Fegin.Logger
实例。我们需要额外指定这个日志的
级别才可以。
1)在 consumer-demo 的配置文件中设置org.example包下的日志级别都为 debug
修改 consumer-demo的application.yml 添加如下配置:
logging:
level:
org.example: debug
2)在 consumer-demo 编写FeignConfifig配置类,定义日志级别
@Configuration
public class FeignConfig {
@Bean
Logger.Level feignLoggerLevel(){
//记录所有请求和响应的明细,包括头信息、请求体、元数据
return Logger.Level.FULL;
}
}
这里指定的Level级别是FULL,Feign支持4种级别:
NONE:不记录任何日志信息,这是默认值。
BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
3)在 consumer-demo 的 UserClient 接口类上的@FeignClient注解中指定配置类:
@FeignClient(value="user-service",fallback= UserClientFallback.class,configuration = FeignConfig.class )
public interface UserClient {
// http://user-service/user/123
@GetMapping("/user/{id}")
User queryByid(@PathVariable("id") Long id);
}
4)重启项目,访问:http://localhost:8080/cf/1 ;即可看到每次访问的日志:
2. Spring Cloud Gateway网关
2.1 简介
- Spring Cloud Gateway是Spring官网基于Spring 5.0、 Spring Boot 2.0、Project Reactor等技术开发的网关服
务。
Spring Cloud Gateway基于Filter链提供网关基本功能:安全、监控/埋点、限流等。
Spring Cloud Gateway为微服务架构提供简单、有效且统一的API路由管理方式。
Spring Cloud Gateway是替代Netflflix Zuul的一套解决方案。
Spring Cloud Gateway组件的核心是一系列的过滤器,通过这些过滤器可以将客户端发送的请求转发(路由)到对
应的微服务。 Spring Cloud Gateway是加在整个微服务最前沿的防火墙和代理器,隐藏微服务结点IP端口信息,从
而加强安全保护。Spring Cloud Gateway本身也是一个微服务,需要注册到Eureka服务注册中心。
网关的核心功能是:过滤和路由
2.2 Gateway加入后的架构
不管是来自于客户端(PC或移动端)的请求,还是服务内部调用。一切对服务的请求都可经过网关,然后再由
网关来实现 鉴权、动态路由等等操作。Gateway就是我们服务的统一入口。
2.3 核心概念
路由(route) 路由信息的组成:由一个ID、一个目的URL、一组断言工厂、一组Filter组成。如果路由断言为真,说明请求URL和配置路由匹配。
断言(Predicate) Spring Cloud Gateway中的断言函数输入类型是Spring 5.0框架中的ServerWebExchange。Spring Cloud Gateway的断言函数允许开发者去定义匹配来自于Http Request中的任何信息比如请求头和参数。
过滤器(Filter) 一个标准的Spring WebFilter。 Spring Cloud Gateway中的Filter分为两种类型的Filter,分别是Gateway Filter和Global Filter。过滤器Filter将会对请求和响应进行修改处理。
2.4 快速入门
新建module命名为example-gateway,修改pom.xml
添加gateway依赖和erueka-client
<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>
</dependencies>
example-gateway中创建启动类
在example-gateway中创建 org.example.gateway.GatewayApplication 启动类
@SpringBootApplication
@EnableDiscoveryClient
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class, args);
}
}
编写配置文件
修改application.yml
server:
port: 10001
spring:
application:
name: api-gateway
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:10086/eureka
instance:
prefer-ip-address: true
编写路由规则
需要用网关来代理 user-service 服务,先看一下控制面板中的服务状态:
其中ip地址为我的内网地址,我们可以使用本地地址localhost访问
端口为9091
修改gateway的application.yml的spring的配置
spring:
application:
name: api-gateway
cloud:
gateway:
routes:
# 路由id,可以任意
- id: user-service-route
# 代理的服务地址
uri: http://127.0.0.1:9091
# 路由断言: 可以匹配映射路径
predicates:
- Path=/user/**
将符合 Path 规则的一切请求,都代理到 uri 参数指定的地址
本例中,我们将路径中包含有 /user/** 开头的请求,代理到http://127.0.0.1:9091
启动测试:访问http://localhost:10001/user/1
2.5 面向服务的路由
在刚才的路由规则中,把路径对应的服务地址写死了!如果同一服务有多个实例的话,这样做显然不合理。
应该根据服务的名称,去Eureka注册中心查找 服务对应的所有实例列表,然后进行动态路由!
因为已经配置了Eureka客户端,可以从Eureka获取服务的地址信息。
修改 gateway的application.yml 文件如下:
spring:
application:
name: api-gateway
cloud:
gateway:
routes:
# 路由id,可以任意
- id: user-service-route
# 代理的服务地址
# uri: http://127.0.0.1:9091
# lb表示从eureka中获取具体服务
uri: lb://user-service
# 路由断言: 可以匹配映射路径
predicates:
- Path=/user/**
路由配置中uri所用的协议为lb时(以uri: lb://user-service为例),gateway将使用 LoadBalancerClient把
user-service通过eureka解析为实际的主机和端口,并进行ribbon负载均衡。
启动测试,这时候gateway进行代理时候,会利用Ribbon进行负载均衡访问:
当我们访问http://localhost:10001/user/1
查看控制台,可以看到动态路由到了user-service同时使用了负载均衡。
2.6 路由前缀
提供服务的地址:http://127.0.0.1:9091/user/8
- 添加前缀:对请求地址添加前缀路径之后再作为代理的服务地址;
http://127.0.0.1:10010/8 --> http://127.0.0.1:9091/user/8 添加前缀路径/user
- 去除前缀:将请求地址中路径去除一些前缀路径之后再作为代理的服务地址;
http://127.0.0.1:10010/api/user/8 --> http://127.0.0.1:9091/user/8 去除前缀路径/api
添加前缀
在gateway中可以通过配置路由的过滤器PrefifixPath,实现映射路径中地址的添加;
修改 gateway的\application.yml 文件:
spring:
application:
name: api-gateway
cloud:
gateway:
routes:
# 路由id,可以任意
- id: user-service-route
# 代理的服务地址
# uri: http://localhost:9091
# lb表示从eureka中获取具体服务
uri: lb://user-service
# 路由断言: 可以匹配映射路径
predicates:
# - Path=/user/**
- Path=/**
filters:
# 添加请求路径的前缀
- PrefixPath=/user
注意,这里需要将路径断言修改为/**
,因为我们要补充前缀
通过 PrefixPath=/xxx 来指定了路由要添加的前缀。
也就是:
PrefixPath=/user http://localhost:10010/1 --》http://localhost:9091/user/1
PrefixPath=/user/abc http://localhost:10010/1 --》http://localhost:9091/user/abc/1
以此类推。
去除前缀
在gateway中可以通过配置路由的过滤器StripPrefifix,实现映射路径中地址的去除,修改application.yml
spring:
application:
name: api-gateway
cloud:
gateway:
routes:
# 路由id,可以任意
- id: user-service-route
# 代理的服务地址
# uri: http://localhost:9091
# lb表示从eureka中获取具体服务
uri: lb://user-service
# 路由断言: 可以匹配映射路径
predicates:
# - Path=/user/**
# - Path=/**
- Path=/api/user/**
filters:
# 添加请求路径的前缀
# - PrefixPath=/user
#1表示过滤1个路径,2表示两个路径,以此类推
- StripPrefix=1
这里1表示过滤路径,这里只有一个/api/,也就是对一个路径/xx/xx/xx..这样的路径中xx的个数
通过 StripPrefix=1 来指定了路由要去掉的前缀个数。如:路径 /api/user/1 将会被代理到 /user/1 。
也就是:
StripPrefix=1 http://localhost:10010/api/user/8 --》http://localhost:9091/user/8
StripPrefix=2 http://localhost:10010/api/user/8 --》http://localhost:9091/8
以此类推。
2.7 过滤器
Gateway作为网关的其中一个重要功能,就是实现请求的鉴权。而这个动作往往是通过网关提供的过滤器来实现的。
前面的 路由前缀 章节中的功能也是使用过滤器实现的。
Gateway自带过滤器有几十个,常见自带过滤器有:
过滤器名称 | 说明 |
---|---|
AddRequestHeader | 对匹配上的请求加上Header |
AddRequestParameters | 对匹配上的请求路由添加参数 |
AddResponseHeader | 对从网关返回的响应添加Header |
StripPrefifix | 对匹配上的请求路径去除前缀 |
详细的说明在官网链接
配置全局默认过滤器
这些自带的过滤器可以和使用 路由前缀 章节中的用法类似,也可以将这些过滤器配置成不只是针对某个路由;而是
可以对所有路由生效,也就是配置默认过滤器:
spring:
application:
name: api-gateway
cloud:
gateway:
routes:
# 路由id,可以任意
- id: user-service-route
# 代理的服务地址
# uri: http://localhost:9091
# lb表示从eureka中获取具体服务
uri: lb://user-service
# 路由断言: 可以匹配映射路径
predicates:
# - Path=/user/**
# - Path=/**
- Path=/api/user/**
filters:
# 添加请求路径的前缀
# - PrefixPath=/user
#1表示过滤1个路径,2表示两个路径,以此类推
- StripPrefix=1
# 默认过滤器,对所有路由都生效
default-filters:
- AddResponseHeader=X-Response-Foo, Bar
# 响应头过滤器,对输出的响应设置其头部属性名称为X-Response-Default-MyName,值为example;
# 如果有多个参数多则重写一行设置不同的参数
- AddResponseHeader=Response-Default-MyName,example
在这里我们增加了一个ResponseHeader,浏览器访问http://127.0.0.1:10001/api/user/8,打开浏览器控制台,查看响应信息
过滤器类型:Gateway实现方式上,有两种过滤器;
局部过滤器:通过
spring.cloud.gateway.routes.filters
配置在具体路由下,只作用在当前路由上;自带的过滤器都可以配置或者自定义按照自带过滤器的方式。如果配置spring.cloud.gateway.default-filters
上会对所有路由生效也算是全局的过滤器;但是这些过滤器的实现上都是要实现GatewayFilterFactory
接口。全局过滤器:不需要在配置文件中配置,作用在所有的路由上;实现
GlobalFilter
接口即可。
执行生命周期
Spring Cloud Gateway 的 Filter 的生命周期也类似Spring MVC的拦截器有两个:“pre” 和 “post”。“pre”和 “post” 分别会在请求被执行前调用和被执行后调用。
这里的 pre
和 post
可以通过过滤器的 GatewayFilterChain
执行fifilter方法前后来实现。
常见的应用场景如下:
请求鉴权:一般 GatewayFilterChain
执行fifilter方法前,如果发现没有访问权限,直接就返回空。
异常处理:一般 GatewayFilterChain
执行fifilter方法后,记录异常并返回。
服务调用时长统计: GatewayFilterChain
执行fifilter方法前后根据时间统计。
2.8 自定义过滤器
自定义局部过滤器
需求:在过滤器(MyParamGatewayFilterFactory)中将http://localhost:10010/api/user/{id}?name={name}中的参数name的值获取到并输出到控制台;并且参数名是可变的,也就是不一定每次都是name;需要可以通过配置过滤器的时候做到配置参数名。****
编写过滤器
在gateway工程编写过滤器工厂类MyParamGatewayFilterFactory
package org.example.gateway.filter;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.stereotype.Component;
import java.util.Arrays;
import java.util.List;
/**
* @ClassName MyParamGatewayFilterFactory
* @Description TODO
* @Author Patrick Star
* @Date 2020/12/20 10:32 上午
*/
@Component
public class MyParamGatewayFilterFactory extends AbstractGatewayFilterFactory<MyParamGatewayFilterFactory.Config> {
public static final String PARAM_NAME = "param";
public MyParamGatewayFilterFactory() {
super(Config.class);
}
/**
* Returns hints about the number of args and the order for shortcut parsing.
*
* @return the list of hints
*/
@Override
public List<String> shortcutFieldOrder() {
return Arrays.asList(PARAM_NAME);
}
@Override
public GatewayFilter apply(Config config) {
return (exchange, chain) -> {
// http://localhost:10001/api/user/11?name=雷军 config.param ==> name
//获取请求参数中param对应的参数名 的参数值
ServerHttpRequest request = exchange.getRequest();
if (request.getQueryParams().containsKey(config.param)) {
request.getQueryParams()
.get(config.param)
.forEach(value -> System.out.printf("------------局部过滤器--------%s = %s------", config.param, value));
}
return chain.filter(exchange);
};
}
public static class Config {
//对应在配置过滤器的时候指定的参数名
private String param;
public String getParam() {
return param;
}
public void setParam(String param) {
this.param = param;
}
}
}
修改配置文件
spring:
application:
name: api-gateway
cloud:
gateway:
routes:
# 路由id,可以任意
- id: user-service-route
# 代理的服务地址
# uri: http://localhost:9091
# lb表示从eureka中获取具体服务
uri: lb://user-service
# 路由断言: 可以匹配映射路径
predicates:
# - Path=/user/**
# - Path=/**
- Path=/api/user/**
filters:
# 添加请求路径的前缀
# - PrefixPath=/user
#1表示过滤1个路径,2表示两个路径,以此类推
- StripPrefix=1
- MyParam=name
# 默认过滤器,对所有路由都生效
default-filters:
- AddResponseHeader=X-Response-Foo, Bar
# 响应头过滤器,对输出的响应设置其头部属性名称为X-Response-Default-MyName,值为example;
# 如果有多个参数多则重写一行设置不同的参数
- AddResponseHeader=Response-Default-MyName,example
注意:自定义过滤器的命名应该为:***GatewayFilterFactory
到此我们设置了一个局部过滤器,然后通过浏览器访问uri后面添加name参数http://127.0.0.1:10001/api/user/11?name=雷军
查看控制台,会打印一个
------------局部过滤器--------name = 雷军------
自定义全局过滤器
需求:模拟一个登录的校验。基本逻辑:如果请求中有token参数,则认为请求有效,放行。
在gateway工程编写全局过滤器类MyGlobalFilter,实现接口GlobalFilter为了让filter有先后顺序,再实现一个接口Ordered
package org.example.gateway.filter;
import org.apache.commons.lang.StringUtils;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
/**
* @ClassName MyGlobalFilter
* @Description TODO
* @Author Patrick Star
* @Date 2020/12/20 11:00 上午
*/
@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
System.out.println("--------------全局过滤器MyGlobalFilter------------------");
String token = exchange.getRequest().getQueryParams().getFirst("token");
if(StringUtils.isBlank(token)){
//设置响应状态码为未授权
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
@Override
public int getOrder() {
//值越小越先执行
return 1;
}
}
重启gateway,使用postman访问查看状态码,可以看到显示了401 Unauthorized
当我们加入token,并且把它放在 参数的第一个位置,我们就能成功访问了
2.9 负载均衡和熔断
Gateway中默认就已经集成了Ribbon负载均衡和Hystrix熔断机制。但是所有的超时策略都是走的默认值,比如熔断超时时间只有1S,很容易就触发了。因此建议手动进行配置:
添加
hystrix:
command:
default:
execution:
isolation:
thread:
timeoutInMilliseconds: 6000
ribbon:
ConnectTimeout: 1000
ReadTimeout: 2000
MaxAutoRetries: 0
MaxAutoRetriesNextServer: 0
2.10 Gateway跨域配置
一般网关都是所有微服务的统一入口,必然在被调用的时候会出现跨域问题。
跨域:在js请求访问中,如果访问的地址与当前服务器的域名、ip或者端口号不一致则称为跨域请求。若不解决则不能获取到对应地址的返回结果。
如:从在http://localhost:9090中的js访问 http://localhost:9000的数据,因为端口不同,所以也是跨域请求。
在访问Spring Cloud Gateway网关服务器的时候,出现跨域问题的话;可以在网关服务器中通过配置解决,允许哪些服务是可以跨域请求的;具体配置如下:
spring:
application:
name: api-gateway
cloud:
gateway:
routes:
# 路由id,可以任意
- id: user-service-route
# 代理的服务地址
# uri: http://localhost:9091
# lb表示从eureka中获取具体服务
uri: lb://user-service
# 路由断言: 可以匹配映射路径
predicates:
# - Path=/user/**
# - Path=/**
- Path=/api/user/**
filters:
# 添加请求路径的前缀
# - PrefixPath=/user
#1表示过滤1个路径,2表示两个路径,以此类推
- StripPrefix=1
- MyParam=name
# 默认过滤器,对所有路由都生效
default-filters:
- AddResponseHeader=X-Response-Foo, Bar
# 响应头过滤器,对输出的响应设置其头部属性名称为X-Response-Default-MyName,值为example;
# 如果有多个参数多则重写一行设置不同的参数
- AddResponseHeader=Response-Default-MyName,example
# 跨域问题配置
globalcors:
corsConfigurations:
'[/**]':
#allowedOrigins: * # 这种写法或者下面的都可以,*表示全部
allowedOrigins:
- "http://docs.spring.io"
allowedMethods:
- GET
上述配置表示:可以允许来自 http://docs.spring.io 的get请求方式获取服务数据。
allowedOrigins
指定允许访问的服务器地址,如:http://localhost:10000 也是可以的。
'[/**]'
表示对所有访问到网关服务器的请求地址
2.11 Gateway的高可用
启动多个Gateway服务,自动注册到Eureka,形成集群。如果是服务内部访问,访问Gateway,自动负载均衡,没问题。
但是,Gateway更多是外部访问,PC端、移动端等。它们无法通过Eureka进行负载均衡,那么该怎么办?
此时,可以使用其它的服务网关,来对Gateway进行代理。比如:Nginx
2.12 Gateway与Feign的区别
Gateway 作为整个应用的流量入口,接收所有的请求,如PC、移动端等,并且将不同的请求转发至不同的处理微服务模块,其作用可视为nginx;大部分情况下用作权限鉴定、服务端流量控制
Feign 则是将当前微服务的部分服务接口暴露出来,并且主要用于各个微服务之间的服务调用
Gateway网关一般直接给终端请求使用;Feign一般用在微服务之间调用。
3. Sping Cloud Config分布式配置中心
3.1 简介
在分布式系统中,由于服务数量非常多,配置文件分散在不同的微服务项目中,管理不方便。为了方便配置文件集中管理,需要分布式配置中心组件。在Spring Cloud中,提供了Spring Cloud Confifig
,它支持配置文件放在配置服务的本地,也支持放在远程Git仓库(GitHub、码云)。
使用Spring Cloud Confifig配置中心后的架构如下图:
配置中心本质上也是一个微服务,同样需要注册到Eureka服务注册中心!
3.2 git配置管理
远程git仓库
github在国内访问比较慢,所以用码云来配置spring cloud的配置中心
创建一个spring-cloud-example-config仓库,本地clone下来,在新建的仓库中创建需要被统一配置管理的配置文件。
配置文件的命名方式:{application}-{profifile}.yml 或 {application}-{profifile}.properties
application为应用名称
profifile用于区分开发环境,测试环境、生产环境等
如user-dev.yml,表示用户微服务开发环境下使用的配置文件。
这里将user-service工程的配置文件application.yml文件的内容复制作为user-dev.yml文件的内容,具体配置如下:
#jdbc:
# driverClassName: com.mysql.jdbc.Driver
# url: jdbc:mysql://127.0.0.1:3306/test
# username: root
# password: root
#激活配置文件;需要制定其他的配置文件名称
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/test
username: root
password: root
redis:
host: localhost
port: 6379
application:
name: user-service
#日志记录级别
logging:
level:
org.example: debug
org.springframework: info
#tomcat端口
server:
port: ${port:9091}
# mybatis配置
mybatis:
# 实体类别名包路径
type-aliases-package: org.example.pojo
# 映射文件路径
# mapper-locations: classpath:mappers/*.xml
configuration:
# 控制台输出执行sql
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
eureka:
client:
service-url:
defaultZone: http://localhost:10086/eureka, http://localhost:10010/eureka
instance:
# 更倾向使用ip地址,而不是host名
prefer-ip-address: true
# ip地址
ip-address: 127.0.0.1
# 续约间隔,默认30秒
lease-renewal-interval-in-seconds: 5
# 服务失效时间,默认90秒
lease-expiration-duration-in-seconds: 5
本地修改后push到远程仓库
3.3 搭建配置中心微服务
新建module
新建一个module为 config-server
并添加依赖
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
</dependencies>
创建启动类
@SpringBootApplication
@EnableConfigServer //允许ConfigServer
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class);
}
}
创建配置文件
application.yml
server:
port: 12000
spring:
application:
name: config-server
cloud:
config:
server:
git:
uri: https://gitee.com/oneloop/spring-cloud-example-config.git
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:10086/eureka
注意上述的 spring.cloud.confifig.server.git.uri 则是在码云创建的仓库地址;可修改为你自己创建的仓库地址
启动测试
启动eureka注册中心和配置中心;然后访问http://localhost:12000/user-dev.yml ,查看能否输出在码云存储管理的
user-dev.yml文件。并且可以在gitee上修改user-dev.yml然后刷新上述测试地址也能及时到最新数据。
3.4 获取配置中心配置
前面已经完成了配置中心微服务的搭建,下面我们就需要改造一下用户微服务 user-service ,配置文件信息不再由微服务项目提供,而是从配置中心获取。如下对 user-service 工程进行改造。
添加依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
修改配置
删除 user-service 工程的 application.yml 文件(因为该文件从配置中心获取)
创建 user-service 工程 user-service\src\main\resources\bootstrap.yml 配置文件
spring:
cloud:
config:
# 要与仓库中的配置文件的application保持一致
name: user
# 要与仓库中的配置文件的profile保持一致
profile: dev
# 要与仓库中的配置文件所属的版本(分支)一样
label: master
discovery:
# 使用配置中心
enabled: true
# 配置中心服务名
service-id: config-server
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:10086/eureka
bootstrap.yml
文件也是Spring Boot的默认配置文件,而且其加载的时间相比于application.yml
更早。application.yml
和bootstrap.yml
虽然都是Spring Boot的默认配置文件,但是定位却不相同。
bootstrap.yml
可以理解成系统级别的一些参数配置,这些参数一般是不会变动的。application.yml
可以用来定义应用级别的参数,如果搭配spring cloud confifig
使用,application.yml
里面定义的文件可以实现动态替换。总结就是,
bootstrap.yml
文件相当于项目启动时的引导文件,内容相对固定。application.yml
文件是微服务的一些常规配置参数,变化比较频繁。
启动测试
启动注册中心 eureka-server 、配置中心 config-server 、用户服务 user-service ,如果启动没有报错其实已经
使用上配置中心内容,可以到注册中心查看,也可以检验 user-service 的服务。
4. Spring Cloud Bus 服务总线
4.1 问题
前面已经完成了将微服务中的配置文件集中存储在远程Git仓库,并且通过配置中心微服务从Git仓库拉取配置文件,
当用户微服务启动时会连接配置中心获取配置信息从而启动用户微服务。
如果我们更新Git仓库中的配置文件,那用户微服务是否可以及时接收到新的配置信息并更新呢?
修改在码云上的user-dev.yml文件,添加一个属性test.name。
test:
name: abboo
修改UserController
@RestController
public class UserController {
@Autowired
private UserService userService;
@Value("${test.name}")
private String name;
/**
* 根据用户id查询用户
*
* @param id 用户id
* @return 用户
*/
@GetMapping("/user/{id}")
public User queryById(@PathVariable long id) {
System.out.println("配置文件中的test.name = " + name);
return userService.queryById(id);
}
}
测试
依次启动注册中心 eureka-server 、配置中心 config-server 、用户服务 user-service ;然后修改Git仓库中的配置信息,访问用户微服务,查看输出内容。
结论:通过查看用户微服务控制台的输出结果可以发现,我们对于Git仓库中配置文件的修改并没有及时更新到用户微服务,只有重启用户微服务才能生效。
如果想在不重启微服务的情况下更新配置该如何实现呢? 可以使用Spring Cloud Bus
来实现配置的自动更新。
需要注意的是Spring Cloud Bus底层是基于RabbitMQ实现的,默认使用本地的消息队列服务,所以需要提前启动本地RabbitMQ服务(安装RabbitMQ以后才有),或者使用上次在这篇文章docker搭建RabbitMQ单机集群搭建的rabbitmq服务
4.2 Spring Cloud Bus简介
Spring Cloud Bus是用轻量的消息代理将分布式的节点连接起来,可以用于广播配置文件的更改或者服务的监控管理。也就是消息总线可以为微服务做监控,也可以实现应用程序之间相互通信。 Spring Cloud Bus可选的消息代理有RabbitMQ和Kafka。
使用了Bus之后:
4.3 改造配置中心
- 在 config-server 项目的pom.xml文件中加入Spring Cloud Bus相关依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-bus</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-stream-binder-rabbit</artifactId>
</dependency>
- 在 config-server 项目修改application.yml文件如下:
server:
port: 12000
spring:
application:
name: config-server
cloud:
config:
server:
git:
uri: https://gitee.com/oneloop/spring-cloud-example-config.git
配置rabbitmq信息;如果是都与默认值一致则不需要配置
rabbitmq:
host: asjunor.site
port: 5670
username: root
password: root
virtual-host: /example
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:10086/eureka
management:
endpoints:
web:
exposure: # 暴露触发消息总线的地址
include: bus-refresh
4.4 改造用户服务
- 在用户微服务 user-service 项目的pom.xml中加入Spring Cloud Bus相关依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
<version>2.2.6.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-bus</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-stream-binder-rabbit</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
- 修改 user-service 项目的bootstrap.yml如下:
spring:
cloud:
config:
# 要与仓库中的配置文件的application保持一致
name: user
# 要与仓库中的配置文件的profile保持一致
profile: dev
# 要与仓库中的配置文件所属的版本(分支)一样
label: master
discovery:
# 使用配置中心
enabled: true
# 配置中心服务名
service-id: config-server
# 配置rabbitmq信息;如果是都与默认值一致则不需要配置
rabbitmq:
host: asjunor.site
port: 5670
username: root
password: root
virtual-host: /example
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:10086/eureka
- 改造用户微服务 user-service 项目的UserController
@RestController
@RefreshScope //刷新配置
public class UserController {
... ...
}
4.5 测试
前面已经完成了配置中心微服务和用户微服务的改造,下面来测试一下,当我们修改了Git仓库中的配置文件,用户
微服务是否能够在不重启的情况下自动更新配置信息。
测试步骤:
第一步:依次启动注册中心 eureka-server 、配置中心 config-server 、用户服务 user-service
第二步:访问用户微服务http://localhost:9091/user/8;查看IDEA控制台输出结果
第三步:修改Git仓库中配置文件 user-dev.yml 的 test.name 内容
第四步:使用Postman或者RESTClient工具发送POST方式请求访问地址http://127.0.0.1:12000/actuator/bus-refresh
注意这一步中要用Post请求的方式,同时content-type要是application/json
第五步:访问用户微服务系统控制台查看输出结果
说明:
1、Postman或者RESTClient是一个可以模拟浏览器发送各种请求(POST、GET、PUT、DELETE等)的工具
2、请求地址http://127.0.0.1:12000/actuator/bus-refresh中 /actuator是固定的,/bus-refresh对应的是配置中心confifig-server中的application.yml文件的配置项include的内容
3、请求http://127.0.0.1:12000/actuator/bus-refresh地址的作用是访问配置中心的消息总线服务,消息总线服务接收到请求后会向消息队列中发送消息,各个微服务会监听消息队列。当微服务接收到队列中的消息后,会重新从配置中心获取最新的配置信息。