springCloud学习1(集中式配置管理)

springcloud 总集：https://www.tapme.top/blog/detail/2019-02-28-11-33

1、前言

  在开发普通的 web 应用中，咱们一般是将配置项写在单独的配置文件中，好比application.yml,application.properties，可是在微服务架构中，可能会出现数百个微服务，若是每一个微服务将配置文件写在自身的配置文件中，会致使配置文件的管理很是复杂。所以集中式的配置管理是很是有必要的，每一个服务启动时从集中式的存储库中读取须要的配置信息。其模型以下：

简单来讲就是以下几点：

1. 启动一个微服务实例时向配置管理服务请求获取其所在环境的特定配置文件
2. 实际的配置信息驻留在存储库中。能够选择不一样的实现来保存配置数据，包含：源代码控制下的文件、关系数据库或键值数据存储
3. 应用程序配置数据的实际管理和应用程序无关。配置的更改一般经过构建和部署管道来处理
4. 进行配置管理更改时，必须通知使用该配置的服务实例

  因为本系列为 spring cloud，因此使用Spring Cloud Config来构建配置管理，固然还有不少其余优秀的解决方案（Etcd,Eureka,Consul...)。

2、构建配置服务

  spring cloud 是创建在 spring boot 的基础上的，所以须要有 spring boot 的构建基础。

一、pom 编写

  pom 主要依赖以下(篇幅缘由列出主要内容，完整代码请到 github 上查看),spring boot 版本和 spring cloud 版本以下，以后不在赘述：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.4.4.RELEASE</version>
</parent>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Camden.SR5</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
    <spring-cloud.version>Camden.SR5</spring-cloud.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-config-server</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-config</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

二、注解引导类

  只需在 spring boot 启动类上加入一个@EnableConfigServer注解便可。

三、配置服务配置编写（使用文件存储）

  这里是给配置服务使用的配置文件，用于声明端口，存储库类别等信息，并非给其余微服务使用的配置。配置以下(使用文件存储配置信息)：

server:
  port: 8888
spring:
  profiles:
    # 使用文件系统来存储配置信息，须要设置为native
    active: native
cloud:
  config:
    server:
      native:
        # 使用文件来存放配置文件,为每一个应用程序提供用逗号分隔的文件夹列表
        searchLocations: file:///D:/configFolder/licensingservice

四、建立供应用程序使用的配置文件

  经过上面的searchLocations可知目前有一个名为 licensingservice 的应用程序，在对应目录下建立以下三个配置文件：

• licensingservice.yml

server:
  port: 10010
spring:
  application:
    name: licensingservice

• licensingservice-dev.yml

server:
  port: 10011

• licensingservice-prod.yml

server:
  port: 10012

配置文件命名约定为：应用程序名称-环境名称.yml。如今启动应用便能经过 http 请求来获取配置了。

  请求localhost:8888/licensingservice/default,返回结果以下：

{
  "name": "licensingservice",
  "profiles": ["default"],
  "label": null,
  "version": null,
  "state": null,
  "propertySources": [
    {
      "name": "file:///D:/configFolder/licensingservice/licensingservice.yml",
      "source": {
        "server.port": 10001,
        "spring.application.name": "licensingservice"
      }
    }
  ]
}

  请求localhost:8888/licensingservice/dev,返回结果以下：

{
  "name": "licensingservice",
  "profiles": ["dev"],
  "label": null,
  "version": null,
  "state": null,
  "propertySources": [
    {
      "name": "file:///D:/configFolder/licensingservice/licensingservice-dev.yml",
      "source": {
        "server.port": 10011
      }
    },
    {
      "name": "file:///D:/configFolder/licensingservice/licensingservice.yml",
      "source": {
        "server.port": 10001,
        "spring.application.name": "licensingservice"
      }
    }
  ]
}

2、和 spring boot 客户端集成

  上面写了如何使用 spring cloud config 构建配置服务，这一节来构建 licensingserivce 服务，使用上面的配置服务来获取配置文件。

一、建立 springboot 工程

  建立 springboot 项目 licensingservice,主要依赖以下：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-config-client</artifactId>
</dependency>

二、编写配置文件

  共两个配置文件，application.yml,bootstrap.yml

• application.yml

  本配置文件用于存放留在本地配置信息，若是存在同名配置，本地的会被覆盖，不会生效

  server:
  port: 10099

• bootstrap.yml

  给 spring cloud config client 读取的配置文件，根据该配置向配置中心请求

  spring:
  application:
    #指定名称，以便spring cloud config客户端知道查找哪一个配置
    name: licensingservice
  profiles:
    #指定环境（default,dev，prod)
    active: dev
  cloud:
    config:
      #指定config server地址
      uri: http://localhost:8888

  PS:若是想要覆盖 bootstrap.yml 的配置可在启动命令加上-d 参数，如：

  java -Dsptring.cloud.config.uri=.... -Dspring.profiles.active=prod xxxxx.jar

三、启动

  启动 licensingservice 能够发现启动端口为 10011，说明远程读取配置生效了。

3、使用 git 做为配置服务的数据源

一、建立源配置文件

  在 github 某个仓库下建立配置文件，好比在https://github.com/FleyX/demo-project仓库下的springcloud/config目录下建立 licengingservice 服务的配置文件。

二、修改 config server 配置文件

  修改 confsvr 中的 application.yml

server:
  port: 8888
spring:
  profiles:
    # 使用文件系统来存储配置信息，须要设置为native,git设置为git
    active: git
  application:
    name: test
  cloud:
    config:
      server:
        native:
          # 使用文件来存放配置文件,为每一个应用程序提供用逗号分隔的文件夹列表
          searchLocations: file:///D:/configFolder/licensingservice
        git:
          uri: https://github.com/FleyX/demo-project
          # 查找配置文件路径（,分隔）
          search-paths: springcloud/config/licensingservice
          #若是为公开仓库，用户名密码可不填写
          username:
          password:
      #配置git仓库的分支
      label: master

三、启动

  从新启动，便可发现配置成功生效。

4、配置刷新

  使用 spring cloud 配置服务器时，有一个问题是如何在属性变化时动态刷新应用程序。spring cloud 配置服务始终提供最新版本的属性，对低层存储库属性的更改将会是最新的。可是 config client 并不会知道配置的变动，所以不会自动刷新属性。

  Spring Boot Actuator 提供了一个@RefreshScope属性来从新读取应用程序配置信息，开发人员可经过/refresh进行刷新。该注释须要注释在启动入口类上。注意:只会加载自定义 Spring 属性，例如数据库，端口等配置不会从新加载。

总结

  本篇只是用到了 spring-cloud-config 这个来进行配置集中管理，并无涉及到微服务，在下一篇将开始微服务的学习。
  本篇两个项目代码存放于：点击跳转