log書寫規範

2021-08-06 08:20:56 字數 943 閱讀 5064

問題追蹤:在程式除錯時,通過日誌追蹤程式的bug,也可在使用者發現bug後,通過日誌對問題進行分析和定位。

狀態監控:通過日誌可檢視系統的執行狀態,做到發現和定位問題。

安全審計:通過對日誌進行分析,可發現是否存在非授權的操作。

安全類資訊:記錄系統邊界互動行為和資訊。

業務類資訊:記錄系統內部業務處理行為和資訊。

效能類資訊:記錄系統硬體對業務處理的支撐能力。

error(錯誤):已經影響到系統正常執行,並且系統不能自行恢復到正常的執行狀態的問題。

warn(警告):系統一般模組存在問題,不影響系統執行。

info(通知):系統執行期間的系統執行狀態變化,或關鍵業務處理記錄等使用者或管理員在系統執行期間關注的一些資訊。

debug(除錯):最詳細的記錄,一般為系統執行過程,以及函式引數和返回值等資訊,主要用於協助程式設計師開發。

trace(跟蹤):類似debug,一般很少使用。

在日誌相關資料輸出的時要特別注意對敏感資訊的保護,比如修改密碼時,不能將密碼輸出到日誌中。

對於可以預見的多數情況下單例執行的class,可以不新增static字首;對於可能是多例居多,尤其是需要頻繁建立的class,我們要求要新增static字首。

系統啟動的引數、配置、環境變數、system.properties等資訊對於軟體的正常執行至關重要,這些資訊的輸出有助於安裝配置人員通過日誌快速定位問題,所以程式有必要在啟動過程中把使用到的關鍵引數、變數在日誌中輸出出來。在輸出時需要注意,不是一股腦的全部輸出,而是將軟體執行涉及到的配置資訊輸出出來。

函式開始與結束新增log,方便檢視程式執行流程。

函式傳入引數與返回引數使用log列印,方便檢視引數是否傳遞錯誤。

log中含義不清晰資料(如:單純的數字等)可轉換為能表達含義的字串進行列印。

log格式統一,如大小寫,同一資料名稱等。

log分級別列印,方便除錯與檢視。

CSS 書寫規範

本文是參考了css森林中的規範,並結合之前幾個專案積累所書寫的乙個基本規範。不敢說是原創,所以鄭重感謝一下css森林。同時,本文件也處於持續改進中。1.基本 css檔案中,選擇器書寫按照 標籤 標籤偽類 id 類 覆蓋 排序,同一型別寫在一起 進行覆蓋時,也按照這樣乙個順序。css定義中,屬性的書寫...

oracle sql書寫規範

一 書寫規範 1 sql編寫時,大小寫一致 2 關鍵字單佔一行,如select from where and group by order by等 3 注意行縮排和對齊,建議語句中的關鍵字右對齊 4 使用空格,sql語句內的算術運算子 邏輯運算子 and or not 比較運算子 between a...

xml書寫規範

xml也就是擴充套件標識語言,可以實現跨平台,真正做到資料和顯示分離,對於webservices等其他網路上資料的傳輸等較多使用。下邊根據個人理解簡單介紹一下xml的一些規範。1 xml文件有且只有乙個根標籤,所謂的根標籤就是一對 根標籤 和就是根標籤了 2 xml文件內沒乙個開始標籤都必須對應乙個...