Понимание Spring Cloud Config Client с примером
View more Tutorials:
OK, мы находимся в serial (серии) инструкции программирования распределенного приложения, используя Spring Cloud. Приложение управления Такси. В прошлой статье я показал вам как создать приложение Config-Server, которое управляет информацией конфигурации для других услуг (приложения).
Смотреть предыдущую статью:

В данной статье мы создадим приложение "About Company", это независимое приложение от приложений "Passenger Management" (Управление клиентами) и "Diver Management" (Управление водителями). Для таких больших Такси, как Uber, количество пользователей имеющих доступ в их вебсайт велик, поэтому стоит иметь приложение предоставляющее компанию отдельно от других функций.
Приложение "About Company" будет использовать независимую базу данных, информация конфигурации базы данных будет управляться на Config-Server. В архитектуре Microservice, данное приложение не просто является вебсайтом представляющим компанию, но так же может быть услугой предоставляющей информацию для других приложений, например предоставлять информацию про горячую линию, электронную почту,... В общем она является частью в системе Microservice.

Примечание, главная цель данной статьи это обсуждение и практика примера "Как приложение может получить свою информацию конфигурации, управляемое на Config-Server".
- Name: ConfigClientAboutCompany
- Group: org.o7planning
- Artifact: ConfigClientAboutCompany
- Description: Spring Cloud Config Client (About Company App)
- Package: org.o7planning.aboutcompany



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> <groupId>org.o7planning</groupId> <artifactId>ConfigClientAboutCompany</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>ConfigClientAboutCompany</name> <description>Spring Cloud Config Config Client (About Company App)</description> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>1.5.9.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <java.version>1.8</java.version> <spring-cloud.version>Edgware.RELEASE</spring-cloud.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-config</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </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> <!-- 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> <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>com.microsoft.sqlserver</groupId> <artifactId>mssql-jdbc</artifactId> <scope>runtime</scope> </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> <repositories> <!-- Repository for ORACLE JDBC Driver --> <repository> <id>codelds</id> <url>https://code.lds.org/nexus/content/groups/main-repo</url> </repository> </repositories> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
ConfigClientAboutCompanyApplication.java
package org.o7planning.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); } }
Данному приложению нужно прочитать свои конфигурации, сохраненные на Config-Server, поэтому вам нужно ему сказать информацию про Config-Server. Данная информация конфигурирована на файле bootstrap.properties (Или bootstrap.yml). Данный файл используется приложением во время старта.

Есть небольшая разница в формате файла *.properties и файла *.yml, и вы можете узнать больше в статье ниже:
- TODO Link!

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
Конфигурировать, чтобы данное приложение работало на порту 7777:
application.properties
server.port=7777
Configuration file for this application (see on GitHub):



MainController.java
package org.o7planning.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.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.bind.annotation.RestController; @RefreshScope @RestController public class MainController { // https://github.com/o7planning/spring-cloud-config-git-repo-example // See: app-about-company.properties @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; @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:
Любой Spring Bean аннотированный (annotate) с помощью @RefreshScope будет обновлен во время запуска (runtime). И все компоненты, которые их используют получат новый объект при следующем вызове метода, будут полностью инициализированы и введены (inject) в зависимости.
Для начала, вам нужно запустить приложение Config-Server. Данное приложение будет работать на порту 8888.

Тестировать его со следующим URL:

После этого, запустите приложение ConfigClientAboutCompany, данное приложение будет работать на порту 7777:
Тестировать его со следующим URL:

