Mybatis-SQL-Viewer技术文档

---

安装指南

IntelliJ IDEA 插件市场安装

1. 打开 IntelliJ IDEA。
2. 进入 设置/首选项 (Preferences on macOS, Settings on Windows/Linux)。
3. 导航至 Plugins。
4. 在搜索框中输入 "mybatis sql viewer"。
5. 点击搜索结果中的插件，然后选择 Install 进行安装。
6. 完成安装后重启IDEA。

手动安装

1. 访问项目 Releases 页面。
2. 下载最新的 .zip 文件。
3. 在IDEA中，同样进入 Plugins 设置，点击齿轮图标，选择 Install Plugin from Disk...。
4. 选择之前下载的 .zip 文件进行安装，并重启IDEA。

---

项目使用说明

前提条件

使用前需配置数据源，支持多数据源配置，通过插件界面进行创建、选择、删除及测试。

操作流程

非 MyBatis 模式

• 禁用 mybatis mode。
• 在 statement 标签页手写SQL。
• 直接进行语法校验、规约检查及SQL执行。

MyBatis 模式

• 启用 mybatis mode。
• 在Mapper接口或XML文件处点击sql图标，生成随机参数或自定义参数。
• 转换XML为真实SQL，进行详细检查和操作。

功能特性

• 数据源管理：通过插件界面对数据源进行管理。
• SQL校验：自动检查SQL语法和遵守《阿里巴巴Java开发手册》中的SQL规约。
• 执行与计划：查看SQL执行结果和执行计划。
• 压力测试：配置并发数和执行时间来测试SQL性能。
• SQL扫描：检查整个项目或特定文件的SQL，识别潜在的性能问题。

---

项目API使用文档

本插件主要是图形用户界面(GUI)驱动，不过，它内部提供了与IDEA交互的API，允许扩展和自定义。具体API细节并未明文列出，但开发者可以通过查看源码和IDEA插件开发文档了解如何利用其提供的事件与数据访问接口进行二次开发或集成。

---

项目安装方式

已涵盖于安装指南，包括通过市场安装和手动安装两种方法。

---

小结

Mybatis-SQL-Viewer插件简化了MyBatis中SQL的编写和测试过程，通过增强的开发体验和全面的SQL分析能力，它成为提升工作效率的重要工具。务必确保正确配置数据源以充分利用其全部功能，不论是进行常规的SQL编辑，还是进行详尽的性能评估，这款插件都是值得拥有的强大辅助。