本篇內(nèi)容主要講解“怎么在Java代碼里正確的打日志”，感興趣的朋友不妨來(lái)看看。本文介紹的方法操作簡(jiǎn)單快捷，實(shí)用性強(qiáng)。下面就讓小編來(lái)帶大家學(xué)習(xí)“怎么在Java代碼里正確的打日志”吧!

讓客戶(hù)滿(mǎn)意是我們工作的目標(biāo)，不斷超越客戶(hù)的期望值來(lái)自于我們對(duì)這個(gè)行業(yè)的熱愛(ài)。我們立志把好的技術(shù)通過(guò)有效、簡(jiǎn)單的方式提供給客戶(hù)，將通過(guò)不懈努力成為客戶(hù)在信息化領(lǐng)域值得信任、有價(jià)值的長(zhǎng)期合作伙伴，公司提供的服務(wù)項(xiàng)目有：域名申請(qǐng)、虛擬空間、營(yíng)銷(xiāo)軟件、網(wǎng)站建設(shè)、綿竹網(wǎng)站維護(hù)、網(wǎng)站推廣。

打日志的正確方式

什么時(shí)候應(yīng)該打日志

1. 當(dāng)你遇到問(wèn)題的時(shí)候，只能通過(guò)debug功能來(lái)確定問(wèn)題，你應(yīng)該考慮打日志，良好的系統(tǒng)，是可以通過(guò)日志進(jìn)行問(wèn)題定為的。

2. 當(dāng)你碰到if…else 或者 switch這樣的分支時(shí)，要在分支的首行打印日志，用來(lái)確定進(jìn)入了哪個(gè)分支

3. 經(jīng)常以功能為核心進(jìn)行開(kāi)發(fā)，你應(yīng)該在提交代碼前，可以確定通過(guò)日志可以看到整個(gè)流程

基本格式

必須使用參數(shù)化信息的方式:

logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);

對(duì)于debug日志，必須判斷是否為debug級(jí)別后，才進(jìn)行使用:

if (logger.isDebugEnabled()) {     logger.debug("Processing trade with id: " +id + " symbol: " + symbol); }

不要進(jìn)行字符串拼接,那樣會(huì)產(chǎn)生很多String對(duì)象，占用空間，影響性能。

反例(不要這么做):

logger.debug("Processing trade with id: " + id + " symbol: " + symbol);

使用[]進(jìn)行參數(shù)變量隔離

如有參數(shù)變量，應(yīng)該寫(xiě)成如下寫(xiě)法:

logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);

這樣的格式寫(xiě)法，可讀性更好，對(duì)于排查問(wèn)題更有幫助。

不同級(jí)別的使用

ERROR:

基本概念

影響到程序正常運(yùn)行、當(dāng)前請(qǐng)求正常運(yùn)行的異常情況:

1. 打開(kāi)配置文件失敗

2. 所有第三方對(duì)接的異常(包括第三方返回錯(cuò)誤碼)

3. 所有影響功能使用的異常，包括:SQLException和除了業(yè)務(wù)異常之外的所有異常(RuntimeException和Exception)

不應(yīng)該出現(xiàn)的情況:

比如要使用Azure傳圖片，但是Azure未響應(yīng)

如果有Throwable信息，需要記錄完成的堆棧信息:

log.error("獲取用戶(hù)[{}]的用戶(hù)信息時(shí)出錯(cuò)",userName,e);

說(shuō)明

如果進(jìn)行了拋出異常操作，請(qǐng)不要記錄error日志，由最終處理方進(jìn)行處理：

反例(不要這么做):

try{     .... }catch(Exception ex){   String errorMessage=String.format("Error while reading information of user [%s]",userName);   logger.error(errorMessage,ex);   throw new UserServiceException(errorMessage,ex); }

WARN

基本概念

不應(yīng)該出現(xiàn)但是不影響程序、當(dāng)前請(qǐng)求正常運(yùn)行的異常情況:

1. 有容錯(cuò)機(jī)制的時(shí)候出現(xiàn)的錯(cuò)誤情況

2. 找不到配置文件，但是系統(tǒng)能自動(dòng)創(chuàng)建配置文件

即將接近臨界值的時(shí)候，例如：

緩存池占用達(dá)到警告線

業(yè)務(wù)異常的記錄,比如:

當(dāng)接口拋出業(yè)務(wù)異常時(shí)，應(yīng)該記錄此異常

INFO:

基本概念

系統(tǒng)運(yùn)行信息

1. Service方法中對(duì)于系統(tǒng)/業(yè)務(wù)狀態(tài)的變更

2. 主要邏輯中的分步驟

外部接口部分

1. 客戶(hù)端請(qǐng)求參數(shù)(REST/WS)

2. 調(diào)用第三方時(shí)的調(diào)用參數(shù)和調(diào)用結(jié)果

說(shuō)明

     1.并不是所有的service都進(jìn)行出入口打點(diǎn)記錄,單一、簡(jiǎn)單service是沒(méi)有意義的(job除外,job需要記錄開(kāi)始和結(jié)束,)。

      反例(不要這么做):

public List listByBaseType(Integer baseTypeId) {      log.info("開(kāi)始查詢(xún)基地"); BaseExample ex=new BaseExample(); BaseExample.Criteria ctr = ex.createCriteria(); ctr.andIsDeleteEqualTo(IsDelete.USE.getValue()); Optionals.doIfPresent(baseTypeId, ctr::andBaseTypeIdEqualTo);    log.info("查詢(xún)基地結(jié)束"); return baseRepository.selectByExample(ex);   }

       2.對(duì)于復(fù)雜的業(yè)務(wù)邏輯，需要進(jìn)行日志打點(diǎn)，以及埋點(diǎn)記錄，比如電商系統(tǒng)中的下訂單邏輯，以及OrderAction操作(業(yè)務(wù)狀態(tài)變更)。

       3.對(duì)于整個(gè)系統(tǒng)的提供出的接口(REST/WS)，使用info記錄入?yún)?/p>

       4.如果所有的service為SOA架構(gòu)，那么可以看成是一個(gè)外部接口提供方，那么必須記錄入?yún)ⅰ?/p>

       5.調(diào)用其他第三方服務(wù)時(shí)，所有的出參和入?yún)⑹潜仨氁涗浀?因?yàn)槟愫茈y追溯第三方模塊發(fā)生的問(wèn)題)

DEBUG

基本概念

1. 可以填寫(xiě)所有的想知道的相關(guān)信息(但不代表可以隨便寫(xiě)，debug信息要有意義,***有相關(guān)參數(shù))

2. 生產(chǎn)環(huán)境需要關(guān)閉DEBUG信息

3. 如果在生產(chǎn)情況下需要開(kāi)啟DEBUG,需要使用開(kāi)關(guān)進(jìn)行管理，不能一直開(kāi)啟。

說(shuō)明

如果代碼中出現(xiàn)以下代碼，可以進(jìn)行優(yōu)化:

//1. 獲取用戶(hù)基本薪資  //2. 獲取用戶(hù)休假情況  //3. 計(jì)算用戶(hù)應(yīng)得薪資

優(yōu)化后的代碼:

logger.debug("開(kāi)始獲取員工[{}] [{}]年基本薪資",employee,year); logger.debug("獲取員工[{}] [{}]年的基本薪資為[{}]",employee,year,basicSalary); logger.debug("開(kāi)始獲取員工[{}] [{}]年[{}]月休假情況",employee,year,month);  logger.debug("員工[{}][{}]年[{}]月年假/病假/事假為[{}]/[{}]/[{}]",employee,year,month,annualLeaveDays,sickLeaveDays,noPayLeaveDays); logger.debug("開(kāi)始計(jì)算員工[{}][{}]年[{}]月應(yīng)得薪資",employee,year,month);  logger.debug("員工[{}] [{}]年[{}]月應(yīng)得薪資為[{}]",employee,year,month,actualSalary);

TRACE

基本概念

特別詳細(xì)的系統(tǒng)運(yùn)行完成信息，業(yè)務(wù)代碼中，不要使用.(除非有特殊用意，否則請(qǐng)使用DEBUG級(jí)別替代)

規(guī)范示例說(shuō)明

@Override @Transactional public void createUserAndBindMobile(@NotBlank String mobile, @NotNull User user) throws CreateConflictException{     boolean debug = log.isDebugEnabled();     if(debug){         log.debug("開(kāi)始創(chuàng)建用戶(hù)并綁定手機(jī)號(hào). args[mobile=[{}],user=[{}]]", mobile, LogObjects.toString(user));     }     try {         user.setCreateTime(new Date());         user.setUpdateTime(new Date());         userRepository.insertSelective(user);         if(debug){             log.debug("創(chuàng)建用戶(hù)信息成功. insertedUser=[{}]",LogObjects.toString(user));         }         UserMobileRelationship relationship = new UserMobileRelationship();         relationship.setMobile(mobile);         relationship.setOpenId(user.getOpenId());         relationship.setCreateTime(new Date());         relationship.setUpdateTime(new Date());         userMobileRelationshipRepository.insertOnDuplicateKey(relationship);         if(debug){             log.debug("綁定手機(jī)成功. relationship=[{}]",LogObjects.toString(relationship));         }         log.info("創(chuàng)建用戶(hù)并綁定手機(jī)號(hào). userId=[{}],openId=[{}],mobile=[{}]",user.getId(),user.getOpenId(),mobile); // 如果考慮安全，手機(jī)號(hào)記得脫敏     }catch(DuplicateKeyException e){         log.info("創(chuàng)建用戶(hù)并綁定手機(jī)號(hào)失敗,已存在相同的用戶(hù). openId=[{}],mobile=[{}]",user.getOpenId(),mobile);         throw new CreateConflictException("創(chuàng)建用戶(hù)發(fā)生沖突, openid=[%s]",user.getOpenId());     } }

到此，相信大家對(duì)“怎么在Java代碼里正確的打日志”有了更深的了解，不妨來(lái)實(shí)際操作一番吧！這里是創(chuàng)新互聯(lián)網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢(xún)，關(guān)注我們，繼續(xù)學(xué)習(xí)！

當(dāng)前標(biāo)題：怎么在Java代碼里正確的打日志
瀏覽路徑：http://aaarwkj.com/article36/jegdpg.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供品牌網(wǎng)站制作、建站公司、品牌網(wǎng)站設(shè)計(jì)、網(wǎng)站排名、、網(wǎng)站設(shè)計(jì)公司

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶(hù)投稿、用戶(hù)轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話(huà)：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源： 創(chuàng)新互聯(lián)