美文网首页Android 优化相关
代码优化--Android Lint(一)

代码优化--Android Lint(一)

作者: 蓝璃penn | 来源:发表于2019-10-23 17:45 被阅读0次

    原文链接:https://blog.csdn.net/luzhenyuxfcy/article/details/79398761

    Android lint是在ADT16(Android SDK Tools 16 )提供的新工具,它是一个代码扫描工具,用于检测 Android 的代码质量。
    可以在项目目录下通过命令调用(Windows:gradlew lint、Mac:./gradlew lint)获得 Lint 检测结果,生成详细的 xml 或者 html 报告文件;也可以通过 Android Studio 的工具栏【Analyze】->【Inspect Code】直接进行Lint 检查。

    Lint优化哪些问题

    • 遗漏的翻译(没用上的翻译),比如国际化未被翻译的字段值
    • 布局性能(以前是 layoutopt工具,可以解决无用布局、嵌套太多、布局太多)
    • 未使用的资源
    • 不一致的数组大小
    • 国际化问题(硬编码)
    • 图标的问题(重复的图标,错误的大小)
    • 可用性问题(如不指定的文本字段的输入型)
    • manifest文件的错误

    Lint 发现的每个问题都有描述信息和等级,我们可以很方便地定位问题,同时按照严重程度进行解决。当然这个“严重程度”可以手动调节,有些原则问题不容侵犯,必须提升到 error,而有的个别问题也可以无视。
    但我们也不能过分依赖该工具,因为有些东西实际开发中会有自己的规则,有可能会出现冲突的地方,需根据实际需求。

    Lint问题种类

    • Correctness: 不够完美的编码,比如硬编码、使用过时 API 等 ;
    • Performance: 对性能有影响的编码,比如:静态引用,循环引用等 ;
    • Internationalization: 国际化,直接使用汉字,没有使用资源引用等 ;
    • Security: 不安全的编码,比如在 WebView 中允许使用 JavaScript Interface 等 ;
    • Usability: 可用的,有更好的替换的,比如排版、图标格式建议.png格式 等 ;
    • Accessibility: 辅助选项,比如 ImageView 的 contentDescription 往往建议在属性中定义等;

    Lint问题等级

    方法:AS -> Settings -> Editor -> Inspections(检测配置页)

    | Fatal :致命的
    | Error :错误
    | Warning :警告
    | Weak Warning:比较弱的警告,提示比较弱
    | Typo:拼写错误,绿色波浪下划线
    | Information :一般信息,注释文档
    ↓ Ignore:忽略
    检查问题列表详见 点我跳转

    下面简要列举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)时分配对象。eg: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编码。
        ...
    

    两种使用方式

    1. 命令行执行

    命令行路径
    ADT:your ‘sdk’ dir\tools\lint.bat
    AS:your ‘sdk’ dir\tools\bin\lint.bat

    命令行使用
    在 ’lint.bat’ 同级目录打开 cmd,可以通过 ’–help’ 获取对应的帮助。

    Issue列表

    • lint –list : list 只是 issue的 id 和 summary 的列表
    • lint –show :show 显示详细的 issue 信息

    disable/enable/check

    • 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。

    • disable/enable是在 default列表的基础上,disable/enable给定列表里的;check是只检查列表里的。
    • <list>是 issue id或 category列表,用逗号隔开。

    生成html/xml报表

    • lint –html <target_filename> <proj_dir>:生成 html 格式的报告 ;
    • lint –html <target_filename> --url filepath=url:生成的 html 文件中,还会引用别的文件,可以通过 url 参数替换其中的地址,使其指向公共访问的地方 ;
    • lint –simplehtml <target_filename> <proj_dir>:生成格式简单的 html 报告 ;
    • lint –xml <target_filename> <proj_dir>:生成 html 格式的报告;

    自定义分析策略
    lint –config <custom-lint_config_filename> <target_filename> <proj_dir>
    虽然 disable/enable/check 选项可以改变本次检查的问题行为,但是下次还要再次指定。可以通过 config选项指定默认的全局配置文件。

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

    lint在Gradle中可以使用”gradlew lint”命令行(Windows),”./gradlew lint”(mac)执行。详细可移步至:https://developer.android.com/studio/write/lint.html#commandline

    2. IDE集成操作

    Android Studio 中内置了 Lint,可以直接使用。
    Lint 的使用路径:
    工具栏 -> Analyze -> Inspect Code…
    具体使用转至文章:代码优化--Android Lint(二)

    参考文章:
    官方,使用Lint改善您的代码
    Android Lint
    Android Lint:自定义Lint调试与开发
    Android自定义Lint实践-美团
    Android ------ 美团的Lint代码检查实践
    Android工具:被你忽视的Lint

    相关文章

      网友评论

        本文标题:代码优化--Android Lint(一)

        本文链接:https://www.haomeiwen.com/subject/fqyrmctx.html