MyBatis Generator 插件使用教程

MyBatis Generator 插件使用教程

mybatis-generator-pluginMybatis Generator 代码生成插件拓展，增加：查询单条数据插件（SelectOneByExamplePlugin）、MySQL分页插件（LimitPlugin）、数据Model链式构建插件（ModelBuilderPlugin）、Example Criteria 增强插件（ExampleEnhancedPlugin）、Example 目标包修改插件（ExampleTargetPlugin）、批量插入插件（BatchInsertPlugin）、逻辑删除插件（LogicalDeletePlugin）、数据Model属性对应Column获取插件（ModelColumnPlugin）、存在即更新（UpsertPlugin）、Selective选择插入更新增强插件（SelectiveEnhancedPlugin）、Table增加前缀插件（TableSuffixPlugin）、自定义注释插件（CommentPlugin）、增量插件（IncrementsPlugin）、查询结果选择性返回插件（SelectSelectivePlugin）、乐观锁插件（OptimisticLockerPlugin）、LombokPlugin等拓展。项目地址:https://gitcode.com/gh_mirrors/my/mybatis-generator-plugin

1. 项目的目录结构及介绍

MyBatis Generator 插件的目录结构如下：

mybatis-generator-plugin/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── itfsw/
│   │   │           └── mybatis/
│   │   │               └── generator/
│   │   │                   └── plugins/
│   │   │                       ├── ExampleTargetPlugin.java
│   │   │                       └── ...
│   │   └── resources/
│   │       └── mybatis-generator-config.xml
├── README.md
├── LICENSE
└── pom.xml

目录结构介绍

• src/main/java/：包含插件的主要源代码。
  • com/itfsw/mybatis/generator/plugins/：插件的具体实现类。
• src/main/resources/：包含配置文件。
  • mybatis-generator-config.xml：MyBatis Generator 的配置文件。
• README.md：项目说明文档。
• LICENSE：项目许可证。
• pom.xml：Maven 项目配置文件。

2. 项目的启动文件介绍

MyBatis Generator 插件的启动文件主要是 ExampleTargetPlugin.java，位于 src/main/java/com/itfsw/mybatis/generator/plugins/ 目录下。

ExampleTargetPlugin.java

该文件是插件的核心实现类，主要功能是将 Example 类独立到一个新包下，方便查看和管理。

package com.itfsw.mybatis.generator.plugins;

import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.api.dom.java.TopLevelClass;

import java.util.List;

public class ExampleTargetPlugin extends PluginAdapter {
    @Override
    public boolean validate(List<String> warnings) {
        return true;
    }

    @Override
    public boolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) {
        String targetPackage = properties.getProperty("targetPackage");
        if (targetPackage != null && targetPackage.length() > 0) {
            topLevelClass.setPackageName(targetPackage);
        }
        return true;
    }
}

3. 项目的配置文件介绍

MyBatis Generator 插件的配置文件是 mybatis-generator-config.xml，位于 src/main/resources/ 目录下。

mybatis-generator-config.xml

该文件包含了 MyBatis Generator 的基本配置和插件配置。

<?xml version="1.0" encoding="UTF-8"?>
<!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">
        <plugin type="com.itfsw.mybatis.generator.plugins.ExampleTargetPlugin">
            <property name="targetPackage" value="com.example.mybatis.example"/>
        </plugin>

        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mydb"
                        userId="root"
                        password="root">
        </jdbcConnection>

        <javaModelGenerator targetPackage="com.example.mybatis.model" targetProject="src/main/java"/>

        <sqlMapGenerator targetPackage="com.example.mybatis.mapper" targetProject="src/main/resources"/>

        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mybatis.mapper" targetProject="src/main/java"/>

        <table tableName="user" domainObjectName="User"/>
    </context>
</generatorConfiguration

mybatis-generator-pluginMybatis Generator 代码生成插件拓展，增加：查询单条数据插件（SelectOneByExamplePlugin）、MySQL分页插件（LimitPlugin）、数据Model链式构建插件（ModelBuilderPlugin）、Example Criteria 增强插件（ExampleEnhancedPlugin）、Example 目标包修改插件（ExampleTargetPlugin）、批量插入插件（BatchInsertPlugin）、逻辑删除插件（LogicalDeletePlugin）、数据Model属性对应Column获取插件（ModelColumnPlugin）、存在即更新（UpsertPlugin）、Selective选择插入更新增强插件（SelectiveEnhancedPlugin）、Table增加前缀插件（TableSuffixPlugin）、自定义注释插件（CommentPlugin）、增量插件（IncrementsPlugin）、查询结果选择性返回插件（SelectSelectivePlugin）、乐观锁插件（OptimisticLockerPlugin）、LombokPlugin等拓展。项目地址:https://gitcode.com/gh_mirrors/my/mybatis-generator-plugin