Java開發手冊(三):代碼風格與日志

一、代碼風格

代碼風格實際上就是合理使用縮進、空格、換行,目的是讓代碼可讀性更強。大家記憶時記清楚用什么樣的縮進,哪些時候使用空格,哪些時候使用換行,單行代碼不要太長就可以,這部分內容通過兩三次的回顧很容易養成習慣,因為是編碼中最長用到的。
可參考以下代碼:

public static void main(String[] args) {
    // 縮進 4 個空格
    String say = "hello";
    // 運算符的左右必須有一個空格 
    int flag = 0;
    // 關鍵詞if/for/while/switch/do與括號之間必須有一個空格,括號內的 flag 與左括號,0 與右括號不需要空格 
    if (flag == 0) {
       System.out.println(say);
    }
    
    // 左大括號前加空格且不換行;左大括號后換行 
    if (flag == 1) {
       System.out.println("world");
    // 右大括號前換行,右大括號后有 else,不用換行 
    } else {
       System.out.println("ok");
    // 在右大括號后直接結束,則必須換行
    }
    
    StringBuffer sb = new StringBuffer();  
    // 超過120個字符的情況下,換行縮進4個空格,點號和方法名稱一起換行   
    sb.append("zi").append("xin")...  
    .append("huang")...  
    .append("huang")...  
    .append("huang");
   
   // 任何二目、三目運算符的左右兩邊都需要加一個空格
   int result = flag == 0 ? 1 : 0;
}

下邊是另外幾點需要注意的:

  1. 注釋的雙斜線與注釋內容之間有且僅有一個空格。
  2. 方法參數在定義和傳入時,多個參數逗號后邊必須加空格,如method("a", "b")。
  3. 沒有必要增加若干空格來使某一行的字符與上一行對應位置的字符對齊。
  4. 方法體內的執行語句組、變量的定義語句組、不同的業務邏輯之間或者不同的語義 之間插入一個空行。相同業務邏輯和語義之間不需要插入空行。沒有必要插入多個空行進行隔開。

二、日志

1.日志配置

主要有日志文件名稱、日志輸出級別、日志是否向上層傳遞、日志保留時間。

  1. 日志文件推薦至少保存15天,因為有些異常具備以“周”為頻次發生的特點。
  2. 避免重復打印日志,浪費磁盤空間,務必在 log4j.xml 中設置 additivity=false
  3. 謹慎地記錄日志。生產環境禁止輸出 debug 日志;有選擇地輸出 info 日志;如果使 用 warn 來記錄剛上線時的業務行為信息,一定要注意日志輸出量的問題,避免把服務器磁盤 撐爆,并記得及時刪除這些觀察日志。
  4. 應用中的擴展日志(如打點、臨時監控、訪問日志等)命名方式:appName_logType_logName.log。logType:日志類型,推薦分類有stats/desc/monitor/visit 等;logName:日志描述。這種命名的好處:通過文件名就可知 道日志文件屬于什么應用,什么類型,什么目的,也有利于歸類查找。
2.日志使用
  1. 應用中不可直接使用日志系統(Log4j、Logback)中的 API,而應依賴使用日志框架SLF4J 中的 API,使用門面模式的日志框架,有利于維護和各個類的日志處理方式統一。
  2. 對 trace/debug/info 級別的日志輸出,必須使用條件輸出形式或者使用占位符的方式。
  3. 異常信息應該包括兩類信息:案發現場信息和異常堆棧信息。如果不處理,那么通過 關鍵字 throws 往上拋出。推薦logger.error(各類參數或者對象toString + "_" + e.getMessage(), e);這種格式,不要簡單的輸出e.getMessage(),那樣具體的錯誤信息都被隱藏,很不利于排查問題。
  4. 注意日志輸出級別和使用場景,避免大量調試日志被生成,最近就遇到過一次在高頻接口輸出調試信息,忘記清理,在調用高峰拖死了tomcat;在生成環境,盡量只記錄異常信息和較重要的業務信息,且控制其量。
  5. while、for循環等內部的異常需要特別注意發生異常的條件,曾經遇到過while循環從redis隊列內取值(事件),redis服務宕機,結果異常日志刷爆磁盤的情況。
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,030評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,310評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,951評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,796評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,566評論 6 407
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,055評論 1 322
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,142評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,303評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,799評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,683評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,899評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,409評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,135評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,520評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,757評論 1 282
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,528評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,844評論 2 372

推薦閱讀更多精彩內容

  • 在應用程序中添加日志記錄總的來說基于三個目的:監視代碼中變量的變化情況,周期性的記錄到文件中供其他應用進行統計分析...
    時待吾閱讀 5,067評論 1 13
  • 在應用程序中添加日志記錄總的來說基于三個目的:監視代碼中變量的變化情況,周期性的記錄到文件中供其他應用進行統計分析...
    時待吾閱讀 5,005評論 0 6
  • 來源與:阿里云棲 禁止用于商業用途 ps:如果需要電子書 評論你們郵箱 我會發給你們 下面感覺還是有點亂 目錄 一...
    小向資源網閱讀 7,614評論 0 12
  • 又一次閱讀阿里編程規范,發現有不少條目又給忘了,離上次閱讀大概一個多月。我的閱讀習慣應該還不錯,每次看書籍之類的不...
    思與學閱讀 3,999評論 5 3
  • 最近,陳冠希在臉書上po了一張照片,網友們又瞬間炸裂了。 天吶,當年那個一臉壞笑的小鮮肉,現在臉上已然爬上了魚尾紋...
    腔調電影閱讀 111,686評論 69 182