使用软件工程理论给代码打分的利器——Analizo

Analizo是一款可以给C、C++、Java以及C#代码进行评分的开源软件。我们可以使用它来分析代码，并得到如下指标的评分

• Afferent Connections per Class (ACC) metric
• Average Cyclomatic Complexity per Method (ACCM) metric
• Average Method Lines of Code (AMLOC) metric
• Average Number of Parameters (ANPM) metric
• Coupling Between Objects (CBO) metric
• Depth of Inheritance Tree (DIT) metric
• Lack of Cohesion of Methods (LCOM4) metric
• Lines of Code (LOC) metric
• Number of Attributes (NOA) metric
• Number of Children (NOC) metric
• Number of Methods (NOM) metric
• Number of Public Attributes (NPA) metric
• Number of Public Methods (NPM) metric
• Response for Class (RFC) metric
• Structural Complexity (SC) metric

这些评分是我们评价代码质量和可维护性的一种依据。
比如Average Cyclomatic Complexity per Method (ACCM) metric，即平均圈复杂度。这是1976年由Thomas J. McCabe, Sr. 提出来的一种代码复杂度的衡量标准。它的算法也很简单，即

V(G) = e – n + 2

其中e是边数量，n是节点数量。

比如上图显示，if else逻辑的圈复杂度是4-4+2=2;而switch case则是6-5+2=3。即上图中的switch case的复杂度要高些，这是因为它要处理的分支要多一些。更多的分支意味着逻辑复杂，也意味着程序写的复杂。
其他指标后面会展开说。我们先看看如何使用Analizo分析出这些指标。

环境准备

Analizo的安装依赖于perl以及其他相关组件，编译和安装的命令如下。

sudo apt update && sudo apt upgrade -y
sudo apt install perl
sudo apt install doxygen-doxyparse
sudo apt install cpanminus
sudo cpanm File::ShareDir::Install
sudo cpanm FindBin::libs
sudo cpanm App::Cmd::Setup
sudo cpanm Class::Inspector
sudo cpanm Env::Path
sudo cpanm Class::Accessor::Fast
sudo cpanm Graph
sudo cpanm Graph::Writer::Dot
sudo cpanm YAML::XS
sudo cpanm Statistics::Descriptive
sudo cpanm File::HomeDir
sudo cpanm CHI
sudo cpanm File::Copy::Recursive
git clone https://git.launchpad.net/ubuntu/+source/analizo
cd analizo
perl Makefile.PL
make
sudo make install

分析代码

我们还是分析《静态分析C语言生成函数调用关系的利器——cflow（二）》中的libevent源码。因为build文件夹是在编译过程中产生的，所以我们需要将其排除。（否则有很多中间文件）

analizo metrics ../../libevent/ --exclude ../../libevent/build > libevent_matrics.yaml

整理结果

环境准备

我们使用pandas解析上面产生的yaml文件，所以需要安装一些python包。env.sh是《管理Python虚拟环境的脚本》中介绍的python虚拟环境管理脚本。

source env.sh init
source env.sh enter
source env.sh install pyyaml
source env.sh install pandas
source env.sh install tabulate

将结果转换成markdown格式

import pandas as pd
import yaml
import sys

def yaml2md(yaml_file, md_file):
    li = []
    summary = None
    with open(yaml_file, 'r') as f:
        for g in yaml.safe_load_all(f):
            if "_module" in g:
                li.append(g)
            else:
                summary = pd.json_normalize(yaml.safe_load_all(yaml.safe_dump_all([g])))
    df = pd.json_normalize(yaml.safe_load_all(yaml.safe_dump_all(li)))
    df.set_index("_module", inplace=True)
    column_to_move = df.pop("_filename")
    df.insert(len(df.columns), "name", column_to_move)
    with open(md_file, 'w') as f:
        f.write(df.to_markdown())
    
    
if __name__ == "__main__":
    yaml_path = sys.argv[1]
    md_path = sys.argv[2]
    yaml2md(yaml_path, md_path)

结果展示

指标说明

Afferent Connections per Class (ACC) metric

类连接性指标。它表示类之间的关联程度。如果关联度越高，值越大，程序越复杂。
举个例子，如果Ci类访问了Cj类的一个方法或者属性，则 client(Ci, Cj)值为1；否则值为0。代码中所有类（N个）这样的关系值总和即ACC的值。
数据公式是：

client(Ci, Cj) = 1, if (Ci => Cj) and (Ci != Cj)
client(Ci, Cj) = 0, otherwise.
ACC(Cj) = (sum(client(Ci, Cj)), i = 1 to N)

它是基于这篇论文《Monitoramento de metricas de codigo-fonte em projetos de software livre》。
其他参考见

• https://manpages.ubuntu.com/manpages//noble/man3/Analizo::Metric::AfferentConnections.3pm.html
• https://metacpan.org/pod/Analizo::Metric::AfferentConnections

Average Cyclomatic Complexity per Method (ACCM) metric

每个函数的圈复杂度指标。如果值越大，代码越复杂。
它是计算代码中节点（区块）和边（跳转）之间关系的方法，即

V(G) = e – n + 2

其中e表示边的数量，n表示节点的数量。
比如下面的代码在逻辑上是相同的，但是写法不同

void foo(void) {
   
    if (a && b)
        x=1;
    else
        x=2;
}

void foo(void) {
   
    if (a)
        if (b) 
            x=1;
    else
        x=2;
 }

它们的流程如下

第一种写法的圈复杂度是：6（边）-6（节点）+2=2；第二种写法的圈复杂度是：7（边）-6（节点）+2=3。即第二种写法比第一种写法复杂度要高一些。我们从代码层面也能看出来如此。

它是基于论文《A Complexity Measure》。
其他参考资料

• https://www.geeksforgeeks.org/cyclomatic-complexity/
• https://www.perforce.com/blog/qac/what-cyclomatic-complexity
• https://en.wikipedia.org/wiki/Cyclomatic_complexity

Average Method Lines of Code (AMLOC) metric

方法的平均行数指标。如果这个值很大就不好，说明大量的逻辑集中在少数方法中，意味着方法逻辑可能比较臃肿，进而意味着复杂度很高。当然也不是越少越好，比如一行逻辑写一个方法。该指标鼓励大家写出更多短小、易于理解的方法，而不是内部极度臃肿的少数方法。

它是基于Paulo Roberto Miranda Meirelles的《Monitoring of source code metrics in open source projects》。

Average Number of Parameters (ANPM) metric

方法的平均参数个数指标。这个值最小是0，最大未知。但是如果值很大，意味着方法关联的参数很多，可能是因为这个方法内部逻辑没有拆解好，导致其包含太多可以独立出去的逻辑，进而需要更多参数来支持。所以这个值越小越好，越大意味着越复杂。
它是基于Paulo Roberto Miranda Meirelles的《Monitoring of source code metrics in open source projects》。

Coupling Between Objects (CBO) metric

对象之间的耦合 (CBO) 是耦合到特定类的类数量的计数，即一个类的方法调用另一个类的方法或访问另一个类的变量的情况。这些调用需要在两个方向上计数，因此类 A 的 CBO 是类 A 引用的类集合和引用类 A 的类集合的大小。由于这是一个集合 - 每个类仅计数一次，即使引用在两个方向上运行，即如果 A 引用 B 并且 B 引用 A，则 B 只计算一次。越大意味着耦合度越高。

比如上图中C的CBO就高，它关联的类也是最多的。

它是基于Shyam R. Chidamber和Chris F. Kemerer的论文《A metrics suite for object oriented design》。
其他参考资料

• https://sites.pitt.edu/~ckemerer/CK%20research%20papers/MetricForOOD_ChidamberKemerer94.pdf

Depth of Inheritance Tree (DIT) metric

最长继承树深度指标。它表示模块到最底层类的继承深度。越大代表越复杂。
数学公式是

DIT(m) = DIT(s(m)) + 1, ifc m != rootClass
DIT(m) = 0, otherwise.

比如上图中D的深度就是3，F的深度就是1。D就比F复杂。

它是基于Eduardo Kessler Piveta, Ana Moreira, Marcelo Soares Pimenta, Joao Araujo, Pedro Guerreiro和R. Tom Price的《An empirical study of aspect-oriented metrics》。
其他参考资料

• https://learn.microsoft.com/en-us/visualstudio/code-quality/code-metrics-depth-of-inheritance?view=vs-2022

Lack of Cohesion of Methods (LCOM4) metric

方法缺乏内聚性指标。在软件工程中，我们希望代码是高内聚低耦合。耦合指标我们可以通过上面的CBO来看，而内聚性则可以看LCOM4指标。该值越高，表示越缺乏内聚性，表示越不好。

该指标基于Martin Hitz和Behzad Montazeri的 《Measuring coupling and cohesion in object-oriented systems》。
更多资料参考

• http://ieeexplore.ieee.org/abstract/document/6178856/
• http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.686.2543
• https://objectscriptquality.com/docs/metrics/lack-cohesion-methods-lcom4
• https://blog.ndepend.com/lack-of-cohesion-methods/
• https://www.arisa.se/compendium/node116.html

Lines of Code (LOC) metric

不包括空行和注释的代码行数。可以很好理解：一般情况下，代码越长越复杂。
它是基于Taghi M. Khoshgoftaar和John C. Munson的《The lines of code metric as a predictor of program faults: a critical analysis》。

Number of Attributes (NOA) metric

类的属性数量指标。如果一个类的属性数量很多，预示着它可能拥有太多的功能，即功能冗余。应该考虑将其拆解成更多高内聚、功能简单的类。一般情况下，该值越大意味着越复杂。
它是基于Paulo Roberto Miranda Meirelles的《Monitoring of source code metrics in open source projects》。

Number of Children (NOC) metric

从属于某个类的直接子类的数量指标。它是一个类对设计和系统的潜在影响的指标。子级的数量越多，父级不正确抽象的可能性就越大，并且可能是滥用子类的情况。但是子级的数量越多，可重用性就越大，因为继承是重用的一种形式。如果一个类有大量子类，则可能需要对该类的方法进行更多测试，从而增加测试时间。所以这个值没有很强的预示性。

它是基于Linda H. Rosenberg和Lawrence E. Hyatt的《Software Quality Metrics for Object-Oriented Environments》。
更多参考资料

• https://www.itwissen.info/en/number-of-children-NOC-122384.html#gsc.tab=0

Number of Methods (NOM) metric

类的方法数指标。如果一个类的方法很多，可能预示着它有太多的功能，缺乏内聚性。最好将其拆解成功能独立的小型类。该指标越大表示越复杂。
它是基于Paulo Roberto Miranda Meirelles的《Monitoring of source code metrics in open source projects》。

Number of Public Attributes (NPA) metric

类的公有属性数指标。类的属性应该通过方法来访问，而不是直接暴露给外面使用。所以该值应该为0，否则就可能不是好的设计。
它是基于Paulo Roberto Miranda Meirelles的《Monitoring of source code metrics in open source projects》。

Number of Public Methods (NPM) metric

类的公有方法数指标。如果类的公有方法比较多，意味着它对外提供的服务很多。这个不符合高内聚的设计思想。最好将这样的类拆解成功能独立的类。所以这个值越小越好。
它是基于Paulo Roberto Miranda Meirelles的《Monitoring of source code metrics in open source projects》。

Response for Class (RFC) metric

类的响应指标。它是指一个类的方法数，加上在它内部调用的其他类的方法数。如果这个数越大，说明这个类的耦合性越大，或者功能太多。这个就是需要拆解的类。所以该值越大，表示越复杂。

class BirdTeam {
   
public:
	void Run() {
   
			Bird * bird = new Bird();
			bird->run();
		}
		
	void Fly() {
   
		Bird * bird = new Bird();
		bird->FlyUp();
		bird->FlyDown();
	}

比如上面BirdTeam这个类，它有2个方法，其中调用了Bird的类3的方法。这样它的RFC就是2+3=5。

它是基于Shyam R. Chidamber和Chris F. Kemerer的《A metrics suite for object oriented design》
其他参考资料

• https://www.cnblogs.com/cuihongyu3503319/archive/2006/12/29/606720.html

Structural Complexity (SC) metric

结构复杂度。CBO（耦合度指标）和LCOM4（缺乏内聚性）的乘积与该指标正相关。所以它越大表示越不好，因为可能内聚比较差，也可能耦合性太高，也可能两者都很差。
它是基于Paulo Roberto Miranda Meirelles的《Monitoring of source code metrics in open source projects》。

代码

https://github.com/f304646673/tools/tree/main/analizo

参考资料

• https://www.analizo.org/
• https://metacpan.org/dist/Analizo
• https://webhostinggeeks.com/howto/how-to-install-perl-on-ubuntu/
• https://baike.baidu.com/item/%E5%9C%88%E5%A4%8D%E6%9D%82%E5%BA%A6/828737
• https://zhuanlan.zhihu.com/p/139386961
• https://manpages.ubuntu.com/manpages//noble/man3/Analizo::Metric::AfferentConnections.3pm.html