温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

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

发布时间:2020-09-17 03:49:38 来源:脚本之家 阅读:376 作者:上帝爱吃苹果 栏目:编程语言

前言

工作中使用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工具执行

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

方式二:通过MAVEN命令

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

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

然后Run就好了:

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

1|5可能出现的BUG

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

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

总结

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

向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

AI