mybatis generator 自动生成sql

为什么使用?

就我个人使用mybatis的感觉,在做一些数据库操作的使用需要写一堆的判断,冗长的sql语句。我觉得一个程序员不应该这种重复的语句上花费太多的时间。
当然之前面试过程中,也被人问过mybatis自动生成sql。那时接触java不久,也不知道这类东西。结果被面试的人嗤之以鼻的笑了一下。这也促使我花了点时间了解一下。

优缺点

优点

省去了po。mapper,sql.xml这些文件的创建,编写。就是快。

缺点

功能比较单一,复杂业务逻辑下,还是要手动写。

使用方法

maven依赖

文件路径:{项目路径}/pom.xml

   <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <configuration>
                    <configurationFile>src/main/resources/mybatis-generator/generatorConfig.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>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.17</version>
                    </dependency>
                </dependencies>
        </plugin>

maven配置详解

  • configurationFile
  • verbose
  • overwrite

XML配置

文件路径:{项目路径}/src/main/resources/mybatis-generator/generatorConfig.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!--mybatis的代码生成器相关配置-->
<!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="jdbc.properties"/>

    <context id="myContext" targetRuntime="MyBatis3Simple"  defaultModelType="flat">
        <commentGenerator>
            <property name="suppressDate" value="false"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="${spring.datasource.driverClassName}"
                        connectionURL="${spring.datasource.url}"
                        userId="${spring.datasource.username}"
                        password="${spring.datasource.password}">
            <!--高版本的 mysql-connector-java 需要设置 nullCatalogMeansCurrent=true-->
            <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>

        <javaModelGenerator targetPackage="com.sz.blog.entity"
                            targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="mapping"
                         targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <javaClientGenerator targetPackage="com.sz.blog.mapper"
                             targetProject="src/main/java" type="XMLMAPPER">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <table tableName="blog_user" domainObjectName="User"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
            <!--<columnRenamingRule searchString="^D_"
                                replaceString=""/>-->
        </table>
    </context>
</generatorConfiguration>

xml配置详解

  • properties
    引入配置文件 ,resource="{文件名称}",url="{文件路径}",由于就在当前路径下,所以没有设置过url参数,不确定url具体效果,一般情况配置文件也都是放在一起的。所以没在过多研究url这个参数
    另外,resource的值我从yml配置文件去除,无法使用。所以单独建了一个jdbc.properties的配置文件。
   <properties resource="jdbc.properties"/>
  • context
    一个数据库一个context,并且context的字元素必须按照顺序给出。如果没按照顺序写入,系统会报错按照错误提示你也会乖乖按照顺序重新排列。
  1. property*,
  2. plugin*,
  3. commentGenerator?,
  4. jdbcConnection,
  5. javaTypeResolver?,
  6. javaModelGenerator,
  7. sqlMapGenerator?,
  8. javaClientGenerator?,
  9. table+
    如果执行过程中报错,将上述子元素都列出来了。那就乖乖根据这个顺序和你系统中的顺序一一对照一下。
  • commentGenerator
    suppressAllComments:true=不生成注释,false=生成注释。
    suppressDate:true=不包含时间戳,false=包含时间戳
    (由于我没有生成注释,即便我这里是false也不生效)
        <commentGenerator>
            <!-- 是否不生成注释 -->
            <property name="suppressAllComments" value="true"/>
            <!-- 不希望生成的注视中包含时间戳 -->
            <property name="suppressDate" value="false"/>
        </commentGenerator>
  • jdbcConnection
    这里主要数据库连接配置,上面在properties标签中引用配置文件,主要是在这里使用配置。参数按照字面不做过多讲解。
    nullCatalogMeansCurrent:我查了些资料说,在高版本mysql中,如果值为false(默认值)的情况下可能会出现串库的情况。

从mysql-connector-java 5.x 到 6.x,nullCatalogMeansCurrent属性由原来的默认true改为了false。
true 使用指定的数据库进行查询。优先取当前传入的数据库名,其次取当前链接的数据库名。
false 代表遍历当前链接下的所有数据库进行查询

      <jdbcConnection driverClass="${spring.datasource.driverClassName}"
                        connectionURL="${spring.datasource.url}"
                        userId="${spring.datasource.username}"
                        password="${spring.datasource.password}">
            <!--高版本的 mysql-connector-java 需要设置 nullCatalogMeansCurrent=true-->
            <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>
  • javaTypeResolver
    javaTypeResolver是配置JDBC与java的类型转换规则,或者你也可以不用配置,使用它默认的转换规则。就算配置也只能配置bigDecimal类型和时间类型的转换。
<javaTypeResolver>
    <!--是否使用 bigDecimal,默认false。
        false,把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer
        true,把JDBC DECIMAL 和 NUMERIC 类型解析为java.math.BigDecimal-->
    <property name="forceBigDecimals" value="true"/>
    <!--默认false
        false,将所有 JDBC 的时间类型解析为 java.util.Date
        true,将 JDBC 的时间类型按如下规则解析
            DATE                    -> java.time.LocalDate
            TIME                    -> java.time.LocalTime
            TIMESTAMP                   -> java.time.LocalDateTime
            TIME_WITH_TIMEZONE      -> java.time.OffsetTime
            TIMESTAMP_WITH_TIMEZONE -> java.time.OffsetDateTime
        -->
    <property name="useJSR310Types" value="true"/>
</javaTypeResolver>
  • javaModelGenerator
    配置po生成的包路径和项目路径,如下
        <javaModelGenerator targetPackage="com.sz.blog.entity"
                            targetProject="src/main/java">
            <!-- 是否让schema作为包的后缀,默认为false -->
            <property name="enableSubPackages" value="true"/>
          <!-- 是否针对string类型的字段在set方法中进行修剪,默认false -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
  • sqlMapGenerator
    配置生成Mapper.xml文件的生成路径。
  <sqlMapGenerator targetPackage="mapping"
                         targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
  • javaClientGenerator
    配置 XxxMapper.java 文件的生成目录

type参数配置

XMLMAPPER 会将接口的实现放在 mapper.xml中,也推荐这样配置。
ANNOTATEDMAPPER 接口的实现通过注解写在接口上面

 <javaClientGenerator targetPackage="com.sz.blog.mapper"
                             targetProject="src/main/java" type="XMLMAPPER">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
  • table
    一个表配置一个table,如果想生成多个表,需要配置多个table。

schema为数据库名,oracle需要配置,mysql不需要配置。
tableName为对应的数据库表名
domainObjectName 是要生成的实体类名(可以不指定).不配置时,它会按照帕斯卡命名法将表名转换成类名
enableXXXByExample 默认为 true, 为 true 会生成一个对应Example帮助类,帮助你进行条件查询,不想要可以设为false.(默认为true,但只有在targetRuntime="MyBatis3"时才生效)

        <table schema="" tableName="blog_user" domainObjectName="User"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
            <!--<columnRenamingRule searchString="^D_"
                                replaceString=""/>-->
        </table>

数据库配置文件(jdbc.properties)

文件路径:{项目路径}/src/main/resources/jdbc.properties

spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/blog?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
spring.datasource.driverClassName=com.mysql.cj.jdbc.Driver
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,509评论 6 504
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,806评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,875评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,441评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,488评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,365评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,190评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,062评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,500评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,706评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,834评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,559评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,167评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,779评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,912评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,958评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,779评论 2 354

推荐阅读更多精彩内容