API文档挖掘研究

发布时间：2020-04-18 02:33

【摘要】：随着软件复用技术的不断发展,软件开发者越来越依赖于使用第三方类库来实现特定的服务和功能。通过调用第三方类库中的应用程序编程接口(API),开发者可以节省大量的开发时间,有效地提高软件的开发效率。然而,API通常比较难以学习和使用。面对一个不熟悉的API,开发者倾向于寻找各种各样的API文档来学习API的正确使用。因此,API文档的质量对于API的学习和使用效率,乃至软件的开发效率都至关重要。近些年来,如何有效地解决API文档的各种问题,进而提高API的学习和使用效率是研究人员研究的热点问题。虽然研究人员已经提出了一些算法来解决API文档的问题,但是这些算法没有充分利用API文档的领域特定知识,算法结果有待进一步提升。本文围绕在API的学习和使用过程中产生的三种典型的API文档,即API教程,API技术问答对和API相关的缺陷报告开展分析与挖掘研究。针对API教程冗长且难理解的问题,本文分别提出了一种更精确的监督算法和一种无监督算法,为开发者推荐API教程解释片段。针对API技术问题难回答,本文提出了一种基于API规范和历史信息的API推荐算法,帮助开发者定位正确的API。针对API相关的缺陷难修复的问题,本文提出了基于贡献者写作风格的缺陷报告摘要构建算法,帮助开发者快速理解API相关的缺陷的修复过程。具体来说,本文主要研究工作包括:(1)监督与无监督API教程片段推荐算法设计。API教程的信息冗长延长了开发者学习API的时间。为了有效地解决API教程冗长问题,本文提出了一种监督的API教程片段推荐算法。该方法将API教程切分成片段,为开发者推荐期望的API教程片段。该方法充分挖掘API教程的内在联系,提出了两类重要的分类特征,即共现API特征和基于扩展的API特征,提高了 API教程片段推荐的准确率。同时,为了提高算法的实用性,本文进一步提出了一种无监督API教程片段推荐算法。经过对大量的API教程片段数据进行观察发现,并不是所有的API教程片段都是在解释API。本文提出了识别非解释性API教程片段的启发式规则,并且创新地利用PageRank算法和主题模型算法,分别从词法结构和语义的角度进行分析和推荐。本文提出的无监督算法不仅获得了最好结果,而且具有很好的实用性。(2)基于API规范和历史信息的API推荐算法设计。API类库中通常封装了成百上千的API,开发者面对众多的API难以选择。Stack Overflow等流行的技术问答网站上积累了海量的API相关问题,它们的解决时长显著超过其他问题。为了减少开发者的等待时间,加快API相关问题的解决,本文创新地利用API规范和历史信息来为API相关问题推荐正确的API。本文提出的API推荐算法显著提高了推荐准确率,节省了开发者选择API的时间。(3)基于贡献者写作风格的API相关的缺陷报告摘要构建算法设计。由于API错误使用导致的缺陷通常难以修复。在修复API错误使用导致的缺陷时,开发者通常需要参考以前已经修复好的缺陷的修复方法。因此,对缺陷报告构建精确的摘要可以减少开发者阅读和理解缺陷报告的时间,加快API相关缺陷的修复过程。现有的缺陷报告摘要构建算法仅仅考虑缺陷报告本身的内容,并没有考虑人的因素。本文创新地对贡献者的写作风格进行建模,并对典型的贡献者写作风格进行了实证研究。以贡献者写作风格相似的缺陷报告作为约简训练集构建算法,不仅可以有效减少训练时间,而且可以提高缺陷报告摘要构建的准确率。本文针对围绕API学习和使用过程中产生的典型的API文档开展分析与挖掘研究。在分析了已有工作及其存在的问题的基础上,充分考虑领域特定知识,提出了相应的解决方案。本论文的研究方法可以进一步用于软件工程其他领域的分析研究工作。
【图文】：

教程,片段

个元素的行为规范，，比如参数类型和返回值类型等。调用ＡＰＩ的开发者如果不遵循这样逡逑的规范非常容易导致软件缺陷。逡逑以Ｊａｖａ邋ＡＰＩ为例，一个典型的Ｊａｖａ邋ＡＰＩ教程片段如图１．２所示。从图１．２中可以看逡逑至ｌｊ，ＡＰＩ教程通常会用标题来显示对应的编程任务，每一个编程任务会有相应的描述和逡逑代码样例。开发者通过阅读自然语言的描述和代码样例可以快速实现该功能。一个典型逡逑的ＡＰＩ规范片段如图１．３所示。Ｊａｖａ邋ＡＰＩ规范由一系列ＨＴＭＬ网页构成，每个网页介绍逡逑特定的ＡＰＩ。如图１．３所示，ＡＰＩ规范通常介绍ＡＰＩ的继承关系和功能描述。除此之外，逡逑针对每个类和接口，ＡＰＩ规范还介绍对应的构造函数，内置函数和字段。逡逑Ｊａｖａ邋ＡＰＩ教程页面平均包含超过５００个单词。在参考ＡＰＩ教程学习和使用ＡＰＩ的时逡逑候，^u发者无法快速定位到他们需要的内容。而且，开发者并不能按照简单的词法匹配逡逑来查找，因为并不是某个ＡＰＩ出现，相应的教程页面就是在解释这个ＡＰＩ。这个ＡＰＩ有逡逑可能被列举出来作为对比或者举例等。面对如此冗长的ＡＰＩ教程及其复杂的内容，一个逡逑简单可行的办法就是将Ａ：ＰＩ教程切分成多个片段。以片段为单位

片段,开发者

网站上通过提问或者浏览己有的问题等方式寻求帮助。一个典型的问答网站Ｓｔａｃｋ逡逑Ｏｖｅｒｆｌｏｗ提供了邋一个开发者之间以问答的方式交流ＡＰ丨使用经验的平台。Ｓｔａｃｋ邋Ｏｖｅｒｆｌｏｗ逡逑中一个典型的问答对如图１．４所示。Ｓｔａｃｋ邋Ｏｖｅｒｆｌｏｗ中不仅记录着问题及其对应的多个逡逑回答，而且包括其他条目，比如标签，用户得分，查看量，收藏量等。这些条目是对问逡逑题和回答的很好的补充，比如可以通过标签知道问题所属的主题范围有哪些，通过用户逡逑得分来了解对应问题或者回答的质量如何。逡逑Ｓｔａｃｋ邋Ｏｖｅｒｆｌｏｗ中积累了超过５００万个问题及其对应的多个回答。面对如此海量的逡逑问答对，开发者无法快速找到他们想要的信息【１６］。虽然Ｓｔａｃｋ邋Ｏｖｅｒｆｌｏｗ己经提供了相应逡逑的搜索机制，但是搜索方式仅依靠词法匹配，搜索结果并不理想。这样，开发者只能针逡逑对自己的情况提出相应的ＡＰＩ使用问题。当开发者提出问题后，他们只能寄希望于其他逡逑开发者尽快回答，进而解决自己的ＡＰＩ使用问题。生成最佳的回答通常比较困难，因此，逡逑提问者需要等待较长的时间
【学位授予单位】：大连理工大学
【学位级别】：博士
【学位授予年份】：2018
【分类号】：TP391.1;TP311.5

【相似文献】