Spring Cloud配置客戶端

在本文中將使用Spring Cloud編程分佈式應用程序 - 出租車管理應用程序 。 在上一篇文章中,演示瞭如何創建Config-Server應用程序,該應用程序管理其他服務的配置信息。

Spring Cloud配置客戶端

參見上一篇文章:

在本示例中,我們將創建一個「About Company」應用程序。 它獨立於「乘客管理」和「司機管理」應用程序。 對於一家大型出租車公司,例如:Uber,訪問其網站的用戶數量巨大,最好有一個應用程序將該公司與其他功能分開引入。

「About Company」應用程序將使用獨立的數據庫。 將在Config-Server上管理數據庫配置信息。 在微服務架構中,該應用程序不僅僅是公司介紹網站,它可以是爲其他應用程序提供信息的服務,例如,提供熱線信息,反饋電子郵件等。簡而言之,它是微服務系統的一部分。

Spring Cloud配置客戶端

注意:本節內容的主要目的是討論和實踐「應用程序如何在Config-Server上管理其配置信息」的示例。

1. 創建Spring Boot項目

首先打開Eclipse,點擊:File -> Project -> Others -> Spring Starter Project,並填寫相關信息。如下所示 -

Spring Cloud配置客戶端

選擇相應功能,如下所示 -
Spring Cloud配置客戶端

項目創建完成 -
Spring Cloud配置客戶端

JDBC Driver (MySQL, PostGres,..)依賴配置(自動生成)內容如下 -

<dependency>
   <groupId>mysql</groupId>
   <artifactId>mysql-connector-java</artifactId>
   <scope>runtime</scope>
</dependency>

<dependency>
   <groupId>org.postgresql</groupId>
   <artifactId>postgresql</artifactId>
   <scope>runtime</scope>
</dependency>

<!-- SQL Server - Mssql-Jdbc driver -->
<dependency>
   <groupId>com.microsoft.sqlserver</groupId>
   <artifactId>mssql-jdbc</artifactId>
   <scope>runtime</scope>
</dependency>

<!-- Oracle Driver -->
<dependency>
   <groupId>com.oracle</groupId>
   <artifactId>ojdbc6</artifactId>
   <version>11.2.0.3</version>
</dependency>

文件: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.1.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.yiibai</groupId>
    <artifactId>ConfigClientAboutCompany</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>ConfigClientAboutCompany</name>
    <description>ConfigClientAboutCompany 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-actuator</artifactId>
        </dependency>

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

        <dependency>
            <groupId>com.microsoft.sqlserver</groupId>
            <artifactId>mssql-jdbc</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.postgresql</groupId>
            <artifactId>postgresql</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </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>

文件:ConfigClientAboutCompanyApplication.java 的內容如下 -

package com.yiibai.aboutcompany;

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

@SpringBootApplication
public class ConfigClientAboutCompanyApplication {

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

}

2. 配置Spring Cloud Config客戶端

該應用程序需要讀取存儲在Config-Server上的配置; 因此,需要告訴它有關Config-Server的信息。 此信息在bootstrap.properties(或bootstrap.yml)文件上配置。 在應用程序啓動期間,應用程序就會使用此文件。

Spring Cloud配置客戶端

接下來添加兩個配置文件 -

文件:bootstrap.properties -

# Read file on Config-Server:
# app-about-company.properties or app-about-company.yml
spring.application.name=app-about-company

# This is the default:
spring.cloud.config.uri=http://localhost:8888
management.security.enabled=false

配置以便此應用程序在端口8877上運行,如下所示 -

文件:application.properties -

server.port=7788

此應用程序的配置文件(請參閱GitHub):

Spring Cloud配置客戶端

瀏覽此文件,內容如下 -
Spring Cloud配置客戶端

3. 創建控制器

首先創建一個名:com.yiibai.aboutcompany.controller,並在這個包下創建一個控制器:MainController.java,如下所示 -

Spring Cloud配置客戶端

MainController.java 的代碼如下所示 -

package com.yiibai.aboutcompany.controller;

import javax.sql.DataSource;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.context.ApplicationContext;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

@RefreshScope
@RestController
public class MainController {

    // 
    @Value("${text.copyright: Default Copyright}")
    private String copyright;

    @Value("${spring.datasource.driver-class-name}")
    private String driverClassName;

    @Value("${spring.datasource.url}")
    private String url;

    @Value("${spring.datasource.username}")
    private String userName;

    @Value("${spring.datasource.password}")
    private String password;

    @Autowired
    private DataSource dataSource;

    @Autowired
    ApplicationContext applicationContext;

    @RequestMapping("/showConfig")
    @ResponseBody
    public String showConfig() {
        String configInfo = "Copy Right: " + copyright //
                + "<br/>spring.datasource.driver-class-name=" + driverClassName //
                + "<br/>spring.datasource.url=" + url //
                + "<br/>spring.datasource.username=" + userName //
                + "<br/>spring.datasource.password=" + password;

        return configInfo;
    }

    @RequestMapping("/pingDataSource")
    @ResponseBody
    public String pingDataSource() {
        try {
            // 獲取配置的數據源
            return this.dataSource.toString();
        } catch (Exception e) {
            e.printStackTrace();
            return "Error: " + e.getMessage();
        }
    }

}

@RefreshScope 說明 -

任何由[@RefreshScope](https://github.com/RefreshScope "@RefreshScope")註釋的Spring Bean都將在運行時刷新,任何使用它們的組件都將在下一個方法調用中獲得一個新實例,完全初始化並注入所有依賴項。

4. 運行應用程序

首先,需要運行Config-Server應用程序(上一篇教程中創建)。 此應用程序將在端口8888上運行。

Spring Cloud配置客戶端

在瀏覽器中打開以下URL測試它:

Spring Cloud配置客戶端

之後,運行ConfigClientAboutCompany 應用程序,該應用程序將在端口7788上運行:
使用以下URL測試它:

Spring Cloud配置客戶端