8288分类目录 8288分类目录 8288分类目录
  当前位置：海洋目录网 » 站长资讯 » 站长资讯 » 文章详细 订阅RssFeed

如何让 Mybatis 自动生成代码，提升开发效率

来源：本站原创　浏览：68次　时间：2022-09-22

来源：cnblogs.com/homejim/p/9782403.html

  • 1，创建代码生成器
    • 1.1，创建Maven项目
    • 1.2，配置generator.xml
    • 1.3，配置pom.xml
    • 1.4，使用及测试
  • 2，XML配置详解
    • 2.1，优先
    • 2.2，官网没有的


在使用mybatis过程中，当手写JavaBean和XML写的越来越多的时候，就越来越容易出错。这种重复性的工作，我们当然不希望做那么多。

还好，mybatis为我们提供了强大的代码生成：MybatisGenerator。

通过简单的配置，我们就可以生成各种类型的实体类，Mapper接口，MapperXML文件，示例对象等。通过这些生成的文件，我们就可以方便的进行单表进行增删改查的操作。

以下的工具使用的都是IDEA

1，创建代码生成器1.1，创建Maven项目

1.1.1，菜单上选择新建项目

档案| 新增| 项目

1.1.2，选择命令行的Maven

由于我们Next只是创造一个普通的项目，此处点击即可。

1.1.3，输入GroupId和ArtifactId

在我的项目中

GroupId填com.homejim.mybatis

ArtifactId填mybatis生成器

点击下一步。

1.1.4，完成

通过以上步骤，一个普通的Maven项目就创造好了。

1.2，配置generator.xml

其实名字无所谓，只要跟下面的pom.xml文件中的对应上就好了。

<?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>

    <!-- 本地数据库驱动程序jar包的全路径 -->
    <classPathEntry location="C:\Users\\Administrator\\.m2\repository\\mysql\\mysql-connector-java\\8.0.12\\mysql-connector-java-8.0.12.jar"/>
    <context id="context" targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="false"/>
            <property name="suppressDate" value="true"/>
        </commentGenerator>

        <!-- 数据库的相关配置 -->
        <jdbcConnection
                driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/mybatis"
                userId="root"
                password="jim777"/>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 实体类生成的位置 -->
        <javaModelGenerator
                targetPackage="com.homejim.mybatis.entity"
                targetProject=".\src\main\java">
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- *Mapper.xml 文件的位置  sqlMapGenerator-->
        <sqlMapGenerator
                targetPackage="mybatis/mapper"
                targetProject=".\src\main\resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- Mapper 接口文件的位置 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.homejim.mybatis.mapper"
                             targetProject=".\src\main\java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- 相关表的配置 -->

        <table tableName="blog" />
    </context>
</generatorConfiguration>

需要改一些内容：

  • 本地数据库驱动程序jar包的全路径（必须要改）。
  • 数据库的相关配置（必须要改）
  • 相关表的配置（必须要改）
  • 实体类生成存放的位置。
  • MapperXML生成文件存放的位置。
  • Mapper连接放置的位置。

如果不知道怎么改，请看后面的配置详解。

1.3，配置pom.xml

在原基础上添加一些内容。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.homejim.mybatis</groupId>
    <artifactId>mybatis-generator</artifactId>
    <version>1.0-SNAPSHOT</version>
    <!--在原基础上添加 这些就好了-->
    <build>
        <finalName>mybatis-generator</finalName>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                   <!--此处需要注意， 文件与上面的文件匹配-->
                   <configurationFile>src/main/resources/generator.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <dependencies>
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>1.3.7</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>
    <!--到此结束-->
</project>

到此，mybatis-generator就可以使用啦。

1.4，使用及测试

1.4.1，打开Maven项目预览

在IDEA上，打开：

View | Tools | Windwos | Maven Projects

1.4.2，Maven项目中双击mybatis -generator

在右边此时可以看到Maven Projects了。找到mybatis-generator插件。

mybatis-generator | Plugins | mybatis-generator | mybatis-generator

1.4.3，双击运行

运行正确后，生成代码，得到如下的结构

2，XML配置详解

如此我们就可以通过更改generator.xml配置文件的方式进行生成的配置。

2.1，优先

推荐查看官方的文档。

英文不错的：

http://www.mybatis.org/generator/configreference/xmlconfig.html

中文翻译版：

http://mbg.cndocs.ml/index.html

2.2，官网没有的

2.2.1，属性标签

该标签在官网中只是说使用指定元素的属性，而怎么用没有详细的讲解。

2.2.1.1，分隔符相关

<property name="autoDelimitKeywords" value="true"/>
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>

以上的配置对应的是mysql，当数据库中的分区和数据库的关键字一样时，就会使用分隔符。

例如我们的数据列是delete，按以上的配置后，在它出现的地方，就变成delete。

2.2.1.2，编码

默认是使用当前的系统环境的编码，可以配置为GBK或UTF-8。

<property name="javaFileEncoding" value="UTF-8"/>

我想项目为UTF-8，如果指定生成GBK，则自动生成的中文就是乱码。

2.2.1.3，格式化

<!--格式化生成的 Java 代码-->
<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
<!--格式化生成的 XML-->
<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>

这些显然都是可以自定义实现的的。

2.2.2，插件标签

plugins 标签用作扩展或修改代码生成器生成的代码。

在生成的XML中，是没有<cache>这个标签的。该标签是配置缓存的。

如果我们想生成这个标签，那么可以plugins中进行配置。

<plugin type="org.mybatis.generator.plugins.CachePlugin" >
            <property name="cache_eviction" value="LRU"/>
</plugin>

例如你想生成的JavaBean中自我实现Serializable接口。

<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />

还能自定义插件。

这些插件都蛮有用的，感觉后续可以专门开一篇文章认为解。

2.2.3，commentGenerator标签

看名称，就知道是用来生成注释用的。

默认配置：

    <commentGenerator >
        <property name="suppressAllComments" value="false"/>
        <property name="suppressDate" value="false"/>
        <property name="addRemarkComments" value="false"/>
    </commentGenerator>
  • inhibitorAllComments：阻止生成注释，默认值是false。
  • inhibitorDate：阻止生成的注释包含默认，默认为false。
  • addRemarkComments：注释中添加数据库的注释，默认为false。

还有一个就是我们可以通过type属性指定我们自定义的注解实现类，生成我们自己想要的注解。

自定义的实现类需要实现org.mybatis.generator.api.CommentGenerator。

  推荐站点

  • At-lib分类目录At-lib分类目录

    At-lib网站分类目录汇集全国所有高质量网站，是中国权威的中文网站分类目录，给站长提供免费网址目录提交收录和推荐最新最全的优秀网站大全是名站导航之家

    www.at-lib.cn
  • 中国链接目录中国链接目录

    中国链接目录简称链接目录，是收录优秀网站和淘宝网店的网站分类目录，为您提供优质的网址导航服务，也是网店进行收录推广，站长免费推广网站、加快百度收录、增加友情链接和网站外链的平台。

    www.cnlink.org
  • 35目录网35目录网

    35目录免费收录各类优秀网站，全力打造互动式网站目录，提供网站分类目录检索，关键字搜索功能。欢迎您向35目录推荐、提交优秀网站。

    www.35mulu.com
  • 就要爱网站目录就要爱网站目录

    就要爱网站目录，按主题和类别列出网站。所有提交的网站都经过人工审查，确保质量和无垃圾邮件的结果。

    www.912219.com
  • 伍佰目录伍佰目录

    伍佰网站目录免费收录各类优秀网站，全力打造互动式网站目录，提供网站分类目录检索，关键字搜索功能。欢迎您向伍佰目录推荐、提交优秀网站。

    www.wbwb.net