java開發工具(5)你的代碼規範麼?快用阿里規約插件掃描下吧

在寫代碼的過程中,我們爲了業務需要快速迭代,快速開發,但是一個不規範的代碼會讓代碼的易讀性,可複用性,可維護性都大打折扣。一個公司如果想長久發展,而不是寫了一次業務便不再變更,規範代碼是非常重要的。
阿里前幾年出了一份編碼規約,裏面涵蓋了從數據庫,代碼編寫,模塊劃分等多個方面的規範。

一、編碼規約示例

下面就幾條規約示例展示如下:

【推薦】循環體中的語句要考量性能,以下操作儘量移至循環體外處理,如定義對象、變量、獲取數據庫連接,進行不必要的 try-catch 操作(這個 try-catch 是否可以移至循環體外)。
【強制】所有的抽象方法(包括接口中的方法)必須要用 Javadoc 註釋、除了返回值、參數、異常說明外,還必須指出該方法做什麼事情,實現什麼功能。
說明:對子類的實現要求,或者調用注意事項,請一併說明。
【強制】日誌文件至少保存 15 天,因爲有些異常具備以“周”爲頻次發生的特點。
【強制】核心業務、核心應用、核心模塊的增量代碼確保單元測試通過。
說明:新增代碼及時補充單元測試,如果新增代碼影響了原有單元測試,請及時修正。

強制表示必須要依照此規則去執行,推薦是建議你按照此規則執行。

這套編碼規約非常實用,一個有經驗的程序員也要對自己的編碼有一個規範,《阿里編碼規約》的內容還是非常多的,一次性記憶也不現實,就算你背下來,真正使用的時候也未必能遵守用上,樓主有一條經驗是,在有問題的時候經常翻閱,這樣也能加深記憶,畢竟偉大的領袖曾說過“實戰是檢驗真理的唯一標準”。

即使你常常翻閱,也難免遇到有時候寫的代碼違反了規約,這個時候如果有一個插件能時刻監測你的代碼提醒是是否規範,那就無後顧之憂了。而阿里也開發了一個代碼規約的插件

二、阿里代碼規約插件

安裝方式:在idea的插件庫中搜索安裝即可,截圖如下:
Idea插件庫
安裝完成後就會在你的Idea上方,出現這兩個標誌阿里規約插件標誌功能如下:

  • 綠色的按鈕:你可以通過此功能進行項目的代碼掃描,掃描哪些代碼不符合編碼規範,但說實話,我一般都是實時監測,主動掃描基本不用。
  • 藍色的圓圈:這個是實時掃描的按鈕,下面我舉例說明如何檢測代碼:
    代碼不符合規約
    標記1處,我的代碼不符合駝峯命名的規範,此時界面上會有兩個地方展示異常
  1. 類名下面會有一個波浪線,把鼠標懸停在波浪線處會告訴你代碼不符合駝峯命名規範。
  2. 界面最右面的標記2處,會出現一個細細的黃線,這個黃線出現說明你的代碼規範有一些問題,此時鼠標懸停在黃線處,也會展示代碼不符合駝峯命名規範。

這樣,有了代碼的實時監測功能,你代碼中的不規範的地方,就可以及時解決。如果你的代碼完全符合規範,在代碼界面的右上角就會有一個“✔️”出現,如下:
完美的代碼

三、敏捷開發,業務快速迭代,代碼規範是不是不重要?

  • 首先當然要說明,我們做任何的開發任務,業務永遠是第一位的,其他的任何編碼技巧,代碼規範都次之。
  • 其次,業務開發,快速迭代,時間來不及無法估計代碼規範,這短期內看是提升了效率,但是有一個問題,你開發的代碼,此後就一成不變了麼?我至今尚未見過,代碼開發完後就放在那裏,不需要後續的迭代或者維護的代碼。就算是自己維護自己寫的代碼,過了幾個月你也忘得差不多了。沒有統一的編碼規範,代碼寫的凌亂不堪,後期的維護怎麼做?當然你大可以大袖一甩,反正挖的坑是給後面的人的,但是在更上的層面,這是公司的時間與效率的損失。
  • 最後,規範代碼,codereview,應該是公司層面的事情,因爲不規範的代碼影響的並不是當前的編碼人員,而是後續補坑的人,應該在整個公司內部開展codeReview的工作,否則編碼規範則無法推行,造成的損失也是公司的。

總結

寫這一篇文章的目的是因爲,許多的程序員並不注重編碼規範,僅僅是將編碼規範當做是可有可無的東西,原因很簡單,利不關己,但是卻事關整個公司。
所以編碼規範的推行只能是從公司層面,技術總監支持,由上到下,降維打擊,纔可施行。
關於規約插件的安裝與使用,非常簡單,重要的是要理解爲什麼要這麼做。

重點:
我的java開發工具專欄上線了,我會每週持續更新,告訴你java開發工具中,你可能不知道的細節,有興趣的朋友可以關注我的專欄《java開發工具》,關注方式:點擊博文左側的分類專欄,點擊java開發工具,進入頁面點擊關注即可,當我有文章更新,會第一時間通知你。
Alt

發佈了183 篇原創文章 · 獲贊 64 · 訪問量 36萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章