Руководство по инструменту проверки качества кода SonarQube+Jenkins

SonarQube
Руководство по инструменту проверки качества кода SonarQube+Jenkins

предисловиеПишите небрежно, и все прочтут небрежно.В 2020 году стремитесь выиграть чемпионат сообщества по настольному теннису.

1 Обзор

SonarQube — это платформа с открытым исходным кодом для управления качеством исходного кода. SonarQube — это не только инструмент для создания отчетов о качестве данных, но и платформа для управления качеством кода. Поддерживает управление качеством кода и тестирование более чем 20 языков программирования, таких как java, C#, C/C++, PL/SQL, Cobol, JavaScript, Groovy и т. д. SonarQube может определять качество кода по следующим семи измерениям, и вам, как разработчику, необходимо иметь дело как минимум с первыми 5 видами проблем с качеством кода.

	(1) 不遵循代码标准
	SonarQube可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具规范代码编写。
	(2) 潜在的缺陷
	SonarQube可以通过PMD,CheckStyle,Findbugs等等代码规则检测工具检 测出潜在的缺陷。
	(3) 糟糕的复杂度分布
	文件、类、方法等,如果复杂度过高将难以改变,这会使得开发人员 难以理解它们, 且如果没有自动化的单元测试,对于程序中的任何组件的改变都将可能导致需要全面的回归测试。
	(4) 重复
	显然程序中包含大量复制粘贴的代码是质量低下的,SonarQube可以展示 源码中重复严重的地方。
	(5) 注释不足或者过多
	没有注释将使代码可读性变差,特别是当不可避免地出现人员变动时,程序的可读性将大幅下降 而过多的注释又会使得开发人员将精力过多地花费在阅读注释上,亦违背初衷。
	(6) 缺乏单元测试
	SonarQube可以很方便地统计并展示单元测试覆盖率。
	(7) 糟糕的设计
	通过SonarQube可以找出循环,展示包与包、类与类之间的相互依赖关系,可以检测自定义的架构规则 通过SonarQube可以管理第三方的jar包,可以利用LCOM4检测单个任务规则的应用情况, 检测耦合。

2 Базовая подготовка среды

В этой статье в основном описывается, как построить автоматическую сборку sonarQube и Jenkins в системе Windows.Пожалуйста, соберите все среды в соответствии с требованиями автора, чтобы каждый мог успешно выполнять сборку.

(1)Java环境1.8

(2)Maven环境

(3)mysql5.6—8.0,该版本之外的Mysql会报异常

(4)node.js

(5)SonarQube7.6

(6)Sonar-Scanner/Runner

(7)SVN代码管理仓库

(8)Jenkins平台

(9)navicat可视化数据库工具

(10)Jenkins Plugins笔者已经下载好了,主要是因为防止很多人插件下载失败,所有的安装文件都放在了网盘中,可自取

2.1 Установка среды Java

jdk1.8_64位

双击安装JDK,细节这里就不说了,大家不会的可以百度一下,安装完JDK之后需要配置一下环境变量

JAVA_HOME变量配置 PATHl路径配置

2.2 Установка Мавена

同样将maven的安装包解压到任意一个磁盘中,同样我们还是要配置一下Maven的环境变量

maven压缩包 maven_home maven_path

2.3 Установка MySQL

安装mysql之前肯定有很多人会问我,为什么要说这些基础的东西,要知道,还是有很多帅气的娃因为一些基础得环境或者版本问题搞得

== Череп должен быть поцарапан налысо! ==秃头

1. 将文件解压入到自定义的目录下【mysql如果安装不对得话,可以百度下对应版本得安装方式】
2. 配置my.ini,在根目录下创建文件my.ini,并在文件中输入以下代码
[mysqld]
basedir ="C:\mysql-6.3-winx64" --此处配置自己得mysql路径名
datadir ="C:\mysql-6.3-winx64\data" --此处配置自己得mysql路径名
port=3306
server_id =10
character-set-server=utf8

[client]
port=3306
default-character-set=utf8
[mysqld_safe]
timezone="CST"
[mysql]
default-character-set=utf8

3. 配置环境变量, 将mysql/bin加入到PATH中

4. 找到cmd.exe,以管理员身份运行(确保是管理员)

5. 首先将MySQL加入到Windows的服务中,输入命令:

	mysqld --install
	有时候没有卸载干净,会提示The service already exists!
	此时,以管理员身份运行cmd,
	-输入命令sc query mysql 查看名为mysql的服务
	-输入命令sc delete mysql,删除该mysql 
	-再执行mysqld --install 就能成功了

6. 开始初始化数据库,输入:
	-mysqld --initialize --console
  	-mysqld --initialize --user=root --console   (记住初使密码)

7.  输入:net start mysql,稍后你也可以用net stop mysql关闭MySQL服务。

8.  然后就可以进入MySQL了,输入:mysql -u root -p,此时会要求你输入密码

9. alter user user() identified by "123456";  改初使秘密

10. show databases ;展示数据库列表;

11. use mysql  使用数据库

12. show tables; 展示 表名

Здесь легко возникают две проблемы: 1. Установка mysql не удалась из-за проблемы со средой C++ в системе, вы можете использовать следующие инструменты.Инструмент завершения среды C++Установить среду C++; 2. После завершения установки базы данных необходимо сначала создать базу данных с именем ==sonar==, потому что при настройке sonarQube ниже нам необходимо инициализировать файл базы данных сонара. Если вы не встречались с ними, вы, ребята, все молодцы.赞 在这里插入图片描述

2.4 установка node.js

node.js也是必不可少得一环,如果没有node.js环境,无法对代码中得Css文件进行扫描。

Способ установки слишком много скринов, вот ссылкаруководство по установке node.js 在这里插入图片描述

2.5 Установка SonarQube7.6

--还是老套路,将压缩包解压后修改conf\sonar.properties-图1配置文件,我这里是本地
  环境,如果是服务器上得Mysql,只需要将localhost转换为对应得IP即可
  sonar.jdbc.url    数据库连接地址
  sonar.jdbc.username 登陆数据库得用户名
  sonar.jdbc.password 登陆数据库得密码
--SonarQube启动后默认得账号和密码都是admin
--关闭SonarQube服务-图3(需要关闭任务管理器中得所有java项目)
--重启sonarQube服务-图4
--再次访问http://localhost:9000,会稍微有点慢,因为要初始化数据库信息(user中可以查看到用户信息

sonar配置文件 sonarqube登陆 kill-java进程 重启sonarqube

2.6 Установка сканера Sonar-Scanner

Sonar-Scanner — это инструмент командной строки, который использует сервер SonarQube для анализа кода, который можно просто понять как клиент SonarQube. После завершения анализа Sonar-Scanner данные будут отправлены в базу данных SonarQube, чтобы их можно было отобразить в sonarQube для упрощения анализа.

--将下载好得sonar-Scanner解压编辑其中得conf\sonar-scanner.properties文件
  sonar.host.url为我们客户端得访问地址,账号密码都为admin
--配置环境变量(路径填写你的安装路径)
  新建变量,name=SONAR_SCANNER_HOME   value=D:\sonar\sonar-scanner-2.5
  打开path,输入 %SONAR_SCANNER_HOME%\bin;
  sonar-runner -version,出现以下信息,则表示环境变量设置成功

在这里插入图片描述 scanner版本号

2.7 Установка хранилища управления кодом SVN

到这里,相信又有很多娃儿说笔者太过于啰嗦了,为什么还不开始给老子扫描项目,莫急,磨刀不误砍柴功,当万事俱备得时候,扫描出BUG还不是分分钟得事情。
说到代码管理工具,首先想到得当然是git,gitlab,但是对于初学者来说Svn这种可视化得更适合,所有笔者这里选择了相对较为简单得Svn。
依然是跑到我给大家提供得工具库中下载下来先,然后解压,点击下面得而这个可爱得小图标,启动我们得Svn客户端,然后创建一个仓库,一直疯狂点击下一步就好了,就是这么得easy。

SVN

创建一个本地仓库

在这里插入图片描述 在这里插入图片描述

创建一个用户,用来提交我们得代码,然后在我们的文件夹下面创建一个文件夹来初始化我们的代码仓库Check Out,这里就不多啰嗦

Каждый может обратиться к Учебник по использованию SVN 在这里插入图片描述 在这里插入图片描述

2.8 Установка платформы Jenkins

Jenkins是一个开源软件项目,是基于Java开发的一种持续集成工具,用于监控持续重复的工作,旨在提供一个开放易用的软件平台,使软件的持续集成变成可能。
Jenkins功能包括:
1、持续的软件版本发布/测试项目。
2、监控外部调用执行的工作。
第一种启动方法,切换到jenkins.war存放的目录,输入如下命令:
$ java -jar jenkins.war
如果需要修改端口可以使用如下命令:
$ java -jar jenkins.jar--httpPort=8081
然后在浏览器中(推荐用火狐)输入localhost:8081,localhost可以是本机的ip,也可以是计算机名。就可以打开jenkins。
第二种方法是用tomcat打开
解压tomcat到某个目录,如/usr/local,进入tomcat下的/bin目录,启动tomcat
将jenkins.war文件放入tomcat下的webapps目录下,启动tomcat时,会自动在webapps目录下建立jenkins目录,在地址栏上需要输入localhost:8080/jenkins。
这里我们就是采用第二种方法来搭建Jenkins,因为我们是在windows上搭建得,所以只要把jenkins.war放到tomcat得wapapps下然后启动Tomcat就可以访问Jenkins了

Начало работы с Дженкинсом

Потому что много друзей вШаг загрузки плагина стоит на коленях, поэтому Бен Чонг также предоставляет вам загруженный плагин, который продается бесплатно, все в конце статьи, заберите его самостоятельно., просто разархивируйте плагин в домашнюю директорию .jenkins, замените плагины и перезапустите.在这里插入图片描述在这里插入图片描述 夸我На данный момент в основном все необходимые среды установлены, поэтому давайте начнем наше путешествие по сканированию.

3 Инструкция по применению

3.1 Используйте команду Sonar-scanner для анализа локальных проектов

1.进入E:\sonarqube-7.6\bin\windows-x86-64(你的sonarqube安装目录),
只要在项目工程目录下新建sonar-project.properties文件并配置如下图-1
2.点击StartSonar.bat启动sonar服务
3.进入项目所在得路径下执行sonar-scanner命令进行代码扫描-图2
4.运行最终结果显示EXECUTION SUCCESS即成功-图3
5.客户端查看代码扫描结果-图4

1 2 3 4 在这里插入图片描述

3.2 Скомпилированный проект maven, в целевом файле нет контента, но он все равно должен быть помечен

在这里插入图片描述

sonar-project.properties文件中的内容

在这里插入图片描述

之后在cmd下进入工程目录下运行:sonar-scanner

在这里插入图片描述

3.3 Компилированное проект Maven, используйте плагин анализатора Maven для анализа проекта

在maven的conf下的settings.xml下

在这里插入图片描述

在<profiles></profiles>节点中添加如下代码
<profile>
     <id>sonar</id>
     <activation>
          <activeByDefault>true</activeByDefault>
     </activation>
      <properties>
           <sonar.jdbc.url>jdbc:mysql://localhost:3306/sonar</sonar.jdbc.url>
           <sonar.jdbc.driver>com.mysql.jdbc.Driver</sonar.jdbc.driver>
           <sonar.jdbc.username>sonar</sonar.jdbc.username>
           <sonar.jdbc.password>sonar</sonar.jdbc.password>
            <!-- SERVER ON A REMOTE HOST -->
           <sonar.host.url>http://localhost:9000</sonar.host.url>
      </properties>
  </profile>

之后在cmd下进入工程目录下运行:mvn clean install sonar:sonar

在这里插入图片描述

3.4 Пошаговое руководство по коду JS, CSS и HTML

在这里插入图片描述

sonar-project.properties文件中的内容
sonar.projectKey=control
sonar.projectName=control
sonar.projectVersion=1.0
sonar.sources=src,WebContent
sonar.java.binaries=build\classes
sonar.sourceEncoding=UTF-8

之后在cmd下进入工程目录下运行:sonar-scanner

在这里插入图片描述

4. Jenkins интегрирует SVN+maven+tomcat+sonarqube+sonar-scanner

 jenkins推荐的插件安装中没有sonarqube的安装,需要到系统管理-插件管理-可选插件中搜索sonarqube,sonarqube插件名是sonarqube scanner for jenkins,直接安装,安装成功后在系统管理-系统设置下就可看到sonarqube servers,即可配置

4.1Дженкинс для конфигурации SonarQube

4.1.1.Установить соответствующий плагин в управлении системой - управление плагинами

在这里插入图片描述

4.1.2. Настройте серверы Sonarqube в системной администрировании - системные настройки

在这里插入图片描述

4.1.3 серверы sonarqube для получения токена пользователя

用户令牌

4.1.4 Установите сканер гидролокатора в управлении системой - глобальная конфигурация инструмента

sonar_scanner

4.1.5 Установите плагин nodeJS.Если вы его не установите, файл CSS не будет сканироваться.

在这里插入图片描述

4.1.6. Установите nodeJS в «Управлении системой» — настройка глобальных инструментов

此处的安装目录填写你node.js的所在路径

node.js

4.2 Проведите пошаговое руководство по коду проекта, отличного от maven, и создайте проект в свободном стиле.

4.2.1 Заполните информацию о конфигурации проекта

在这里插入图片描述

4.2.2 Установка объема сохранения и времени

在这里插入图片描述

4.2.3 Путь SVN и настройки учетной записи

在这里插入图片描述

若是用Git管理代码仓库的可以参考如下配置
这里是使用了Git来做源码管理,gitlab作为源码库 项目分支填写master

在这里插入图片描述

4.2.4 Установить опрос проекта, опрос каждые 5 минут

在这里插入图片描述

4.2.5 Проверьте среду nodeJS

在这里插入图片描述

4.2.6 Триггер сборки, среда сборки (пароль учетной записи сонара)

在这里插入图片描述

4.2.7 После сохранения выполните операцию «построить сейчас» над проектом, и вы сможете просмотреть анализ проекта в sonarqube.

在这里插入图片描述

4.3 Пошаговое руководство по коду проекта maven и сборка проекта maven

4.3.1 Заполните информацию о конфигурации проекта, установите объем сохранения и время сборки

在这里插入图片描述

4.3.2 Установите путь и учетную запись SVN

svn

4.3.3 Установить опрос проекта, опрос каждые 5 минут

4.3.4 Проверьте среду nodeJS

node.js

4.3.5 Триггер сборки, среда сборки (пароль учетной записи сонара)

在这里插入图片描述

4.3.6 Операция добавления военного пакета в операции после сборки

在这里插入图片描述

4.3.7 После сохранения выполните операцию «построить сейчас» над проектом, и вы сможете просмотреть анализ проекта в сонаркубе.

在这里插入图片描述

5 индикаторов, связанных с SonarQube Описание

5.1 Карта мозга индикатора SonarQube

在这里插入图片描述

5.2 Код клапана качества

代码质量的统计,可以帮助我们判断项目是否可以投入生产环境

在这里插入图片描述Клапан качества можно настроить в соответствии с фактическими требованиями проекта (конфигурация сонара по умолчанию).在这里插入图片描述

6. Заключение

Следующая статья: Как использовать Jenkins для создания DingTalk и уведомлений по электронной почте

Я надеюсь, что у вас, кто читает эту статью, новый год будет гладким, и вы сможете спешить к поставленным целям.在这里插入图片描述Вот приходит точка: Если вам это нравится, вы можете нажать на него. Сегодня эта статья действительно взяла меня более чем на 4 часа, и моя талия болит.

Все инструменты, использованные в этой статье, доступны на моем официальном аккаунте [Reply] [sonarqube] бесплатно.

Адрес ссылки CSDN:blog.CSDN.net/Roman Body And/AR… 在这里插入图片描述