sonarQube java代码规则下载 sonarqube自定义规则开发

转载

技术极客之光 2024-08-02 14:53:57

文章标签 开发语言代码规范规则集 docker 离线 文章分类 Java 后端开发

背景

试想一下，团队每个人的代码风格千奇百怪，代码质量参差不齐，作为团队的管理者是不是会很头疼？如果有一个代码审查机制，让所有人遵循共同的规范，并且能起到监管的作用，这个审查标准还可以不断扩展优化，岂不爽哉？

经过多方研究，目前的代码扫描方法各有优劣。

1、SonarQube，目前主流的代码质量扫描平台。优势是支持插件扩展，功能强大；支持在线报告查看和审批；支持筛选规则；很多大厂比如阿里云效都有使用，上车不用担心翻车。缺点是无法在线扩展规则；大多数规则都是英文不太友好。

2、alibaba/p3c，也就是很多人熟知的阿里代码编写规范，本质上是利用PMD编写的代码风格扫描IDE插件。优点是全中文容易理解，规则扩展相对较容易（实际上这点有待确认，因为无论sonarqube还是pmd扩展规则都需要开发代码）；缺点是BUG扫描能力较弱，只能给出编码规范的建议；而且这个项目的规则相对较少只有五十几条，扫描能力不够强大。

经过一番考量，笔者认为应该将两者结合起来，p3c的规则用来规范代码风格，sonarQube的规则用来提高代码质量，两全其美。

SonarQube

首先要做的就是SonarQube的搭建。其实很简单，经过我一番摸索，只需要两行命令就可以搞定。

docker run -d --name postgres -e POSTGRES_PASSWORD=csf@123 \
    -e ALLOW_IP_RANGE=0.0.0.0/0 -v pgdata:/var/lib/postgresql/data \
    -p 55432:5432 postgres:13-alpine3.16

上面的代码是启动一个postgres数据库，开放55432端口是为了使用一些桌面应用方便管理，实际上不是必须。

docker run -d --name sonarqube \
    -p 9000:9000 \
    --link postgres \
    -e SONAR_JDBC_URL="jdbc:postgresql://postgres:5432/postgres?currentSchema=public" \
    -e SONAR_JDBC_USERNAME=postgres \
    -e SONAR_JDBC_PASSWORD=csf@123 \
    -v sonarqube_data:/opt/sonarqube/data \
    -v sonarqube_extensions:/opt/sonarqube/extensions \
    -v sonarqube_logs:/opt/sonarqube/logs \
    sonarqube:8.9.9-community

上面的代码是启动sonarqube服务器，通过--link的方式与postgres数据库交互，因此是走的内部端口5432而不是55432。

现在正常情况下就可以访问ip:9000进行sonarqube页面访问了，如下图所示。默认账户是admin/admin

sonarQube java代码规则下载 sonarqube自定义规则开发_规则集

但是真正要实现上面的效果，还有几件事情要做。

SonarQube汉化

这一步是可选项，不需要的可以跳过。首先你得确保SonarQube能够正常连接外网，然后打开Settings->marketplace，搜索Chinese Pack，点击安装。然后点击Restart Server重启服务，一切就OK了。但如果你的SonarQube是离线环境下，就会比较复杂一些。

离线环境的安装plugin的关键是获取到这个plugin对应的Jar包。因此可以在一个有网络的环境临时搭建一个SonarQube，然后按照上面的步骤将plugin先装上。

其次，在Linux服务器上查找sonarqube_extensions卷对应的挂载目录。

docker volume inspect sonarqube_extensions

#上面的命令会产生类似下面的结果，其中Mountpoint就是挂载目录
[
    {
        "CreatedAt": "2022-08-02T20:22:07+08:00",
        "Driver": "local",
        "Labels": null,
        "Mountpoint": "/var/lib/docker/volumes/sonarqube_extensions/_data",
        "Name": "sonarqube_extensions",
        "Options": null,
        "Scope": "local"
    }
]

然后得到/var/lib/docker/volumes/sonarqube_extensions/_data/plugins下的jar包，将其拷贝到离线环境中sonarqube_extensions卷下的plugins目录中，再Restart Server就可以了。