108-SpringCloud
SpringCloud 总架构图
一、远程调用 Spring Cloud Feign
前面学习中,使用RestTemplate大大简化了远程调用的代码:
1 |
|
如果就学到这里,你可能以后需要编写类似的大量重复代码,格式基本相同,无非参数不一样。有没有更优雅的方式,来对这些代码再次优化呢?
这就是接下来要学的Feign的功能了。
1.1 简介
Feign 的英文表意为“假装,伪装,变形”, 是一个http请求调用的轻量级框架,是以Java接口的方式调用Http接口,而不用像Java中通过封装HTTP请求报文的方式直接调用。Feign通过处理注解,将请求模板化,当实际调用的时候,传入参数,根据参数再应用到请求上,进而转化成真正的请求,这种请求相对而言比较直观。
Feign被广泛应用在Spring Cloud 的解决方案中,是学习基于Spring Cloud 微服务架构不可或缺的重要组件。
Feign可以把Rest的请求进行隐藏,伪装成类似SpringMVC的Controller一样。你不用再自己拼接url,拼接参数等等操作,一切都交给Feign去做。
封装了Http调用流程,更符合面向接口化的编程习惯。 类似Dubbo服务调用。
项目主页:https://github.com/OpenFeign/feign
1.2 入门案例
使用Feign替代RestTemplate发送Rest请求。使之更符合面向接口化的编程习惯。
实现步骤:
- 导入依赖feign的starter
- 启动引导类加@EnableFeignClients注解
- 编写FeignClient接口,使用SpringMVC的注解
- 在Controller中注入Feign接口,直接调用,无需实现类
- 访问接口测试
实现过程:
导入依赖feign的starter
1
2
3
4
5<!--配置feign-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>启动引导类加@EnableFeignClients注解
1
2
3
4
5
6
7@SpringCloudApplication
@EnableFeignClients//开启Feign功能
public class ConsumerApplication {
public static void main(String[] args) {
SpringApplication.run(ConsumerApplication.class,args);
}
}Feign中已经自动集成Ribbon负载均衡
在consumer_service中编写Feign客户端接口UserService
1
2
3
4
5
6@FeignClient("user-service")//指定feign调用的服务
public interface UserService {
@RequestMapping("/user/findById") // 逆向去 服务提供者查询用户的信息。
User findById(@RequestParam("id") Integer id);
}- 首先这是一个接口,Feign会通过动态代理,帮我们生成实现类。这点跟mybatis的mapper很像。
- 注解@FeignClient声明Feign的客户端接口,需指明服务名称
- 接口定义的方法,采用SpringMVC的注解。Feign会根据注解帮我们逆向生成URL地址然后请求
在Controller中注入UserService接口,直接调用,无需实现类
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21@RestController
public class ConsumerController {
@Autowired
RestTemplate restTemplate;
@Autowired
UserService userService;
@Autowired
DiscoveryClient discoveryClient;
@RequestMapping("/consumer/{id}")
public String hello(@PathVariable("id") Integer id){
String url = "http://user-service/user/findById?id="+id;
String jsonResult = restTemplate.getForObject(url, String.class);
return jsonResult;
}
@RequestMapping("/feignconsumer/{id}")
public User hellofeign(@PathVariable Integer id){
return userService.findById(id);
}
}启动测试:访问接口http://localhost:8080/feignconsumer/1,正常获取结果![1558146683844](/img/java/course/108/1558146683844.png)
Feign实现原理简单分析:
1.3 负载均衡
负载均衡是远程过程调用必备的要素。Feign本身集成了Ribbon,因此不需要额外引入依赖,也不需要再注册RestTemplate对象。即可无感知使用负载均衡这一特性。
Fegin内置Ribbon默认设置了连接超时,是1000毫秒(1秒)。和读取超时时间。我们可以通过手动配置来修改。Ribbon内部有重试机制,一旦超时,会自动重新发起请求。如果不希望重试,可以修改。
1 |
|
1.4 熔断器支持
Feign本身也集成Hystrix熔断器,starter内查看。
服务降级方法实现步骤:
- 在配置文件application.yml中开启feign熔断器支持
- 编写FallBack处理类,实现FeignClient客户端接口
- 在@FeignClient注解中,指定FallBack处理类。
- 测试服务降级效果
实现过程:
在配置文件application.yml中开启feign熔断器支持:默认关闭
1
feign.hystrix.enabled: true # 开启Feign的熔断功能
Feign中的Fallback配置不像Ribbon中那样简单。需要定义一个类UserServiceFallBack,实现刚才编写的UserFeignClient,作为FallBack的处理类
1
2
3
4
5
6
7
8
9
10@Component//需要注意:一定要注入Spring 容器
public class UserServiceFallBack implements UserService {
@Override
public User findById(Integer id) {
User user = new User();
user.setId(id);
user.setUsername("用户不存在!!!");
return user;
}
}然后在@FeignClient注解中,指定FallBack处理类。。
1
2
3
4
5@FeignClient(value = "user-service",fallback = UserServiceFallBack.class)
public interface UserService {
@RequestMapping("/user/findById")
User findById(@RequestParam("id") Integer id);
}重启测试:关闭user_service服务,然后在页面访问;http://localhost:8080/feignConsumer/2
- 关闭前:
- 关闭后:
1.5 请求压缩和响应压缩
SpringCloudFeign支持对请求和响应进行GZIP压缩,以提升通信过程中的传输速度。
为什么RPC远程调用的方式性能更高?传输的数据量小
通过配置开启请求与响应的压缩功能:
1 |
|
也可以对请求的数据类型,以及触发压缩的大小下限进行设置
1 |
|
1.6 配置日志级别
在发送和接收请求的时候,Feign定义了日志的输出定义了四个等级:这里我们配置测试一下。
级别 | 说明 |
---|---|
NONE | 不做任何记录 |
BASIC | 只记录输出Http 方法名称、请求URL、返回状态码和执行时间 |
HEADERS | 记录输出Http 方法名称、请求URL、返回状态码和执行时间 和 Header 信息 |
FULL | 记录Request 和Response的Header,Body和一些请求元数据 |
实现步骤:
- 在application.yml配置文件中开启日志级别配置
- 编写配置类,定义日志级别bean。
- 在接口的@FeignClient中指定配置类
- 重启项目,测试访问
实现过程:
在consumer_service的配置文件中设置com.itheima包下的日志级别都为debug
1
2
3# com.itheima 包下的日志级别都为Debug
logging.level:
com.itheima: debug在consumer_service编写配置类,定义日志级别
1
2
3
4
5
6
7
8@Configuration
public class FeignConfiguration {
@Bean
public Logger.Level feignLoggerLevel(){
//记录所有请求和响应的明细,包括头信息,请求体,元数据
return Logger.Level.FULL;
}
}这里指定的Level级别是FULL,Feign支持4种级别:
- NONE:不记录任何日志信息,这是默认值。
- BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
- HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
- FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据
在consumer_service的FeignClient中指定配置类
1
2
3
4
5@FeignClient(value="user-service",fallback = UserServiceFallBack.class,configuration = FeignConfig.class)
public interface UserService {
@RequestMapping("/user/{id}")
User queryById(@PathVariable("id") Long id);
}重启项目,即可看到每次访问的日志
二、网关 Spring Cloud Gateway
2.1 简介
Gateway网关是我们服务的守门神,所有微服务的统一入口。Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。
在Gateway之前,SpringCloud并不自己开发网关,可能是觉得Netflix公司的Zuul不行吧,然后自己就写了一个,也是替代Netflix Zuul。其不仅提供统一的路由方式,并且基于 Filter 链的方式提供了网关基本的功能,例如:安全,监控/指标和限流。
本身也是一个微服务,需要注册到Eureka
功能特性
- 基于 Spring Framework 5,Project Reactor 和 Spring Boot 2.0
- 动态路由
- Predicates 和 Filters 作用于特定路由
- 集成 Hystrix 断路器
- 集成 Spring Cloud DiscoveryClient
- 简单好用的 Predicates 和 Filters
- 限流
- 路径重写
不管是来自客户端的请求,还是服务内部调用。一切对服务的请求都可经过网关。网关实现鉴权、动态路由等等操作。Gateway是我们服务的统一入口
术语解释
- Route(路由):这是网关的基本模块。它由一个 ID,一个目标 URI,一组断言和一组过滤器定义。如果断言为真,则路由匹配。
- Predicate(断言):这是一个 Java 8 的 Predicate。输入类型是一个 ServerWebExchange。我们可以使用它来匹配来自 HTTP 请求的任何内容,例如 headers 或参数。
- Filter(过滤器):这是org.springframework.cloud.gateway.filter.GatewayFilter的实例,我们可以使用它修改请求和响应。
2.2 快速入门
搭建网关微服务,实现服务路由分发。
http://访问网关的服务/user/findById?id=11 ==> http://127.0.0.1:9091/user/findById?id=11
实现步骤:
- 创建SpringBoot工程gateway_server
- 勾选starter:网关、Eureka客户端
- 编写基础配置:端口,应用名称,注册中心地址
- 编写路由规则:唯一表示id,路由url地址,路由限定规则
- 启动网关服务进行测试
实现过程:
创建SpringBoot工程gateway_server
勾选Starter:网关、Eureka客户端
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>heima-springcloud</artifactId>
<groupId>com.itheima</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.itheima</groupId>
<artifactId>heima-gateway</artifactId>
<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>
</project>启动引导类开启注册中心Eureka客户端发现
1
2
3
4
5
6
7@SpringBootApplication
@EnableDiscoveryClient// 开启Eureka客户端发现功能
public class GatewayApplication {
public static void main(String[] args) {
SpringApplication.run(GatewayApplication.class,args);
}
}编写基础配置。在gateway_server中创建application.yml文件,配置
1
2
3
4
5
6# 端口
server.port: 10010
# 应用名
spring.application.name: api-gateway
# 注册中心地址
eureka.client.service-url.defaultZone: http://127.0.0.1:10086/eureka编写路由规则
需要用网关来路由user_service服务,查看服务ip和端口修改gateway_server的配置文件application.yml,配置网关内容
1
2
3
4
5
6
7
8
9
10
11
12spring:
cloud:
gateway:
# 路由si(集合)
routes:
# id唯一标识
- id: user-service-route
# 路由服务地址
uri: http://127.0.0.1:9091
# 断言
predicates:
- Path=/user/**将符合
path
规则的请求,路由到uri
参数指定地址。
举例:http://localhost:10010/user/findById?id=1 路由转发到http://localhost:9091/user/findById?id=1启动GatewayApplication进行测试
访问路径中,必须包含路由规则的映射路径/user才会被路由
2.3 动态路由(面向服务的路由)
刚才路由规则中,我们把路径对应服务地址写死了!如果服务提供者集群的话,这样做不合理。应该是根据服务名称,去Eureka注册中心查找服务对应的所有实例列表,然后进行动态路由!
修改映射配置:通过服务名称获取。因为已经配置了Eureka客户端,可以从Eureka获取服务的地址信息,修改application.yml文件如下
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17# 注解版
spring:
cloud:
gateway:
# 路由si(集合)
routes:
# id唯一标识
- id: user-service-route
# 路由地址
# uri: http://127.0.0.1:9091
# 采用lb协议,会从Eureka注册中心获取服务请求地址
# 路由地址如果通过lb协议加服务名称时,会自动使用负载均衡访问对应服务
# 规则:lb协议+服务名称
uri: lb://user-service
# 路由拦截地址(断言)
predicates:
- Path=/user/**路由配置中uri所用的协议为lb时,gateway将把user-service解析为实际的主机和端口,并通过Ribbon进行负载均衡。
启动GatewayApplication测试
这次gateway进行路由时,会利用Ribbon进行负载均衡访问。日志中可以看到使用了负载均衡器。
2.4 路由前缀
第一:添加前缀:
在gateway中可以通过配置路由的过滤器PrefixPath 实现映射路径中的前缀添加。可以起到隐藏接口地址的作用,避免接口地址暴露。
配置请求地址添加路径前缀过滤器
1
2
3
4
5
6
7
8
9
10
11
12
13spring:
cloud:
gateway:
routes:
- id: user-service-route # 路由id,可以随意写
# 代理服务地址;lb表示从Eureka中获取具体服务
uri: lb://user-service
# 路由断言,配置映射路径
predicates:
- Path=/**
# 请求地址添加路径前缀过滤器
filters:
- PrefixPath=/user重启GatewayApplication
配置完成的效果:
配置 访问地址 路由地址 PrefixPath=/user localhost:10010/findById?id=1 localhost:9091/user/findById?id=1 PrefixPath=/user/abc localhost:10010/findById?id=1 localhost:9091/user/abc/findById?id=1
第二:去除前缀:
在gateway中通过配置路由过滤器StripPrefix,实现映射路径中地址的去除。通过StripPrefix=1来指定路由要去掉的前缀个数。如:路径/api/user/1将会被路由到/user/1。
配置去除路径前缀过滤器
1
2
3
4
5
6
7
8
9
10
11
12
13spring:
cloud:
gateway:
routes:
- id: user-service-route # 路由id,可以随意写
# 代理服务地址;lb表示从Eureka中获取具体服务
uri: lb://user-service
# 路由断言,配置映射路径
predicates:
- Path=/**
# 去除路径前缀过滤器
filters:
- StripPrefix=1重启GatewayApplication
访问查看效果
配置 访问地址 路由地址 StripPrefix=1 localhost:10010/api/user/findById?id=1 localhost:9091/user/findById?id=1 StripPrefix=2 localhost:10010/aa/api/user/findById?id=1 localhost:9091/user/findById?id=1
2.5 过滤器
2.5.1 简介
过滤器作为网关的其中一个重要功能,就是实现请求的鉴权。前面的路由前缀
章节中的功能也是使用过滤器实现的。
Gateway自带过滤器有几十个,常见自带过滤器有:
过滤器名称 | 说明 |
---|---|
AddRequestHeader | 对匹配上的请求加上Header |
AddRequestParameters | 对匹配上的请求路由 |
AddResponseHeader | 对从网关返回的响应添加Header |
StripPrefix | 对匹配上的请求路径去除前缀 |
PrefixPath | 对匹配上的请求路径添加前缀 |
详细说明官方链接
使用场景:
- 请求鉴权:一般 GatewayFilterChain 执行filter方法前,如果发现没有访问权限,直接就返回空。
- 异常处理:一般 GatewayFilterChain 执行filter方法后,记录异常并返回。
- 服务调用时长统计: GatewayFilterChain 执行filter方法前后根据时间统计。
2.5.2 过滤器配置
过滤器类型: Gateway有两种过滤器
- 局部过滤器:只作用在当前配置的路由上。通过 spring.cloud.gateway.routes.filters 配置在具体路由下,只作用在当前路由上;
自带的过滤器都可以配置或者自定义按照自带过滤器的方式。如果配置spring.cloud.gateway.default-filters 上会对所有路由生效也算是全局的过滤器;
但是这些过滤器的实现上都是要实现GatewayFilterFactory接口。 - 全局过滤器:作用在所有路由上。不需要在配置文件中配置,作用在所有的路由上;实现 GlobalFilter 接口即可。
配置全局默认过滤器:
对输出的响应设置其头部属性名称为i-love,值为itheima
修改配置文件
1
2
3
4
5
6
7spring:
cloud:
gateway:
# 配置全局默认过滤器
default-filters:
# 往响应过滤器中加入信息
- AddResponseHeader=i-love,itheima查看浏览器响应头信息
2.5.3 执行顺序(了解)
Spring Cloud Gateway 的 Filter 的执行顺序有两个:“pre” 和 “post”。“pre”和 “post” 分别会在请求被执行前调用和被执行后调用。
这里的 pre
和post
可以通过过滤器的 GatewayFilterChain 执行filter方法前后来实现。
2.6 自定义过滤器[重点]
2.6.1 自定义局部过滤器
需求:在application.yml中对某个路由配置过滤器,该过滤器可以在控制台输出配置文件中指定名称的请求参数的值。
编写过滤器。在gateway工程编写过滤器工厂类MyParamGatewayFilterFactory
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@Component
public class MyParamGatewayFilterFactory extends AbstractGatewayFilterFactory<MyParamGatewayFilterFactory.Config> {
public static final String PARAM_NAME = "param";
public MyParamGatewayFilterFactory() {
super(Config.class);
}
@Override
public List<String> shortcutFieldOrder() {
return Arrays.asList(PARAM_NAME);
}
@Override
public GatewayFilter apply(Config config) {
return (exchange, chain) -> {
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;
}
}
}修改配置文件 application.yml
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
26server:
port: 10010
spring:
application:
name: api-gateway
cloud:
gateway:
routes:
# 路由id,可以随意写
- id: user-service-route
# 代理的服务地址;lb表示从eureka中获取具体服务
uri: lb://user-service
# 路由断言,可以配置映射路径
predicates:
- Path=/api/user/**
filters:
# 表示过滤1个路径,2表示两个路径,以此类推
- StripPrefix=1
# 自定义过滤器
- MyParam=name
eureka:
client:
service-url:
defaultZone: http://127.0.0.1:10086/eureka
instance:
prefer-ip-address: true测试访问:http://localhost:10010/api/user/8?name=itcast 检查后台是否输出name和itcast;但是若访问http://localhost:10010/api/user/8?name2=itcast 则是不会输出的。
2.6.2 自定义全局过滤器
需求: 模拟登录校验。
基本逻辑:如果请求中有token参数,则认为请求有效,放行。
实现步骤:
- 在gateway_server中,全局过滤器类MyGlobalFilter,实现GlobalFilter和 Ordered接口
- 编写业务逻辑代码判断:【过滤器必须注入SpringIOC容器中】
- 如果请求中有token参数,则认为请求有效,放行,
- 如果没有则拦截提示未授权。
- 访问接口测试,加token和不加token。
实现过程:
在gateway_server中,全局过滤器类MyGlobalFilter,实现GlobalFilter和 Ordered接口
编写业务逻辑代码判断:
- 如果请求中有token参数,则认为请求有效,放行
- 如果没有则拦截提示未授权
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22@Component
public class MyGlobalFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
System.out.println("-----------------全局过滤器MyGlobalFilter---------------------");
//1、获取参数中的token,以及token的值
String token = exchange.getRequest().getQueryParams().getFirst("token");
//2、如果token的值为空,则拦截
if (StringUtils.isBlank(token)) {
exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
return exchange.getResponse().setComplete();
}
return chain.filter(exchange);
}
@Override
public int getOrder() {
//值越小越先执行
return 0;//
}
}
2.7 负载均衡和熔断(了解)
Gateway中默认就已经集成了Ribbon负载均衡和Hystrix熔断机制。但是所有的超时策略都是走的默认值,比如熔断超时时间只有1S,很容易就触发了。因此建议手动进行配置:
1 |
|
2.8. Gateway跨域配置
一般网关都是所有微服务的统一入口,必然在被调用的时候会出现跨域问题。
跨域:在js请求访问中,如果访问的地址与当前服务器的域名、ip或者端口号不一致则称为跨域请求。若不解决则不能获取到对应地址的返回结果。
如:从在http://localhost:9090中的js访问 http://localhost:9000的数据,因为端口不同,所以也是跨域请求。
在访问Spring Cloud Gateway网关服务器的时候,出现跨域问题的话;可以在网关服务器中通过配置解决,允许哪些服务是可以跨域请求的;具体配置如下:
1 |
|
2.9 Gateway与Feign的区别
- Gateway 作为整个应用的流量入口,接收所有的请求,如PC、移动端等,并且将不同的请求转发至不同的处理微服务模块,其作用可视为nginx;大部分情况下用作权限鉴定、服务端流量控制
- Feign 则是将当前微服务的部分服务接口暴露出来,并且主要用于各个微服务之间的服务调用
三、配置中心 Spring Cloud Config
3.0 Config 简介
分布式系统中,由于服务数量非常多,配置文件分散在不同微服务项目中,管理极其不方便。为了方便配置文件集中管理,需要分布式配置中心组件。
在Spring Cloud中,提供了Spring Cloud Config,它支持配置文件放在配置服务的本地,也支持配置文件放在远程仓库Git(GitHub、码云)。配置中心本质上是一个微服务,同样需要注册到Eureka服务中心!
配置中心,也是一个微服务,需要注册到注册中心
3.1 配置中心整合步骤:
- 配置文件集中放在码云
- 配置中心获取码云配置文件
- 用户服务获取配置中心文件
3.2 Git配置管理
3.2.1 远程Git仓库
- 知名的Git远程仓库有国外的GitHub和国内的码云(gitee);
- GitHub主服务在外网,访问经常不稳定,如果希望服务稳定,可以使用码云;
- 码云访问地址:http://gitee.com
3.2.2 创建远程仓库
- 首先使用码云上的git仓库需要先注册账户
- 账户注册完成,然后使用账户登录码云控制台并创建公开仓库
- 配置仓库名称和路径
3.2.3 创建配置文件
在新建的仓库中创建需要被统一配置管理的配置文件
配置文件的命名方式:{application}-{profile}.yml或{application}-{profile}.properties- application为应用名称
- profile用于区分开发环境dev,测试环境test,生产环境pro等
- 开发环境 user-dev.yml
- 测试环境 user-test.yml
- 生产环境 user-pro.yml
将user-service工程里的配置文件application.yml内容复制作为user-dev.yml文件内容
创建完user-dev.yml配置文件之后,gitee中的仓库如下:
3.3 搭建配置中心微服务
实现步骤:
- 创建配置中心SpringBoot项目config_server
- 勾选Starter:配置中心,Eureka客户端
- 在启动引导类上加@EnableConfigServer注解
- 修改配置文件:端口,应用名称,注册中心地址,码云仓库地址
- 启动测试,测试配置文件实时同步
实现过程:
创建配置中心SpringBoot项目config_server
勾选Starter坐标依赖:配置中心starter,Eureka客户端starter
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>heima-springcloud</artifactId>
<groupId>com.itheima</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.itheima</groupId>
<artifactId>config-server</artifactId>
<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>
</project>启动类:创建配置中心工程config_server的启动类ConfigServerApplication
1
2
3
4
5
6
7
8@SpringBootApplication
@EnableDiscoveryClient//开启Eureka客户端发现功能
@EnableConfigServer //开启配置服务支持
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class,args);
}
}配置文件:创建配置中心工程config_server的配置文件application.yml
1
2
3
4
5
6
7
8# 端口
server.port: 12000
# 应用名称
spring.application.name: config-server
# git仓库地址
spring.cloud.config.server.git.uri: https://gitee.com/liuyaxiong01/itheima-spring-cloud-config.git
# 注册中心地址
eureka.client.service-url.defaultZone: http://127.0.0.1:10086/eureka注意:上述spring.cloud.config.server.git.uri是在码云创建的仓库地址
启动测试:启动eureka注册中心和配置中心;访问http://localhost:12000/user-dev.yml查看能否输出码云存储管理的user-dev.yml文件
并且可以在gitee上修改user-dev.yml,然后刷新上述测试地址也能及时更新数据
3.4 获取配置中心配置
关于application.yml和bootstrap.yml文件的说明:
- bootstrap.yml文件是SpringBoot的默认配置文件,而且其加载时间相比于application.yml更早。
- bootstrap.yml和application.yml都是默认配置文件,但定位不同
- bootstrap.yml相当于项目启动的引导文件
- application.yml文件是微服务的常规配置参数,变化比较频繁
- 搭配spring-cloud-config使application.yml的配置可以动态替换。
目标:改造user_service工程,配置文件不再由微服务项目提供,而是从配置中心获取。
实现步骤:
- 在user_service服务中,添加Config的starter依赖
- 删除application.yml配置文件,新增bootstrap.yml配置文件
- 配置bootstrap.yml配置文件:
- 配置中心相关配置(配置文件前缀、后缀,仓库分支,是否开启配置中心)
- 注册中心地址
- 启动服务,测试效果
实现过程:
添加依赖
1
2
3
4
5<!--spring cloud 配置中心-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>修改配置。
删除user_service工程的application.yml文件
创建user_service工程bootstrap.yml配置文件,配置内容如下1
2
3
4
5
6
7
8
9
10
11
12
13# 注册中心地址
eureka.client.service-url.defaultZone: http://127.0.0.1:10086/eureka
# 配置中心相关配置
# 使用配置中心
spring.cloud.config.discovery.enabled: true
# 配置中心服务id
spring.cloud.config.discovery.service-id: config-server
# 与远程仓库中的配置文件的application和profile保持一致,{application}-{profile}.yml
spring.cloud.config.name: user
spring.cloud.config.profile: dev
# 远程仓库中的分支保持一致
spring.cloud.config.label: master启动测试:依次启动:注册中心、配置中心、用户中心user_service。如果启动没报错,其实已经使用上配置中心内容了,可以在服务中心查看也可以检验user_service的服务
3.5 配置中心存在的问题
修改在码云上的user-dev.yml文件,添加一个属性test.name
修改UserController
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@RestController
@RequestMapping("/user")
public class UserController {
@Value("${server.port}")
private String port;
@Value("${test.hello}")
private String name;
@Autowired
UserService userService;
//查询所有
@RequestMapping("/findAll")
public List<User> findAll() {
return userService.findAll();
}
//根据id查询
@RequestMapping("/findById")
public User findById(Integer id) {
System.out.println("服务【"+port+"】被调用");
User user = userService.findById(id);
user.setNote("服务【"+port+"】被调用");
user.setName(name);
return user;
}
}测试:依次启动Eureka,配置中心,用户微服务;访问用户微服务,查看输出内容。
结论:通过浏览器输出结果发现,我们对于Git仓库中的配置文件的修改,并没有及时更新到user-service微服务,只有重启用户微服务才能生效。
如果想在不重启微服务的情况下更新配置该如何实现呢? 可以使用Spring Cloud Bus来实现配置的自动更新。
四、消息总线 Spring Cloud Bus
Spring Cloud Bus底层是基于RabbitMQ实现的,默认使用本地的消息队列服务,所以需要提前启动本地RabbitMQ服务
4.1 简介
Bus是用轻量的消息代理将分布式的节点连接起来,可以用于 广播配置文件的更改 或者服务的监控管理。Bus可以为微服务做监控,也可以实现应用程序之间互相通信。Bus可选的消息代理(消息队列)RabbitMQ和Kafka。
广播出去的配置文件服务会进行本地缓存。
4.2 整合案例
目标:消息总线整合入微服务系统,实现配置中心的配置自动更新。不需要重启微服务。
4.2.1 改造配置中心
改造步骤:
- 在config_server中,加入Bus和RabbitMQ的依赖
- 修改配置文件:RabbitMQ服务地址,触发配置文件更改接口
实现过程:
在config_server项目中加入Bus相关依赖
1
2
3
4
5
6
7
8
9
10<!--消息总线依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-bus</artifactId>
</dependency>
<!--RabbitMQ依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-stream-binder-rabbit</artifactId>
</dependency>在config_server项目中修改application.yml
1
2
3
4
5
6
7
8# RabbitMQ的服务地址
spring.rabbitmq.host: 192.168.200.128
spring.rabbitmq.port: 5672
spring.rabbitmq.username: guest
spring.rabbitmq.password: guest
# 触发配置文件广播的地址actuator的endpoint
management.endpoints.web.exposure.include: bus-refresh
4.2.2 改造用户服务
改造步骤:
- 在user-service中,加入Bus和RabbitMQ的依赖
- 修改配置文件:RabbitMQ服务地址
- 在需要刷新配置的类上加@RefreshScope注解
- 测试效果
实现过程:
在用户微服务user_service项目中加入Bus相关依赖
1
2
3
4
5
6
7
8
9
10<!--消息总线依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-bus</artifactId>
</dependency>
<!--RabbitMQ依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-stream-binder-rabbit</artifactId>
</dependency>修改user_service项目的bootstrap.yml
1
2
3
4
5# RabbitMQ的服务地址
spring.rabbitmq.host: 192.168.200.128
spring.rabbitmq.port: 5672
spring.rabbitmq.username: guest
spring.rabbitmq.password: guest改造用户微服务user_service项目的UserController
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@RestController
@RequestMapping("/user")
@RefreshScope //刷新配置
public class UserController {
@Value("${server.port}")
private String port;
@Value("${test.hello}")
private String name;
@Autowired
UserService userService;
//查询所有
@RequestMapping("/findAll")
public List<User> findAll() {
return userService.findAll();
}
//根据id查询
@RequestMapping("/findById")
public User findById(Integer id) {
System.out.println("服务【"+port+"】被调用");
User user = userService.findById(id);
user.setNote("服务【"+port+"】被调用");
user.setName(name);
return user;
}
}
4.3 测试
- 依次启动Eureka注册中心,配置中心,用户微服务
- 访问用户微服务查看输出结果
- 修改Git仓库中配置文件内容
- 使用Postman工具发送POST请求,地址:http://127.0.0.1:12000/actuator/bus-refresh。刷新配置![1558284875412](/img/java/course/108/1558284875412.png)
- 访问服务接口,浏览器查看输出结果
说明:
- Postman或者RESTClient是一个可以模拟浏览器发生各种请求的工具
- 请求地址http://127.0.0.1:12000/actuator/bus-refresh中actuator是固定的,bus-refresh对应的是配置中心的config_server中的application.yml文件的配置项include的内容
- 请求http://127.0.0.1:12000/actuator/bus-refresh地址的作用是访问配置中心的消息总线服务,消息总线服务接收到请求后会向消息队列中发送消息,各个微服务会监听消息队列。当微服务接收到队列中的消息后,会重新从配置中心获取最新的配置信息。
消息总线实现消息分发过程:
- 请求地址访问配置中心的消息总线
- 消息总线接收到请求
- 消息总线向消息队列发送消息
- user-service微服务会监听消息队列
- user-service微服务接到消息队列中消息后
- user-service微服务会重新从配置中心获取最新配置信息