README.zh.md · UI自动化学习小组/sonar-mybatis

[![Build Status](https://travis-ci.com/donhui/sonar-mybatis.svg?branch=master)](https://travis-ci.com/donhui/sonar-mybatis)
[![SonarCloud Status](https://sonarcloud.io/api/project_badges/measure?project=donhui_sonar-mybatis&metric=alert_status)](https://sonarcloud.io/dashboard?id=donhui_sonar-mybatis)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/donhui/sonar-mybatis)](https://github.com/donhui/sonar-mybatis/releases/)
[![GitHub All Releases](https://img.shields.io/github/downloads/donhui/sonar-mybatis/total)](https://github.com/donhui/sonar-mybatis/releases/)
[![HitCount](http://hits.dwyl.com/donhui/sonar-mybatis.svg)](http://hits.dwyl.com/donhui/sonar-mybatis)

[README 英文版](README.md)

## SonarQube MyBatis 插件
MyBatis SonarQube Plugin ：自定义规则用于检查 MyBatis Mapper XML 文件中的风险 SQL。

## 什么是风险 SQL?
风险 SQL 是指在 mybatis mapper 文件中，有一些动态 SQL，例如 `<if test=""></if>` 元素，
如果 Mapper XML 中的 SQL 语句中的所有参数为 null，那么 SQL 会有比较大的风险。

示例如下:

```
DELETE FROM table_name
WHERE 1=1
<if test="startTime != null">
    AND start_time <![CDATA[=]]> #{startTime}
</if>
<if test="endTime != null">
    AND end_time <![CDATA[=]]> #{endTime}
</if>
```

## MyBatis 规则
有7个内置的规则，select 语句有3个规则，update 以及 delete 语句分别有2个规则。

![mybatis-rules](images/mybatis-rules.png)

## 如何安装？
在SonarQube中安装插件有两种选择：
- 应用市场（Marketplace） - 自动从 SonarQube UI 安装插件。
- 手动安装 - 如果您的 SonarQube 实例无法访问互联网，请将使用此方法。

### 应用市场（Marketplace）
如果您能够访问互联网，并且您的用户具有全局权限“管理系统”的权限，则可以访问"配置 > 应用市场"。
- 通过搜索 `mybatis` 找到该插件
- 点击安装然后等待下载完成

下载完成后，将使用“重启”按钮重新启动 SonarQube 实例。

### 手动安装
该插件可以从 [github release](https://github.com/donhui/sonar-mybatis/releases/) 下载。

将下载的 jar 放到 `$SONARQUBE_HOME/extensions/plugins` 目录，并移除该插件的旧版本。

一旦完成，您将需要重新启动 SonarQube 服务器。

## 如何使用？
使用 maven 构建命令的示例如下：
```
mvn clean compile -U -Dmaven.test.skip=true -Dmaven.javadoc.skip=true sonar:sonar -Dsonar.host.url=http://127.0.0.1:9000/ -Dsonar.projectKey=demo -Dsonar.projectName=demo -Dsonar.sourceEncoding=UTF-8 -Dsonar.sources=. -Dsonar.inclusions=src/main/** -Dsonar.exclusions==src/main/webapp/**
```
要想分析 mybatis mapper 文件， `src/main/resources` 目录必须在 `sonar.sources` 中。

## 支持全局 Stmt ID 排除列表
对于一些特殊语句的问题，要想忽略它们，可以将附带 namespace 的 statement id 放入全局 stmt id 排除列表。

![stmt-id-exclude](images/stmt-id-exclude.png)

## 跳过 MyBatis 扫描
如果有时候想要跳过 MyBatis 扫描，你可以修改全局属性 `sonar.mybatis.skip` 为 `true` 或者在命令行中添加参数：
`-Dsonar.mybatis.skip=true` 。

## 贡献
可以在 https://github.com/donhui/sonar-mybatis/issues 提交 bug 和新功能请求。

或者可以提交 pull requests 用于修复 bug 或提交新功能，欢迎任何形式的贡献。

# Star 趋势图

[![Stargazers over time](https://starchart.cc/donhui/sonar-mybatis.svg)](https://starchart.cc/donhui/sonar-mybatis)

UI自动化学习小组/sonar-mybatis

简介

发行版

贡献者

近期动态

UI自动化学习小组/sonar-mybatis .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

UI自动化学习小组/sonar-mybatis