记录docker 安装sonarqube和安装的一些坑

sonarqube

基于本地服务和mvn命令进行的代码分析，并将分析结果推送到sonar服务器中

一、Sonar可以从以下七个维度检测代码质量，而作为开发人员至少需要处理前5种代码质量问题。

1. 不遵循代码标准（Coding Standards Breach）

        sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具规范代码编写。

2. 潜在的缺陷（Bugs and Potential Bugs)

        sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具检 测出潜在的缺陷。

3. 糟糕的复杂度分布（Bad Distribution of Complexity）

        文件、类、方法等，如果复杂度过高将难以改变，这会使得开发人员 难以理解它们, 且如果没有自动化的单元测试，对于程序中的任何组件的改变都将可能导致需要全面的回归测试。

4. 重复（Duplications）

        显然程序中包含大量复制粘贴的代码是质量低下的，sonar可以展示 源码中重复严重的地方。

5. 注释不足或者过多（Not Enough or Too Many Comments）

        没有注释将使代码可读性变差，特别是当不可避免地出现人员变动 时，程序的可读性将大幅下降 而过多的注释又会使得开发人员将精力过多地花费在阅读注释上，亦违背初衷。

6. 缺乏单元测试（Lack of Unit Tests）

        sonar可以很方便地统计并展示单元测试覆盖率。

7. 糟糕的设计

        通过sonar可以找出循环，展示包与包、类与类之间的相互依赖关系，可以检测自定义的架构规则 通过sonar可以管理第三方的jar包，可以利用LCOM4检测单个任务规则的应用情况， 检测藕合。

下面通过以下介绍SonarQube的安装、使用说明。

二、为什么要选择sonarQube?

个人使用之后认为 : sonarQube的优势如下(相比于阿里编码规约这种市面上常见的类似软件)：

1. 更加优秀的图形化界面

基本上通过界面就可以对自己项目的代码状况一目了然

2. 可以查询出其它软件难以定位到的问题

比如 : 可能导致空指针异常的问题 (对象在进行使用前没有加空的判断)

       可能导致内存泄漏的问题, 在try catch 块里面,直接使用e.printStackTrace()将堆栈信息打印到内存的

       可能导致的漏洞 : 成员变量使用public定义的

       还有诸如 : 流等未关闭或者是非正常关闭都能够检测出来!

       功能非常强大!!

三. docker 安装sonarqube

docker pull postgres 拉取数据库

docker pull sonarqube 拉取sonarqube

启动postgres数据库创建sonar用户

docker run --name db -p 5432:5432 -e POSTGRES_USER=sonar -e POSTGRES_PASSWORD=sonar -d postgres

进入容器

docker exec -it db /bin/bash

进入命令行

psql -U sonar

create database sonar；创建sonar数据库

alter role sonar createdb;alter role sonar superuser;alter role sonar createrole;给sonar授权

alter database sonar owner to sonar；更改sonar数据库拥有者(这一步是必须的，否则会sonarqube会连接失败)

/p

exit退出

启动sonarqube 

docker run --name sq -e sonar.jdbc.password=sonar -e sonar.jdbc.username=sonar -e sonar.jdbc.url=jdbc:postgresql://postgres/sonar --link db:postgres -p 9000:9000 -d sonarqube

如果启动报vm.max_map_count错误的话是给elasticsearch分配的数量不够

进入配置文件最后一行添加配置

 vi  /etc/sysctl.conf

vm.max_map_count=262144

启动成功后登录ip:9000端口就可以访问了 默认账号密码:admin

四. 通过maven使用

输入maven命令:

mvn sonar:sonar \   -Dsonar.projectKey=test \   -Dsonar.host.url=http://172.16.1.83:9000 \   -Dsonar.login=4dd2e88ac9587b02c03edb8185f307a3e8dd1ccc

这个命令是sonarqube 帮我们生成的

完成后就可以在页面中看到了