MyBatis Generator 插件详解（idea下使用方法）

最新推荐文章于 2024-06-25 09:38:52 发布

nmmbwan

最新推荐文章于 2024-06-25 09:38:52 发布

阅读量5.2k

点赞数 2

本文链接：https://blog.csdn.net/nmmbwan/article/details/104424711

版权

MyBatis Generator（MBG）是MyBatis和iBATIS的代码生成器。可以生成简单CRUD操作的XML配置文件、Mapper文件(DAO接口)、实体类。实际开发中能够有效减少程序员的工作量，甚至不用程序员手动写sql。
它将为所有版本的MyBatis以及版本2.2.0之后的iBATIS版本生成代码。它将内省数据库表（或许多表），并将生成可用于访问表的工件。这减少了设置对象和配置文件以与数据库表交互的初始麻烦。MBG寻求对简单CRUD（创建，检索，更新，删除）的大部分数据库操作产生重大影响。您仍然需要为连接查询或存储过程手动编写SQL和对象代码。

MyBatis Generator将生成：

与表结构匹配的Java POJO。这可能包括：
    一个匹配表的主键的类（如果有主键）
    一个匹配表的非主键字段的类（BLOB字段除外）
    包含表的BLOB字段的类（如果表具有BLOB字段）
    用于启用动态选择，更新和删除的类

这些类之间存在适当的继承关系。请注意，生成器可以配置为生成不同类型的POJO层次结构 - 例如，如果您愿意，可以选择为每个表生成单个域对象。
MyBatis / iBATIS兼容的SQL Map XML文件。MBG在配置中的每个表上为简单的CRUD函数生成SQL。生成的SQL语句包括：
    插入
    按主键更新
    通过示例更新（使用动态where子句）
    按主键删除
    按示例删除（使用动态where子句）
    按主键选择
    按示例选择（使用动态where子句）
    以身作则

根据表的结构，这些语句有不同的变体（例如，如果表没有主键，则MBG不会通过主键功能生成更新）。
适当使用上述对象的Java客户端类。Java客户端类的生成是可选的。MBG将为MyBatis 3.x生成以下类型的Java客户端：
    适用于MyBatis 3.x映射器基础结构的映射器接口
MBG将为iBATIS 2.x生成以下类型的Java客户端：
    符合Spring框架的DAO
    仅使用iBATIS SQL映射API的DAO。这些DAO可以生成两种：通过构造函数或setter注入提供SqlMapClient。
    符合iBATIS DAO框架的DAO（iBATIS的可选部分，现在不推荐使用此框架，我们建议您使用Spring框架）

MyBatis生成器设计为在迭代开发环境中运行良好，并且可以作为Ant任务或Maven插件包含在连续构建环境中。迭代运行MBG时需要注意的重要事项包括：

如果存在与新生成的XML文件同名的现有文件，MBG将自动合并XML文件。MBG不会覆盖您对其生成的XML文件所做的任何自定义更改。您可以反复运行它，而不必担心会丢失对XML的自定义更改。MBG将替换先前运行中生成的任何XML元素。
MBG 不会合并Java文件，它可以覆盖现有文件或使用不同的唯一名称保存新生成的文件。如果对生成的Java文件进行更改并以迭代方式运行MBG，则必须手动合并更改。当作为Eclipse 插件运行时，MBG可以自动合并Java文件。

以上介绍转载自MyBatis Generator

mybatis-generator有多种用法：命令行、maven插件等。命令行方式通常要把相关jar包下载到本地，再使用java -jar 运行。方便起见，本文演示使用maven插件的方式。
练习项目地址：源码地址

新建一个Maven项目

点击完成。
pom文件引入mybatis-generator-maven-plugin

配置Mybatis Generator的依赖和插件，配置 maven中的pom.xml文件

```java
<build>
    <plugins>
        <!-- mybatis-generator自动生成代码插件 -->
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.5</version>
        </plugin>
    </plugins>
</build>

将插件需要的配置文件添加到resource目录下，并做配置

添加generator.properties文件，该文件配置数据库信息,在generatorConfig.xml使用

#generatorConfig Info
#maven文件的位置
generator.location=F:\\MavenHome\\repository\\mysql\\mysql-connector-java\\5.1.32\\mysql-connector-java-5.1.32.jar
#生成模型的包名和位置
generator.targetPackage=com.thly.user.generated
#tableName是数据库中的表名或视图
gererator.tableName=tb_user
#domainObjectName是实体类名
gererator.domainObjectName=UserInfo
jdbc.driver=com.mysql.jdbc.Driver
jdbc.host=jdbc:mysql://localhost:3306/ssmdemo
jdbc.userName=root
jdbc.passWord=123456
jdbc.initialSize=0
jdbc.maxActive=20
jdbc.maxIdle=20
jdbc.minIdle=1
jdbc.maxWait=1000

添加generatorConfig.xml：配置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>
    <!-- 引入配置文件 -->
    <properties resource="generator.properties"/>
    <!-- 数据库驱动包位置,路径请不要有中文-->
    <!-- <classPathEntry location="F:\\MavenHome\\repository\\mysql\\mysql-connector-java\\5.1.32\\mysql-connector-java-5.1.32.jar" /> -->
    <classPathEntry location="${generator.location}"/>
    <!-- 一个数据库一个context-->
    <context id="DB2Tables" targetRuntime="MyBatis3">
        <!-- 生成的pojo，将implements Serializable -->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>

        <!-- 注释 -->
        <commentGenerator>
            <property name="suppressAllComments" value="false"/><!-- 是否取消注释 -->
            <!-- <property name="suppressDate" value="true" />  是否生成注释代时间戳 -->
        </commentGenerator>

        <!-- 数据库链接URL、用户名、密码 -->
        <!-- <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/ssm" userId="root" password="123456"> -->
        <jdbcConnection driverClass="${jdbc.driver}" connectionURL="${jdbc.host}" userId="${jdbc.userName}"
                        password="${jdbc.passWord}">
        </jdbcConnection>

        <!-- 类型转换 -->
        <javaTypeResolver>
            <!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer true，把JDBC DECIMAL
                和 NUMERIC 类型解析为java.math.BigDecimal -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成model模型，设置对应的包名(targetPackage)和存放路径(targetProject)。targetProject可以指定具体的路径,如./src/main/java,也可以使用MAVEN来自动生成,这样生成的代码会在target/generatord-source目录下 -->
        <javaModelGenerator targetPackage="${generator.targetPackage}" targetProject="./src/main/java">
            <!-- 是否在当前路径下新加一层schema,eg：false路径com.oop.eksp.user.model 而true:com.oop.eksp.user.model.[schemaName] -->
            <property name="enableSubPackages" value="false"/>
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!--对应的mapper.xml文件 -->
        <sqlMapGenerator targetPackage="${generator.targetPackage}" targetProject="./src/main/java">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <!-- 对应的Mapper接口类文件 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="${generator.targetPackage}"
                             targetProject="./src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <!-- 列出要生成代码的所有表，这里配置的是不生成Example文件 -->
        <!-- schema即为数据库名tableName为对应的数据库表 domainObjectName是要生成的实体类 enable*ByExample是否生成 example类   -->
        <table tableName="${gererator.tableName}" domainObjectName="${gererator.domainObjectName}"
               schema="${gererator.schema}"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
            <!-- 忽略列，不生成bean 字段
            <ignoreColumn column="FRED" />-->
            <!-- 指定列的java数据类型
            <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" />  -->
            <!-- 用于指定生成实体类时是否使用实际的列名作为实体类的属性名。false是 Camel Case风格-->
            <property name="useActualColumnNames" value="false"/>
        </table>
    </context>
</generatorConfiguration>

运行generator插件（本文使用mysql数据，数据测试代码在本文最后）
方法1：直接找到mybatis-generator的插件，点击运行。

如果在mavn中没有找到该插件，刷新一下即可。
方法2：在运行配置里面添加maven命令

添加命令：
mybatis-generator:generate -e

点击确定，然后运行即可
运行结果
查看生成的文件

准备数据工作

创建数据库：

CREATE DATABASE ssmdemo;

创建表：

 DROP TABLE IF EXISTS tb_user;
    CREATE TABLE tb_user (
	id int(32) NOT NULL AUTO_INCREMENT,
	user_name varchar(32) DEFAULT NULL,
    password varchar(32) DEFAULT NULL,
    name varchar(32) DEFAULT NULL,
    age int(10) DEFAULT NULL,
    sex int(2) DEFAULT NULL,
    birthday date DEFAULT NULL,
    created datetime DEFAULT NULL,
    updated datetime DEFAULT NULL,
    PRIMARY KEY (id)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

插入数据：

INSERT INTO ssmdemo.tb_user (id,user_name, password, name, age, sex, birthday, created, updated) VALUES (1,'zpc', '123456', '鹏程', '22', '1', '1990-09-02', sysdate(), sysdate());
INSERT INTO ssmdemo.tb_user (id,user_name, password, name, age, sex, birthday, created, updated) VALUES (2,'hj', '123456', '静静', '22', '1', '1993-09-05', sysdate(), sysdate());

参考链接mybait教程

nmmbwan

关注

2
点赞
踩
10

收藏

觉得还不错? 一键收藏
0
评论
MyBatis Generator 插件详解（idea下使用方法）

MyBatis Generator（MBG）是MyBatis 和iBATIS的代码生成器。可以生成简单CRUD操作的XML配置文件、Mapper文件(DAO接口)、实体类。实际开发中能够有效减少程序员的工作量，甚至不用程序员手动写sql。mybatis-generator有多种用法：命令行、maven插件等。命令行方式通常要把相关jar包下载到本地，再使用java -jar 运行。方便起见，本...
复制链接

扫一扫