Logback 配置的利器：深入理解＜property＞與＜variable＞

在構建現代 Java 應用程序時，日志是不可或缺的一部分。一個健壯的日志系統不僅能幫助我們監控應用程序的運行狀態，還能在問題發生時提供關鍵的診斷信息。Logback 作為 SLF4J 的一個流行實現，以其高性能和靈活的配置而廣受開發者喜愛。

然而，僅僅將日志打印到控制臺或文件通常不足以滿足復雜應用的需求。我們可能需要根據不同的部署環境調整日志路徑、動態地注入一些運行時信息，或者從外部文件加載配置。這時，Logback 提供的 <property> 和 <variable> 標簽就成為了配置的強大工具。

本文將深入探討 Logback 中 <property> 和 <variable> 的功能、配置、典型使用場景以及它們之間的關鍵區別，幫助您構建更靈活、更易維護的 Logback 配置。

Logback 中的屬性：<property>

<property> 標簽是 Logback 配置中最基本也是最常用的元素之一，它允許您定義一個可在整個配置文件中重復使用的鍵值對。

功能與配置：

<property> 可以通過兩種主要方式定義其值：

  1. 直接指定值： 使用 value 屬性來直接定義屬性的值。

    <configuration><property name="log.file.name" value="application.log"/><appender name="FILE" class="ch.qos.logback.core.FileAppender"><file>${log.file.name}</file> <!-- 引用屬性 --><encoder><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern></encoder></appender><root level="info"><appender-ref ref="FILE"/></root>
</configuration>

    在這個例子中，log.file.name 被定義為 application.log，并通過 ${log.file.name} 在 <file> 標簽中引用。

  2. 從外部文件加載： 使用 file 或 resource 屬性來加載一個外部的 .properties 文件。file 用于指定文件系統路徑，resource 用于指定類路徑中的資源。這種方式非常適合在不修改 Logback XML 文件的情況下，根據不同環境調整配置。

    示例：

    假設您有一個名為 application-logger.properties 的文件，位于您項目的 src/main/resources/config 目錄下（或者在部署時位于文件系統的 /etc/app/config/ 目錄下）。

    src/main/resources/config/application-logger.properties 文件內容：

    # 日志文件存儲路徑
log.dir=/var/log/my-app
# 應用程序日志文件的基本名稱
app.log.basename=backend-service
# 應用程序日志級別
app.log.level=INFO

    logback.xml 文件內容：

    <configuration><!-- 方式一：從類路徑加載 .properties 文件 --><!-- Logback 會在類路徑下查找 config/application-logger.properties --><property resource="config/application-logger.properties"/><!-- 方式二：從文件系統路徑加載 .properties 文件 --><!-- 如果您知道確切的文件系統路徑，例如在Linux服務器上 --><!-- <property file="/etc/app/config/application-logger.properties"/> --><appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 使用從 properties 文件加載的 log.dir 和 app.log.basename --><file>${log.dir}/${app.log.basename}.log</file><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${log.dir}/${app.log.basename}.%d{yyyy-MM-dd}.gz</fileNamePattern><maxHistory>30</maxHistory></rollingPolicy><encoder><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern></encoder></appender><!-- 使用從 properties 文件加載的 app.log.level --><root level="${app.log.level}"><appender-ref ref="ROLLING_FILE"/></root>
</configuration>

    在這個擴充的例子中：

    • 通過 <property resource="config/application-logger.properties"/>，Logback 會讀取 application-logger.properties 文件中的所有鍵值對。
    • 這些鍵值對（例如 log.dir、app.log.basename、app.log.level）隨后就可以像 XML 中定義的屬性一樣，通過 ${propertyName} 的語法在 logback.xml 的其他地方被引用。
    • 這種方式極大地增強了配置的靈活性，使得您可以根據不同的部署環境或需求，輕松切換不同的屬性文件，而無需修改核心的 logback.xml 結構。

使用場景：

  • 集中管理常量： 將日志文件名、路徑、模式字符串等常量定義為屬性，方便統一修改和管理。
  • 外部化配置： 將部分配置（尤其是環境相關的）從 XML 文件中分離出來，存儲在 .properties 文件中，實現配置的外部化和靈活部署。
  • 提高可讀性： 將復雜的模式字符串定義為屬性，使 <encoder> 部分更簡潔。
應對更復雜的場景：<variable>

<variable> 標簽與 <property> 類似，也用于定義可以在配置文件中引用的鍵值對。但它的核心區別在于其 scope 屬性，這使得它能夠從更廣泛的來源獲取值，以應對更動態的配置需求。

功能與配置：

<variable> 最大的特點是其 scope 屬性，它決定了變量值的查找范圍：

  1. scope="context"： 變量的值直接在 value 屬性中定義，并存儲在 Logback 的 LoggerContext 中。這與 <property value="..." /> 的行為非常相似。

    <variable name="application.id" value="my-service-alpha" scope="context"/>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>%d [%thread] ${application.id} %-5level %logger{36} - %msg%n</pattern></encoder>
</appender>

    這里的 ${application.id} 會被解析為 my-service-alpha。

  2. scope="system"： 變量的值將從 Java **系統屬性（System Properties）**中獲取。這意味著您可以通過 JVM 啟動參數來動態地設置這些值。

    <variable name="server.port" scope="system"/>
<appender name="FILE" class="ch.qos.logback.core.FileAppender"><file>logs/app-${server.port}.log</file><!-- ... -->
</appender>

    如果您通過 java -Dserver.port=8080 -jar your-app.jar 啟動應用程序，那么日志文件名將是 app-8080.log。

  3. scope="env"： 變量的值將從**操作系統環境變量（Environment Variables）**中獲取。

    <variable name="LOG_LEVEL_OVERRIDE" scope="env"/>
<root level="${LOG_LEVEL_OVERRIDE:-INFO}"> <!-- 默認值為INFO --><appender-ref ref="CONSOLE"/>
</root>

    如果您的操作系統設置了環境變量 LOG_LEVEL_OVERRIDE=DEBUG，那么應用程序的根日志級別將是 DEBUG。這里還展示了 ${VAR_NAME:-defaultValue} 的用法，當環境變量不存在時提供默認值。

使用場景：

  • 動態環境參數： 獲取應用程序啟動時的 JVM 參數或操作系統環境變量，實現根據部署環境動態調整日志行為。
  • 云原生部署： 在 Docker、Kubernetes 等容器化環境中，環境變量是傳遞配置的常用方式，<variable scope="env"/> 提供了無縫集成。
  • 運行時標識符： 將服務器 ID、容器 ID 等動態生成的標識符注入到日志中，以便在分布式日志系統中進行關聯和追蹤。
<property> 與 <variable> 的核心區別與選擇

盡管兩者都用于定義和引用鍵值對，但它們在功能側重和值獲取優先級上存在顯著差異。

主要區別總結：

特性<property><variable>
主要功能定義通用鍵值對，可從 XML 或外部 .properties 文件加載。定義變量，尤其擅長從 Java 系統屬性或操作系統環境變量獲取值。
值來源直接在 value 中指定；從 file 或 resource 指定的 .properties 文件加載。直接在 value 中指定（scope="context"）；從 Java 系統屬性（scope="system"）；從操作系統環境變量（scope="env"）。
scope屬性無此屬性。核心屬性，用于指定變量值的查找范圍。
典型用途應用程序內部的靜態配置值；從外部配置文件加載。動態獲取外部環境參數（如機器名、環境變量）；在 Logback 上下文中定義變量。

優先級查找順序：

當 Logback 解析配置文件中 ${...} 形式的占位符時，它會按照以下優先級順序查找對應的值：

  1. 本地作用域 / 上下文作用域： 在 logback.xml 配置文件中直接使用 <property> 或 <variable scope="context"/> 定義的屬性和變量。這是最高優先級。
  2. Java 系統屬性（System Properties）： 通過 JVM 啟動參數 -Dkey=value 設置的屬性。
  3. 操作系統環境變量（Operating System Environment）： 操作系統中設置的環境變量。這是最低優先級。

這個優先級順序意味著：本地定義的值會覆蓋系統屬性，系統屬性會覆蓋環境變量。理解這一點對于解決 Logback 配置中的變量沖突和確保您期望的值被正確使用至關重要。

如何選擇：

  • 使用 <property>：

    • 當您需要定義一個靜態的、在配置文件內部或從特定 .properties 文件加載的通用值時。
    • 當您主要關注配置的模塊化和重用，并且值不會隨運行時環境而頻繁變化時。

  • 使用 <variable>：

    • 當您需要從 JVM 啟動參數或操作系統環境變量中動態獲取值時。
    • 當應用程序需要適應不同的部署環境，而這些環境的配置通過外部機制（如容器編排系統）注入時。
    • 當您需要在日志中包含一些運行時動態生成的標識符時。
結語

<property> 和 <variable> 是 Logback 靈活配置的關鍵組成部分。通過合理地利用它們，您可以創建高度可配置、易于管理和適應性強的日志系統。理解它們的區別和優先級查找規則，將幫助您更好地駕馭 Logback，確保您的應用程序在任何環境下都能高效、準確地記錄信息。希望這篇博客能幫助您在 Logback 配置的道路上更進一步！

本文來自互聯網用戶投稿，該文觀點僅代表作者本人，不代表本站立場。本站僅提供信息存儲空間服務，不擁有所有權，不承擔相關法律責任。
如若轉載，請注明出處：http://www.pswp.cn/web/89466.shtml
繁體地址，請注明出處：http://hk.pswp.cn/web/89466.shtml
英文地址，請注明出處：http://en.pswp.cn/web/89466.shtml

如若內容造成侵權/違法違規/事實不符，請聯系多彩編程網進行投訴反饋email:809451989@qq.com，一經查實，立即刪除！

相關文章

Java中excel字典轉換

Java中excel字典轉換

? 背景說明EasyExcel 原生的 ExcelProperty 注解不支持 dictType&#xff08;不像那樣有 Excel(dictType"xxx")&#xff09;&#xff0c;所以如果你想實現字典翻譯功能&#xff0c;就需要自己實現 Converter 接口&#xff0c;比如 DictConvert。? 什么是 DictConve…
閱讀更多...
數據結構-3(雙向鏈表、循環鏈表、棧、隊列)

數據結構-3(雙向鏈表、循環鏈表、棧、隊列)

一、思維導圖二、雙向循環鏈表的判空、尾插、遍歷(反向)、尾刪class Node:def __init__(self, data):self.data dataself.next Noneself.prior Noneclass circularDoublyLinkedList():def __init__(self):self.head Noneself.tail Noneself.size 0def isEmpty(self):retu…
閱讀更多...
IDEA運行Tomcat一直提示端口被占用（也查不到該端口）

IDEA運行Tomcat一直提示端口被占用（也查不到該端口）

首先查看是否是因為Java程序異常終止&#xff0c;進程沒有完全釋放導致。打開資源管理器&#xff0c;找到所有的java.exe&#xff0c;強制結束任務。如果仍然不行&#xff0c;那就極可能還是開啟了hyper-V虛擬化&#xff0c;查看排除的tcp端口范圍端口號沒被占用卻提示占用&…
閱讀更多...
AWS Lambda 最佳實踐：構建高效無服務器應用的完整指南

AWS Lambda 最佳實踐：構建高效無服務器應用的完整指南

引言 AWS Lambda 作為無服務器計算的核心服務，讓開發者能夠專注于業務邏輯而無需管理服務器。本文將通過實際案例和代碼示例，分享 Lambda 開發中的關鍵最佳實踐。 1. 函數設計原則 單一職責原則 每個 Lambda 函數應該只做一件事，這樣更容易測試、維護和擴展。 # ? 不推…
閱讀更多...
29、鴻蒙Harmony Next開發：深淺色適配和應用主題換膚

29、鴻蒙Harmony Next開發：深淺色適配和應用主題換膚

目錄 應用深淺色適配 應用跟隨系統的深淺色模式 應用主動設置深淺色模式 系統默認判斷規則 使用建議與限制 設置應用內主題換膚 概述 自定義主題色 設置應用內組件自定義主題色 設置應用局部頁面自定義主題風格 設置應用頁面局部深淺色 系統缺省token色值 應用深淺…
閱讀更多...
源鑒SCA4.9︱多模態SCA引擎重磅升級，開源風險深度治理能力再次進階

源鑒SCA4.9︱多模態SCA引擎重磅升級，開源風險深度治理能力再次進階

SCA技術已成為數字供應鏈開源治理的關鍵入口。源鑒SCA深度融合懸鏡原創專利級AI智能代碼疫苗技術&#xff0c;是國內首款集源碼組件成分分析、代碼成分溯源分析、制品成分二進制分析、容器鏡像成分掃描、運行時成分動態追蹤及開源供應鏈安全情報預警分析等六大核心引擎為一體的…
閱讀更多...
Git語義化提交規范及提交模板設置

Git語義化提交規范及提交模板設置

Git語義化提交規范&#xff08;Conventional Commits&#xff09; &#x1f4da; 常見的語義化提交類型包括&#xff1a;類型含義說明feat? 新增功能&#xff08;feature&#xff09;fix&#x1f41b; 修復 bugdocs&#x1f4da; 修改文檔&#xff08;如 README&#xff09;st…
閱讀更多...
用TensorFlow進行邏輯回歸(五)

用TensorFlow進行邏輯回歸(五)

Softmax分類#List3-50%matplotlib inlineimport numpy as npimport tensorflow as tfimport matplotlib.pyplot as pltx1_label0 np.random.normal(1, 1, (100, 1))x2_label0 np.random.normal(1, 1, (100, 1))x1_label1 np.random.normal(5, 1, (100, 1))x2_label1 np.ran…
閱讀更多...
基于 Django + 協同過濾算法的電影推薦系統設計與實現

基于 Django + 協同過濾算法的電影推薦系統設計與實現

&#x1f3ac; 基于 Django 協同過濾算法的電影推薦系統設計與實現?? 本項目由成都理工大學宜賓校區的三位同學曾銘楊、楊皓麟、陳禧錦共同完成。項目以豆瓣電影數據為基礎&#xff0c;通過協同過濾算法為用戶構建個性化電影推薦服務&#xff0c;是一款集數據爬取、推薦算法…
閱讀更多...
小白全棧項目部署指南

小白全棧項目部署指南

小白全棧項目部署指南&#xff1a;前端后端數據庫完整攻略 &#x1f4d6; 寫在前面 當你學會了基礎的靜態網站部署后&#xff0c;是不是想挑戰更有趣的項目&#xff1f;比如一個能夠注冊登錄、保存數據的完整應用&#xff1f; 這就需要學習全棧項目部署了&#xff01; 別被&quo…
閱讀更多...
C# Linq 左關聯查詢詳解與實踐

C# Linq 左關聯查詢詳解與實踐

在 C# 開發中&#xff0c;Linq&#xff08;Language Integrated Query&#xff09;提供了強大的數據查詢能力&#xff0c;尤其是在處理集合間的關聯操作時。本文將詳細解析 C# Linq 中的左關聯查詢&#xff0c;并通過實際案例說明其用法。左關聯查詢基礎左關聯&#xff08;Left…
閱讀更多...
【機器學習深度學習】LoRA 微調詳解：大模型時代的高效適配利器

【機器學習深度學習】LoRA 微調詳解：大模型時代的高效適配利器

目錄 前言 一、LoRA 的核心思想 二、LoRA 為什么高效&#xff1f; ? 1. 參數效率 ? 2. 內存友好 ? 3. 即插即用 三、LoRA 適用場景 四、LoRA 實踐建議 五、LoRA 和全參數微調對比 六、 LoRA的具體定位 &#x1f4cc; 總結 &#x1f517; 延伸閱讀 前言 在大模型…
閱讀更多...
vue頁面不銷毀的情況下再返回，總是執行created，而不觸發 activated

vue頁面不銷毀的情況下再返回，總是執行created，而不觸發 activated

vue頁面不銷毀的情況下再返回&#xff0c;總是執行created&#xff0c;而不觸發 activated 原因&#xff1a; 沒有進行頁面緩存地址和頁面組件的name沒對上 解決方案: 組件只有在被 包裹時才會觸發 activated 和 deactivated 生命周期 如果沒有被緩存&#xff0c;每次進入路由…
閱讀更多...
從 C# 到 Python：6 天極速入門（第二天）

從 C# 到 Python：6 天極速入門（第二天）

作為一名資深 C# 開發者&#xff0c;我們在第一天已經掌握了 Python 的基礎語法框架。今天我們將深入 Python 的特色語法與高級特性&#xff0c;通過實際項目開發場景的代碼對比&#xff0c;理解這些特性在真實業務中的應用價值。一、簡潔語法糖&#xff1a;項目開發中的實戰應…
閱讀更多...
MyBatis 動態 SQL：讓 SQL 語句隨條件靈活變化

MyBatis 動態 SQL：讓 SQL 語句隨條件靈活變化

目錄 1. 動態SQL 1.1. if 1.1.1. 持久層接口添加方法 1.1.2. 映射文件添加標簽 1.1.3. 編寫測試方法 1.2. where 1.3. set 1.4. choose、when、otherwise 1.5. foreach 1.5.1. 遍歷數組 1.5.2. 遍歷Collection 1.5.3. 遍歷Map 2. 總結 前言 本文來講解MyBatis的動…
閱讀更多...
AI 驅動的儀表板：從愿景到 Kibana

AI 驅動的儀表板：從愿景到 Kibana

作者&#xff1a;來自 Elastic Jeffrey Rengifo 及 Toms Mura 使用 LLM 處理圖像并將其轉換為 Kibana 儀表板。 想獲得 Elastic 認證&#xff1f;了解下一次 Elasticsearch Engineer 培訓的舉辦時間&#xff01; Elasticsearch 擁有眾多新功能&#xff0c;幫助你為你的使用場景…
閱讀更多...
AI產品經理面試寶典第17天：AI時代敏捷開發與MVP構建面試題與答法

AI產品經理面試寶典第17天：AI時代敏捷開發與MVP構建面試題與答法

機器學習MVP構建問題怎么答？ 面試官：請舉例說明如何將業務問題轉化為機器學習可解的問題？ 你的回答：以電商供應商評價為例，傳統方法用人工設定的低維度指標評分，而機器學習能利用大數據構建高維模型。比如通過供應商歷史交易數據、物流時效、售后投訴率等數百個特征，訓…
閱讀更多...
HBase2.5.4單機模式與偽分布式的安裝與配置（Ubuntu系統）

HBase2.5.4單機模式與偽分布式的安裝與配置（Ubuntu系統）

HBase的安裝也分為三種&#xff0c;單機模式、偽分布式模式、完全分布式模式&#xff1b;我們先來安裝單機版。 一、環境準備 1. 系統要求 Ubuntu 20.04/22.04 LTS Java 8&#xff08;必須&#xff0c;HBase不兼容更高版本&#xff09; Hadoop&#xff08;單機模式不需要&a…
閱讀更多...
Honeywell霍尼韋爾DV-10 變速器放大器 輸入 15-28 VDC,輸出 +/- 10VDC 060-6881-02

Honeywell霍尼韋爾DV-10 變速器放大器 輸入 15-28 VDC,輸出 +/- 10VDC 060-6881-02

Honeywell霍尼韋爾DV-10 變速器放大器 輸入 15-28 VDC,輸出 /- 10VDC 060-6881-02
閱讀更多...
騰訊位置商業授權鴻蒙地圖SDK工程配置

騰訊位置商業授權鴻蒙地圖SDK工程配置

工程配置 安裝 DevEco Studio 開發環境 手機HarmonyOS系統&#xff1a;OpenHarmony-5.0.0.71及以上DevEco Studio版本&#xff1a;DevEco Studio NEXT Release(Build Version: 5.0.3.900)及以上 獲取key與生成秘鑰 獲取key 登錄騰訊位置服務控制臺&#xff0c;未注冊過賬號可…
閱讀更多...
最新文章

Copyright @ 2022~2023