1. 【強制】應用中不可直接使用日志系統(Log4j、Logback)中的API,而應依賴使用日志框架
SLF4J中的API,使用門面模式的日志框架,有利于維護和各個類的日志處理方式統一。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class);
1. 【強制】日志文件推薦至少保存15天,因為有些異常具備以“周”為頻次發生的特點。
2. 【強制】應用中的擴展日志(如打點、臨時監控、訪問日志等)命名方式:
appName\_logType\_logName.log。logType:日志類型,推薦分類有
stats/desc/monitor/visit等;logName:日志描述。這種命名的好處:通過文件名就可知道日志文件屬于什么應用,什么類型,什么目的,也有利于歸類查找。正例:mppserver應用中單獨監控時區轉換異常,如:
mppserver\_monitor\_timeZoneConvert.log
說明:推薦對日志進行分類,如將錯誤日志和業務日志分開存放,便于開發人員查看,也便于通過日志對系統進行及時監控。
1. 【強制】對trace/debug/info級別的日志輸出,必須使用條件輸出形式或者使用占位符的方式。
說明:logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
如果日志級別是warn,上述日志不會打印,但是會執行字符串拼接操作,如果symbol是對象,會執行toString()方法,浪費了系統資源,執行了上述操作,最終日志卻沒有打印。
#### 正例:(條件)
if (logger.isDebugEnabled()) { logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
}
#### 正例:(占位符)
logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);
1. 【強制】避免重復打印日志,浪費磁盤空間,務必在log4j.xml中設置additivity=false。
正例:<logger name="com.taobao.dubbo.config" additivity="false">
1. 【強制】異常信息應該包括兩類信息:案發現場信息和異常堆棧信息。如果不處理,那么通過關鍵字throws往上拋出。
正例:logger.error(各類參數或者對象toString + "\_" + e.getMessage(), e);
1. 【推薦】謹慎地記錄日志。生產環境禁止輸出debug日志;有選擇地輸出info日志;如果使用warn來記錄剛上線時的業務行為信息,一定要注意日志輸出量的問題,避免把服務器磁盤撐爆,并記得及時刪除這些觀察日志。
說明:大量地輸出無效日志,不利于系統性能提升,也不利于快速定位錯誤點。記錄日志時請思考:這些日志真的有人看嗎?看到這條日志你能做什么?能不能給問題排查帶來好處?
1. 【參考】可以使用warn日志級別來記錄用戶輸入參數錯誤的情況,避免用戶投訴時,無所適從。注意日志輸出的級別,error級別只記錄系統邏輯出錯、異常等重要的錯誤信息。如非必要,請不要在此場景打出error級別。
- 一、編程規約????1
- (一) 命名風格????1
- (二) 常量定義????3
- (三) 代碼格式????4
- (四) OOP規約????6
- (五) 集合處理????9
- (六) 并發處理????12
- (七) 控制語句????14
- (八) 注釋規約????16
- (九) 其它????17
- 二、異常日志????18
- (一) 異常處理????18
- (二) 日志規約????19
- 三、單元測試????21
- 四、安全規約????23
- 五、MySQL數據庫????24
- (一) 建表規約????24
- (二) 索引規約????25
- (三) SQL語句????27
- (四) ORM映射????28
- 六、工程結構????30
- (一) 應用分層????30
- (二) 二方庫依賴????31
- (三) 服務器????32
- 附1:版本歷史????34
- 附2:本手冊專有名詞????35