Spring Cloud組態用戶端


在本文中將使用Spring Cloud程式設計分散式應用程式 - 出租車管理應用程式 。 在上一篇文章中,演示了如何建立Config-Server應用程式,該應用程式管理其他服務的組態資訊。

參見上一篇文章:

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

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

注意:本節內容的主要目的是討論和實踐「應用程式如何在Config-Server上管理其組態資訊」的範例。

1. 建立Spring Boot專案

首先開啟Eclipse,點選:File -> Project -> Others -> Spring Starter Project,並填寫相關資訊。如下所示 -

選擇相應功能,如下所示 -

專案建立完成 -

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)檔案上組態。 在應用程式啟動期間,應用程式就會使用此檔案。

接下來新增兩個組態檔案 -

檔案: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):

瀏覽此檔案,內容如下 -

3. 建立控制器

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

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注釋的Spring Bean都將在執行時重新整理,任何使用它們的元件都將在下一個方法呼叫中獲得一個新範例,完全初始化並注入所有依賴項。

4. 執行應用程式

首先,需要執行Config-Server應用程式(上一篇教學中建立)。 此應用程式將在埠8888上執行。

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

之後,執行ConfigClientAboutCompany 應用程式,該應用程式將在埠7788上執行:
使用以下URL測試它: