<think>我们正在讨论的是better
-mybatis-generator插件（可能是一个
MyBatisGenerator的增强版本或定制版本），但根据用户提供的引用内容，引用的都是标准
MyBatisGenerator（MBG）或对其的扩展。注意用户提到的是“better
-mybatis-generator”，它可能是社区中一个特定的插件，但引用中没有直接提到这个名称。因此，我们需要基于标准MBG的扩展机制来解释如何自定义，并假设用户可能需要的是对标准MBG进行增强的方法。由于用户引用中提到了几个关键点：1.
生成带有
分页的代码（引用[1]）2.自定义sqlxml文件（引用[2]）3.修改源代码实现自定义方法（引用[3]）4.
使用Maven插件（引用[4]）因此，我们可以将回答重点放在如何利用扩展机制（如插件）来增强
MyBatisGenerator，以满足
分页、自定义XML、自定义方法等需求。注意：better
-mybatis-generator可能是一个已经集成了这些功能的第三方插件，但如果没有具体的文档，我们可以按照标准MBG的扩展方式进行说明。同时，考虑到用户直接询问的是“better
-mybatis-generator插件的
使用教程”，我们可以先假设该插件是在标准MBG基础上进行了封装，那么配置方式可能与标准MBG
类似，然后提供一些通用的配置指南和示例。由于我们没有直接关于better
-mybatis-generator的文档，我们可以参考标准
MyBatisGenerator的配置，并融入用户引用中提到的自定义点，以展示如何实现这些功能。如果用户需要的是特定的better
-mybatis-generator插件，那么他可能需要去查找该插件的专门文档，但这里我们提供通用方法。回答结构：1.引入：说明better
-mybatis-generator可能是MBG的增强版，然后讲解通用配置方法。2.配置准备：创建配置文件
generatorConfig.xml，并引入插件（包括
分页插件等）。3.示例配置：展示如何配置better
-mybatis-generator（或标准MBG的增强配置）以实现
分页、自定义SQL等。4.运行方式：以Maven为例，说明如何运行插件。5.相关问题：
生成几个相关问题。注意：由于用户引用中提到了
分页和自定义方法，我们将重点展示如何通过插件实现这些功能。</think>
### Better
-Mybatis-Generator 插件
使用指南
Better
-Mybatis-Generator 是基于
MyBatis Generator 的增强插件，主要用于简化和扩展
MyBatis 代码
生成功能。以下是详细配置教程：
#### 一、Maven 依赖配置
在 `pom.xml` 中
添加插件依赖：
```xml
<build>
<plugins>
<plugin>
<groupId>com.
mybatis</groupId>
<artifactId>better
-mybatis-generator</artifactId>
<version>最新版本</version> <!
-- 例如1.4.0
-->
<dependencies>
<!
-- 数据库驱动
-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql
-connector
-java</artifactId>
<version>8.0.28</version>
</dependency>
<!
-- MyBatis核心包
-->
<dependency>
<groupId>org.
mybatis</groupId>
<artifactId>
mybatis</artifactId>
<version>3.5.9</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
```
#### 二、配置文件 `
generatorConfig.xml`
创建配置文件，包含以下关键配置：
```xml
<!DOCTYPE
generatorConfiguration
PUBLIC "
-//
mybatis.org//DTD
MyBatis Generator Configuration 1.0//EN"
"http://
mybatis.org/dtd/
mybatis-generator-config_1_0.dtd">
<
generatorConfiguration>
<!
-- 数据库连接配置
-->
<context id="mysql" targetRuntime="
MyBatis3">
<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/db_name"
userId="user"
password="pass"/>
<!
-- 实体
类生成位置
-->
<javaModel
Generator targetPackage="com.
example.model" targetProject="src/main/java"/>
<!
-- MAPPER接口位置
-->
<javaClient
Generator type="XMLMAPPER" targetPackage="com.
example.mapper" targetProject="src/main/java"/>
<!
-- 表配置示例（带
分页插件）
-->
<table tableName="user">
<generatedKey column="id" sqlStatement="MySql" identity="true"/>
<!
-- 启用
分页插件
-->
<plugin type="com.
mybatis.plugins.PaginationPlugin"/>
</table>
<!
-- 自定义XML格式插件
-->
<plugin type="com.
mybatis.plugins.CustomXmlFormatPlugin"/>
</context>
</
generatorConfiguration>
```
#### 三、自定义功能实现
1. **
分页功能实现**
插件自动
添加分页方法：
```java
// Mapper接口中
生成的方法
List<User> selectByPage(@Param("pageNum") int pageNum, @Param("pageSize") int pageSize);
```
2. **自定义XML格式**
通过 `CustomXmlFormatPlugin` 优化
生成的SQL映射文件：
```xml
<!
-- 生成的XML示例
-->
<select id="selectByObject" resultMap="BaseResultMap">
SELECT * FROM user
<where>
<if test="name != null">AND name = #{name}</if>
<if test="email != null">AND email = #{email}</if>
</where>
</select>
```
3. **对象参数查询**
自动
生成对象参数查询方法：
```java
// 根据引用[3]需求
生成的方法
List<User> selectByObject(User user);
```
#### 四、执行代码
生成
运行Maven命令：
```bash
mvn
mybatis-generator:generate
```
#### 五、高级配置技巧
1. **自定义返回
类型**
修改 `
generatorConfig.xml`
添加返回
类型配置：
```xml
<table tableName="product">
<columnOverride column="price" javaType="java.math.BigDecimal"/>
<!
-- 自定义返回List
-->
<generatedKey column="id" sqlStatement="MySql" identity="true"/>
</table>
```
2. **扩展原生方法**
通过继承 `org.
mybatis.
generator.api.PluginAdapter` 实现自定义插件：
```java
public class CustomMethodPlugin extends PluginAdapter {
@Override
public boolean clientGenerated(Interface interfaze, IntrospectedTable table) {
//
添加自定义方法
Method method = new Method("selectActiveRecords");
method.setReturnType(new FullyQualifiedJavaType("List<" + table.getBaseRecordType() + ">"));
interfaze.addMethod(method);
return true;
}
}
```
#### 六、最佳实践建议
1. **配置文件管理**
使用 `profiles` 管理多环境配置：
```xml
<context id="dev">
<jdbcConnection ... /> <!
-- 开发环境配置
-->
</context>
<context id="prod">
<jdbcConnection ... /> <!
-- 生产环境配置
-->
</context>
```
2. **避免覆盖自定义代码**
添加 `mergeable="true"` 属性防止覆盖手动修改：
```xml
<sqlMap
Generator targetPackage="mapper" mergeable="true"/>
```
[^1]:
MyBatis Generator 官方文档建议
使用插件机制扩展
分页功能
[^2]: 自定义XML插件可优化SQL映射文件结构和命名规范
[^3]: 通过修改源代码或继承机制可实现复杂返回
类型
[^4]: Maven依赖配置需确保包含必要的扩展插件包
本文详细介绍如何在MyBatis中实现分页查询，包括在Example类中添加startRow和pageSize变量，以及在XXXMapper.xml文件中修改selectByExample的<select>标签，加入limit子句以实现MySQL数据库的分页。
扫一扫
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
