SpringBoot項(xiàng)目多層級(jí)多環(huán)境yml設(shè)計(jì)詳解

更新時(shí)間：2023年03月01日 09:03:52 作者：CoderV的進(jìn)階筆記

這篇文章主要為大家介紹了SpringBoot項(xiàng)目多層級(jí)多環(huán)境yml設(shè)計(jì)詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

需求場(chǎng)景

基礎(chǔ)設(shè)施模塊中有一些通用固定的基礎(chǔ)配置。例如：日志的配置，Spring本身的配置以及MyBatis Plus相關(guān)的固定配置等等。這些配置往往與環(huán)境無關(guān)，如何復(fù)用？

# 日志配置
logging:
  level:
    # 記得配置到包名
    com.agileboot: debug
    org.springframework: info
  pattern:
    console: "%date %thread %green(%level) [%cyan(%logger{10}):%magenta(%line)] %red(%method) | %msg%n"
# Spring配置
spring:
  # 文件上傳
  servlet:
     multipart:
       # 單個(gè)文件大小
       max-file-size:  10MB
       # 設(shè)置總上傳的文件大小
       max-request-size:  20MB
  mvc:
    pathmatch:
      matching-strategy: ANT_PATH_MATCHER
  jackson:
    deserialization:
      fail-on-unknown-properties: false
    serialization:
      write-dates-as-timestamps: false
    date-format: yyyy-MM-dd HH:mm:ss

基礎(chǔ)設(shè)施模塊中還有一些獨(dú)立于環(huán)境的配置。例如Mysql和Redis或者M(jìn)Q之類的。如何區(qū)分環(huán)境？

# 數(shù)據(jù)源配置
spring:
    # redis 配置
    redis:
        # 地址
        host: localhost
        # 端口，默認(rèn)為6379
        port: 36379
        # 數(shù)據(jù)庫索引
        database: 0
        # 密碼
        password: 12345
        # 連接超時(shí)時(shí)間
        timeout: 10s
        lettuce:
            pool:
                # 連接池中的最小空閑連接
                min-idle: 0
                # 連接池中的最大空閑連接
                max-idle: 8
                # 連接池的最大數(shù)據(jù)庫連接數(shù)
                max-active: 8
                # #連接池最大阻塞等待時(shí)間（使用負(fù)值表示沒有限制）
                max-wait: -1ms

日志相關(guān)的配置我們一般都配在logback.xml文件中。如何實(shí)現(xiàn)不同環(huán)境日志路徑不一樣？

想要達(dá)到的效果

復(fù)用基礎(chǔ)設(shè)施模塊中的固定配置。
區(qū)分多環(huán)境的配置。
logback日志引入多環(huán)境配置。

詳細(xì)代碼實(shí)現(xiàn)在開源項(xiàng)目Agileboot中：github.com/valarchie/A…

實(shí)現(xiàn)

假設(shè)我們有一個(gè)Admin模塊，我們可以給它定義一份application.yml文件。文件中描述該模塊特定的配置。比如端口，訪問路徑之類的。

# 開發(fā)環(huán)境配置
server:
  # 服務(wù)器的HTTP端口，默認(rèn)為8080
  port: 8080
  servlet:
    # 應(yīng)用的訪問路徑
    context-path: /
  tomcat:
    # tomcat的URI編碼
    uri-encoding: UTF-8
    # 連接數(shù)滿后的排隊(duì)數(shù)，默認(rèn)為100
    accept-count: 1000
    threads:
      # tomcat最大線程數(shù)，默認(rèn)為200
      max: 800
      # Tomcat啟動(dòng)初始化的線程數(shù)，默認(rèn)值10
      min-spare: 100
# Spring配置 如果需要無Mysql  無Redis直接啟動(dòng)的話  dev改為test
# 生產(chǎn)環(huán)境把dev改為prod
spring:
  profiles:
    active: basic,dev

在基礎(chǔ)設(shè)施模塊中新建

applicaiton-basic.yml，配置一些與環(huán)境無關(guān)的基礎(chǔ)固定復(fù)用配置。

application-dev.yml，配置一些和環(huán)境相關(guān)的配置，例如數(shù)據(jù)庫的配置。

然后在spring.profiles.active配置中指定basic和dev文件。

此時(shí)springboot會(huì)自動(dòng)去找applicaiton-basic.yml和application-dev.yml文件。
所以我們最終的配置文件是由applicaiton.yml+applicaiton-basic.yml+applicaiton-dev.yml疊加的配置。

日志的多環(huán)境配置，我們可以新建一份logback-spring.xml文件。假設(shè)我們想要根據(jù)環(huán)境配置不同的日志路徑。可以在例如application-dev.yml文件中配置logging.file.path。