ZoeyYoung / blog

博客
1 stars 0 forks source link

【安装/配置/使用】Sonar #6

Open ZoeyYoung opened 8 years ago

ZoeyYoung commented 8 years ago

文档:http://docs.sonarqube.org/display/SONAR/Documentation

Get Started in Two Minutes http://docs.sonarqube.org/display/SONAR/Get+Started+in+Two+Minutes

Sonar简介

Sonar是一个用于代码质量管理的开源平台,用于管理源代码的质量,可以从七个维度检测代码质量

通过插件形式,可以支持包括java,C#,C/C++,PL/SQL,Cobol,JavaScrip,Groovy等等二十几种编程语言的代码质量管理与检测

sonarQube能带来什么?

Developers' Seven Deadly Sins

  1. 糟糕的复杂度分布
  2. 重复
  3. 缺乏单元测试
  4. 没有代码标准
    • sonar可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具规范代码编写
  5. 没有足够的或者过多的注释
    • 没有注释将使代码可读性变差,特别是当不可避免地出现人员变动时,程序的可读性将大幅下降
    • 而过多的注释又会使得开发人员将精力过多地花费在阅读注释上,亦违背初衷
  6. 潜在的bug
  7. 糟糕的设计(原文Spaghetti Design,意大利面式设计)
    1. 通过sonar可以找出循环,展示包与包、类与类之间的相互依赖关系
    2. 可以检测自定义的架构规则
    3. 通过sonar可以管理第三方的jar包
    4. 可以利用LCOM4检测单个任务规则的应用情况
    5. 检测耦合
    6. 关于Spaghetti Design:http://docs.codehaus.org/display/SONAR/Spaghetti+Design

通过sonar可以有效检测以上在程序开发过程中的七大问题

SonarQube安装

预置条件

  1. 已安装JAVA环境
  2. 已安装有MySQL数据库(其它数据库也可以) [非必须]

下载地址:http://www.sonarqube.org/downloads/

下载SonarQube与SonarQube Runner

中文补丁包下载:http://docs.codehaus.org/display/SONAR/Chinese+Pack (有点旧)

1. 数据库配置【非必须】

进入数据库命令

# mysql -u root -p
mysql> CREATE DATABASE sonar CHARACTER SET utf8 COLLATE utf8_general_ci;
mysql> CREATE USER 'sonar' IDENTIFIED BY 'sonar';
mysql> GRANT ALL ON sonar.* TO 'sonar'@'%' IDENTIFIED BY 'sonar';
mysql> GRANT ALL ON sonar.* TO 'sonar'@'localhost' IDENTIFIED BY 'sonar';
mysql> FLUSH PRIVILEGES;

2. 安装sonar与sonar-runner

将下载的sonarqube-5.2.zip包解压至/etc/sonarqube

将下载的sonar-runner-dist-2.4.zip包解压至/etc/sonar-runner

添加SONAR_HOMESONAR_RUNNER_HOME环境变量,并将SONAR_RUNNER_HOME加入PATH

export SONAR_HOME=/etc/sonarqube
export SONAR_RUNNER_HOME=/etc/sonar-runner
export PATH=$PATH:$SONAR_HOME/bin/macosx-universal-64:$SONAR_RUNNER_HOME/bin

修改sonar配置文件

编辑_/conf/sonar.properties_文件,配置数据库设置,默认已经提供了各类数据库的支持

这里使用mysql,因此取消mysql模块的注释

#vi sonar.properties
sonar.jdbc.username:sonar  
sonar.jdbc.password:sonar  
sonar.jdbc.url:jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true  
# Optional properties
sonar.jdbc.driverClassName:com.mysql.jdbc.Driver  

修改sonar-runner的配置文件

切换至sonar-runner的安装目录下,修改sonar-runner.properties

根据实际使用数据库情况取消相应注释

#Configure here general information about the environment, such as SonarQube DB details for example  
#No information about specific project should appear here  
#----- Default SonarQube server  
sonar.host.url=http://localhost:9000  
#----- PostgreSQL  
#sonar.jdbc.url=jdbc:postgresql://localhost/sonar  
#----- MySQL  
sonar.jdbc.url=jdbc:mysql://localhost:3306/sonar?useUnicode=true&characterEncoding=utf8  
#----- Oracle  
#sonar.jdbc.url=jdbc:oracle:thin:@localhost/XE  
#----- Microsoft SQLServer
#sonar.jdbc.url=jdbc:jtds:sqlserver://localhost/sonar;SelectMethod=Cursor
#----- Global database settings
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
#----- Default source code encoding
sonar.sourceEncoding=UTF-8
#----- Security (when 'sonar.forceAuthentication' is set to 'true')
sonar.login=admin
sonar.password=admin

3.添加数据库驱动

除了Oracle数据库外,其它数据库驱动都默认已经提供了,且这些已添加的驱动是sonar唯一支持的,因此不需要修改

如果是Oracle数据库,需要复制JDBC驱动至_/extensions/jdbc-driver/oracle_目录

4.启动服务

(添加环境变量后可直接运行)

# sonar.sh start    启动服务
# sonar.sh stop    停止服务
# sonar.sh restart 重启服务

至此,sonar就安装好了

访问http:\localhost:9000即可

5.sonar中文补丁包安装

中文包安装

安装中文补丁包可以通过访问http:\localhost:9000,打开sonar后,进入更新中心安装

或者下载中文补丁包后,放到_SONARQUBE_HOME/extensions/plugins_目录,然后重启SonarQube服务

使用SonarQube Runner分析源码

预置条件

已安装SonarQube Runner且环境变量已配置,即sonar-runner命令可在任意目录下执行

1. 在项目源码的根目录下创建sonar-project.properties配置文件

以android项目为例:

sonar.projectKey=android-sonarqube-runner  
sonar.projectName=Simple Android project analyzed with the SonarQube Runner
sonar.projectVersion=1.0
sonar.sources=src
sonar.binaries=bin/classes
sonar.language=java
sonar.sourceEncoding=UTF-8
sonar.profile=Android Lint

注:要使用Android Lint

规则分析需要先访问http:\localhost:9000更新中心添加Android Lint插件,使其可以分析Android Lint规则

JavaScript

# Required metadata    
sonar.projectKey=org.sonarqube:javascript-simple-sq-scanner    
sonar.projectName=JavaScript :: Simple Project :: SonarQube Scanner    
sonar.projectVersion=1.0    
# Comma-separated paths to directories with sources (required)    
sonar.sources=src    
# Language    
sonar.language=js    
# Encoding of sources files    
sonar.sourceEncoding=UTF-8

注:需要添加JavaScript Lint插件 http://docs.sonarqube.org/display/PLUG/JavaScript+Plugin

2. 执行分析

切换到项目源码根目录,执行命令# sonar-runner

分析成功后访问http:\localhost:9000即可查看分析结果

不同参数的意思:

http://docs.codehaus.org/display/SONAR/Analysis+Parameters

不同项目的源码分析示例下载:

https://github.com/SonarSource/sonar-examples

与IDE关联

最后,当然了,得与IDE相关联,才能更方便地实时查看

以Eclipse为例,请见:http://docs.sonarqube.org/display/SONAR/SonarQube+in+Eclipse

结合intellij使用:https://github.com/sonar-intellij-plugin/sonar-intellij-plugin

附: