properties 配置類型

application.properties 中的鍵值對 key-value 主要分為以下兩類：

• 系統(tǒng)配置：指 key 值是由 SOFABoot 框架指定，并能影響框架運行的配置。可在 properties-系統(tǒng) 中查看所有系統(tǒng)配置項。

• 自定義配置：指 key 值是由用戶指定，被用戶程序代碼使用的自定義配置，這類配置不會影響 SOFABoot 框架，具體含義與用途完全由用戶決定。

properties 默認配置

• properties 文件路徑：resources/config/application.properties

  properties 文件存放路徑的要求為：

  • 在標準 Maven 工程里，配置文件必須存放于上述路徑，以確保應用會將這個文件打包到最終的 JAR 或 War 包中。

  • 在 IDE 中運行時，也需要保證文件能被正確加載到 classpath 中。

• properties 主要默認參數(shù)

  spring.application.name={APPNAME}
  logging.level.com.alipay.sofa=INFO
  logging.path=./logs
  ...

默認參數(shù)說明

在默認的 application.properties 中，主要包含以下 3 個參數(shù)。

• spring.application.name

  • 不可被刪除。

  • 應用名字符僅允許包含 a~z 小寫字母和 “-”，不允許包含任何其他符號。

  • 用于指定應用名稱，應用名稱必須保持 唯一性。SOFABoot 框架以及一些中間件會以此配置值作為應用的名稱，該配置以創(chuàng)建工程時填寫的 artifactId 為默認值。在 RPC 調用、消息投遞時，框架會在框架日志中打印應用名稱，也會在上下文中傳遞。一旦重名，將會導致監(jiān)控和服務治理時無法區(qū)分不同應用的日志。此外，應用代碼也可以利用這個值來做一些跟應用名相關的業(yè)務邏輯判斷或者標識區(qū)分。

• logging.level.com.alipay.sofa=INFO 用于設定當前應用的日志級別，其值可為：

  • INFO：默認值，表示基礎信息日志。

  • WARN：表示警告日志。

  • DEBUG：表示調試日志。

• logging.path=./logs 用于指定 SOFABoot 框架以及各個中間件的日志輸出目錄。

  • 默認為 ./logs，且不建議修改此值。

  • 當在本地運行時，日志會輸出到工程的根目錄的 logs 目錄下。

  • 當在 Linux/OS X 下運行時，技術棧會切換到 admin 用戶運行程序，同時日志文件會輸出到 /home/admin/logs 目錄下。

動態(tài)修改 properties 配置值

• application.properties：支持所有配置的設置，但卻無法動態(tài)指定，文件中的 key-value 一旦硬編碼就無法改變。

• 可以通過 java -D 動態(tài)設置參數(shù)：對于和工作空間相關的配置等需要動態(tài)設置的參數(shù)， SOFABoot 支持用 -D 參數(shù)來動態(tài)設置值。該配置方式有下述優(yōu)勢：

  • 可以實現(xiàn)動態(tài)調整。

  • 有更高的優(yōu)先級：當 application.properties 中的 key 和 -D 參數(shù)的 key 沖突時，-D 參數(shù)的值生效。

  • 通過 -D 的動態(tài)性來覆蓋或者修正硬編碼的配置，可實現(xiàn)靈活部署。

• 配置示例如下：

  java -Dparam1=value2 -Dparam2=value2

相關閱讀

若您需要在不同工作空間下（如開發(fā)、測試、預發(fā)布、生產工作空間）提供不同的配置，可參考 技術棧使用指南。