SpringBoot中根據環境加載不同的配置的方案
前言
我們的一個應用,開發上線,需要一定的流程,比如需要先在測試環境中進行測試,測試環境中有它的一整套配置,如MySQL、Redis、MQ等。
測試環境測試完畢,我們會在預發環境再度測試,最后再上線,即線上環境。每個環境都有他們自己獨有的一套配置,而代碼邏輯都是一樣,就是環境配置不一樣而已。
如何低耦合地分離各個環境的配置,就是我們所追求的,下面闡述下SpringBoot中的方案。
方案
我寫了個demo,下面是它的代碼結構:
1.業務代碼
下面假定以下是業務代碼,主要就是從配置文件中讀取env的值,并返回出去:
- package com.example.configenv.controller;
- import org.springframework.beans.factory.annotation.Value;
- import org.springframework.web.bind.annotation.GetMapping;
- import org.springframework.web.bind.annotation.RequestMapping;
- import org.springframework.web.bind.annotation.RestController;
- @RestController
- @RequestMapping("/")
- public class EnvController {
- @Value("${env}")
- private String env;
- @GetMapping("/env")
- public String showEnvValue() {
- return env;
- }
- }
2.配置文件
配置文件中,application.yml是一個主配置,即無論如何,都會被加載的,類似SSM時代的spring-config.xml。里邊的邏輯,就一個active,就是指定配置環境:
- spring:
- profiles:
- active: dev
對應其他其他環境的配置,它們有2個點,一個是環境名稱on-profile,一個對應環境下的值env。
- SpringBoot中根據環境加載不同的配置的方案
- 原創2021-07-26 17:31·IT小村
- 前言
- 我們的一個應用,開發上線,需要一定的流程,比如需要先在測試環境中進行測試,測試環境中有它的一整套配置,如MySQL、Redis、MQ等。
- 測試環境測試完畢,我們會在預發環境再度測試,最后再上線,即線上環境。每個環境都有他們自己獨有的一套配置,而代碼邏輯都是一樣,就是環境配置不一樣而已。
- 如何低耦合地分離各個環境的配置,就是我們所追求的,下面闡述下SpringBoot中的方案。
- 方案
- 我寫了個demo,下面是它的代碼結構:
- SpringBoot中根據環境加載不同的配置的方案
- 1.業務代碼
- 下面假定以下是業務代碼,主要就是從配置文件中讀取env的值,并返回出去:
- package com.example.configenv.controller;
- import org.springframework.beans.factory.annotation.Value;
- import org.springframework.web.bind.annotation.GetMapping;
- import org.springframework.web.bind.annotation.RequestMapping;
- import org.springframework.web.bind.annotation.RestController;
- @RestController
- @RequestMapping("/")
- public class EnvController {
- @Value("${env}")
- private String env;
- @GetMapping("/env")
- public String showEnvValue() {
- return env;
- }
- }
- 2.配置文件
- 配置文件中,application.yml是一個主配置,即無論如何,都會被加載的,類似SSM時代的spring-config.xml。里邊的邏輯,就一個active,就是指定配置環境:
- spring:
- profiles:
- active: dev
- 對應其他其他環境的配置,它們有2個點,一個是環境名稱on-profile,一個對應環境下的值env。
- application-dev.yml
- spring:
- config:
- activate:
- on-profile: dev
- env: '測試環境'
application-online.yml
- spring:
- config:
- activate:
- on-profile: pre
- env: '預發環境'
application-online.yml
- spring:
- config:
- activate:
- on-profile: online
- env: '線上環境'
3.驗證效果
當我的主配置文件為如下時,即指定環境為dev測試環境
- spring:
- profiles:
- active: dev
http://localhost:8080/env
可以看到,加載的是application-dev.yml的配置
而當我的主配置文件是如下時,即加載的是online線上環境
- spring:
- profiles:
- active: online
http://localhost:8080/env
可以看到,加載的是application-online.yml的配置。
其他
部署應用的時候,我們只需要覆蓋application.yml即可,就可以在測試環境、預發環境、線上環境等環境,加載他們對應的配置。