前言
在微服务架构中,由于服务数量众多,如果使用传统的配置文件管理方式,配置文件分散在各个项目中,不易于集中管理和维护。在 spring cloud 中使用 config-server 集中管理配置文件,可以使用 git、svn、本地资源目录 来管理配置文件,在集成了 spring cloud bus 之后还可以通过一条 post 请求,让所有连接到消息总线的服务,重新从 config-server 拉取配置文件,非常方便。
创建config-server
新建一个maven工程,修改pom.xml引入 spring cloud 依赖:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.4.2.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Camden.SR2</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
在 resources 目录中创建 application.yml 配置文件,在配置文件内容:
spring:
application:
name: @project.artifactId@
cloud:
config:
server:
git:
uri: https://git.oschina.net/yuelenghan/soa-demo.git
searchPaths: spring-cloud-2.0/config-repo
username: username
password: password
server:
port: 8888
eureka:
client:
serviceUrl:
defaultZone: http://localhost:8000/eureka/
这里使用 git 作为配置文件管理,searchPaths 指定配置文件所在的目录,username 和 password 分别git仓库的用户名和密码。
这里把 config-server-demo 也注册到 eureka,这样在 eureka 注册的服务,就可以通过指定 config-server-demo 的 serviceId ,从 config-server-demo 拉取配置文件,这样的话在 config-server 改变url时,就不需要修改代码了,而且在多实例情况下也可以负载均衡。
在 java 目录中创建一个包 demo ,在包中创建启动入口 ConfigServerApplication.java
@EnableDiscoveryClient
@SpringBootApplication
@EnableConfigServer
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
这里使用了 @EnableConfigServer
注解,设置此工程为配置中心。
在服务注册中心已经运行的情况下,运行 ConfigServerApplication.java 中的 main 方法,启动配置中心。
访问服务注册中心页面 http://localhost:8000, 可以看到已经成功注册了 CONFIG-SERVER-DEMO 配置中心。
修改配置文件加载方式
至此配置中心已经创建好了,我们把之前的项目 service-gateway-demo 和 add-service-demo 拿过来改造一下,让这两个项目从配置中心加载配置文件。
给 service-gateway-demo 和 add-service-demo 增加maven依赖:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
删除之前的配置文件 application.yml 和 application-docker.yml,新建配置文件 bootstrap.yml,文件内容:
spring:
application:
name: @project.artifactId@
profiles:
active: @activatedProperties@
cloud:
config:
profile: dev
label: master
discovery:
enabled: true
serviceId: CONFIG-SERVER-DEMO
failFast: true
retry:
initialInterval: 10000
multiplier: 2
maxInterval: 60000
maxAttempts: 10
eureka:
client:
serviceUrl:
defaultZone: http://localhost:8000/eureka/
bootstrap.yml 在加载顺序上先于 application.yml ,常用于配置一些初始化的配置项。
这里主要看下 spring.cloud.config 节点下的配置, profile 和 label 这两个配置一起决定加载哪个配置文件。label 表示配置文件所在分支,配置文件的名称为 {ApplicationName}-{profile}.yml 或 {ApplicationName}-{profile}.properties。
根据配置文件中的配置信息,add-service-demo 加载的配置文件为 add-service-demo-dev.yml,文件在 git 仓库的 master 分支下。service-gateway-demo 加载的配置文件为 service-gateway-demo-dev.yml,文件同样在 git 仓库的 master 分支下,文件路径都为 spring-cloud-2.0/config-repo。
spring.cloud.discovery.enabled
和 spring.cloud.discovery.serviceId
,这两个配置项配置了从服务注册中心获取 config-server-demo 的地址,而不使用传统url的方式。
spring.cloud.config.failFast
和 spring.cloud.config.retry
联合配置失败重试策略。
在 git 仓库的 master 分支下的 spring-cloud-2.0/config-repo 目录中新增两个配置文件:add-service-demo-dev.yml 和 service-gateway-demo-dev.yml。
add-service-demo-dev.yml:
server:
port: 8100
这里只需要配置端口即可,注册中心的地址已经在 bootstrap.yml 中进行了配置。
service-gateway-demo-dev.yml:
server:
port: 80
zuul:
routes:
add-service-demo:
path: /add-service/**
serviceId: add-service-demo
启动 add-service-demo 和 service-gateway-demo,注意观察控制台,可以看到:
Fetching config from server at: http://config-server的IP:8888/
,说明配置文件从 config-server 中拉取。
集成spring cloud bus功能
给 config-server-demo、service-gateway-demo、add-service-demo 这3个工程分别添加 spring cloud bus 的maven依赖:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>
修改 config-server-demo 的配置文件 application.yml,在 spring 节点下增加 rabbitmq 的配置信息:
rabbitmq:
host: rabbitmq地址
port: 端口
username: guest
password: guest
在git仓库中修改 service-gateway-demo 和 add-service-demo 的配置文件,增加 rabbitmq 的配置信息:
spring:
rabbitmq:
host: rabbitmq地址
port: 端口
username: guest
password: guest
在 add-service-demo-dev.yml 中额外增加一条用于测试的配置信息:my.info.str: test1111
,修改 AddController.java,输出这条配置信息:
@RestController
@RefreshScope
public class AddController {
@Value("${my.info.str}")
private String infoStr;
@RequestMapping(value = "/add", method = RequestMethod.GET)
public Map<String, Object> add(Integer a, Integer b) {
System.out.println("端口为8100的实例被调用");
System.out.println("infoStr : " + infoStr);
Map<String, Object> returnMap = new HashMap<>();
returnMap.put("code", 200);
returnMap.put("msg", "操作成功");
returnMap.put("result", a + b);
return returnMap;
}
}
这里增加了一个 @RefreshScope
注解,表明 AddController 这个 Bean 中的配置可动态刷新。
先启动 config-server-demo,配置服务启动完毕后,启动 add-service-demo 和 service-gateway-demo。
打开 rabbitmq 的web管理页面,可以看到有3个 connection 连接到了 rabbitmq。
访问 http://localhost/add-service/add?a=1&b=2 查看 add-service-demo 的控制台打印出的 infoStr 信息,infoStr : test1111
。
修改 git 仓库中的 add-service-demo-dev.yml 文件里的 my.info.str
配置,提交后发送 bus 刷新的指令,向使用 spring cloud bus 的服务发送一条post请求,随便哪一个都行,这里以 config-server-demo 为例: curl -X POST http://localhost:8888/bus/refresh
,发送这条 post 信息之后,查看控制台的输出日志,会发现 add-service-demo 和 service-gateway-demo 会重新加载 git 仓库中的配置文件。
再次访问 http://localhost/add-service/add?a=1&b=2,控制台输出了修改之后的 infoStr 信息。
使用docker-maven-plugin打包并生成docker镜像
这里的内容和前几篇文章基本相同,都是把配置文件复制一份,修改为 docker 环境下的配置,在 pom.xml 中增加 docker 环境的profile。这里不再赘述,直接附上源码:
demo源码 spring-cloud-2.0目录
最后
目前为止,已经有了服务注册中心、配置中心、服务网关、消息总线、服务提供者和消费者,并且在网关层做了前端跨域处理。在开发层面,使用这些内容已经可以进行简单微服务的开发了。
但是在服务运维方面,尤其在服务数量不断增多的情况下,日志分散在各个工程下,如何进行日志聚合,方便的查看日志信息。服务之间互相调用出错时如何快速排查,如何熔断降级,使错误不至于影响整个服务网络。这些内容涉及到日志聚合、服务追踪、熔断器等,将在后续的文章中再做介绍。
下一篇介绍如何在 docker 环境下部署 zookeeper 和 kafka ,以及使用 log4j2 的 kafka appender 把微服务中的日志聚合输出到 kafka 中,为后边搭建 ELK 日志统计分析环境做准备。