Android-Lint：查错与代码优化利器

田海立

2012-10-03

Android-Lint是SDK Tools 16 (ADT 16)之后才引入的工具，通过代码检查，可发现潜在的问题，并能对Android程序进行优化处理。Android-Lint提供了命令行方式执行，还可与IDE（如Eclipse）集成，并提供了html形式的输出报告。Android-Lint可以方便的与项目中的其他自动系统（配置/ Build / 测试等）集成。

Android-Lint相关的文章：

• Android-Lint：查错与代码优化利器

Android-Lint的简述：Lint检查哪些问题；如何使用；有哪些选项；与其他系统集成。

• 定制Android-Lint检查问题的现有规则

对Android-Lint发现的问题进行处理。可定制项目中采用的规则。

• Android-Lint检查问题列表

Android SDK Tools / ADT 20.0.3中所支持的默认检查的所有问题。

有英文版本和中文版本。英文版本从Android-Lint中直接导出；中文版本还不完整，对每一条的解释会逐步完善。

当然，最关键最权威的还是应该看官方网站：http://tools.android.com/tips/lint

一、Android-Lint检查的潜在问题

1.1问题描述-- Issue

Android-Lint所要检查的问题以Issue来描述。

Issue分9类（Category）：Correctness/ Correctness: Messages / Security / Performance / Usability: Typography /Usability: Icons / Usability / Accessibility / Internationalization。

Issue以一个文本短语来作为id，对Issue的定制等操作都是基于id的。

Issue以Severity来标识该Issue的危害程度：Fatal / Error / Warning/ Information / Ignore。对Issue的忽略操作其实也就是降低它的Severity为Ignore。

1.2 检查的潜在问题

Android-Lint所检查的潜在问题，可以通过命令行$lint --show来获得所要扫描问题的详细列表。

下面简要列举Android-Lint所检查的常见问题：

1. Correctness
1) DuplicatedIds
Layout中id应该唯一
2) NewApi
代码中使用的某些API高于Manifest中的Min SDK
3) InconsistentArrays
字符串国际化中，同一名字的的String-Array对应的item值不相同
4) Registered
Activity/Service/ContentProvider没有通过AndroidManifest注册
5) Deprecated
使用已经废弃的API
6) PxUsage
避免使用px，使用dp
 
2. Correctness:Messeges
1) MissingTranslation
字符串国际化不完全
2) ExtraTranslation
国际化的字符串，在默认位置(defaultlocale)，没有定义
 
3. Security
1) SetJavaScriptEnabled
不确定你的程序中确实需要JavaScript就不要执行SetJavaScriptEnabled。
2)ExportedContentProvider/ExportedReceiver/ExportedService/ExportedActivity
ContentProvider/Receiver/Service/Activity的exported为true时，设置一个Permission，让使用者获取了Permission才能使用。
3) HardcodedDebugMode
不要在manifest中设置android:debuggable。
设置它，编译的任何版本都要采用指定的debug模式。不设置，编译Eng版本采用debug模式；编译User版本采用release模式。
 
4. Performance
1) DrawAllocation
避免在绘制或者解析布局(draw/layout)时分配对象。E.g.,Ondraw()中实例化Paint对象。
2) ObsoleteLayoutParam
Layout中无用的参数。
3) UseCompoundDrawables
可优化的布局：如包含一个Imageview和一个TextView的线性布局，可被采用CompoundDrawable的TextView代替。
4) UseSparseArrays
尽量用Android的SparseArray代替Hashmap
5) DisableBaselineAlignment
如果LinearLayout被用于嵌套的layout空间计算，它的android:baselineAligned属性应该设置成false，以加速layout计算。
6) FloatMath
使用FloatMath代替Math。
7) NestedWeights
避免嵌套weight，那将拖累执行效率
8) UnusedResources/UnusedIds
未被使用的资源会是程序变大，并且编译速度降低。
9) Overdraw
如果为RootView指定一个背景Drawable，会先用Theme的背景绘制一遍，然后才用指定的背景，这就是所谓的“Overdraw”。
可以设置theme的background为null来避免。
10) UselessLeaf/UselessParent
View或view的父亲没有用
 
5. Usability:Typography
1) TypographyDashes
特殊字符需用编码代替：“–”需要用“–”；“—”需要用“—”
2) TypographyEllipsis
特殊字符需用编码代替：“…”需要用“…”
3) TypographyOther
问题：“(c)”需要用“©”
 
6. Usability:Icons
1) IconNoDpi
Icon在nodpi和指定dpi的目录下都出现。
2) GifUsage
Image不要用GIF，最好用PNG，可以用JPG。
 
7. Usability
1) BackButton
Android中不要设计有Back的按钮，Android中一般有Back的硬按键。
2) ButtonCase
Button的“Ok”/“Cancel”显示大小写一定，不要全大写或全小写。有标准的资源的字符串，不要自己再定义，而要用系统定义的：@android:string/ok和@android:string/cancel
 
8. Accessibility
1) ContentDescription
ImageView和ImageButton应该提供contentDescription
 
9. Internationalization
1) HardcodeText
硬编码的字符串应该在资源里定义
2) EnforceUTF8
所有XML资源文件都应该以UTF-8编码

...

二、执行Android-Lint

1.1 Eclipse中执行

Eclipse中的Runs Android Lint的按钮。

点击它可执行对所有当前Workspace中的Android项目执行Android Lint；也可以点击它右边的下箭头，选择对某一个Android项目执行Android Lint。

执行Lint检查之后，检查的结果在Eclipse的Lint Warnings View里：

可以在这里解决问题或者定制忽略掉这些问题。

1.2 命令行执行

Lint的命令行指令在AndroidSDK Tools中，<android-sdk-root>\tools\下有lint.bat这个批处理文件。

执行>lint<dest>可对<dest>中的所有Android项目进行递归检查。

三、Android-Lint选项

Android-Lint在命令行下，提供了写参数选项，提供定制。

3.1 issue列表

lint --show
lint --list

通过show和list可以查看所有支持要检测的Issue列表：show显示详细的issue信息；list只是issue的id和summary的列表。

3.2 disable/enable/check issue

lint --disable <list>
lint --enable <list>
lint --check <list>

Android-Lint所支持要检测的Issue列表，默认有检查（Severity为非Ignore）和忽略（Severity为Ignore）之分。

可以用disable不检查指定<list>中默认要检查的id或category；用enable检查指定<list>中默认忽略的id或category；用check只检查指定<list>中的id或category。

注意：

[1] disable/enable是在default列表的基础上，disable/enable给定列表里的；check是只检查列表里的。

[2] <list>是issue id或category列表，用逗号隔开。

3.3 html输出

lint --html <filename>
lint --html <filename> --url filepath=url

Android-Lint可以通过html选项指定本次检查的结果输出。

生成的html文件中，还会引用别的文件，可以通过url参数替换其中的地址，使其指向公共访问的地方。

3.4 指定全局配置文件

lint --config <filename>

虽然disable/enable/check选项可以改变本次检查的问题行为，但是下次还要再次指定。可以通过config选项指定默认的全局配置文件。

注意：如果项目中已经有lint.xml文件，对于某条issue的检查来说，1先用项目中lint.xml的规则，然后是2config指定的规则，最后才是3系统默认的规则。

3.5 其他选项

lint --help

Android-Lint还有很多其他选项，可以通过lint --help查看。

四、与其他系统集成

Android-Lint提供命令行和IDE集成方式。IDE可以极大提升个体单兵作战能力；而命令行则对团队作战至关重要。如果一个工具要被用于自动系统中，命令行执行模式是否支持是一个重要的指标。

Android-Lint已经完全具备，可以与现有的配置系统，自动Build系统以及自动测试系统集成：

• 配置系统中有资源加入或更改后；（触发的时机也可以是Daily Build/ Weekly Build / etc.）
• 触发自动Build系统做Build；
• Build完成之后，启动Android-Lint系统执行Lint做检查；

Lint检查的结果以html报告的形式连同自动测试结果一起作为判断这个版本质量的重要指标。