Android 代码规范之Inspection 定制

本文主要讲述两个方面:

1)为何制定Radio_Inspections 规范及实操

2)IDE Inspection 使用 

第一部分 :为何制定Radio_Inspections 规范及实操

一 、制定Radio_Inspections 规范的目的

    (1)写代码时发现并解决不规范的书写或潜在的bug (其他工具未扫描出来)

    (2)解决部分代码性能问题

二、Radio_Inspections 能够解决的问题

       当前虽然IDE Inspection 能够提供实时提示,但是往往开发者没太注意,原因主要有以下几点:

    (1)IDE Inspection 默认检查项过多,扫描结果过多,处理费时,不愿处理;

    (2)IDE Inspection 提示级别多为warning ,让人容易忽视(有时往往会产生致命np问题);

    (3)IDE Inspection 部分检查项,默认关闭的(规则太多,开发者也不会一一浏览过滤);

          针对上述三个问题,freddy想出相应对策,来制定符合自身项目的Inspection 规则(Radio_Inspections) :

(1)浏览相关规则,结合平时开发,将部分默认未开启有意义的检查项开启;

(2)将提示级别设置为error ;

(3)优先处理error 级别问题。


Radio_Inspections新增 规则如下(暂时未引入阿里插件检查项):

(1)Class structure

        1) Utility class without ‘private’ constructor

             工具类 建议添加 私有构造方法,防止实例化

        2)Class with only ‘private’ constructors should be declared ‘final'

              工具类 建议 添加final 修饰符

(2)Code style issues 

        1) ‘expression.equals(“literal”) rather than “literal”.equals(expression)

               防止潜在np

(3)Control flow issues

        1) Unnecessary ‘null’ check before ‘instanceof’ expression  

(4)Declaration redundancy

        1) Access static member via instance reference

(5)Imports

        1)Static import

(6)Java language level migration aids 

     1) Identical ‘catch’ branches in ‘try’ statement (语法糖)

     案例:

图 案例
图 建议写法

    同时,对应关闭 “Multiple-catch can be split into separate catch blocks” 

(7)Memory issues

      1)Inner class may be ‘static’

(8)Probable bugs

        1)Return of "null"

        public 方法返回 null ,建议添加 @Nullable (强制添加,不然提示)

       2) equals( ) and hashCode( ) not paired 

  (9) Inheritance issues

           1) @Overridate

 (10) Numeric issues

         1)Divide by zero

         2) 'long' literal ending with "l" instead of "L'

(11) Serialization issues 

      1)Serializable class without 'serialVersionUID'

       2)‘serialVersionUID’ field not declared 'private static final long'

       3)Transient field in non-serializable class

             防止 transient 关键字 和 @Transient 用混


另外,有一些比较好的建议(暂时未添加):

(1)Performance issues 

      1)Collection without initial capacity (638+)

            设置初始容量

(2)  Magic number  (1273 个)


建议关闭的默认规则 :

(1)Javadoc issues  

        直接checkStyle 就可以

(2)General  Default File template   (模板)

         This inspections reports usage of the default file template for File Header.

(3)Syntax error inspection

          Allows you to see syntax errors in the results of batch code inspection.

(4)Spelling 

(5)Android Lint :Internationlization

        1) Using left / right instead of start/end attributes (1640+)


第二部分  :IDE Inspection 使用 

一、默认情况  (Project Default)

1)Specify Inspection scope 

      选择Inspection scope  以及 Inspection profile 

图 Specify Inspection scope 

       Inspections profile 主要有两种存储方式  :IDE (选择IDE即可)  和 project,建议使用IDE 存储,切换分支不会发生变化;

图 Inspections profile 存储选择方式

二、规则挑选过滤  

       Inspection 检查 主要 分为 :Error 、Blocker 、Critical、Major 等等  。可以通过左侧漏斗按钮进行相关过滤。

图 规则过滤选择

三、过滤机制  

(1)检查结果相关点

图 过滤方式选择

        右侧对应Suppress 方式 (分别针对 method/class/ all inspections for class),尽可能选择粒度较小的方式,如method 。

(2)具体Method过滤 

图 方法过滤实例

(3)检查项不配置,则对整个工程都不会检查


©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,560评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,104评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,297评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,869评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,275评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,563评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,833评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,543评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,245评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,512评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,011评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,359评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,006评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,062评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,825评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,590评论 2 273
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,501评论 2 268

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,099评论 18 139
  • 原文:https://legacy.python.org/dev/peps/pep-3333 PEP:3333标题...
    老周_o_o阅读 2,356评论 0 5
  • 故地密竹新,慌急刻字寻。 山盟依旧在,不见意中人。 注:以“人不风流枉少年”任意平声字做韵脚。 (中华新韵)
    云淡风轻110阅读 593评论 14 31
  • 遇见另外一个你 22的结束,100天新的征程开启 目标一 减到100斤 1 晚上不吃饭(聚餐少吃)...
    A我愿阅读 276评论 2 1
  • 当你决定不再去打扰她的时候, 内心有太多的纠结和不舍。 因为只有你自己知道, 为了这个决定, 你是用了多大的勇气,...
    丹华君阅读 284评论 0 0