sonarQube代码质检入门使用

本文介绍了如何在Windows环境下,使用Java、Maven和MySQL搭建sonarQube代码质量检查平台。详细步骤包括安装webServer、配置数据库、下载语言插件及分析代码。在分析过程中,可能会遇到一些错误,如缺少servlet相关依赖,需确保Maven项目中包含正确依赖。sonarQube能够帮助开发者发现代码中的潜在问题。

##sonarQube代码质检平台
##教程适用:windows+Java+Mysql+Maven

准备条件
  • 数据库:mysql(版本高于5.6)、sqlServer、oracle
安装webServer
  • 下载路径
  • 下载并解压后,编辑安装路径下的<install_directory>/conf/sonar.properties文件
    编辑数据库配置信息

    sonar.jdbc.username=userName
    sonar.jdbc.password=password
    sonar.jdbc.url=jdbc:mysql://localhost:3306/DbName?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance
    useUnicode=true&characterEncoding=utf8为必须参数(否则后面启动sonar报错)
    rewriteBatchedStatements=true&useConfigs=maxPerformance为推荐添加参数(启动日志中推荐)

:题主是想测试自己的项目代码,因此在数据库中新建一个用户(sonarque),再给sonarque赋予操作相应表的权限(mysql创建用户+赋权限过程略)

  • 添加JDBC驱动(除了oracle外,其他数据库驱动已经提供,此驱动只能有一个),oracle添加到 <install_directory>/extensions/jdbc-driver/oracle目录下
  • 启动webServer
    监听的默认端口是9090,路径为’/’,可在 <install_directory>/conf/sonar.properties中修改
    sonar.web.host=192.0.0.1
    sonar.web.port=80
    sonar.web.context=/sonar
下载对应语言插件

sonar-java插件地址
其他语言插件一样
将下载的插件放在extensions/plugins路径中

现在,就可以开启sonar啦

双击bin/windows-x86-64/StartSonar.bat,启动。
访问localhost:9000,出现如下图片,安装sonar成功
安装成功

下面,就是要分析自己的代码啦

题主使用maven管理依赖,因此下面只有Maven项目的步骤,其他请移步官网自行查看~~
先放官网使用maven的文档说明:分析maven项目

  • maven Version:3.x,2.x不适用

  • maven安装目录下的settins.xml

    org.sonarsource.scanner.maven sonar true

不错不错,看见的第一个bug就是之前一直想的一个毛病~~
跑题在此记录下:放在session中的对象一定要序列化~~

几个官网路径

-快速入门:2分钟入门

### SonarQube 使用教程 #### 安装配置 SonarQube 是一款开源平台,用于持续检测代码质量,支持多种编程语言。为了使用 SonarQube 进行代码质量管理,需完成如下安装配置: - **安装 Java JDK**:由于 SonarQube 是基于 Java 开发的应用程序,因此需要先安装适合版本的 Java Development Kit (JDK)[^1]。 - **安装 SonarQube Server**:下载对应操作系统的服务器包,并按照官方文档指导进行部署。对于初次使用者来说,推荐采用默认设置来简化过程。 - **安装 Sonar-scanner**:这是用来执行实际扫描工作的客户端工具。同样地,依据操作系统选择相应的发行版并依照说明文件完成安装。确保环境变量已正确设定以便于后续调用[^3]。 #### 修改配置文件 编辑 `${SonarqubeScanner}/conf/sonar-scanner.properties` 文件中的 `sonar.host.url=http://localhost:9000` 来指定目标 SonarQube 服务器地址;同时可以调整其他参数如源码编码方式 (`sonar.sourceEncoding=UTF-8`) 等以满足特定需求。 #### 汉化界面(可选) 如果希望将用户界面转换成中文,则可通过上传汉化的 jar 包至 sonar 安装目录下的 extensions/plugins 下实现国际化支持,在此之后记得重启服务使更改生效[^4]。 ```bash cp path/to/chinese-lang-plugin.jar $SONAR_HOME/extensions/plugins/ $SONAR_HOME/bin/linux-64/sonar.sh restart ``` #### 项目扫描 创建新项目的流程相对直观——登录 Web 控制台后依次填写基本信息、获取 Token 并保存好用于身份验证。接着利用命令行工具或构建脚本触发具体工程的静态分析工作流。 针对 Maven 构建体系而言,只需简单添加两个插件指令就能启动完整的编译加质检环节: ```xml <build> ... <plugins> <!-- 清理旧产物 --> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-clean-plugin</artifactId> <version>3.1.0</version> <executions> <execution> <id>auto-clean</id> <phase>initialize</phase> <goals><goal>clean</goal></goals> </execution> </executions> </plugin> <!-- 执行单元测试与打包 --> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>2.22.2</version> <configuration> <skipTests>true</skipTests> </configuration> </plugin> <!-- 发起 Sonar 分析请求 --> <plugin> <groupId>org.sonarsource.scanner.maven</groupId> <artifactId>sonar-maven-plugin</artifactId> <version>3.7.0.1746</version> <executions> <execution> <phase>verify</phase> <goals><goal>sonar</goal></goals> </execution> </executions> </plugin> </plugins> ... </build> ``` 最后通过终端发出 `mvn clean verify` 或者更简洁的形式 `mvn sonar:sonar` 即可开始一轮全面审查[^2]。 #### 查看报告 一旦上述步骤顺利完成,返回浏览器访问之前定义好的 SonarQube URL 地址,登陆账号进入仪表板页面就可以浏览详尽的质量评估详情了。这里不仅能看到各缺陷统计图表,还能深入探究每一处潜在风险点及其修复建议。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值