Java项目的热点分析

软件项目往往变得非常复杂且难以维护。 借助重构，可使代码相对易于理解。 但是，在实际项目中，似乎不可能在任何地方都具有很高的代码质量。

对于程序的热点，复杂性和变更率很高的位置，重构工作很可能具有最高的投资回报率。 这篇博客文章探讨了如何在Java项目中识别它们的方法。

一种pache Wicket was chosen as an example project. For its analysis, the open-source tools SonarCube, Code Charta, and Code Maat, and Python scripting are being used. The complexity is measured with SonarCube's Cognitive complexity metric and the change rate by the number of commits for a particular file.

Environment

The steps below are done in a DigitalOcean droplet, except of the final visualization.

• Ubuntu 18.04预先安装的Docker

Preparation

Download of required repositories

遵循以下方式需要以下存储库：

mkdir ~/src && cd ~/src
git clone https://github.com/apache/wicket.git
git clone https://github.com/adamtornhill/code-maat.git
git clone https://github.com/experimental-software/code-analytics.git

Tool setup

SonarQube服务器可以以此启动泊坞窗运行指令：

docker run --env ES_JAVA_OPTS="-Xms750m -Xmx750m" -d -p 9000:9000 -p 9092:9092 sonarqube

稍后我们还将需要几个系统工具：

apt update && apt install maven npm leiningen unzip -y

需要通过Node Package Manager安装Code Charta：

npm install codecharta-analysis -g
npm install codecharta-visualization -g

对于Code Mate，没有二进制分发版，我们需要自己进行编译：

cd ~/src/code-maat
lein uberjar
mkdir ~/bin
cp target/code-maat-1.1-SNAPSHOT-standalone.jar ~/bin/code-maat.jar

通过安装声纳扫描仪CLI工具，我们可以导入Java项目而无需更改其配置：

cd ~/bin

curl https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-3.3.0.1492-linux.zip \
    > sonar-scanner-cli-3.3.0.1492-linux.zip

unzip sonar-scanner-cli-3.3.0.1492-linux.zip 

PATH="$PATH:~/bin/sonar-scanner-3.3.0.1492-linux/bin"

Analysis

现在我们可以开始代码分析了。 第一步是将Java项目导入SonarCube：

cd ~/src/wicket

mvn install

sonar-scanner -Dsonar.projectKey=wicket \
    -Dsonar.source=. -Dsonar.java.binaries=. \
    -Dsonar.exclusions='**/*.js,**/*.xml'

curl http://localhost:9000/api/ce/task?id=AWrweUgHuDEJjgfjbZpz \
    | jq '.task.status'

接下来，我们将数据从SonarQube提取到JSON文件中，这是最终代码可视化的基础：

ccsh sonarimport http://localhost:9000 wicket > /tmp/sonar.json

每个文件的提交次数的计数将通过Code Maat完成，该代码将git日志作为输入：

cd ~/src/wicket

git log --since="1 year" --all --numstat --date=short \
    --pretty=format:'--%h--%ad--%aN' --no-renames \
    > /tmp/gitlog.txt

java -jar ~/bin/code-maat.jar --log /tmp/gitlog.txt \
    --version-control git2 --analysis revisions \
    > /tmp/codemaat-revisions.txt

然后我们可以丰富声纳文件，其中包含Code Maat提取的信息以及一些辅助脚本：

cd ~/src/code-analytics

python enrich_codecharta_data.py --sonar-json /tmp/sonar.json \
    --codemaat-csv /tmp/codemaat-revisions.txt

最后，我们可以启动Code Charta可视化，加载声纳在其GUI中，然后选择我们要可视化的指标。

codecharta-visualization

Result

from: https://dev.to//janux_de/hotspot-analysis-for-a-java-project-4ej6