完整源码-仅供参考

https://github.com/ChannD/SpringCloudDemo

1. 概述

1. 分布式系统面临的---配置问题

  • 微服务意味着要将单体应用中的业务拆分成一个个子服务,每个服务的粒度相对较小,因此系统中会出现大量的服务。由于每个服务都需要必要的配置信息才能运行,所以一套集中式的、动态的配置管理设施是必不可少的。SpringCloud提供了ConfigServer来解决这个问题,我们每一个微服务自己带着一个application.yml,上百个配置文件的管理....../(ㄒoㄒ)/~~

2. 是什么 [图示]

  • 图像.png
  • 是什么 : SpringCloud Config为微服务架构中的微服务提供集中化的外部配置支持,配置服务器为各个不同微服务应用的所有环境提供了一个中心化的外部配置。
  • 举个例子,可能运维工程师不懂java,但是人家可以去碰github, 这个时候他可以,在远端发布一个, 然后再本地写好上传到github, Config Server发现Github变动了, 可以自然而然的下下来,或者说感应到.
  • 可以有一个非常轻量级的集中式管理来协调这些服务, 可以使用不同的语言来编写服务, 也可以使用不同的数据存储.
  • 怎么玩 : SpringCloud Config分为服务端和客户端两部分。
  • 服务端也称为分布式配置中心,它是一个独立的微服务应用,用来连接配置服务器并为客户端提供获取配置信息,加密/解密信息等访问接口.
  • 客户端则是通过指定的配置中心来管理应用资源,以及与业务相关的配置内容,并在启动的时候从配置中心获取和加载配置信息配置服务器默认采用git来存储配置信息,这样就有助于对环境配置进行版本管理,并且可以通过git客户端工具来方便的管理和访问配置内容。

3. 能干嘛

  • 集中管理配置文件
  • 不同环境不同配置,动态化的配置更新,分环境部署比如dev/test/prod/beta/release
  • 运行期间动态调整配置,不再需要在每个服务部署的机器上编写配置文件,服务会向配置中心统一拉取配置自己的信息
  • 当配置发生变动时,服务不需要重启即可感知到配置的变化并应用新的配置
  • 将配置信息以REST接口的形式暴露

4. 与GitHub整合配置

  • 由于SpringCloud Config默认使用Git来存储配置文件(也有其它方式,比如支持SVN和本地文件),
  • 但最推荐的还是Git,而且使用的是http/https访问的形式
  • image.png

SpringCloud Config服务端配置

1. 用自己的GitHub账号在GitHub上新建一个名为microservicecloud-config的新Repository

2. 由上一步获得SSH协议的git地址

3. 本地硬盘目录上新建git仓库并clone [git命令]

image.png

4. 在本地E:\configdemo\microservicecloud-config里面新建一个application.yml

5. 将上一步的YML文件推送到github上 [不熟悉git的,自行去熟悉一下]

  • git add .
  • git commit -m "init yml"
  • git push origin master
  • image.png
  • image.png

6. 新建Module模块microservicecloud-config-3344它即为Cloud的配置中心模块

7. POM [完整代码]

<?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>microservicecloud</artifactId>
        <groupId>com.chann.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>microservicecloud-config-3344</artifactId>
    <dependencies>
        <!-- springCloud Config -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
        <!-- 避免Config的Git插件报错:org/eclipse/jgit/api/TransportConfigCallback  -->
<!--        <dependency>-->
<!--            <groupId>org.eclipse.jgit</groupId>-->
<!--            <artifactId>org.eclipse.jgit</artifactId>-->
<!--            <version>4.10.0.201712302008-r</version>-->
<!--        </dependency>-->
        <!-- 图形化监控 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!-- 熔断 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-hystrix</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</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-jetty</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
        <!-- 热部署插件 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>springloaded</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>

</project>

8. YML [完整代码]

server:
  port: 3344

spring:
  application:
    name:  microservicecloud-config
  cloud:
    config:
      server:
        git:
          uri: https://github.com/ChannD/microservicecloud-config.git #GitHub上面的git仓库名字

9. 主启动类Config_3344_StartSpringCloudApp [代码]

package com.chann.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;

@SpringBootApplication
@EnableConfigServer
public class Config_3344_StartSpringCloudApp
{
    public static void main(String[] args)
    {
        SpringApplication.run(Config_3344_StartSpringCloudApp.class,args);
    }
}


10. windows下修改hosts文件,增加映射

  • 127.0.0.1 config-3344.com

11. 测试通过Config微服务是否可以从GitHub上获取配置内容

12. 配置读取规则

// 20191011212931
// http://config-3344.com:3344/application/dev/master

{
  "name": "application",
  "profiles": [
    "dev"
  ],
  "label": "master",
  "version": null,
  "state": null,
  "propertySources": [
    {
      "name": "https://github.com/ChannD/microservicecloud-config.git/application.yml#dev",
      "source": {
        "spring.profiles": "dev",
        "spring.application.name": "microservicecloud-config-chann-dev"
      }
    },
    {
      "name": "https://github.com/ChannD/microservicecloud-config.git/application.yml",
      "source": {
        "spring.profiles.active[0]": "dev"
      }
    }
  ]
}
// 20191011213230
// http://config-3344.com:3344/application/test/master

{
  "name": "application",
  "profiles": [
    "test"
  ],
  "label": "master",
  "version": null,
  "state": null,
  "propertySources": [
    {
      "name": "https://github.com/ChannD/microservicecloud-config.git/application.yml#test",
      "source": {
        "spring.profiles": "test",
        "spring.application.name": "microservicecloud-config-chann-test"
      }
    },
    {
      "name": "https://github.com/ChannD/microservicecloud-config.git/application.yml",
      "source": {
        "spring.profiles.active[0]": "dev"
      }
    }
  ]
}
// 20191011213250
// http://config-3344.com:3344/application/xxx/master

{
  "name": "application",
  "profiles": [
    "xxx"
  ],
  "label": "master",
  "version": null,
  "state": null,
  "propertySources": [
    {
      "name": "https://github.com/ChannD/microservicecloud-config.git/application.yml",
      "source": {
        "spring.profiles.active[0]": "dev"
      }
    }
  ]
}

13. 成功实现了用SpringCloud Config通过GitHub获取配置信息


SpringCloud Config客户端配置与测试

1. 在本地E:\configdemo\microservicecloud-config路径下新建文件microservicecloud-config-client.yml

2. microservicecloud-config-client.yml内容

spring:
  profiles:
    active:
    - dev
---
server: 
  port: 8201 
spring:
  profiles: dev
  application: 
    name: microservicecloud-config-client
eureka: 
  client: 
    service-url: 
      defaultZone: http://eureka-dev.com:7001/eureka/   
---
server: 
  port: 8202 
spring:
  profiles: test
  application: 
    name: microservicecloud-config-client
eureka: 
  client: 
    service-url: 
      defaultZone: http://eureka-test.com:7001/eureka/
 

3. 将上一步提交到GitHub中[提交方式不重复说明]

4. 新建microservicecloud-config-client-3355

5. POM [完整代码]

<?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>microservicecloud</artifactId>
        <groupId>com.chann.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>microservicecloud-config-client-3355</artifactId>
    <dependencies>
        <!-- SpringCloud Config客户端 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-hystrix</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
       
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jetty</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>springloaded</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>

</project>

6. bootstrap.yml

  • 是什么
    • applicaiton.yml是用户级的资源配置项
    • bootstrap.yml是系统级的,优先级更加高
    • Spring Cloud会创建一个Bootstrap Context,作为Spring应用的Application Context父上下文。初始化的时候,Bootstrap Context负责从外部源加载配置属性并解析配置。这两个上下文共享一个从外部获取的EnvironmentBootstrap属性有高优先级,默认情况下,它们不会被本地配置覆盖。 Bootstrap contextApplication Context有着不同的约定,
      所以新增了一个bootstrap.yml文件,保证Bootstrap ContextApplication Context配置的分离。
    • 不过这个很容易让人联想到前端的bootstrap框架, 不是一个东西哈记住, 有点类似类加载器.
  • 代码内容
spring:
  cloud:
    config:
      name: microservicecloud-config-client #需要从github上读取的资源名称,注意没有yml后缀名
      profile: dev   #本次访问的配置项
      label: master
      uri: http://config-3344.com:3344  #本微服务启动后先去找3344号服务,通过SpringCloudConfig获取GitHub的服务地址
 

7. application.yml

spring:
  application:
    name: microservicecloud-config-client
 

8. windows下修改hosts文件,增加映射

  • 127.0.0.1 client-config.com

9. 新建rest类,验证是否能从GitHub上读取配置

package com.chann.springcloud.rest;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ConfigClientRest {

    @Value("${spring.application.name}")
    private String applicationName;

    @Value("${eureka.client.service-url.defaultZone}")
    private String eurekaServers;

    @Value("${server.port}")
    private String port;

    @RequestMapping("/config")
    public String getConfig()
    {
        String str = "applicationName: "+applicationName+"\t eurekaServers:"+eurekaServers+"\t port: "+port;
        System.out.println("******str: "+ str);
        return "applicationName: "+applicationName+"\t eurekaServers:"+eurekaServers+"\t port: "+port;
    }
}


10. 主启动类ConfigClient_3355_StartSpringCloudApp

package com.chann.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ConfigClient_3355_StartSpringCloudApp
{
    public static void main(String[] args)
    {
        SpringApplication.run(ConfigClient_3355_StartSpringCloudApp.class,args);
    }
}

11. 测试

12. 成功实现了客户端3355访问SpringCloud Config3344通过GitHub获取配置信息


SpringCloud Config配置实战

1. 目前情况

  • Config服务端配置配置OK且测试通过,我们可以和config+GitHub进行配置修改并获得内容
  • 此时我们做一个eureka服务+一个Dept访问的微服务,将两个微服务的配置统一由于github获得实现统一配置分布式管理,完成多环境的变更

2. Git配置文件本地配置

  • 在本地E:\configdemo\microservicecloud-config路径下新建文件microservicecloud-config-eureka-client.yml
  • microservicecloud-config-eureka-client.yml内容 [代码]
spring: 
  profiles: 
    active: 
    - dev
---
server: 
  port: 7001 #注册中心占用7001端口,冒号后面必须要有空格
   
spring: 
  profiles: dev
  application:
    name: microservicecloud-config-eureka-client
    
eureka: 
  instance: 
    hostname: eureka7001.com #冒号后面必须要有空格
  client: 
    register-with-eureka: false #当前的eureka-server自己不注册进服务列表中
    fetch-registry: false #不通过eureka获取注册信息
    service-url: 
      defaultZone: http://eureka7001.com:7001/eureka/
---
server: 
  port: 7001 #注册中心占用7001端口,冒号后面必须要有空格
   
spring: 
  profiles: test
  application:
    name: microservicecloud-config-eureka-client
    
eureka: 
  instance: 
    hostname: eureka7001.com #冒号后面必须要有空格
  client: 
    register-with-eureka: false #当前的eureka-server自己不注册进服务列表中
    fetch-registry: false #不通过eureka获取注册信息
    service-url: 
      defaultZone: http://eureka7001.com:7001/eureka/

  • 在本地E:\configdemo\microservicecloud-config路径下新建文件microservicecloud-config-dept-client.yml
  • microservicecloud-config-dept-client.yml内容 [代码]
spring: 
  profiles:
    active:
    - dev
--- 
server:
  port: 8001
spring: 
   profiles: dev
   application: 
    name: microservicecloud-config-dept-client
   datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: org.gjt.mm.mysql.Driver
    url: jdbc:mysql://localhost:3306/cloudDB03
    username: root
    password: root
    dbcp2:
      min-idle: 5
      initial-size: 5
      max-total: 5
      max-wait-millis: 200 
mybatis:
  config-location: classpath:mybatis/mybatis.cfg.xml
  type-aliases-package: com.chann.springcloud.entities
  mapper-locations:
  - classpath:mybatis/mapper/**/*.xml
 
eureka: 
  client: #客户端注册进eureka服务列表内
    service-url: 
      defaultZone: http://eureka7001.com:7001/eureka
  instance:
    instance-id: dept-8001.com
    prefer-ip-address: true
 
info:
  app.name: chann-microservicecloud-springcloudconfig01
  company.name: www.jiangdalong.com
  build.artifactId: $project.artifactId$
  build.version: $project.version$
---
server:
  port: 8001
spring: 
   profiles: test
   application: 
    name: microservicecloud-config-dept-client
   datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: org.gjt.mm.mysql.Driver
    url: jdbc:mysql://localhost:3306/cloudDB02
    username: root
    password: root
    dbcp2:
      min-idle: 5
      initial-size: 5
      max-total: 5
      max-wait-millis: 200  
  
  
mybatis:
  config-location: classpath:mybatis/mybatis.cfg.xml
  type-aliases-package: com.chann.springcloud.entities
  mapper-locations:
  - classpath:mybatis/mapper/**/*.xml
 
eureka: 
  client: #客户端注册进eureka服务列表内
    service-url: 
      defaultZone: http://eureka7001.com:7001/eureka
  instance:
    instance-id: dept-8001.com
    prefer-ip-address: true
 
info:
  app.name: chann-microservicecloud-springcloudconfig02
  company.name: www.jiangdalong.com
  build.artifactId: $project.artifactId$
  build.version: $project.version$

3. Config版的eureka服务端

  • 新建工程microservicecloud-config-eureka-client-7001
  • POM
  • bootstrap.yml
  • application.yml
  • 主启动类Config_Git_EurekaServerApplication
  • 测试
    • 先启动microservicecloud-config-3344微服务,保证Config总配置是OK的
    • 再启动microservicecloud-config-eureka-client-7001微服务
    • http://eureka7001.com:7001/
    • 出现eureak主页表示成功启动

4. Config版的dept微服务

  • 参考之前的8001拷贝后新建工程microservicecloud-config-dept-client-8001
  • POM
<?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>microservicecloud</artifactId>
        <groupId>com.chann.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>microservicecloud-config-dept-client-8001</artifactId>

    <dependencies>
        <!-- SpringCloudConfig配置 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
        <dependency>
            <groupId>com.chann.springcloud</groupId>
            <artifactId>microservicecloud-api</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jetty</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>springloaded</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>

</project>
  • bootstrap.yml
spring:
  cloud:
    config:
      name: microservicecloud-config-dept-client #需要从github上读取的资源名称,注意没有yml后缀名
      #profile配置是什么就取什么配置dev or test
      #profile: dev
      profile: dev
      label: master
      uri: http://config-3344.com:3344  #SpringCloudConfig获取的服务地址

  • application.yml
spring:
  application:
    name: microservicecloud-config-dept-client

  • 主启动类及其它一套业务逻辑代码
    • 主启动类
package com.chann.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

@SpringBootApplication
@EnableEurekaClient //本服务启动后会自动注册进eureka服务中
@EnableDiscoveryClient //服务发现
public class DeptProvider8001_App
{
    public static void main(String[] args)
    {
        SpringApplication.run(DeptProvider8001_App.class, args);
    }
}

- 其它业务逻辑代码
  • 配置说明

    • 主要看bootstrap.yml文件里面的
    • profile: 属性具体值是什么,从而确定它能从github上取得什么样的配置
    • 假如配置dev左图,如果配置test那就找右图,具体各自数据库不同,从而依据配置得到分布式配置的目的
    • image.png
  • 测试

// 20191013103105
// http://localhost:8001/dept/list

[
  {
    "deptno": 1,
    "dname": "开发部",
    "db_source": "cloudDB02"
  },
  {
    "deptno": 2,
    "dname": "人事部",
    "db_source": "cloudDB02"
  },
  {
    "deptno": 3,
    "dname": "财务部",
    "db_source": "cloudDB02"
  },
  {
    "deptno": 4,
    "dname": "市场部",
    "db_source": "cloudDB02"
  },
  {
    "deptno": 5,
    "dname": "运维部",
    "db_source": "cloudDB02"
  }
]
- 本地换配置成dev
- http://localhost:8001/dept/list
   - 可以看到数据库配置是01
// 20191013103249
// http://localhost:8001/dept/list

[
  {
    "deptno": 1,
    "dname": "开发部",
    "db_source": "cloudDB03"
  },
  {
    "deptno": 2,
    "dname": "人事部",
    "db_source": "cloudDB03"
  },
  {
    "deptno": 3,
    "dname": "财务部",
    "db_source": "cloudDB03"
  },
  {
    "deptno": 4,
    "dname": "市场部",
    "db_source": "cloudDB03"
  },
  {
    "deptno": 5,
    "dname": "运维部",
    "db_source": "cloudDB03"
  }
]

Q.E.D.

知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议

脸朝大海, 春暖花开 ----江大脸