05日志標(biāo)準(zhǔn)化規(guī)范初稿(編輯修改稿)
2025-05-11 10:34 本頁(yè)面
【文章內(nèi)容簡(jiǎn)介】 志規(guī)約。，即每一次接口的調(diào)用。但由于各種原因，web日志中有些記錄是缺失或不完整的數(shù)據(jù)，推薦在每個(gè)接口調(diào)用后，在其入口輸出調(diào)用類(lèi)名及輸入?yún)?shù)的日志，以及接口結(jié)束前輸出返回?cái)?shù)據(jù)的日志，并使用info級(jí)別。另外，重要方法入口，業(yè)務(wù)流程前后及處理的結(jié)果等，推薦記錄log，并使用debug級(jí)別，因?yàn)閷?duì)于非開(kāi)發(fā)人員掌控的環(huán)境（無(wú)法做DEBUG），記錄方法調(diào)用、入?yún)?、返回值的方式?duì)于排查問(wèn)題會(huì)有很大幫助。10. 日志輸出規(guī)范。應(yīng)用程序禁止直接使用Log4J API，并且禁止使用JDK Console輸出(, , (), etc.)，、。所有的日志實(shí)例的屬性都應(yīng)從根日志（root logger）繼承。日志信息必須支持輸出到控制臺(tái)（console）和文本文件（TextFiles）。輸出到文本文件（TextFiles）的日志，應(yīng)提供日志文件分析腳本，以方便查詢閱讀、統(tǒng)計(jì)分析。11．關(guān)注日志記錄對(duì)于系統(tǒng)性能、安全性的影響，不要多次重復(fù)記錄日志。日志記錄太過(guò)于頻繁，日志記錄到文件IO或者數(shù)據(jù)庫(kù)都是很費(fèi)CPU和內(nèi)存資源的事，會(huì)對(duì)系統(tǒng)的性能產(chǎn)生影響。關(guān)注日志是否會(huì)被惡意攻擊頻繁打印日志，使得日志文件超過(guò)100G、500G直到磁盤(pán)容量爆滿，服務(wù)器掛掉。12．記錄要精簡(jiǎn)、不濫用日志，關(guān)注日志記錄的正確性和必要性。分清楚什么時(shí)候應(yīng)該記錄日志，什么時(shí)候不需要記錄日志。什么是TRACE、DEBUG信息，什么是INFO、ERROR信息。對(duì)于異常處理，不要多次重復(fù)的記錄同一個(gè)異常的堆棧信息。比如在DAO層記錄了異常堆棧信息，然后拋出異常，在web層catch了異常之后，又記錄了一次異常堆棧信息。 13．在日志信息上添加便于檢閱、查找的額外標(biāo)識(shí)。每條日志都應(yīng)有關(guān)鍵標(biāo)識(shí)，能夠盡快定位某條信息的位置。包括日期和時(shí)間，程序Java類(lèi)的名稱(chēng)、方法甚至行號(hào)，錯(cuò)誤類(lèi)型或者錯(cuò)誤代碼。否則前端web頁(yè)面報(bào)錯(cuò)，告訴開(kāi)發(fā)人員去查找問(wèn)題，開(kāi)發(fā)人員很難去查找當(dāng)時(shí)的操作日志或者異常信息。僅以下代碼是符合規(guī)范：// （推薦）private static final Logger logger =()。private final Logger logger = (getClass())。private static Logger logger = ()。protected final Logger logger =(getClass())。private Logger logger = (getClass())。protected Logger logger = (getClass())。private static final Logger logger =(loggerName)。，導(dǎo)致業(yè)務(wù)不正常服務(wù)的，用error級(jí)別；錯(cuò)誤是預(yù)期會(huì)發(fā)生的，并且已經(jīng)有了其他的處理流程，使用warn級(jí)別。16. Log的內(nèi)容須確保不會(huì)因?yàn)長(zhǎng)og語(yǔ)句的問(wèn)題而拋出異常造成中斷，如下有可能會(huì)拋出NullPointerException：(Processing request with id: {}, ())。一般有：日志級(jí)別、輸出位置，如果有日志分析工具，還需仔細(xì)設(shè)計(jì)日志格式的配置，以能夠在工具中完美展示。所有的日志配置文件放在src目錄下，編譯時(shí)隨同。class文件一同拷貝到(%webapp_HOME%)\
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1