解決SpringCloud Config結合github無法讀取配置的問題
前言
配置中心存放文件在github是讀取過程,可能你會出現讀取不到配置信息。本次筆者將這一過程進行詳細介紹。
準備
父工程
由於筆者是使用聚合工程,所以這次也是把相關的工程創建說明寫上。當然你也可以完全創建兩個獨立的工程來引用。
創建父工程時直接隻有一個pom文件,以下是這個文件的依賴信息
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <packaging>pom</packaging> <modules> <module>ch2-2-eureka-client</module> <module>ch2-3-config-server</module> <module>ch4-1-feign</module> <module>ch5-1-zuul</module> <module>config-client</module> </modules> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.2.RELEASE</version> </parent> <groupId>com.example</groupId> <artifactId>ch2-1</artifactId> <version>0.0.1-SNAPSHOT</version> <name>ch2-1</name> <description>eureka</description> <properties> <java.version>1.8</java.version> </properties> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Finchley.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> </project>
子工程-config-server
這個工程內容目錄如下圖
依賴
由於在父工程已經引入瞭WEB,所以這裡隻引入spring-cloud-config-server,另外一個spring-boot-starter-actuator主要是用來查看端點信息的,可以不引用,後續手機刷新時需要這個開啟相關的訪問端點(好像是,具體後續可能有相關文章再細說)
<?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"> <parent> <artifactId>ch2-1</artifactId> <groupId>com.example</groupId> <version>0.0.1-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>ch2-3-config-server</artifactId> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-server</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> </dependencies> </project>
啟動主類
package springcloud; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.config.server.EnableConfigServer; @SpringBootApplication //隻加這個即可,表示這個啟動的是config的服務中心 @EnableConfigServer public class Ch21ConfigServerApplication { public static void main(String[] args) { SpringApplication.run(Ch21ConfigServerApplication.class, args); } }
配置文件
服務端的配置不需要註意什麼的,按下面的配置即可,因為默認是git的,所以不需要寫profiles 指向git瞭
server: port: 9090 spring: application: name: config-server cloud: config: server: git: uri: https://github.com/xxx1/xxx2.git #xxx2 是指存放當前配置文件的倉庫名 username: 寫自己的github賬號 password: 寫自己的github密碼
啟動項目後,訪問http://localhost:9090/config/dev/main 即可以看到配置信息 這個地址要註意的是 http://localhost:9090/{配置文件名前綴}/{環境類型}/{倉庫分支標簽}
如在倉庫創建的文件名為config-dev.yml,那麼配置文件名前綴就是config,環境就是指文件名後綴 dev,倉庫標簽就是當前存放文件的倉庫分支名
看到以下信息說明啟動項目且配置獲取成功
子工程-config-client
子工程就是個問題瞭,當時創建時一直無法讀取配置信息就是子工程這裡出現的問題,有兩個問題覺得要說明的,先看下子工程創建過程。
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"> <parent> <artifactId>ch2-1</artifactId> <groupId>com.example</groupId> <version>0.0.1-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <groupId>ch2.springcloud</groupId> <artifactId>config-client</artifactId> <version>0.0.1-SNAPSHOT</version> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-client</artifactId> </dependency> </dependencies> </project>
啟動類
package cn.springcloud; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class ClientApplication { public static void main(String[] args) { SpringApplication.run(ClientApplication.class,args); } }
配置類或者通過@Value獲取配置信息說明
package cn.springcloud.config; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; @Component @ConfigurationProperties(prefix = "cn.springcloud.book") public class ConfigInfoProperties { private String config; public String getConfig() { return config; } public void setConfig(String config) { this.config = config; } }
測試類Controller
這個類寫瞭兩個獲取配置信息的方式,一個是通過@Autowired註入配置類,一個是通過@Value來獲取
package cn.springcloud.controller; import cn.springcloud.config.ConfigInfoProperties; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class ConfigController { @Autowired private ConfigInfoProperties configInfoProperties; @Value("${demo.value}") private String value; @GetMapping("/getmsg") public String getMsg(){ System.out.println("value: "+value); System.out.println("this config is: "+configInfoProperties.getConfig()); return configInfoProperties.getConfig(); } }
配置文件
這裡的配置文件就是一個問題點瞭,配置如下啟動時會先摘取配置信息再啟動,所以把配置中心的配置放到bootstrap.yml中
問題:label: main 這個是指配置指向當前創建的分支,如果沒有則默認是master,網上就是這樣說的,後來發現,現在的直接在github創建倉庫後,顯示的是main,所以當時我沒有配置或者配置成master時一直獲取不瞭配置信息,所以重新查看瞭倉庫信息,如下圖:
bootstrap.yml說明:
spring: cloud: config: label: main uri: http://localhost:9090 name: config profile: dev
application.yml說明
server: port: 9000 spring: application: name: config-client
另一個問題
配置瞭配置中心的URL,即上面bootstrap.yml中的 uri: http://localhost:9090,但是項目一直啟動的是訪問 uri: http://localhost:8888,當時就納悶,找瞭很久都沒有找到在哪裡配置瞭8888,後來又是清緩存,還是不行,最後在client添加server依賴包,再重啟,結果發現正常瞭,正常後又把它刪除,也正常瞭。
org.springframework.cloud spring-cloud-config-server
從github拉取的文件在本地存放的目錄
如果你不知道文件在哪裡,在啟動server時又顯示瞭以下信息,則說明文件是拉取到本地瞭:
當前你也可以直接在電腦上查找文件名,看到以下類似目錄即可以找到
不知道能不能指定目錄的,這個讀者可以試下
測試結果
啟動server client,訪問client提供的接口localhost:9000/getmsg
結果如圖,說明正常獲取信息瞭
以上為個人經驗,希望能給大傢一個參考,也希望大傢多多支持WalkonNet。如有錯誤或未考慮完全的地方,望不吝賜教。
推薦閱讀:
- SpringCloud如何搭建一個多模塊項目
- SpringCloud整合Consul的實現
- springcloud gateway無法路由問題的解決
- SpringCloud服務註冊和發現組件Eureka
- SpringCloud eureka(server)微服務集群搭建過程