Java代碼飛檢案例輸出

1、文檔名稱文檔密級(jí)1 類、方法和變量缺少注釋1.1 【問題描述】變量沒有注釋：方法沒有注釋：類沒有注釋： 文件名：ConfigNetworkService.java起始行：40上下文：public class ConfigNetworkService【問題解讀】 變量、方法缺少注釋，影響代碼走讀效率，對(duì)java類沒有做注釋說明，會(huì)導(dǎo)致使用該類的人不知道這個(gè)類的功能是什么【糾正措施】在變量、方法和類上面添加必要的注釋，方便后來維護(hù)者維護(hù)理解【舉一反三】平時(shí)開發(fā)是嚴(yán)格按照華為java編程規(guī)范編碼2 代碼注釋未與上方代碼空行隔開2.1 【問題描述】為了提高代碼的可讀性，跟層次感，注釋應(yīng)該跟上面的代碼空

2、一行緊貼下面代碼（以DGAlarmService.java為例）/* * 獲取油機(jī)的原始當(dāng)前告警列表 * * param dgInfo * return */ public List<OmsAlarm> getOrginalCurAlarms(DGInfo dgInfo) List<String> tempDns = dgInfo.getDgDnList(); List<OmsAlarm> currentAlarmList = getDGAlarmsBySiteDn(dgInfo.getSiteDN(); / 告警分2套，原來的告警可以取到subFdn,新的

3、告警取不到，只有Mocid和InsId if (currentAlarmList != null) return currentAlarmList; 在上面的代碼中紅色字體中的注釋沒有跟上面代碼中空一行或者跟下面代碼空一行，都不符合編碼規(guī)范?！締栴}解讀】為了提高代碼的可讀性（減少歧義）跟層次感，代碼規(guī)范要求注釋應(yīng)該跟上面的代碼空一行，緊貼下面代碼行?！炯m正措施】根據(jù)編碼規(guī)范，該場(chǎng)景的解決方法如下：/* * 獲取油機(jī)的原始當(dāng)前告警列表 * * param dgInfo * return */ public List<OmsAlarm> getOrginalCurAlarms(DGIn

4、fo dgInfo) List<String> tempDns = dgInfo.getDgDnList(); List<OmsAlarm> currentAlarmList = getDGAlarmsBySiteDn(dgInfo.getSiteDN(); / 告警分2套，原來的告警可以取到subFdn,新的告警取不到，只有Mocid和InsId if (null != currentAlarmList) return currentAlarmList; 【舉一反三】在編碼中為了之后的維護(hù)，我們要增強(qiáng)代碼的可讀性我們?cè)诰幋a的過程中應(yīng)適當(dāng)加一些注釋，提高代碼的層次感，以

5、方便維護(hù)人員能更好的維護(hù)。3 對(duì)象判斷是否為空，應(yīng)該把Null放在前面（常量和變量作比較未把常量放在前面）3.1 【問題描述】判斷一個(gè)對(duì)象是否為null時(shí)，應(yīng)該把null放在前面如if(null = XXX),null放后面不符合編碼規(guī)范（以DGAlarmService.java為例）/* * 獲取油機(jī)的原始當(dāng)前告警列表 * * param dgInfo * return */ public List<OmsAlarm> getOrginalCurAlarms(DGInfo dgInfo) List<String> tempDns = dgInfo.getDgDnLis

6、t(); List<OmsAlarm> currentAlarmList = getDGAlarmsBySiteDn(dgInfo.getSiteDN(); / 告警分2套，原來的告警可以取到subFdn,新的告警取不到，只有Mocid和InsId if (currentAlarmList != null) String subFdn = null; String mocId = null; String insId = null; for (Iterator<OmsAlarm> it = currentAlarmList.iterator(); it.hasNext(

7、);) Properties userData = it.next().getUserData(); subFdn = userData.getProperty(FmDataPropertyDefine.PROP_SUB_FDN); if (subFdn = null | subFdn.isEmpty() mocId = userData.getProperty(FmDataPropertyDefine.PROP_MOC_ID); insId = userData.getProperty(FmDataPropertyDefine.PROP_INS_ID); if (!tempDns.conta

8、ins(mocId + "_" + insId) it.remove(); else if (!tempDns.contains(subFdn) it.remove(); return currentAlarmList; 在上面的代碼中紅色字體中的空判斷雖然不會(huì)對(duì)系統(tǒng)跟邏輯產(chǎn)生影響但不符合編碼規(guī)范?！締栴}解讀】為了防止程序報(bào)空指針異常，對(duì)象為null的比較經(jīng)常會(huì)用到，按照編碼規(guī)范來可以養(yǎng)成良好的習(xí)慣，減少程序異常率?！炯m正措施】根據(jù)編碼規(guī)范，該場(chǎng)景的解決方法如下：/* * 獲取油機(jī)的原始當(dāng)前告警列表 * * param dgInfo * return */ public L

9、ist<OmsAlarm> getOrginalCurAlarms(DGInfo dgInfo) List<String> tempDns = dgInfo.getDgDnList(); List<OmsAlarm> currentAlarmList = getDGAlarmsBySiteDn(dgInfo.getSiteDN(); / 告警分2套，原來的告警可以取到subFdn,新的告警取不到，只有Mocid和InsId if (null != currentAlarmList) String subFdn = null; String mocId = n

10、ull; String insId = null; for (Iterator<OmsAlarm> it = currentAlarmList.iterator(); it.hasNext();) Properties userData = it.next().getUserData(); subFdn = userData.getProperty(FmDataPropertyDefine.PROP_SUB_FDN); if (null = subFdn | subFdn.isEmpty() mocId = userData.getProperty(FmDataPropertyDe

11、fine.PROP_MOC_ID); insId = userData.getProperty(FmDataPropertyDefine.PROP_INS_ID); if (!tempDns.contains(mocId + "_" + insId) it.remove(); else if (!tempDns.contains(subFdn) it.remove(); return currentAlarmList; 【舉一反三】在編碼中我們要防止null對(duì)象的引用，防止因拋空指針程序無法正常運(yùn)行，所以對(duì)Null的判斷要按照編碼規(guī)范來，比方對(duì)二個(gè)對(duì)象進(jìn)行equals比較，

12、就應(yīng)該把有可能為Null的放在equals里面，把不可能為null的放equals前面。對(duì)null進(jìn)行 = 比較時(shí)，把null放在前面在閱讀代碼時(shí)也能讓一眼就看出做了Null 判斷4 代碼包含很多 Tab 鍵4.1 【問題描述】【問題解讀】程序塊縮進(jìn)風(fēng)格不規(guī)范，采用的是 Tab 鍵縮進(jìn)方式，違反規(guī)則程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)的空格數(shù)為4個(gè)，不允許使用TAB縮進(jìn)【糾正措施】導(dǎo)入項(xiàng)目組通用的代碼格式模板樣式【舉一反三】導(dǎo)入項(xiàng)目組通用的代碼格式模板樣式5 重復(fù)代碼5.1 【問題描述】【問題解讀】 重復(fù)代碼，影響系統(tǒng)運(yùn)行效率【糾正措施】把重復(fù)代碼重構(gòu)為公共方法調(diào)用【舉一反三】 平時(shí)編碼嚴(yán)格按照華為

13、java編程規(guī)范編寫，重復(fù)代碼可以重構(gòu)公共方法6 “”未換行，出現(xiàn) 100 多次6.1 【問題描述】【問題解讀】 違法規(guī)則分界符（如大括號(hào)）【糾正措施】 應(yīng)各獨(dú)占一行【舉一反三】 平時(shí)編碼嚴(yán)格按照華為java編程規(guī)范編寫7 注釋有誤/方法命名不規(guī)范7.1 【問題描述】【問題解讀】 違反華為的Java編碼規(guī)范。錯(cuò)誤的注釋對(duì)不了解系統(tǒng)的員工產(chǎn)生誤導(dǎo)。降低工作交接、定位解決問題的效率?！炯m正措施】 在代碼調(diào)整后，應(yīng)該同步更新相關(guān)注釋?！九e一反三】 方法的注釋應(yīng)一句話介紹方法的功能及使用場(chǎng)景。還應(yīng)介紹輸入?yún)?shù)條件限制條件，出差參數(shù)的含義等。8 對(duì)象、字符串強(qiáng)轉(zhuǎn)之前沒有非空判斷8.1 【問題描述】對(duì)一個(gè)

14、對(duì)象、字符串進(jìn)行強(qiáng)制轉(zhuǎn)換時(shí)，必須要先做類型、非空判斷（包含空字符）。若未做校驗(yàn)，可能直接導(dǎo)致功能不可用。（QueryRemoteHAStatusTask.java） Override public int getTimeout() String stringtimeout=getConfigName("timeout"); if (null != stringtimeout) int timeout = Integer.valueOf(stringtimeout); LOGGER.info("timeout valure is: " + timeout)

15、; return timeout; else return 600000; 在上面的代碼中紅色字體中的方法有可能會(huì)返回空字符串，而黃色字體處未對(duì)空字符串添加判斷就進(jìn)行類型強(qiáng)制轉(zhuǎn)換，會(huì)報(bào)異常。【問題解讀】為了防止程序報(bào)類型轉(zhuǎn)換異常，在對(duì)對(duì)象、字符串進(jìn)行強(qiáng)制轉(zhuǎn)換時(shí)，添加必要的判斷是必須的，否則會(huì)導(dǎo)致功能失效。【糾正措施】此處正確的判斷應(yīng)該為（添加代碼中加粗代碼的判斷）： Override public int getTimeout() String stringtimeout=getConfigName("timeout"); if (null != stringtimeout

16、 && !"".equals(stringtimeout) int timeout = Integer.valueOf(stringtimeout); LOGGER.info("timeout valure is: " + timeout); return timeout; else return 600000; 【舉一反三】在編碼中經(jīng)常會(huì)用到強(qiáng)制轉(zhuǎn)換，如果必要的校驗(yàn)沒有處理的話，會(huì)導(dǎo)致異常，從而可能功能不可用的現(xiàn)象。如對(duì)象的強(qiáng)轉(zhuǎn)，那么我們?cè)趶?qiáng)轉(zhuǎn)之前必須添加：if (name instanceof type) 類似的判斷，若是字符串的強(qiáng)轉(zhuǎn)

17、，就必須添加：if (null != string && !"".equals(string)判斷。9 對(duì)校驗(yàn)的充分考慮能提高代碼的可讀性9.1 【問題描述】為了提高代碼的可讀性，不應(yīng)該添加沒必要的判斷以及必要的校驗(yàn)需要充分考慮添加或者去除：（RpcQueryHAStatus.java） public static String getConfigName(String configName) String path = getOSSPath() + File.separator + "engr" + File.separator + &

18、quot;engineering" + File.separator + "ha_review" + File.separator + "change_timeout.conf" File file = new File(path); FileInputStream fis = null; String configValues = "" try fis = new FileInputStream(file); catch (FileNotFoundException e) LOGGER.error("getCon

19、figName exception: " + e.getMessage(); InputStreamReader read = new InputStreamReader(fis); BufferedReader br = new BufferedReader(read); String line = "" StringBuffer sb = new StringBuffer(); try while (true) line = br.readLine(); if(null = line) break; if(line.indexOf(configName) !=

20、 -1) sb.append(line); catch (IOException e) LOGGER.error("getConfigName exception: " + e.getMessage(); if (null != sb.toString() String str = sb.toString().split("="); configValues = str1.trim(); LOGGER.info("getConfigName success: the key " + configName +" value i

21、s :" + configValues); else LOGGER.error("getConfigName error: the file: " + path +" doesn't have the key :" + configName); try if (null != br) br.close(); if (null != read) read.close(); if (null != fis) fis.close(); catch (IOException e) LOGGER.error("getConfigName

22、 exception: " + e.getMessage(); return configValues; 在上面的代碼中紅色字體中代碼StringBuffer 在聲明的時(shí)候已經(jīng)new了一個(gè)對(duì)象，后面的null判斷永遠(yuǎn)為true（null != sb.toString() ），且在判斷里對(duì)數(shù)組直接使用：configValues = str1.trim(),如果數(shù)組的大小不大于等于2的話會(huì)報(bào)數(shù)組越界。【問題解讀】為提高代碼的可讀性，非必要的判斷應(yīng)該去掉，以及對(duì)數(shù)組大小的校驗(yàn)需要添加?！炯m正措施】 public static String getConfigName(String conf

23、igName) String path = getOSSPath() + File.separator + "engr" + File.separator + "engineering" + File.separator + "ha_review" + File.separator + "change_timeout.conf" File file = new File(path); FileInputStream fis = null; String configValues = "" try

24、 fis = new FileInputStream(file); catch (FileNotFoundException e) LOGGER.error("getConfigName exception: " + e.getMessage(); InputStreamReader read = new InputStreamReader(fis); BufferedReader br = new BufferedReader(read); String line = "" StringBuffer sb = new StringBuffer(); t

25、ry while (true) line = br.readLine(); if(null = line) break; if(line.indexOf(configName) != -1) sb.append(line); catch (IOException e) LOGGER.error("getConfigName exception: " + e.getMessage(); String str = sb.toString().split("="); if (str.length >= 2) configValues = str1.tri

26、m(); LOGGER.info("getConfigName success: the key " + configName +" value is :" + configValues); else LOGGER.error("getConfigName error: the file: " + path +" doesn't have the key :" + configName); try if (null != br) br.close(); if (null != read) read.clos

27、e(); if (null != fis) fis.close(); catch (IOException e) LOGGER.error("getConfigName exception: " + e.getMessage(); return configValues; 【舉一反三】在編碼中對(duì)于非必要的校驗(yàn)以及必要的校驗(yàn)需要充分考慮到，只有充分考慮了這些情況，寫出來的代碼的可讀性才可能直觀，后續(xù)維護(hù)也更容易。10 校驗(yàn)的順序以及變量的抽取能有效的提高性能10.1 【問題描述】校驗(yàn)的順序能夠有效的提高性能以及內(nèi)存的使用，局部變量的抽取能有效的提高效率。（ParseResul

28、tXmlTask.java）private static void parseDesc(final String lang, final Element desc, final ErrorInfo errorInfo, final List<CheckItem> checkItemList) throws DataConversionException final String type = desc.getAttributeValue("type"); if (null= lang | HAStatusUtil.isEmpty(type) return; fi

29、nal CheckItem checkItem = new CheckItem(); checkItem.setCheckSubItemList(new ArrayList<CheckSubItem>(); checkItem.setItemType(type); final List<Element> scriptList = desc.getChildren("SCRIPT"); if (HAStatusUtil.isEmpty(scriptList) return; for (final Element script : scriptList)

30、 final int id = script.getChild("ID").getAttribute("name").getIntValue(); final int result = script.getChild("RESULT").getAttribute("name").getIntValue(); final String enName = script.getChild("check_item_en").getAttribute("name").getValue(

31、); final String cnName = script.getChild("check_item_cn").getAttribute("name").getValue(); final String alarmLevel = script.getChild("alarm_level").getAttribute("name").getValue(); final String enDesc = script.getChild("desc_en").getAttribute("n

32、ame").getValue(); final String cnDesc = script.getChild("desc_cn").getAttribute("name").getValue(); final CheckSubItem checkSubItem = new CheckSubItem(); checkSubItem.setSubItemID(id); checkSubItem.setSubItemType("zh_CN".equals(lang) ? cnName : enName); checkSubIte

33、m.setAlarmLevel(HAStatusUtil.getAlarmLevel(alarmLevel); checkSubItem.getErrorInfo().setErrorCode(result); checkSubItem.getErrorInfo().setErrorMsg("zh_CN".equals(lang) ? cnDesc : enDesc); if (HAStatusConstant.ErrorCode.NOT_SUPPORT = result) continue; / 設(shè)置檢查大項(xiàng)的值 if (HAStatusConstant.SUCCESS

34、!= result) checkItem.getErrorInfo().setErrorCode(result); if (HAStatusUtil.getAlarmLevel(alarmLevel) > checkItem.getAlarmLevel() checkItem.setAlarmLevel(HAStatusUtil.getAlarmLevel(alarmLevel); checkItem.getCheckSubItemList().add(checkSubItem); if (!HAStatusUtil.isEmpty(checkItem.getCheckSubItemLi

35、st() checkItemList.add(checkItem); 在上面的代碼中標(biāo)紅的判斷位置不對(duì)，可能會(huì)導(dǎo)致內(nèi)存消耗過大；標(biāo)紅加粗代碼，數(shù)據(jù)量大的時(shí)候可能會(huì)導(dǎo)致效率低，性能存在問題?！締栴}解讀】在編碼過程中，所需的校驗(yàn)應(yīng)該在方法(循環(huán))的入口，這樣可以避免不必要的內(nèi)存開銷，而局部變量的抽取，多次使用的值，抽取成局部變量，對(duì)性能是有很大的提高的，不需要每次使用都需要去取值?！炯m正措施】校驗(yàn)放在方法（循環(huán)）入口，多次使用的值，抽取成局部變量： SuppressWarnings("unchecked") private static void parseDesc(final

36、 String lang, final Element desc, final ErrorInfo errorInfo, final List<CheckItem> checkItemList) throws DataConversionException final String type = desc.getAttributeValue("type"); if (null= lang | HAStatusUtil.isEmpty(type) return; final CheckItem checkItem = new CheckItem(); checkI

37、tem.setCheckSubItemList(new ArrayList<CheckSubItem>(); checkItem.setItemType(type); final List<Element> scriptList = desc.getChildren("SCRIPT"); if (HAStatusUtil.isEmpty(scriptList) return; int tempAlarmLevel = 0; for (final Element script : scriptList) final int result = scrip

38、t.getChild("RESULT").getAttribute("name").getIntValue(); if (HAStatusConstant.ErrorCode.NOT_SUPPORT = result) continue; final int id = script.getChild("ID").getAttribute("name").getIntValue(); final String enName = script.getChild("check_item_en").ge

39、tAttribute("name").getValue(); final String cnName = script.getChild("check_item_cn").getAttribute("name").getValue(); final String alarmLevel = script.getChild("alarm_level").getAttribute("name").getValue(); final String enDesc = script.getChild(&qu

40、ot;desc_en").getAttribute("name").getValue(); final String cnDesc = script.getChild("desc_cn").getAttribute("name").getValue(); final CheckSubItem checkSubItem = new CheckSubItem(); checkSubItem.setSubItemID(id); checkSubItem.setSubItemType("zh_CN".equals

41、(lang) ? cnName : enName); tempAlarmLevel = HAStatusUtil.getAlarmLevel(alarmLevel); checkSubItem.setAlarmLevel(tempAlarmLevel); checkSubItem.getErrorInfo().setErrorCode(result); checkSubItem.getErrorInfo().setErrorMsg("zh_CN".equals(lang) ? cnDesc : enDesc); / 設(shè)置檢查大項(xiàng)的值 if (HAStatusConstant

42、.SUCCESS != result) checkItem.getErrorInfo().setErrorCode(result); if (tempAlarmLevel > checkItem.getAlarmLevel() checkItem.setAlarmLevel(tempAlarmLevel); checkItem.getCheckSubItemList().add(checkSubItem); if (!HAStatusUtil.isEmpty(checkItem.getCheckSubItemList() checkItemList.add(checkItem); 【舉一

43、反三】在編碼中對(duì)于校驗(yàn)的位置，我們是盡可能的減少開銷，提高效率，校驗(yàn)一般都放在入口，而校驗(yàn)順序一般是：權(quán)限校驗(yàn) -參數(shù)合法性校驗(yàn) - 需求特定的條件性校驗(yàn)。11 固定值字符串需要定義成靜態(tài)常量11.1 【問題描述】為了提高代碼的可讀性，一些特殊的固定值的字符串要定義成靜態(tài)常量，并且準(zhǔn)確命名常量，方便維護(hù)的時(shí)候理解和閱讀。（以BatchUpgradeNeByModbusExecutor.java為例）if ("WHOLE_VERSION".equals(neVersionPackage.getReleaseType() / 標(biāo)識(shí)升級(jí)包 releaseType = "

44、0xE0"else / 標(biāo)識(shí)補(bǔ)丁包 releaseType = "0xE1"在上面的代碼中紅色字體中的字符串應(yīng)該用靜態(tài)常量表示【問題解讀】為了提高代碼的可閱讀性，以及方便后面的代碼維護(hù)修改，應(yīng)該將固定值的字符串定義成靜態(tài)常量?！炯m正措施】根據(jù)編碼規(guī)范，該場(chǎng)景的解決方法如下：public static final String RELEANSE_TYPE_WHOLE_VERSION = "WHOLE_VERSION"public static final String RELEANSE_TYPE_UPGRADE_CODE = "0xE0"public static final String RELEANSE_TYPE_PATCH_CODE = "0xE1"if(RELEANSE_TYPE_WHOLE_VERSION.equals(neVersionPackage.getReleaseType() / 標(biāo)識(shí)升級(jí)包 releaseType = RELEANSE_TYPE_UPGRADE_CODE;else / 標(biāo)識(shí)補(bǔ)丁包 releaseType = RELEANSE_TYPE_PATCH_CODE;【舉一反三】在編碼中為了之后的維護(hù)，我們要增強(qiáng)代碼的可讀性我們?cè)诰幋a的過程中應(yīng)適當(dāng)加