1. 程式人生 > >阿里java開發規約的Idea外掛安裝(中文)

阿里java開發規約的Idea外掛安裝(中文)

首先非常感謝大家對外掛的支援與意見,英文版的文件還是略為簡單,這裡詳細介紹一下外掛的安裝使用。

外掛安裝

通過Jetbrains官方倉庫安裝

  1. 開啟 Settings >> Plugins >> Browse repositories...

  1. 在搜尋框輸入alibaba即可看到Alibaba Java Code Guidelines外掛,點選Install進行安裝,然後重啟IDE生效 注意:因為外掛zip包託管在Jetbrains官方CDN上,所以是從國外的伺服器進行下載,可能會出現超時的情況

通過下載安裝包進行安裝

  1. 開啟外掛頁面

download

  1. Settings >> Plugins >> Install plugin from disk...,選擇剛剛下載的zip包安裝,然後重啟IDE

注意

最低支援IDEA版本為14.1(buildNumber 141.0,可以在About Intellij IDEA中檢視版本資訊),使用IDEA14的同學最好升級到14.1.7(歷史版本傳送門)

外掛基於JDK1.7打包,所以IDEA啟動時使用的JDK版本如果是1.6的話就會報Unsupported major.minor version 51.0異常,建議大家都升級一下。

中文亂碼解決方法

  1. 修改字型——Appearance&Behavior -> Appearance -> UI Options -> Name 裡面設定成中文字型——如微軟雅黑(microsoft yahei light)、文泉驛(linux)

  2. Switch Language to English and restart.

外掛使用

目前外掛實現了開發手冊中的的53條規則,大部分基於PMD實現,其中有4條規則基於IDEA實現,並且基於IDEA Inspection實現了實時檢測功能。部分規則實現了Quick Fix功能,對於可以提供Quick Fix但沒有提供的,我們會盡快實現,也歡迎有興趣的同學加入進來一起努力。 目前外掛檢測有兩種模式:實時檢測、手動觸發。

實時檢測

實時檢測功能會在開發過程中對當前檔案進行檢測,並以高亮的形式提示出來,同時也可以支援Quick Fix,該功能預設開啟,可以通過配置關閉。

結果高亮提示

檢測結果高亮提示,並且滑鼠放上去會彈出提示資訊。

Intention QuickFix功能

Alt+Enter鍵可撥出Intention選單,不同的規則會提示不同資訊的Quick Fix按鈕

關閉實時檢測

在某些情況下,我們不希望對程式碼提示違規資訊,比如我們在閱讀Github開源專案程式碼的時候,如果介面出現一堆紅色、黃色的提示,此時心裡肯定是飄過一萬隻草泥馬。這個時候我們可以通過Inspection的設定關閉實時檢測功能。

  1. 通過右鍵快速關閉(開啟)所有規則的實時檢測功能

 2. 通過Settings >> Editor >> Inspections 進行手動設定

也可以關閉某條規則的實時檢測功能或者修改提示級別。

程式碼掃描

可以通過右鍵選單、Toolbar按鈕、快捷鍵三種方式手動觸發程式碼檢測。同時結果面板中可以對部分實現了QuickFix功能的規則進行快速修復。

觸發掃描

在當前編輯的檔案中點選右鍵,可以在彈出的選單中觸發對該檔案的檢測。

在左側的Project目錄樹種點選右鍵,可以觸發對整個工程或者選擇的某個目錄、檔案進行檢測。

如果您打開了IDE的Toolbar,也可以通過Toolbar中的按鈕來觸發檢測,目前Toolbar的按鈕觸發的檢測範圍與您IDE當時的焦點有關,如當前編輯的檔案或者是Project目錄樹選中的項,是不是感覺與右鍵選單的檢測範圍類似呢。

使用快捷鍵(Ctrl+Shift+Alt+J)觸發彈出視窗,選擇檢測範圍;您也可自定義快捷鍵。

掃描結果

檢測結果直接使用IDEA Run Inspection By Name功能的結果介面,外掛的檢測結果分級為Blocker、Critical、Major。預設按等級分組,方便統計每個級別錯誤的數量。

預設情況我們在結果面板需要雙擊具體違規項才能開啟對應的原始檔,開啟Autoscroll To Source選項,單擊面板中的檔名、或者是具體的違規項的時候IDEA會自動開啟對應的原始檔。

QuickFix

對於實現Quick Fix的規則,在結果面板中可以直接一鍵修復 注意:IDEA14、15可以通過左下角的燈泡進行一鍵修復操作。

其他

面板中其他按鈕的功能大家自行探索吧,就不一一贅述了

程式碼提交時檢測

  1. 在提交程式碼框勾選Alibaba Code Guidelines選項 
  2. 如果有違反手冊的地方會提示是否繼續提交,選擇取消後會自動對修改的程式碼進行掃描 

    相關推薦

    阿里java開發規約Idea外掛安裝中文

    首先非常感謝大家對外掛的支援與意見,英文版的文件還是略為簡單,這裡詳細介紹一下外掛的安裝使用。 外掛安裝 通過J

    阿里巴巴Java開發規約IDEA外掛安裝及使用

    技術交流群:233513714 一、通過Jetbrains官方倉庫安裝 1. 開啟 Settings >> Plugins >> Browse repositories... 2. 在搜尋框輸入alibaba即可看到Alibaba Java C

    阿里java開發規約Idea外掛安裝英文

    Idea Plugin Prepare Project JDK: 1.7+ Gradle: 3.0+(Req

    阿里巴巴Java開發規約掃描外掛-Alibaba Java Coding Guidelines 在idea安裝使用教程

    經過247天的持續研發,阿里巴巴於10月14日在杭州雲棲大會上,正式釋出眾所期待的《阿里巴巴Java開發規約》掃描外掛!該外掛由阿里巴巴P3C專案組研發。P3C是世界知名的反潛機,專門對付水下潛水艇,寓意是掃描出所有潛在的程式碼隱患。這個專案組是阿里巴巴開發愛好者自發組織

    阿裏巴巴Java開發規約IDEA插件安裝及使用

    需要 其中 輸入 ctp gin 燈泡 代碼提示 發的 ide 技術交流群:233513714 一、通過Jetbrains官方倉庫安裝 1. 打開 Settings >> Plugins >> Browse repositories.

    阿里巴巴Java開發手冊》外掛安裝及使用

    Idea安裝 IDEA版的外掛已釋出到IDEA官方倉庫中(最低支援版本14.1.7,JDK1.7+),只需開啟 Settings >> Plugins >> Browse repositories 輸入 Alibaba 搜尋一下便可以看

    阿里巴巴Java開發規約外掛全球首發!

    經過247天的持續研發,阿里巴巴於10月14日在杭州雲棲大會上,正式釋出眾所期待的《阿里巴巴Java開發規約》掃描外掛! 外掛全球首發儀式,大牛雲集 阿里巴巴大牛天團傾力助陣:畢玄、玄難、索尼、葉渡,淘寶程式碼第一人多隆、程式碼規約作者孤盡攜手規約專案組成員,以及業界規約生態代表等重

    阿里Java開發規範IDEA開發外掛

    期待已久的阿里Java開發規範外掛,終於在2017-10-14日釋出了,這個規範外掛真的Java開發人員必備的工具,值得點贊! 1、下載安裝外掛 Settings >> Plugins >> Browse repositories…

    阿里巴巴程式碼規約 eclipse外掛安裝

    1.開啟Eclipse,點選選單 Help >> Install New Software(Myeclipse中選擇:Install from Site) 2.點選Add,在Locati

    阿里巴巴開發手冊解析個人筆記Mysql規約

    文章目錄 1.建立資料庫 2. 建立表 2.1 建立名稱 2.2 建立索引 3.建立欄位 3.1 建立名稱 3.2 建立型別 4.sql的執行流程

    java開發之eclipse外掛安裝與配置(完)

    Tomcat外掛的安裝與配置          TomcatPlugin外掛下載網址http://www.eclipsetotale.com/tomcatPlugin.html,下載一個壓縮包tomcatPluginV321.zip解壓到eclipse根目錄下的plugins子目錄下,這樣,安裝完成。重新啟

    Java開發手冊之異常日誌】日誌規約

    【強制】應用中不可直接使用日誌系統 (Log 4 j 、 Logback) 中的 API ,而應依賴使用日誌框架SLF 4 J 中的 API ,使用門面模式的日誌框架,有利於維護和各個類的日誌處理方式統一。 import org.slf4j.Logg

    java開發常用jar包介紹轉載

    jta.jar 標準JTA API必要 commons-collections.jar 集合類 必要 antlr.jar ANother Tool for Language Recognition 必要 asm.jar ASM位元組碼庫 如果使用“cglib” 則必要 asm

    阿里巴巴開發手冊解析個人筆記流程控制

    註釋規範為純記憶,不再說明 1. 【強制】在一個 switch 塊內,每個 case 要麼通過 break/return 等來終止,要麼註釋說明程 序將繼續執行到哪一個 case 為止; 在一個 switch 塊內,都必須包含一個 default 語句並且 放在最後,即使空程式碼。

    阿里巴巴開發手冊解析個人筆記集合處理

    文章目錄 1. 【強制】 關於 hashCode 和 equals 的處理,遵循如下規則: 1) 只要重寫 equals,就必須重寫 hashCode。 2) 因為 Set 儲存的是不重複的物件,依據 hashCode 和 equals 進行判斷,所以 Set 儲存

    阿里巴巴開發手冊解析個人筆記

    文章目錄 1.2常量定義 1.3程式碼格式 1.4 OOP規約 1.2常量定義 1. 【強制】不允許任何魔法值(即未經預先定義的常量) 直接出現在程式碼中。 反例 String key = "Id#taobao

    阿里巴巴開發手冊解析個人筆記

    文章目錄 1.編碼規約篇 1.1命名風格 1.1.1 $與_ 1.1.2 拼音命名的壞處 1.1.3 駝峰命名規格 1.1.3.1駝峰命名

    java開發中遇到的錯誤bug及解決方案

    遇到同樣的錯誤,難題,可再一再二,卻不可再三再四。所以對自己程式設計,開發過程中遇到的難題,bug,錯誤,當時是整麼解決的做一下記錄,我覺得是很有必要: 1.javac編譯.java類檔案時,報: 錯誤: 編碼GBK的不可對映字元, 解決方案是:將  Javac xxx.jav

    JAVA IDE IntelliJ IDEA使用簡介—之介面元素

    (注:簡介基於IDEA的版本為:11.0,下載地址:http://www.jetbrains.com/idea/) 開啟IDEA,(當第一次開啟的時候出現的是一個歡迎頁面,隨便建立一個project來進入到IDEA的主介面),主介面顯示如下: 主介面由6個主要區域組成(圖中

    java開發中的那些事1-------關於ORA00604和ORA12705

    ******************************有關myEclipse和oracle連線中出現的一個問題********************************* 介面拿給使用者提意見,然後又是修修改改,總算是審批通過,下一步就要開始編碼了,結果一出手