強(qiáng)制執(zhí)行Lint規(guī)范代碼

Lint

開發(fā)中使用靜態(tài)代碼檢測工具對代碼進(jìn)行檢查,達(dá)到規(guī)范代碼減少bug的目的。常用的檢測工具有FindBugs、PMD技俐、Coverity,Checkstyle。
Android工程使用Lint是最方便统台。Lint作為官方配套工具雕擂,功能完善,自定義擴(kuò)展性強(qiáng)贱勃,常規(guī)需求基本可以做到無需修改井赌。
自定義Lint網(wǎng)上相關(guān)文章也很多,不在本篇討論范圍之中贵扰。

現(xiàn)實(shí)

雖然Lint很好族展,能夠在代碼中實(shí)時(shí)提示,但只要不影響到編譯流程拔鹰,改不改,全看開發(fā)者自覺贵涵。所以我們需要增加一些強(qiáng)制性列肢,不修改就不能繼續(xù)恰画。

  1. 將Lint任務(wù)部署到CI中,Pull Request進(jìn)行Lint任務(wù)瓷马,不通過則不允許提交
  2. hook到git commit拴还,在git commit時(shí)執(zhí)行Lint任務(wù)
  3. 本地編譯時(shí)執(zhí)行Lint任務(wù),不通過中斷編譯

根據(jù)實(shí)際情況選擇即可欧聘,下面對方案3講解一下

插入到編譯過程中

眾所周知片林,apk生成或者aar生成會執(zhí)行assemble任務(wù),子module時(shí)在不輸出aar并不會執(zhí)行這個(gè)任務(wù)怀骤,經(jīng)過
觀察會執(zhí)行bundleLibRuntimeToDirxxxx任務(wù)费封,所以可以把Lint任務(wù)插入到這兩個(gè)任務(wù)之前執(zhí)行。

common.gradle, 基于AGP7.0+

/**當(dāng)設(shè)置為true時(shí)每次運(yùn)行都會進(jìn)行l(wèi)int,設(shè)置為false時(shí)只會在發(fā)布版本時(shí)檢查*/
def lintAlways = true

def isAppModule = plugins.hasPlugin('com.android.application')
def isLibraryModule = plugins.hasPlugin('com.android.library')

//lint檢測
if (isAppModule) {
    android.applicationVariants.all { variant ->
        def lintTask = tasks["lint${variant.name.capitalize()}"]
        variant.assembleProvider.get().dependsOn lintTask
    }
} else if (isLibraryModule) {
    android.libraryVariants.all { variant ->
        def lintTask = tasks["lint${variant.name.capitalize()}"]
        if (lintAlways) {
            def runTask = tasks["bundleLibRuntimeToDir${variant.name.capitalize()}"]
            if (runTask != null) {
                //直接運(yùn)行時(shí)也進(jìn)行l(wèi)int
                runTask.dependsOn lintTask
            }
        }
        //打包成aar
        variant.assembleProvider.get().dependsOn lintTask
    }
}

最后在每個(gè)模塊引入這個(gè)gradle即可蒋伦。

Lint配置

只有error或者fatal級別的issue弓摘,才會中斷編譯。如果我們想修改issue等級或者我們想忽略某些文件錯(cuò)誤痕届∪拖祝可以在工程根目錄添加lint.xml文件,

<?xml version="1.0" encoding="UTF-8"?>
<lint>
    <!-- Disable the given check in this project -->
    <issue id="IconMissingDensityFolder" severity="ignore" />

    <!-- Ignore the ObsoleteLayoutParam issue in the specified files -->
    <issue id="ObsoleteLayoutParam">
        <ignore path="res/layout/activation.xml" />
        <ignore path="res/layout-xlarge/activation.xml" />
    </issue>

    <!-- Ignore the UselessLeaf issue in the specified file -->
    <issue id="UselessLeaf">
        <ignore path="res/layout/main.xml" />
    </issue>

    <!-- Change the severity of hardcoded strings to "error" -->
    <issue id="HardcodedText" severity="error" />
</lint>

配置好后,當(dāng)有error級別的issue未解決時(shí)就不編譯不通過研叫,督促開發(fā)人員進(jìn)行修改锤窑。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市嚷炉,隨后出現(xiàn)的幾起案子渊啰,更是在濱河造成了極大的恐慌,老刑警劉巖渤昌,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件虽抄,死亡現(xiàn)場離奇詭異,居然都是意外死亡独柑,警方通過查閱死者的電腦和手機(jī)迈窟,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來忌栅,“玉大人车酣,你說我怎么就攤上這事∷餍鳎” “怎么了湖员?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵,是天一觀的道長瑞驱。 經(jīng)常有香客問我娘摔,道長,這世上最難降的妖魔是什么唤反? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任凳寺,我火速辦了婚禮鸭津,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘肠缨。我一直安慰自己逆趋,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布晒奕。 她就那樣靜靜地躺著闻书,像睡著了一般。 火紅的嫁衣襯著肌膚如雪脑慧。 梳的紋絲不亂的頭發(fā)上魄眉,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天,我揣著相機(jī)與錄音漾橙,去河邊找鬼杆融。 笑死,一個(gè)胖子當(dāng)著我的面吹牛霜运,可吹牛的內(nèi)容都是我干的脾歇。 我是一名探鬼主播,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼淘捡,長吁一口氣:“原來是場噩夢啊……” “哼藕各!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起焦除,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤激况,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后膘魄,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體乌逐,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年创葡,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了浙踢。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,040評論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡灿渴,死狀恐怖洛波,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情骚露,我是刑警寧澤蹬挤,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站棘幸,受9級特大地震影響焰扳,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一蓝翰、第九天 我趴在偏房一處隱蔽的房頂上張望光绕。 院中可真熱鬧,春花似錦畜份、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至愕鼓,卻和暖如春钙态,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背菇晃。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工册倒, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人磺送。 一個(gè)月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓驻子,卻偏偏與公主長得像,于是被迫代替她去往敵國和親估灿。 傳聞我的和親對象是個(gè)殘疾皇子崇呵,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,979評論 2 355

推薦閱讀更多精彩內(nèi)容