4. Quick Start

此快速Starter介绍了如何同时使用 Spring Cloud Config Server 的服务器和 Client 端。

首先,启动服务器,如下所示:

$ cd spring-cloud-config-server
$ ../mvnw spring-boot:run

该服务器是一个 Spring Boot 应用程序,因此,如果愿意,您可以从 IDE 中运行它(主类是ConfigServerApplication)。

接下来尝试一个 Client 端,如下所示:

$ curl localhost:8888/foo/development
{"name":"foo","label":"master","propertySources":[
  {"name":"https://github.com/scratches/config-repo/foo-development.properties","source":{"bar":"spam"}},
  {"name":"https://github.com/scratches/config-repo/foo.properties","source":{"foo":"bar"}}
]}

定位属性源的默认策略是克隆 git 存储库(位于spring.cloud.config.server.git.uri)并使用它来初始化 mini SpringApplication。小型应用程序的Environment用于枚举属性源并将其发布在 JSON 端点上。

HTTP 服务具有以下形式的资源:

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

其中application作为_注入SpringApplication(在常规 Spring Boot 应用程序中通常为application),profile是Active配置文件(或属性的逗号分隔列表),label是可选的 git 标签(默认为master)。 )

Spring Cloud Config Server 从 git 存储库(必须提供)中为远程 Client 端提取配置,如以下示例所示:

spring:
  cloud:
    config:
      server:
        git:
          uri: https://github.com/spring-cloud-samples/config-repo

4.1Client 端使用

要在应用程序中使用这些功能,您可以将其构建为依赖于 spring-cloud-config-client 的 Spring Boot 应用程序(例如,请参阅 config-client 或示例应用程序的测试用例)。添加依赖项最方便的方法是使用 Spring Boot 启动器org.springframework.cloud:spring-cloud-starter-config。对于 Maven 用户,还有一个父 pom 和 BOM(spring-cloud-starter-parent),对于 Gradle 和 Spring CLI 用户,还有一个 Spring IO 版本 Management 属性文件。以下示例显示了典型的 Maven 配置:

pom.xml.

<parent>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-parent</artifactId>
       <version>{spring-boot-docs-version}</version>
       <relativePath /> <!-- lookup parent from repository -->
   </parent>

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

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

<build>
	<plugins>
           <plugin>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-maven-plugin</artifactId>
           </plugin>
	</plugins>
</build>

   <!-- repositories also needed for snapshots and milestones -->

现在,您可以创建一个标准的 Spring Boot 应用程序,例如以下 HTTP 服务器:

@SpringBootApplication
@RestController
public class Application {

    @RequestMapping("/")
    public String home() {
        return "Hello World!";
    }

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

}

当此 HTTP 服务器运行时,它将从端口 8888 上的默认本地配置服务器(如果正在运行)中获取外部配置。要修改启动行为,可以使用bootstrap.properties(类似于application.properties)来更改配置服务器的位置。但适用于应用程序上下文的引导阶段),如以下示例所示:

spring.cloud.config.uri: http://myconfigserver.com

默认情况下,如果未设置应用程序名称,将使用application。要修改名称,可以将以下属性添加到bootstrap.properties文件中:

spring.application.name: myapp

Note

设置属性${spring.application.name}时,请勿在您的应用名称前加上保留字application-前缀,以防止解析正确的属性源时出现问题。

引导程序属性在/env端点中显示为高优先级属性源,如以下示例所示。

$ curl localhost:8080/env
{
  "profiles":[],
  "configService:https://github.com/spring-cloud-samples/config-repo/bar.properties":{"foo":"bar"},
  "servletContextInitParams":{},
  "systemProperties":{...},
  ...
}

名为``configService:<URL of remote repository>/<file name>''的属性源包含值bar且具有最高优先级的foo属性。

Note

属性源名称中的 URL 是 git 存储库,而不是配置服务器 URL。