SonarQube上代碼掃描報告效果圖

多模塊maven項目結構大概如下：

cfw-project            #父工程
       -module-One     #子工程（1）
             -src
                 -main
             -pom.xml
       -module-Two     #子工程（n）
             -src
                 -main
             -pom.xml
       -sonar-project.properties  #文件與子工程同級目錄

準備工作：

• 宿主機：centos7.5（192.168.1.107 localhost）
• 安裝Jenkins
  http://www.reibang.com/p/42e2771dcc94
  
• 安裝锭碳、漢化SonarQube(8+) + postgres
• 安裝sonar-scanner
• 編寫 sonar-project.properties文件
• 創(chuàng)建jenkins流水線工程，觸發(fā)構建勿璃，查看代碼掃描報告
  備注：
  （1）通過此文章擒抛，不需要在jenkins上安裝sonar插件 （SonarQube Scanner for Jenkins），即不需要在jenkins上配置SonarQube相關配置

1补疑、安裝歧沪、漢化SonarQube(8+) + postgres

編寫docker-compose.yml

mkdir -p /data/sonar   &&  cd /data/sonar
cat docker-compose.yml  #編寫docker-compose.yml

version: '3'
services: 
  postgres: 
    image: postgres    #基礎鏡像名字
    restart: always      #在容器退出時總是重啟容器
    container_name: sonarqube_postgres    #自定義sonarqube容器名字
    ports:
      - 5432:5432   #-宿主機端口:容器暴露端口 ； 即將容器暴露端口映射到宿主機上某個端口
    volumes:
      - /data/sonar/postgres/postgresql:/var/lib/postgresql    #將容器目錄文件映射到宿主機上
      - /data/sonar/postgres/data:/var/lib/postgresql/data
    environment:
      TZ: Asia/Shanghai    #指定容器時區(qū)
      POSTGRES_USER: sonar               #自定義postgres數(shù)據(jù)庫登錄用戶
      POSTGRES_PASSWORD: sonar    #自定義postgres數(shù)據(jù)庫登錄密碼
      POSTGRES_DB: sonar                    #自定義postgres數(shù)據(jù)庫 “庫”
    networks: 
      - sonar-network  #使用文件末定義的網(wǎng)絡模式
  sonarqube:
    image: sonarqube    #8.5.1 
    restart: always 
    container_name: sonarqube_master
    ports:
      - 9000:9000
    volumes:
      - /data/sonar/sonarqube/extensions:/opt/sonarqube/extensions
      - /data/sonar/sonarqube/logs:/opt/sonarqube/logs
      - /data/sonar/sonarqube/data:/opt/sonarqube/data
      - /data/sonar/sonarqube/conf:/opt/sonarqube/conf
    environment:
      SONARQUBE_JDBC_USERNAME: sonar    #指定postgres數(shù)據(jù)庫連接信息
      SONARQUBE_JDBC_PASSWORD: sonar
      SONARQUBE_JDBC_URL: jdbc:postgresql://postgres:5432/sonar
    depends_on:    #指定依賴某個服務 （本實例sonarqube依賴postgres）
      - postgres
    networks: 
      - sonar-network
networks:
  sonar-network:
    driver: bridge   #定義網(wǎng)絡模式為bridge (缺省值bridge; 支持bridge莲组，host诊胞，none，container四種類型)

運行

1锹杈、修改宿主機內核參數(shù)
echo "vm.max_map_count = 655360"  >> /etc/sysctl.conf
sysctl -p
2撵孤、賦權給sonarqube/data目錄下所有目錄、文件
mkdir -p  /data/sonar/sonarqube/data
chmod  -R 777 /data/sonar/sonarqube/data
3竭望、運行SonarQube(8+) + postgres
docker-compose  up -d   #啟動容器
docker ps #查看容器狀態(tài)

容器啟動成功

sonarqube-web.png

漢化

• 登錄后操作

• 找到“Chinese Pack”插件邪码，安裝并重啟sonarqube服務即可漢化成功

  
  
  
  

2、安裝sonar-scanner

• 由于jenkins服務我是用docker方式安裝（http://www.reibang.com/p/42e2771dcc94
  ）咬清，jenkins容器與宿主機環(huán)境隔離闭专，想要jenkins流水線引用sonar-scanner命令，那就把sonar-scanner掃描工具安裝到jenkins容器里面旧烧。

docker cp sonar-scanner-cli-3.2.0.1227-linux.zip  jenkins:/usr/local/    #將壓縮包復制到容器里（前提jenkins容器啟動成功）
docker exec -it jenkins /bin/bash                                        #進入jenkins容器
cd /usr/local
unzip sonar-scanner-cli-3.2.0.1227-linux.zip                             #解壓得到sonar-scanner-3.2.0.1227-linux
ln -s sonar-scanner-3.2.0.1227-linux/bin/sonar-scanner   /usr/sbin/sonar-scanner  #做軟鏈接
sonar-scanner -v    #jenkins容器終端可以直接使用sonar-scanner命令即為安裝影钉、配置成功

3、編寫 sonar-project.properties文件

sonar.projectKey=cfw-project   #自定義項目唯一標識
sonar.projectName=cfw-project  #自定義項目名字
sonar.sourceEncoding=UTF-8
sonar.projectVersion=v3.2    #自定義版本
sonar.ce.workerCount=1
sonar.language=java
sonar.forceAnalysis=true
sonar.ce.workerCount=1
sonar.java.binaries=target/classes
sonar.sources=src/main/java

sonar.host.url=http://192.168.1.107:9000              #指定SonarQube服務地址
sonar.login=88288b599e11b4d86a23ge6r85e81774619c2c8b  #SonarQube服務生成的登錄令牌
#sonar.login相當于登錄用戶 & 密碼
sonar.modules=module-One,module-Two    #多個子工程用逗號隔開
module-One.sonar.projectName=module-One  #子工程名字
module-Two.sonar.projectName=module-Two

SonarQube服務生成登錄令牌

4掘剪、創(chuàng)建jenkins流水線工程平委，觸發(fā)構建，查看代碼掃描報告

• 當前只有一個多模塊maven項目（cfw-project）夺谁，因為往后會有n個多模塊maven項目肆汹，所以創(chuàng)建jenkins流水線工程時使用“選擇參數(shù)”指定多模塊maven項目
  
  
  
  
  編寫聲明式Jenkinsfile

pipeline {
    agent any
    options {
        timestamps()    //設置在項目打印日志時帶上對應時間
        disableConcurrentBuilds()   //不允許同時執(zhí)行流水線，被用來防止同時訪問共享資源等
        timeout(time: 5, unit: 'MINUTES')   // 設置流水線運行超過n分鐘予权，Jenkins將中止流水線
        buildDiscarder(logRotator(numToKeepStr: '20'))   // 表示保留n次構建歷史
    }

    //gitlab  webhook觸發(fā)器
    //triggers{
    //   gitlab( triggerOnPush: true,                       //代碼有push動作就會觸發(fā)job
    //       triggerOnMergeRequest: true,                   //代碼有merge動作就會觸發(fā)job
    //        branchFilterType: "NameBasedFilter",          //只有符合條件的分支才會觸發(fā)構建 “ALL/NameBasedFilter/RegexBasedFilter”
    //        includeBranchesSpec: "${JOB_BASE_NAME}")      //基于branchFilterType值昂勉，輸入期望包括的分支的規(guī)則
    //}

    stages{
        stage('Print Message') {      //打印信息
            steps {
                echo '打印信息'
                echo "project: ${Project_name}"
                echo "workspace: ${WORKSPACE}"
                echo "branch: ${Branch_name}"           //gitlab分支名
                echo "build_id: ${BUILD_ID}"
           }
        }
        //此步驟在調試Jenkinsfile時可以注釋以便了解目錄結構
        stage('Delete Workspace') {         //清理工作目錄
            steps {
                echo "清理工作目錄: ${WORKSPACE}"
                deleteDir()     //表示刪除當前目錄(${WORKSPACE})下內容，通常用在構建完畢之后清空工作空間
            }
        }
        stage ('Checkout'){         //拉取代碼
            steps{
                echo '拉取代碼'
                script {
                    checkout([$class: 'GitSCM', branches: [[name: '${Branch_name}']], doGenerateSubmoduleConfigurations: false, extensions: [], submoduleCfg: [],
                        userRemoteConfigs: [[credentialsId: '7ff3778d-124f-40b1-a5e6-05db20a7e59e',     //gitlab登錄令牌扫腺，設置自行搜索方法
                        url: 'http://192.168.1.101/java/${Project_name}.git']]])    //gitlab項目clone地址
                }
            }
        }
        stage('Sonar-canner') {   //sonar-scanner代碼檢查
            steps {
                echo '代碼檢查'
                dir ('./') {       //指定工作目錄（默認為${WORKSPACE}）
                    script {
                        sh 'source /etc/profile && mvn clean package  -Dmaven.test.skip=true'
                        sh 'sonar-scanner'  //執(zhí)行命令開始掃描代碼(前提要maven編譯生成classes文件)
                    }
                }
            }
        }
        
    }
}

觸發(fā)構建流水線工程（代碼掃描報告自動上傳到SonarQube服務）