A Context-based Automated Approach for Method Name Consistency Checking and Suggestion笔记

绝地灬酷狼 2023-01-13 04:15 75阅读 0赞

# 引用 #

Li Y, Wang S, Nguyen T N. A Context-based Automated Approach for Method Name Consistency Checking and Suggestion\[J\]. arXiv preprint arXiv:2103.00269, 2021.

# 摘要 #

**背景**

软件项目中错误的方法名会让开发人员感到困惑，这可能会导致软件缺陷并影响代码的可理解性。

**本文方法概述**

DEEPNAME: 一种基于上下文的深度学习方法

*  用于检测方法名称的不一致
 *  为方法建议一个合适的名称

**出发点**

*  *Show Me Your Friends, I’ll Tell You Who You Are*

与最先进方法获取方法体信息源的比较

*  除了方法本体之外，还考虑了当前所研究的方法与其他方法的相互作用
    
     *  包括调用者和被调用者方法
     *  以及同一包围类中的兄弟方法

**本文方法介绍**

*  在上下文中提取程序实体名称中的子标记序列
 *  输入基于RNN的编码器-解码器
    
     *  以产生当前方法的表示

*  对RNN模型进行了修改
    
     *  将复制机制和新开发的组件（称为非复制机制）整合在一起
        
         *  强调某个not to be copied的子标记在当前生成的方法名中跟随当前子标记的可能性

**实验**

*  数据集大小：+14M方法
 *  结果
    
     *  对于一致性检查
        
         *  DEEPNAME在召回率、精度和F-score上分别相对提高了2.1%、19.6%和11.9%
     *  对于名称建议
        
         *  DEEPNAME在精度(1.8%- 30.5%)、召回(8.8%-46.1%)和F-score(5.2%-38.2%)方面比最新方法相对的有所提升

**评估其实用性**

*  在活跃的项目中检测出不一致的方法并建议新的方法名称
    
     *  在50个pull请求中
        
         *  有12个被合并到主分支中
         *  在30/50个案例中，团队成员一致认为建议的方法名比当前的名字更有意义

# Introduction #

**前人研究**

主要遵循两个方向

*  信息检索(IR)
    
     *  思想
        
         *  相似的方法应该有相似的名称
     *  方法
        
         *  一般遵循搜索策略
            
             *  因此，不能推荐一个在训练数据中未见的新方法名称

> 1.  L. Jiang, H. Liu, and H. Jiang, “Machine learning based automated method name recommendation: How far are we,” in Proceedings of the 34th ACM/IEEE International Conference on Automated Software Engineering (ASE’19). IEEE CS, 2019.
> 2.  K. Liu, D. Kim, T. F. Bissyande ́, T. Kim, K. Kim, A. Koyuncu, S. Kim, and Y. L. Traon, “Learning to spot and refactor inconsistent method names,” in Proceedings of the 41th International Conference on Software Engineering, ser. ICSE ’19. ACM, 2019, pp. 1–12.  
>     【觉得这篇论文虽然有用IR检索，但同时也用到了机器学习技术的】

*  机器学习(ML）
    
     *  特点
        
         *  可以克服IR方向的关键限制，能够生成一个新的名称

> 1.  M. Allamanis, E. T. Barr, C. Bird, and C. Sutton,“Suggesting accurate method and class names,” in Proceedings of the 10th Joint Meeting on Foundations of Software Engineering, ser. ESEC/FSE 2015. New York, NY, USA: Association for Computing Machinery, 2015, pp. 38–49. \[Online\]. Available: https: //doi.org/10.1145/2786805.2786849
> 2.  M. Allamanis, H. Peng, and C. A. Sutton, “A convolutional attention network for extreme summarization of source code,” in Proceedings of the 33nd International Conference on Machine Learning, ICML 2016, New York City, NY, USA, June 19-24, 2016, ser. JMLR Workshop and Conference Proceedings, M. Balcan and K. Q. Weinberger, Eds., vol. 48. JMLR.org, 2016, pp. 2091–2100. \[Online\]. Available: http://proceedings.mlr.press/v48/allamanis16.html
> 3.  U. Alon, M. Zilberstein, O. Levy, and E. Yahav,“Code2vec: Learning distributed representations of code,” Proceedings of the ACM on Programming Languages, vol. 3, no. POPL, pp. 40:1–40:29, Jan. 2019. \[Online\]. Available: http: //doi.acm.org/10.1145/3290353
> 4.  S. V. Nguyen, T. Le, and T. N. Nguyen, “Suggesting natural method names to check name consistencies,” in Proceedings of the 42th Inter- national Conference on Software Engineering, ser. ICSE ’20. ACM, 2020, pp. 1–12.

尽管这些方法取得了成功，但最先进的ML方法在处理内容不多的方法或与功能无关的实体名称时仍有局限性

**本文方法**

`we leverage a philosophy for this naming problem: “Show Me Your Friends, I’ll Tell You Who You Are”`

> 方法细节见下面

**本文贡献**

A. 表示和工具

*  提出一种新颖的方法
    
     *  使用内部和交互上下文进行方法名一致性检查和建议

B. 新颖的技术

*  在DEEPNAME中，
    
     *  修改了一个基于RNN的编码器-解码器，
     *  整合了一个新开发的机制，称为Non-copy机制
        
         *  帮助模型将正确的候选者推到顶部，提高顶部排名的准确性

C.实证评估

*  DEEPNAME在现实世界的项目和现场研究中比现有的方法更有用，更准确
 *  所有四个上下文相互补充，对高准确度贡献很大

# Concepts #

**01-Caller and Callee Methods**

A caller method (caller for short)

*  a method calling the current method

> caller: 调用当前方法的方法

A callee method (callee for short)

*  a method called within the body of the current method

> callee: 被调用的方法

**02-contexts(上下文)**

Internal Context

*  方法体中的内容
 *  接口中参数的类型和名称
 *  方法的返回类型

Interaction Context

*  callers的方法名称
 *  callers中的内容（例如方法体，接口，返回类型）
 *  callees的方法名称
 *  callees中的内容（例如方法体，接口，返回类型）

Sibling Context

*  与当前方法在同一个类中的其他方法（称作兄弟方法）名称
 *  兄弟方法中的内容（例如方法体，接口，返回类型）

Enclosing Context

*  当前方法的封装类的名称
 *  程序实体的名称、方法调用、字段访问、变量以及类中常量的名称

> 对于一个方法，获取的信息： 方法体，接口，返回类型和方法名（当前方法除外）  
> 对于一个类，获取的信息：类名，成员变量… …

# approach overview #

方法目的是在两种使用场景下提供帮助

*  项目在开发过程中，可以得到当前所考虑的方法的源代码以及调用者、被调用者、同级类和封装类的源代码
    
     *  可以判断其名称的一致性，如果认为当前名称不一致，则用它来建议一个替代名称
 *  当前方法的源代码已经写好了，但是，由于它的名字还没有，所以它的调用者方法是不可用的
    
     *  可以为该方法建议一个合适的名称

> 第一个应用场景，更像是对于一个项目中方法名称的重构

**方法步骤**

DEEPNAME主要有四个步骤  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70]

## 01-Context Building ##

目的：

*  收集上述四种contexts构建上下文特征

总体方式：

*  使用CamelCase和Hungarian(匈牙利)惯例将每个名称分解成一个sub-tokens序列
    
     *  例如，calculateFlowLayout被分解成calculate、Flow、Layout
 *  以其在源代码中的顺序将程序实体名称中的所有sub-tokens表示成序列

`对于internal context, sibling context and enclosing context`

*  直接从程序实体、返回类型和接口中的类型中提取名称
    
     *  这些名称被分解成sub-tokens，按照源代码中相同的外观顺序收集到序列中
 *  删除单个字符的琐碎（子）标记

`对于interaction context`

*  使用Soot建立一个调用图
    
     *  确定当前所研究方法的调用者和被调用者
        
         *  子标记序列的构建方式与前面的上下文相同
     *  从调用的方法中获取其对应的sub-tokens

`对于一致性检查，调用者和被调用者都会被考虑。但是，对于方法名的建议，如果调用者方法还不存在，我们只考虑被调用者方法。`

使用sub-tokens作为特征的合理之处在于名称的自然性（naturalness）

*  开发人员不会随机给出名称，他们使用与当前方法的任务相关的程序实体或方法调用/字段的名称

## 02-Context Representation Learning ##

目的：

*  把这些序列转换为模型的向量表示

方式：

`将所有语境的子标记序列视为单词的句子`

*  使用 *词嵌入模型*(GloVe) 将子标记的序列转换为向量
 *  将所有子标记的向量按照这些子标记在源码中出现的顺序排列

例如:

*  对于一个上下文特征序列Fi，我们有一个向量序列VFi=\[v1，v2，…，vn\]，其中vi是序列中一个子标记的GloVe向量

由于向量序列可能具有不同的长度，我们通过填充长度小于最大长度的序列的零向量来执行零填充。这使得向量的序列具有相同的长度。

结果，对于每一个上下文，我们都有一个对应于该上下文的子标记序列的表示向量序列

## 03-Context-based Method Representation Learning ##

目的：

*  为方法m制作一个包含所有上下文编码的表示

方式：

*  使用一个*编码器* 来学习上下文的特征编码
 *  使用*解码器* 将所有上下文的编码信息组合成方法m的表示，它具有所有上下文的集成

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 1]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 2]

### A. Context Feature Encoding ###

*  使用基于RNN的seq2seq编码器对上一步的所有上下文的向量集进行编码
    
     *  对于每个上下文，我们用一个门循环单元（GRU）进行编码
        
         *  使用多个GRU原因
            
             *  不同的上下文可能有不同的结构和信息类型
             *  有助于减少不同上下文之间的交叉影响

每个GRUi的输入是代表上下文的n个向量的序列VFi  
每个向量代表上下文中程序实体名称中的一个子标记

例如，在图4中

*  一个GRU用于交互上下文(interaction context)
    
     *  包括callee方法的名称、interface和界面中的sub-tokens。
        
         *  Calculate Flow Layout …
 *  另一个 GRU 用于内部上下文(internal context)
    
     *  包括当前方法的主体/interface
        
         *  Dimension Calculate Flow …

对于每一个时间步t，我们在这n个向量中输入一个向量Vt，我们得到一个隐藏状态向量ht作为这个时间步的输出。

通过收集每个时间步的所有输出，我们得到一个隐藏状态向量Hi = \[h1 ，…，hn \]的列表，这就是GRUi的输出

数学上，输入序列VFi= \[v1，v2，…，vn\]被编码器学习并转换为隐藏向量Hi。解码器用于将表示的隐藏向量Hi传输回目标序列Y = \[y1 ，y2 ，…，ym \]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 3]

*  公式1为编码器RNN
    
     *   h t h\_t ht为时间步t的隐藏状态；
     *  f代表RNN动态函数  
          
        
 *  公式2是针对解码器的
    
     *   h ′ t h′\_t h′t是解码器在时间步长t的隐藏状态；
     *  g代表RNN动态函数  
          
        
 *  公式3是用于预测
    
     *  s是可能性计算函数

将所有GRU的所有输出 H i s H\_is His放在一起，我们得到所有的隐藏状态向量 H = \[ H 1 ， H 2 ， . . . ， H i \] H=\[H\_1，H\_2，...，H\_i\] H=\[H1，H2，...，Hi\]。这是编码器的输出，用于attention层

因为并非上下文中的所有子标记都是同等重要的，所以我们的目标是对某些子标记进行强调。这种强调是通过注意力机制来学习的。  
从技术上讲，注意力层使用一个不断变化的上下文 C t C\_t Ct代替一个隐藏向量 H i H\_i Hi。 C t C\_t Ct被计算为编码器隐藏状态的加权和

![在这里插入图片描述][20210415203829531.png]  
其中r是用来表示注意力强度的函数，由多层神经网络近似

\#\#\# B. Context Feature Decoding

我们修改了解码器输出层GRU的操作，以整合我们新开发的非复制机制。它的操作与注意层有关。

首先，在GRU的每一个时间步长t，将之前的隐藏状态 h ′ t − 1 h′\_\{t-1\} h′t−1作为注意力层的输入，注意力层的输出将作为GRU在时间步长t的输入

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 2]  
在图4中，从注意力层在时间步长2的输出中得到的sub-token Preferred的向量作为GRU在时间步长3的输入。这样，在每个时间步骤进行解码的同时，强调了重要的sub-tokens

接下来，在解码器的输出层，我们还整合了两种机制的操作。CopyNet和Non-copy。

**1) copyNet**

介绍：

*  采用RNN seq2seq模型和注意力机制的复制机制

作用：

*  计算将输入的subtokens复制到输出的可能性

CopyNet的状态更新不仅考虑了词嵌入，还考虑了RNN编码器的隐藏状态集H=\[h1，h2，…，ht\]中对应的特定位置隐藏状态  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 4]

其中涉及到的一些公式，可以通过论文——Incorporating Copying Mechanism in Sequence-to-Sequence Learning或者一些博客了解一下

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 5]

[copyNet的一些介绍01][copyNet_01]  
[copyNet的一些介绍02][copyNet_02]

**2) Non-copy mechanism**

目的  
确定一个子令牌一定不会跟随当前子令牌的可能性

> 例如，如果(m-1)位置的sub-token get是一个已知的sub-token，而训练数据集中的sub-token Preferred跟随它，我们就计算Preferred不会跟随sub-token get的可能性。

这样的计算是基于我们对词汇上的词分布的统计分析

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 6]  
其中，  
 c o u n t y m ∣ y m − 1 count\_\{y\_m|y\_\{m-1\}\} countym∣ym−1： 在训练数据集中，sub-token m跟在（m-1）后面的数量  
 c o u n t y m − 1 count\_\{y\_\{m-1\}\} countym−1： 在训练数据集中，(m-1)处的sub-token出现次数

这个公式是用来计算单词分布的可能性，它在\[0,1\]之间

数值越大，表示这个sub-token在(m-1)处不跟随前一个sub-token的可能性越大

此外，因为我们有多个上下文特征作为输入，可以传递给复制模式，所以我们将所有的可能性加在一起，作为权重不同的复制模式的总可能性

With this, the copy-mode Formula 7 has now become  
![在这里插入图片描述][20210416210612593.png]

其中 W i W\_i Wi为不同类型上下文特征的可训练权重， W N O N W\_\{NON\} WNON为可训练权重，且总是小于零，I为上下文特征类型的总数。

**3)Method Representation Decoding**

最终得到每个时间步解码器的输出公式就是公式9；

sub-token的得分的可能性计算可以参照如下例子：

例如，w=Size，计算方式为：P(w) = P1(w,GEN) + P2(w,CPY) +P3(w,NON)。  
我们将选取当前时间步t中可能性得分最高的sub-token的表示向量，作为解码器在该时间步的输出

在得到所有时间步的预测向量 V t V\_t Vt后，我们将它们放在一起，按照原来的顺序得到一组向量，作为当前方法的向量集 V c u r V\_\{cur\} Vcur

## 04-Consistency Checking and Method Name Suggestion ##

DEEPNAME有两个独立的模型来完成两个任务

### 一致性检查 ###

*  将上一步得到的方法m的名称与现有的待检查方法名作为输入，并反馈给一个基于CNN的双通道模型，充当分类器，对方法名进行分类，以判断其是否一致

**具体步骤**

*  将encoder-decoder得到的向量 V c u r V\_\{cur\} Vcur视为矩阵 M c u r M\_\{cur\} Mcur
 *  应用同样的词嵌入步骤将当前方法的名称表示为向量集 V e x i s t V\_\{exist\} Vexist
    
     *  将该集合视为矩阵 M e x i s t M\_\{exist\} Mexist
 *  将上述两个矩阵结合形成二通道表示矩阵 M c l a s s i f i c a t i o n = \[ M c u r , M e x i s t \] M\_\{classification\} =\[M\_\{cur\},M\_\{exist\}\] Mclassification=\[Mcur,Mexist\]
 *  输入到双通道CNN模型中，通过softmax函数产生输出。
    
     *  输出值在\[0-1\]之间
        
         *  其中1代表一致性，0代表不一致性

### 方法名的建议 ###

*  将  V k V\_k Vk看作是 V c u r V\_\{cur\} Vcur中的sub-token
 *  从语料库中所有词汇的词典 d i c a l l dic\_\{all\} dicall中，我们找到与 V k V\_k Vk最接近的向量 V s k V\_\{sk\} Vsk
 *  并将 V s k V\_\{sk\} Vsk对应的sub-token sk作为 V k V\_k Vk的suggested sub-token
 *  最后，我们获得所有 V k V\_k Vk的sub-token序列。

所得序列被认为是所研究方法的建议名称

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70]: /images/20221022/8c8241ed077542aa86c983d73c17fcbc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 1]: /images/20221022/e22d6b487bea4448bcd88bc0119e385c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 2]: /images/20221022/e6e3ca563e6b43cfb9daae3cb6780454.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 3]: /images/20221022/f74707ddb7c042f6b782245dc3baac66.png
[20210415203829531.png]: /images/20221022/a43dc39354304b758baa6bed8bdeb759.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 4]: /images/20221022/86af523636b04ac3aaffe25cded64423.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 5]: /images/20221022/c7ba0cf4dc3c4e1081a2001bb9c2a55e.png
[copyNet_01]: https://zhuanlan.zhihu.com/p/102131182
[copyNet_02]: https://blog.csdn.net/xvshiting/article/details/82216112
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2MTU5MzAz_size_16_color_FFFFFF_t_70 6]: /images/20221022/796534426d4e4904a1d20b5e6b567a1c.png
[20210416210612593.png]: /images/20221022/2cbf2f3c763e4791a1e2cbded019646e.png