美文网首页
14, 配置中心Git例子(转)

14, 配置中心Git例子(转)

作者: 滔滔逐浪 | 来源:发表于2019-01-23 11:51 被阅读19次

    http://www.ityouknow.com/springcloud/2017/05/22/springcloud-config-git.html
    随着线上项目变的日益庞大,每个项目都散落各种配置文件,如果采用分布式的开发模式,需要的配置文件随着服务的增加而不断增多。某个服务基础信息变更,都会引起一系列的更新和重启,运维苦不堪言也容易出错。配置中心便是解决此类问题的灵丹妙药。

    市面上开源的配置信息很多,BAT每家都出过,360的QConf,淘宝的diamond,百度的disconf都是解决此类问题。国外也有很多开源的陪孩子中心Apache Commons Configuration ,owner, cfg4等等。这些开源的软件以及解决方案都很优秀,,但是Spring cloud Config,功能全面强大,可以无缝的和spring体系相结合。


    Spring Cloud Config

    在我们了解spring cloud config 之前,我们可以想象一个配置中心提供的核心功能应该有什么
    1,提供服务端和客户端的支持
    2,集中管理各环境的配置文件
    3,配置文件修改后,可以快速的生效
    4,可以进行版本的管理
    5,支持大的兵法查询
    6,支持各种语言。

    Spring cloud Config可以完美的支持以上所有的需求
    Spring Cloud Config 项目是一个解决分布式系统的配置管理方案。它包含了Client 和server 2 个部分 ,server提供配置文件的存储,以借口的形式将配置文件的内容提供出去,client通过接口获取数据,并依据此数据初始化自己的应用。spring cloud 使用git或svn存放配置文件,默认情况下使用git,我们先以git做一套示例。
    首先在github上面创建了一个文件夹config-repo用来存放配置文件,为了模拟生产环境,我们创建以下三个配置文件:

    //开发环境
    neo-config-dev.properties
    //测试环境
    neo-config-test.properties
    //生产环境
    neo-config-pro.properties
    
    
    

    每一个配置文件都写一个属性neo.hello,属性值分别是hello im dev/test/pro .下面开始配置server端口

    1,添加依赖pom.xml

    <?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">
            <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.2.RELEASE</version>
            <relativePath/> <!-- lookup parent from repository -->
        </parent>
    <groupId>com.taotao</groupId>
        <artifactId>springcloud-server-git</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>springcloud-server-git</name>
        <description>Demo project for Spring Boot</description>
    
    <properties>
            <java.version>1.8</java.version>
            <spring-cloud.version>Greenwich.RC2</spring-cloud.version>
        </properties>
    
        <dependencies>
            <dependency>
            <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
    <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>${spring-cloud.version}</version>
                    <type>pom</type>
                <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    <repositories>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
            </repository>
        </repositories>
    
    </project>
    
    
    
    
    

    2,配置文件:

    server:
      port: 8001
    spring:
      application:
        name: spring-cloud-config-server
      cloud:
        config:
          server:
            git:
              uri: https://github.com/ityouknow/spring-cloud-starter/     # 配置git仓库的地址
              search-paths: config-repo                             # git仓库地址下的相对地址,可以配置多个,用,分割。
              username:                                             # git仓库的账号
              password:                                             # git仓库的密码
    
    

    Spring Cloud Config 也提供本地的存储配置的方式,我们只需要社会组属性 spring.profiles.active=native,Config Server 会默认从应用的src/main/resource目录 下检索配置文件。也可以通过
    spring.cloud.config.server.native.searchLocations=file:E:/properties/属性来制定配置文件的位置。虽然Spring Cloud Config提供了这样的功能,但是为了支持更好的管理内容和版本控制的功能,还是推荐使用git模式。


    3,启动类
    启动类加 @EnableConfigServer,激活多配置中心的支持

    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.config.server.EnableConfigServer;
    
    @EnableConfigServer
    @SpringBootApplication
    public class SpringcloudServerGitApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(SpringcloudServerGitApplication.class, args);
        }
    
    }
    

    到此server端相关配置完成

    4,测试
    首先我们测试server端是否可以读取到github上的配置信息,直接访问:
    http://localhost:8001/neo-config/dev
    返回的信息如下:

    {
        "name": "neo-config", 
        "profiles": [
            "dev"
        ], 
        "label": null, 
        "version": null, 
        "state": null, 
        "propertySources": [
            {
                "name": "https://github.com/ityouknow/spring-cloud-starter/config-repo/neo-config-dev.properties", 
                "source": {
                    "neo.hello": "hello im dev"
                }
            }
        ]
    }
    

    上述的返回信息包含了配置文件的位置,版本,配置文件的名称以及配置文件中的具体内容,说明server端已经获取了git仓库的配置信息。

    如果直接查看配置文件中的配置信息可以访问:
    http://localhost:8001/neo-config-dev.properties,返回:neo.hello: hello im dev .说明server端会自动读取最新的提交的内容。
    仓库中 的配置文件会被换成web接口,访问可以参照一下的规则:

    /{application}/{profile}[/{label}]
    /{application}-{profile}.yml
    /{label}/{application}-{profile}.yml
    /{application}-{pofile}.properties
    /{label}/{application}-{profile}.properties
    
    
    

    以neo-config-dev.properties为例子,他的application是neo-config是dev。client 会根据填写的参数来选择读取对应的配置


    client 端

    主要展示如何在业务项目中去获取server端的配置信息

    1、添加依赖
    <dependencies>
    <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</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>
    <scope>test</scope>
    </dependency>
    </dependencies>
    引入spring-boot-starter-web包方便web测试

    2、配置文件
    需要配置两个配置文件,application.properties和bootstrap.properties

    application.properties如下:

    spring.application.name=spring-cloud-config-client
    server.port=8002
    bootstrap.properties如下:

    spring.cloud.config.name=neo-config
    spring.cloud.config.profile=dev
    spring.cloud.config.uri=http://localhost:8001/
    spring.cloud.config.label=master
    spring.application.name:对应{application}部分
    spring.cloud.config.profile:对应{profile}部分
    spring.cloud.config.label:对应git的分支。如果配置中心使用的是本地存储,则该参数无用
    spring.cloud.config.uri:配置中心的具体地址
    spring.cloud.config.discovery.service-id:指定配置中心的service-id,便于扩展为高可用配置集群。
    特别注意:上面这些与spring-cloud相关的属性必须配置在bootstrap.properties中,config部分内容才能被正确加载。因为config的相关配置会先于application.properties,而bootstrap.properties的加载也是先于application.properties。

    3、启动类
    启动类添加@EnableConfigServer,激活对配置中心的支持

    @SpringBootApplication
    public class ConfigClientApplication {

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

    }
    启动类只需要@SpringBootApplication注解就可以

    4、web测试
    使用@Value注解来获取server端参数的值

    @RestController
    class HelloController {
    @Value("${neo.hello}")
    private String hello;

    @RequestMapping("/hello")
    public String from() {
        return this.hello;
    }
    

    }
    启动项目后访问:http://localhost:8002/hello,返回:hello im dev update说明已经正确的从server端获取到了参数。到此一个完整的服务端提供配置服务,客户端获取配置参数的例子就完成了。

    相关文章

      网友评论

          本文标题:14, 配置中心Git例子(转)

          本文链接:https://www.haomeiwen.com/subject/alirjqtx.html