1. MyBatisPse 插件有什么用
MyBatisPse 插件的作用类似于 IntelliJ IDEA 中的 MybatisX 插件,安装后可以在 Mapper.java 和 Mapper.xml 文件中来回跳转
MyBatisPse 是 Eclipse 的一个插件,主要用于增强 MyBatis 开发体验。它的主要功能包括:
- SQL 语法高亮:在 MyBatis 的 XML 映射文件(如
Mapper.xml)中,自动高亮 SQL 语句,提高代码可读性 - 参数提示:在 MyBatis 的 Mapper 接口中,显示参数类型和返回类型,帮助快速理解方法签名
- 错误检查:实时检查 XML 文件中的语法错误(如未闭合的标签、错误的属性值),并在编辑器中标记问题
- 导航功能:在 Mapper 接口和 XML 文件之间快速跳转(例如,点击接口方法直接定位到对应的 SQL 语句)
2. 最新版本 Eclipse(Eclipse-2025-12-R)
2.1 在线安装
2.1.1 下载 MyBatisPse 插件
点击 Eclipse 菜单栏中的 Help 选项,找到 Install New Software 选项。
[图片]
点击 Add 按钮。
[图片]
Name 自行填写,Location 中输入 https://harawata.github.io/eclipse-site/ 网址。
mybatipse
https://harawata.github.io/eclipse-site/
[图片]
勾选 MyBatipse 插件后点击 Next 按钮。
[图片]
等待下载完成。
[图片]
点击 Next 按钮。
[图片]
同意协议后点击 Finish 按钮。
[图片]
安装时可能有几步操作需要我们授权确认。
[图片]
安装成功之后需要重启 Eclipse。
[图片]
2.1.2 Add Mybatis Nature
重启 Eclipse 后鼠标右键项目的根目录,点击 Configure 下的 Add Mybatis Nature 选项。
[图片]
按住 CTRL 键后将鼠标悬浮在 Mapper.java 文件的某个方法上,会出现 Open xxx in 选项,点击之后会跳转到具体的 Mapper.xml 文件。
[图片]
跳转到具体的 Mapper.xml 文件之后,Eclipse 默认不会以文本的方式打开 xml 文件,我们切换成 Source 模式。
[图片]
切换成 source 模式打开 xml 文件后,可以看到对应的 sql 语句自动被选中了。
[图片]
关于如何解决 Mapper.xml 文件报错的问题,请参考文本的 解决 Mapper.xml 文件中 sql 标签报错的问题 章节。
2.2 离线安装
2.2.1 下载 MyBatisPse 插件
先按照本文最新版本 Eclipse 的 在线安装 的教程完整走完一遍,在线安装成功之后分别打开 Eclipse 根目录下的 features 目录和 plugins 目录。
[图片]
在 features 目录下按照修改日期降序排列,找到 net.harawata.mybatipse.feature_1.3.0.202210300418 目录。
net.harawata.mybatipse.feature_1.3.0.202210300418
[图片]
在 plugins 目录下按照修改日期降序排列,找到 net.harawata.mybatipse_1.3.0.202210300418.jar 文件。
net.harawata.mybatipse_1.3.0.202210300418.jar
[图片]
2.2.2 拷贝文件到其它电脑上
- 将
net.harawata.mybatipse.feature_1.2.4.202006282327目录拷贝到 Eclipse 根目录的 features 目录中(拷贝时如果源目录和目标目录名字一样,会自动将源目录中的文件加到目标目录中) - 将
net.harawata.mybatipse_1.2.4.202006282327.jar文件拷贝到 Eclipse 根目录的 plugins 目录中
拷贝完成后记得重启 Eclipse。
2.2.3 Add Mybatis Nature
剩下的步骤与本文最新版本 Eclipse 在线安装的 Add Mybatis Nature 部分相同。
3. 历史版本 Eclipse(以 Eclipse-2020-03-R 为例)
3.1 在线安装
3.1.1 下载 MyBatisPse 插件
点击 Eclipse 菜单栏中的 Help 选项,找到 Install New Software 选项。
[图片]
点击 Add 按钮。
[图片]
Name 自行填写,Location 中输入 https://harawata.github.io/eclipse-site/ 网址。
mybatipse
https://harawata.github.io/eclipse-site/
[图片]
加载完成后我们取消勾选 Show only the latest versions of available software 选项。
[图片]
接着我们点开 MyBatipse 列表,找到最接近我们 Eclipse 发行日期的一个版本,例如 Eclipse 发行日期为 2020-03-R,就要找到 20203 日期之后的第一个出现版本,选中后点击 Next 按钮。
[图片]
点击 Next 按钮。
[图片]
同意协议后点击 Finish 按钮。
[图片]
安装时需要我们授权。
[图片]
安装完成后需要重启 Eclipse。
[图片]
3.1.2 Add Mybatis Nature
重启 Eclipse 后鼠标右键项目的根目录,点击 Configure 下的 Add Mybatis Nature 选项。
[图片]
按住 CTRL 键后将鼠标悬浮在 Mapper.java 文件的某个方法上,会出现 Open xxx in 选项,点击之后会跳转到具体的 Mapper.xml 文件。
[图片]
跳转到具体的 Mapper.xml 文件之后,Eclipse 默认不会以文本的方式打开 xml 文件,我们切换成 Source 模式。
[图片]
切换成 source 模式打开 xml 文件后,可以看到对应的 sql 语句自动被选中了。
[图片]
3.2 离线安装
3.2.1 下载 MyBatisPse 插件
先按照本文历史版本 Eclipse 的 在线安装 的教程完整走完一遍,在线安装成功之后分别打开 Eclipse 根目录下的 features 目录和 plugins 目录。
[图片]
在 features 目录下按照修改日期降序排列,找到 net.harawata.mybatipse.feature_1.2.4.202006282327 目录。
[图片]
在 plugins 目录下按照修改日期降序排列,找到 net.harawata.mybatipse_1.2.4.202006282327.jar 文件。
[图片]
3.2.2 拷贝文件到其它电脑上
- 将
net.harawata.mybatipse.feature_1.2.4.202006282327目录拷贝到 Eclipse 根目录的 features 目录中(拷贝时如果源目录和目标目录名字一样,会自动将源目录中的文件加到目标目录中) - 将
net.harawata.mybatipse_1.2.4.202006282327.jar文件拷贝到 Eclipse 根目录的 plugins 目录中
拷贝完成后记得重启 Eclipse。
3.2.3 Add Mybatis Nature
剩下的步骤与本文历史版本在线安装的 Add Mybatis Nature 部分相同。
4. 解决 Mapper.xml 文件中 sql 标签报错的问题
4.1 问题呈现(Element type 'select' must be declared. [MSG_ELEMENT_NOT_DECLARED])
可以看到 Mybatis 的 select 等 sql 标签都报错了,报错原因显示 select 等标签没有声明。
[图片]
其实这个报错是表象原因,我们滑到 Mapper.xml 文件的最开头,可以看到是 Eclipse 禁止下载外部的资源文件。
[图片]
我们只需要在 Eclipse 的设置中允许下载外部资源就可以了。
4.2 解决方法(开启 Download external resources like referenced DTD, XSD 选项)
点击 Eclipse 菜单栏中的 Help 选项,找到 Install New Software 选项。
[图片]
找到 XML (Wild Web Developer) 选项,开启 Download external resources like referenced DTD, XSD 选项,勾选后点击 Apply 按钮。
[图片]
如果勾选 Download external resources like referenced DTD, XSD 选项之后还是报错,可以重启 Eclipse。
[图片]
5. 调整 Java 文件和 XML 文件代码补全提示的触发条件
Eclipse 默认的代码补全触发条件不够智能,我们可以为不同类型的文件设置不同的触发条件。
在 Eclipse 的菜单栏中找到 Windows–>Preferences 选项。
[图片]
搜索 Content Assist 关键字。
Content Assist
5.1 Java 文件
[图片]
将以下内容粘贴分别粘贴到两个输入框中,点击 Apply 按钮。
.@(abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
[图片]
5.2 XML 文件
[图片]
将代码补全的延迟更改为 0 毫秒,并以下内容粘贴到 Prompt when these characters are inserted: 输入框中,点击 Apply 按钮。
<=:#{abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
[图片]
6. 完整的 MyBatisPse 插件使用手册
参考 MyBatisPse 文章。
https://github.com/mybatis/mybatipse?tab=readme-ov-file
[图片]


