乐趣区

6如何获取配置中心的配置

jiezi

在《配置中心》这一篇博文里学习了如何 git 获取配置文件。大概的流程可以用下图来概括。

《配置中心》这篇博文说的是 Config Server，本篇将和大家看看如何编写一个 Config Client 从 Config Server 获取配置。
1、先在仓库中创建如下配置文件（具体参考下面地址）

https://gitee.com/hjj520/spring-cloud-2.x/tree/master/config-repos/sc-config-client

2、创建 maven 项目 sc-config-client，对应的 pom.xml 如下

<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>

    <groupId>spring-cloud</groupId>
    <artifactId>sc-config-client</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>sc-config-client</name>
    <url>http://maven.apache.org</url>

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

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Finchley.RELEASE</version>
                <type>pom</type>
            </dependency>

        </dependencies>
    </dependencyManagement>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>
    <dependencies>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
            <version>2.0.1.RELEASE</version>
        </dependency>

        <!-- 
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-client</artifactId>
            <version>2.0.1.RELEASE</version>
        </dependency>
         -->

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

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            <version>2.0.1.RELEASE</version>
        </dependency>

    </dependencies>
</project>

其中：spring-cloud-starter-config 与 spring-cloud-config-client 可以二选一，但是根据选择的依赖不同对应的配置文件有些许不一样。spring-cloud-starter-config 已经包含 spring-cloud-config-client，所以选择依赖 spring-cloud-starter-config。

3、创建配置文件 bootstrap.yml

# 服务端口
server:
  port: 8200

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:5001/eureka/
      
spring:
  application:
    name: sc-config-client
  cloud:
    config:
      label: master # 配置文件所在分支
      #uri: http://127.0.0.1:8100/  #配置服务中心
      profile: dev  # dev 根据具体情况来修改
      discovery:
        serviceId: sc-config-server #配置服务实例名称
        enabled: true  #开启配置服务发现

备注：sc-config-server 为配置服务实例名称，对应 sc-config-server 项目的 bootstrap.yml 配置文件的如下配置项

4、创建启动类 ConfigClientApplication.java

package sc.config.client;

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
//@EnableDiscoveryClient
@EnableEurekaClient
public class ConfigClientApplication {public static void main(String[] args) {SpringApplication.run(ConfigClientApplication.class, args);
    }
}

5、为了验证是否能不能在 config server 获取到配置项，创建一个 restful 类型的 controller：ConfigController.java

package sc.config.client.controller;

import java.util.HashMap;
import java.util.Map;

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

@RestController
public class ConfigController {

    // git 配置文件里的 key
    @Value("${jdbc.driverClassName}") 
    private String driverClassName;
    
    @Value("${jdbc.url}") 
    private String url;
    
    @Value("${jdbc.username}") 
    private String username;
    
    @Value("${jdbc.password}") 
    private String password;
    
    @RequestMapping(value="/config/getValue")
    public Map<String, Object> getConfigFromGit() {Map<String, Object> result = new HashMap<String, Object>();
        result.put("code", "000000");
        result.put("msg", "ok");
        Map<String, Object> body = new HashMap<String, Object>();
        body.put("driverClassName", driverClassName);
        body.put("url", url);
        body.put("username", username);
        body.put("password", password);
        result.put("body", body);
        return result;
    }

}

6、先启动注册中心，对应的项目为 sc-eureka-server；再启动 config sever，对应的项目为 sc-config-server。然后验证一下 config sever 是否启动成功
方式一：访问注册中心，可以看到 config sever 已经注册到注册中心了

方式二：访问配置文件对应的路径看看是否可以获取配置文件，如果能获取到说明启动成功

给大家一一对应一下 yml 问下的访问方式，这些在 config server 那篇博文只是大概提了一下：

{[/{name}-{profiles}.yml || /{name}-{profiles}.yaml],methods=[GET]}：
http://127.0.0.1:8100/application-dev.yml
{[/{name}/{profiles:.1.}],methods=[GET]}:
http://127.0.0.1:8100/application/dev
{[/{name}/{profiles}/{label:.*}],methods=[GET]}: http://127.0.0.1:8100/application/dev/master
{[/{label}/{name}-{profiles}.yml || /{label}/{name}-{profiles}.yaml],methods=[GET]}:
http://127.0.0.1:8100/master/application-dev.yml

7、启动 config client 对应的项目 sc-config-client
当 spring.cloud.config.profile 的值为 dev 时访问 http://127.0.0.1:8200/config/getValue

当 spring.cloud.config.profile 的值为 prd 时访问 http://127.0.0.1:8200/config/getValue

可以看到 spring.cloud.config.profile 配置不一样时，分配获取到 git 仓库的 application-dev.yml 和 application-prd.yml 配置文件的内容

  1. – ↩
退出移动版