workandroid成神之路Android知识

FindBugs静态代码分析工具

2016-11-03  本文已影响1527人  _Justin

一、介绍

Findbugs,它是一个静态分析工具,它检查类或者jar文件,将字节码和一组缺陷模式进行对比以发现可能的问题。有了静态分析工具,就可以在不实际运行程序的情况下对软件进行分析。不是通过分析类文件的形式或结构来确定程序的意图,而是通常使用Visitor模式来鉴别代码是否符合一些固定的规范。Findbugs可作为一款插件用在Eclipse或 IntelliJ IDEA环境的编译器上。下面介绍一下在Android Studio中如何使用FindBugs

二、安装

2.1、在线安装:

首先打开Android studio的设置中的插件,输入findbugs,如下图所示,点击Browse查找

1.png

结果如下图所示,不出意外的话第一个选择安装就没问题了,祝各位安装顺利。

2.png

安装完毕之后重启Android studio,然后你就能看到一个红色小鸟图标,证明安装成功了,接下来就能进行使用了。

2.2、本地安装

下载官网:http://andrepdo.github.io/findbugs-idea/

3.png

下载完毕后在Android studio中选择本地安装即可


4.png

三、通过面板使用

FindBugs支持对包级别、项目级别、模块级别、单个文件级别,以及自定义范围的Bug分析。使用方法很简单,选择你需要分析的文件,右键,选择findbugs,然后选择需要分析的文件或者资源或者项目


5.png 6.jpg

分析完毕,此时就可以对分析结果进行查看,并有针对性的去解决这些可能存在的问题

7.jpg

利用findbugs可以找到潜在的很多问题,避免上线后才发现这些低级的问题

最后可以为这些bug定义等级,发布到控制台,然后逐一解决.

四、通过集成在gradle使用

建议在每个project的module下的build.gradle中进行修改

4.1、添加插件

apply plugin: 'com.android.application'
//下面是添加的
apply plugin: 'findbugs'

4.2、添加 task :

task findbugs(type: FindBugs,dependsOn:'assembleDebug') {

    ignoreFailures= true
    effort= "default"
    reportLevel= "high"
    println( "$project.buildDir")
    classes = files("$project.buildDir/intermediates/classes")
    source= fileTree("src/main/java/")
    classpath= files()
    reports{
        xml.enabled=false
        html.enabled=true
        xml {
            destination "$project.buildDir/findbugs.xml"
        }
        html{
            destination "$project.buildDir/findbugs.html"
        }
    }
}

定义一个task任务,这个任务的类型是FindBugs,依赖assembleDebug先生成.classe文件。

4.3、运行方式

在右侧的Gradle的对于的Module可以在Tasks中找到对应的findBugs任务,点击即可运行。也可以在控制台输入gradle findbugs或./gradlew findbugs,执行完成会看到report 生成的路径信息

FindBugs rule violations were found. See the report at: file:///Users/.../app/build/reports/findbugs/findbugs.html

4.4、报告

我们会得到对应的一个类似与这样的报告:

8.png

四、bug种类

以下是搜罗的一些关于findBugs发现的bug种类说明

Bad practice 坏的实践
一些不好的实践,下面列举几个:

Malicious code vulnerability 可能受到的恶意攻击

如果代码公开,可能受到恶意攻击的代码,下面列举几个:

Correctness 一般的正确性问题

可能导致错误的代码,下面列举几个:

Dodgy 危险的

具有潜在危险的代码,可能运行期产生错误,下面列举几个:

Performance 性能问题

可能导致性能不佳的代码,下面列举几个:

Multithreaded correctness

多线程的正确性多线程编程时,可能导致错误的代码,下面列举几个:

Internationalization 国际化
当对字符串使用upper或lowercase方法,如果是国际的字符串,可能会不恰当的转换。

五、扩展

官方文档

https://docs.gradle.org/current/dsl/org.gradle.api.plugins.quality.FindBugs.html
上一篇 下一篇

猜你喜欢

热点阅读