如何自动生成Mybatis的Mapper文件详解

 更新时间:2019年07月28日 11:03:21   作者:上帝爱吃苹果  
这篇文章主要给大家介绍了关于如何自动生成Mybatis的Mapper文件的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用Mybatis具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧

前言

工作中使用mybatis时我们需要根据数据表字段创建pojo类、mapper文件以及dao类,并且需要配置它们之间的依赖关系,这样的工作很琐碎和重复,mybatis官方也发现了这个问题,因此给我们提供了mybatis generator工具来帮我们自动创建pojo类、mapper文件以及dao类并且会帮我们配置好它们的依赖关系。

实际上,最非常流行MyBatis-Plus中内置了代码生成器:采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码,支持模板引擎,有超多自定义配置等,在这主要介绍Mybatis的自动生成步骤。

1|1插件依赖

 <build>
  <plugins>
   <plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
   </plugin>
   <plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.5</version>
    <dependencies>
     <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>6.0.6</version>
     </dependency>
     <dependency>
      <groupId>org.mybatis.generator</groupId>
      <artifactId>mybatis-generator-core</artifactId>
      <version>1.3.5</version>
     </dependency>
    </dependencies>
    <!--<executions>-->
     <!--<execution>-->
      <!--<id>Generate MyBatis Artifacts</id>-->
      <!--<phase>package</phase>-->
      <!--<goals>-->
       <!--<goal>generate</goal>-->
      <!--</goals>-->
     <!--</execution>-->
    <!--</executions>-->
    <configuration>
     <!--允许移动生成的文件 -->
     <verbose>true</verbose>
     <!-- 是否覆盖 -->
     <overwrite>true</overwrite>
     <!-- 自动生成的配置 -->
     <configurationFile>
      src/main/resources/generatorConfig.xml
     </configurationFile>
    </configuration>
   </plugin>
  </plugins>
 </build>

注意:mysql-connector-java的版本问题,如果你的驱动是com.mysql.cj.jdbc.Driver,你就需要6.0.x的版本。如果是com.mysql.jdbc.Driver 则是5.1.x的版本。

1|2配置generatorConfig.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>
 <!--导入属性配置-->
 <properties resource="datasource.properties"></properties>

 <!-- context 是逆向工程的主要配置信息 -->
 <!-- id:name -->
 <!-- targetRuntime:设置生成的文件适用于那个 mybatis 版本 -->
 <context id="default" targetRuntime="MyBatis3">

  <!-- 生成的 Java 文件的编码 -->
  <property name="javaFileEncoding" value="UTF-8"/>

  <!-- optional,旨在创建class时,对注释进行控制 -->
  <commentGenerator>
   <property name="suppressDate" value="true"/>
   <property name="suppressAllComments" value="true"/>
  </commentGenerator>

  <!--jdbc的数据库连接 -->
  <jdbcConnection
    driverClass="${db.driverClassName}"
    connectionURL="${db.url}"
    userId="${db.username}"
    password="${db.password}">
  </jdbcConnection>

  <!-- 非必需,类型处理器,在数据库类型和java类型之间的转换控制-->
  <javaTypeResolver>
   <property name="forceBigDecimals" value="false"/>
  </javaTypeResolver>

  <!-- Model模型生成器,用来生成含有主键key的类,记录类 以及查询Example类
   targetPackage  指定生成的model生成所在的包名
   targetProject  指定在该项目下所在的路径
  -->
  <!--<javaModelGenerator targetPackage="com.mmall.pojo" targetProject=".\src\main\java">-->
  <javaModelGenerator targetPackage="com.ke.likehouse.model" targetProject="./src/main/java">
   <!-- 是否允许子包,即targetPackage.schemaName.tableName -->
   <property name="enableSubPackages" value="false"/>
   <!-- 是否对model添加 构造函数 -->
   <property name="constructorBased" value="true"/>
   <!-- 是否对类CHAR类型的列的数据进行trim操作 -->
   <property name="trimStrings" value="true"/>
   <!-- 建立的Model对象是否 不可改变 即生成的Model对象不会有 setter方法,只有构造方法 -->
   <property name="immutable" value="false"/>
  </javaModelGenerator>

  <!--mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 -->
  <!--<sqlMapGenerator targetPackage="mappers" targetProject=".\src\main\resources">-->
  <sqlMapGenerator targetPackage="mybatis/mappers" targetProject="./src/main/resources">
   <property name="enableSubPackages" value="false"/>
  </sqlMapGenerator>

  <!-- 客户端代码,生成易于使用的针对Model对象和XML配置文件 的代码
    type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
    type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
    type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口
  -->
  <!-- targetPackage:mapper接口dao生成的位置 -->
  <!--<javaClientGenerator type="XMLMAPPER" targetPackage="com.mmall.dao" targetProject=".\src\main\java">-->
  <javaClientGenerator type="XMLMAPPER" targetPackage="com.ke.likehouse.dao" targetProject="./src/main/java">
   <!-- enableSubPackages:是否让schema作为包的后缀 -->
   <property name="enableSubPackages" value="false" />
  </javaClientGenerator>

  <!--生成的表-->
  <!--domainObjectName:生成的domain类的名字,如果不设置,直接使用表名作为domain类的名字;可以设置为somepck.domainName,那么会自动把domainName类再放到somepck包里面;-->
  <!--enableInsert(默认true):指定是否生成insert语句;-->
  <!--enableSelectByPrimaryKey(默认true):指定是否生成按照主键查询对象的语句(就是getById或get);-->
  <!--enableSelectByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询语句;-->
  <!--enableUpdateByPrimaryKey(默认true):指定是否生成按照主键修改对象的语句(即update);-->
  <!--enableDeleteByPrimaryKey(默认true):指定是否生成按照主键删除对象的语句(即delete);-->
  <!--enableDeleteByExample(默认true):MyBatis3Simple为false,指定是否生成动态删除语句;-->
  <!--enableCountByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询总条数语句(用于分页的总条数查询);-->
  <!--enableUpdateByExample(默认true):MyBatis3Simple为false,指定是否生成动态修改语句(只修改对象中不为空的属性);-->
  <table tableName="agent" domainObjectName="Agent"
    enableCountByExample="false"
    enableUpdateByExample="false"
    enableDeleteByExample="false"
    enableSelectByExample="false"
    selectByExampleQueryId="false">
  </table>

  <!-- geelynote mybatis插件的搭建 -->
 </context>
</generatorConfiguration>

1|3提供datasource.properties

db.driverClassName = com.mysql.cj.jdbc.Driver
db.url = jdbc:mysql://localhost:3306/twelve?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
db.username = root
db.password = 你的密码

1|4执行maven命令

方式一:通过IDEA的MAVEN工具执行

方式二:通过MAVEN命令

配置命令:mybatis-generator:generate -e

然后Run就好了:

1|5可能出现的BUG

如果你复制粘贴了代码却出现稀奇古怪的BUG,很有可能是:

  • 你的maven的配置文件问题
  • 引用的mysql-connector-java与driverClassName版本不匹配
    如果你的驱动是com.mysql.cj.jdbc.Driver,你就需要6.x.x的版本。如果是com.mysql.jdbc.Driver 则是5.x.x的版本。

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对脚本之家的支持。

相关文章

  • Java 中的语法糖,真甜

    Java 中的语法糖,真甜

    语法糖(Syntactic sugar),也叫做糖衣语法,是英国科学家发明的一个术语,通常来说使用语法糖能够增加程序的可读性,从而减少程序代码出错的机会.这篇文章主要介绍了Java 中的语法糖知识,需要的朋友可以参考下
    2020-12-12
  • Spring的初始化和XML解析的实现

    Spring的初始化和XML解析的实现

    这篇文章主要介绍了Spring的初始化和XML解析的实现,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03
  • Spring中@PostConstruct的实现方法

    Spring中@PostConstruct的实现方法

    大多数java程序员都使用过@PostConstruct注解,它的作用就是在Bean初始化完成后执行,相当于我们常说的init()方法,但是我们看@PostConstruct只有单单的一个注解,它到底是如何实现在Bean初始化完成后就被调用的呢,本文将详细给大家介绍一下
    2023-06-06
  • Redis command timed out两种异常情况的解决方式

    Redis command timed out两种异常情况的解决方式

    Redis是我们开发中常用的数据库,下面这篇文章主要给大家介绍了关于Redis command timed out两种异常情况的解决方式,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-04-04
  • java项目中的多线程实践记录

    java项目中的多线程实践记录

    项目开发中对于一些数据的处理需要用到多线程,比如文件的批量上传,数据库的分批写入,大文件的分段下载等,主要涉及到多线程的一些知识,本文通过实例代码给大家介绍的非常详细,需要的朋友参考下
    2021-11-11
  • RocketMQ的消费者类型与最佳实践详解

    RocketMQ的消费者类型与最佳实践详解

    这篇文章主要介绍了RocketMQ的消费者类型与最佳实践详解,在 RocketMQ 5.0 中,更加强调了客户端类型的概念,尤其是消费者类型,为了满足多样的 RocketMQ 中一共有三种不同的消费者类型,分别是 PushConsumer、SimpleConsumer 和 PullConsumer,需要的朋友可以参考下
    2023-10-10
  • 带你了解Java数据结构和算法之队列

    带你了解Java数据结构和算法之队列

    这篇文章主要为大家介绍了Java数据结构和算法之队列,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-01-01
  • Java后台实现浏览器一键导出下载zip压缩包

    Java后台实现浏览器一键导出下载zip压缩包

    这篇文章主要为大家详细介绍了Java后台实现浏览器一键导出下载zip压缩包,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-07-07
  • Spring学习笔记1之IOC详解尽量使用注解以及java代码

    Spring学习笔记1之IOC详解尽量使用注解以及java代码

    这篇文章主要介绍了Spring学习笔记1之IOC详解尽量使用注解以及java代码 的相关资料,需要的朋友可以参考下
    2016-07-07
  • java排序高级之选择排序实现方法

    java排序高级之选择排序实现方法

    这篇文章主要介绍了java排序高级之选择排序实现方法,较为全面的分析了选择排序的原理与具体实现技巧,非常具有实用价值,需要的朋友可以参考下
    2015-02-02

最新评论