CN109857648A

CN109857648A - 一种api误用的变更模式挖掘方法

Info

Publication number: CN109857648A
Application number: CN201910030995.9A
Authority: CN
Inventors: 陈碧欢; 彭鑫; 赵文耘
Original assignee: Fudan University
Current assignee: Fudan University
Priority date: 2019-01-14
Filing date: 2019-01-14
Publication date: 2019-06-07
Anticipated expiration: 2039-01-14
Also published as: CN109857648B

Abstract

本发明属于软件工程技术领域，具体为一种API误用的变更模式挖掘方法。本发明从代码托管服务上海量开源项目的变更提交历史中选取出修复API误用的变更提交，通过分析变更提交的细粒度代码差异来抽取API误用的变更方式，对API误用的变更方式的项目间频次(在开源项目中出现的项目数)和项目内频次(在所有开源项目中出现的次数)进行排序得到API误用的变更模式。本发明所挖掘出的API误用的变更模式在海量开源项目中频繁出现，可以用来检测开源项目中的API误用，从而提高开源项目的质量。

Description

一种API误用的变更模式挖掘方法

技术领域

本发明属于软件工程技术领域，具体涉及一种API误用的变更模式挖掘方法。

背景技术

第三方库和框架通常以API的方式提供给软件开发人员使用，从而提高软件开发的效率和软件系统的质量。然而，在实践中，即使对于非常有经验的开发人员，学习和使用API是一件非常困难的事情。这主要归因于以下几个问题：API的使用约束通常是隐含的假设、API之间的组合调用往往是非常复杂的、API的文档经常是不完整或者含有二义性的、API由于自身演化而变得不稳定。这就使得开发人员经常误用API，导致未知的软件行为或者软件缺陷(包括功能缺陷、性能缺陷、安全缺陷、兼容性问题等)。

开源项目中存在着大量关于API使用的知识，而且代码托管服务上的开源项目正快速增长，这些都促成了API使用模式挖掘的发展。目前的API使用模式主要有三种表示形式。第一种表示是一个API调用集合，例如{FileInputStream.read,FileInputStream.close}。这个集合中的API调用经常在一起频繁使用，但不区分调用的次序，例如只要调用FileInputStream.read就需要调用FileInputStream.close，反之亦然。第二种表示是一个API调用的序列，例如FileInputStream.read->FileInputStream.close。这个序列表示一组API经常以固定的先后顺序被调用，例如FileInputStream.close不能在FileInputStream.read之前被调用。第三种表示是API调用的前置条件，表示一个API在被调用之前必须要满足某种前置条件，例如File.createNewFile在被调用之前File.exists必须要返回false。以上三种模式都关注于API调用的上下文关系，而并没有关注API调用本身的信息，例如API调用的参数设置是否正确、是否在一组类似的API中选择了一个合适的API、API调用的返回值是否进行了特殊值的额外判断等。本发明所关注的挖掘方法针对API调用本身。

发明内容

本发明的目的是提供一种API误用的变更模式挖掘方法，从而识别开源项目中常见的API误用及其变更模式，从而便于在开源项目中检测API误用并提高开源项目的质量。

为了达到上述目的，本发明提供一种API误用的变更模式挖掘方法，其包括以下：

(1)从代码托管服务上开源项目的变更提交历史中，根据启发式规则选择与修复API误用相关的变更提交；

(2)针对每个变更提交，进行变更提交前后开源项目在抽象语法树上的代码差异分析，并抽取和分析API误用的变更方式；

(3)对API误用的变更方式进行项目间频次以及项目内频次的统计，并通过加权排序得到API误用的变更模式。

本发明中，步骤(1)中所使用的启发式规则是选择缺陷修复的变更提交。API误用会导致软件缺陷，本发明在变更提交日志中通过关键字匹配的方式来选择缺陷修复的变更提交。本发明所使用的关键字包括“bug”、“fix”、“patch”、“performance”、“slow”、“throughput”、“security”、“insecure”、“compatibility”、以及“compatible”。这些关键字是为了覆盖各种软件缺陷(包括功能缺陷、性能缺陷、安全缺陷、以及兼容性缺陷)。

本发明中，步骤(2)中所使用的抽象语法树代码差异分析可以得到一个编辑操作序列，每个编辑操作是对抽象语法树上一个结点的增、删、改、移。这个编辑操作序列可以把变更前的抽象语法树转换为变更后的抽象语法树。通过遍历这个编辑操作序列并根据各个编辑操作所在的结点类型，可以判断是否是一个API调用的参数、方法名、或者对象发生了变更。这三种变更方式分别对应于API调用参数的修改(例如，Thread.sleep(long)的参数被修改)、同类API调用的替换(例如，System.currentTimeMillis()被替换为System.nanoTime())、以及异类API调用的替换(例如，StringBuffer.append(char)被替换为StringBuilder.append(char))。

步骤(3)中对各个API误用的变更方式进行项目间频次f_cr(即在开源项目中出现的总项目数)以及项目内频次f_in(即在所有开源项目中出现的总次数)的计数统计，并对这两个计数统计根据公式p＝w*(f_in-f_in ^min)/(f_in ^max-f_in ^min)+(1-w)*(f_cr-f_cr ^min)/(f_cr ^max-f_cr ^min)进行归一化并计算API误用的变更方式在项目内和项目间的加权和。其中，w是权重，f_in ^min和f_in ^max是所有API误用的变更方式关于项目内频次的最小值和最大值，f_cr ^min和f_cr ^max是所有API误用的变更方式关于项目间频次的最小值和最大值。最后通过对加权和的排序得到常见的API误用的变更模式(例如，StringBuffer.append(char)被替换为StringBuilder.append(char))。

本发明由于采用了上述的技术方案，使之与现有的技术相比，具有以下的优点和积极效果：本发明关注于API调用本身的误用情况，可以挖掘出API调用本身的误用模式，从而便于在开源项目中检测API误用并提高开源项目的质量。

附图说明

图1为本发明的基本过程示意图。

具体实施方式

图1为本发明的基本过程示意图。本节给出了一个基于GitHub开源项目以及JavaSE 8API的具体实施方式。基于该实施方式的主要使用过程为：

(1)选择GitHub上星数大于1000的Java开源项目，总共为1162个Java开源项目。这些开源项目中总共包含了3191057个变更提交。

(2)通过匹配关键字“bug”、“fix”、“patch”、“performance”、“slow”、“throughput”、“security”、“insecure”、“compatibility”、以及“compatible”从3191057个变更提交中选择出320222个与修复软件缺陷有关的变更提交。

(3)针对320222个变更提交中的每个变更提交，通过代码差异分析抽取出12508个误用Java SE 8API的变更方式。

(4)通过项目间和项目内的频次统计挖掘出676个Java SE 8API误用的变更模式。针对30个最常见的API误用的变更模式，人工分析了它们所对应的1262个API变更方式，发现误报率为11.4％，即11.4％的API变更方式跟缺陷修复和API误用无关。此外，利用其中的4个API误用的变更模式，在开源项目中发现了26个新的API误用缺陷。

Claims

1.一种API误用的变更模式挖掘方法，其特征在于，包括如下步骤：

2.根据权利要求1所述的变更模式挖掘方法，其特征在于，步骤(1)中，在变更提交日志中通过关键字匹配的方式选择缺陷修复的变更提交。

3.根据权利要求2所述的变更模式挖掘方法，其特征在于，关键字包括“bug”、“fix”、“patch”、“performance”、“slow”、“throughput”、“security”、“insecure”、“compatibility”、以及“compatible”。

4.根据权利要求1所述的变更模式挖掘方法，其特征在于，步骤(2)中，使用了基于抽象语法树的代码差异分析来抽取API误用的变更方式，通过遍历代码差异分析而来的编辑操作序列并根据各个编辑操作所在的结点类型，判断并抽取API调用参数的修改、同类API调用的替换、以及异类API调用的替换这三种API误用的变更方式。

5.根据权利要求1所述的变更模式挖掘方法，其特征在于，步骤(3)中，使用了项目间频次f_cr和项目内f_in频次来对各个API误用的变更模式进行加权和和排序，从而挖掘常见的变更模式；其中：项目间频次f_cr表示API误用的变更方式在开源项目中出现的总项目数，而项目内频次f_in表示API误用的变更方式在所有开源项目中出现的总次数；

通过如下公式计算对API误用的变更方式在项目内和项目间的加权和:

p＝w*(f_in-f_in ^min)/(f_in ^max-f_in ^min)+(1-w)*(f_cr-f_cr ^min)/(f_cr ^max-f_cr ^min)

其中：w是权重，f_in ^min和f_in ^max是所有API误用的变更方式关于项目内频次的最小值和最大值，f_cr ^min和f_cr ^max是所有API误用的变更方式关于项目间频次的最小值和最大值。