TK.Mybatis-Generator 代码生成器
一、代码生成工具
Mybatis 生成代码工具有效提交了开发效率。 MyBatis 代码生成器简称 MBG
。
常见的三种工具:
- Mybatis-Generator
- TK.Mybatis-Generator
- Mybatis-Plus-generator
本文要整理的是 Mybatis-Generator ,Mybatis 原生的 Generator 。
Mybatis 原生的 Generator 之前使用最为频繁,干脆重新重新整理一下形成系列。
当然除了这三种之外,也有其他第三方工具。
二、介绍
官网:http://mybatis.org/generator/
Git仓库:https://github.com/mybatis/generator
三、代码生成
新建springboot工程。
1、引入依赖:
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.4.0</version>
</plugin
2、MySQL 准备
建库建表
create schema if not exists test collate utf8_general_ci;
create table if not exists user
(
id bigint not null comment '主键ID'
primary key,
name varchar(30) null comment '姓名',
age int null comment '年龄',
email varchar(50) null comment '邮箱'
);
insert into test.user (id, name, age, email) values (1, 'Jone', 18, 'test1@gmail.com');
insert into test.user (id, name, age, email) values (2, 'Jack', 20, 'test2@qq.com');
insert into test.user (id, name, age, email) values (3, 'Tom', 28, 'test3@126.com');
insert into test.user (id, name, age, email) values (4, 'Sandy', 21, 'test4@163.com');
insert into test.user (id, name, age, email) values (5, 'Billie', 24, 'test5@qq.com');
3、增加配置
server.port=8806
# DataSource Config
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=GMT%2b8&useSSL=true&Unicode=true&characterEncoding=utf8&autoReconnectForPools=true&allowMultiQueries=true&rewriteBatchedStatements=true
mybatis.mapper-Locations=classpath:/mapper/*.xml,classpath:/mapper/**/*.xml"
mybatis.configuration.map-underscore-to-camel-case=true
mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
4、添加生成文件相关
连接数据库的属性文件:mybatisGeneratorinit.properties
,非必须,只是独立出来再用 <properties>
引入,不喜欢可以将连接写在xml里面。
#Mybatis Generator configuration
#dao类和实体类的位置
project=mybatis-generator/src/main/java
#mapper文件的位置
resources=mybatis-generator/src/main/resources/
#根据数据库中的表生成对应的pojo类、dao、mapper
jdbc_driver =com.ibm.db2.jcc.DB2Driver
jdbc_url=jdbc:db2://192.168.150.123:50000/datacb:deferPrepares=false;
jdbc_user=db2das
jdbc_password=luheng
创建生成代码的XML文件 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>
<!--执行generator插件生成文件的命令: call mvn mybatis-generator:generate -e -->
<!-- 引入配置文件 -->
<properties resource="mybatis-generator/mybatisGeneratorinit.properties"/>
<!--classPathEntry:数据库的JDBC驱动,换成你自己的驱动位置 可选 -->
<classPathEntry location="E:\server\MavenRepository\maven_jar\com\ibm\db2\jcc\db2jcc4\10.1\db2jcc4-10.1.jar" />
<!-- 一个数据库一个context -->
<!--defaultModelType="flat" 大数据字段,不分表 -->
<!-- 设置targetRuntime=MyBatis3。如果targetRuntime=MyBatis3Simple将不会生成sample动态代码 -->
<context id="DB2Tables" targetRuntime="MyBatis3" defaultModelType="flat">
<!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表;
一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖 -->
<property name="autoDelimitKeywords" value="true" />
<!-- 生成的Java文件的编码 -->
<property name="javaFileEncoding" value="utf-8" />
<!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,比如ORACLE就是双引号,MYSQL默认是`反引号; -->
<property name="beginningDelimiter" value="" />
<property name="endingDelimiter" value="" />
<!-- 格式化java代码 -->
<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
<!-- 格式化XML代码 -->
<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
<plugin type="org.mybatis.generator.plugins.RenameExampleClassPlugin">
<property name="searchString" value="Example$" />
<property name="replaceString" value="Query" />
</plugin>
<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
<plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
<plugin type="org.mybatis.generator.plugins.MapperAnnotationPlugin" /><!-- 生成@Mapper注解 -->
<!-- 指定主键的插件 可设置联合主键-->
<!--
<plugin type="org.mybatis.generator.plugins.VirtualPrimaryKeyPlugin" />
-->
<!-- 注释 -->
<commentGenerator >
<property name="javaFileEncoding" value="GB2312"/>
<property name="suppressAllComments" value="true"/><!-- 是否取消注释 -->
<property name="suppressDate" value="true" /> <!-- 是否生成注释代时间戳-->
</commentGenerator>
<!-- jdbc连接 -->
<jdbcConnection driverClass="${jdbc_driver}" connectionURL="${jdbc_url}" userId="${jdbc_user}" password="${jdbc_password}" />
<!-- 类型转换 -->
<javaTypeResolver>
<!-- 是否使用bigDecimal, false可自动转化以下类型(Long, Integer, Short, etc.) -->
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!-- 生成实体类地址 -->
<javaModelGenerator targetPackage="com.luheng.dbcm.web.sys.po" targetProject="${project}" >
<property name="enableSubPackages" value="true"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- 生成mapxml文件 -->
<sqlMapGenerator targetPackage="mapper" targetProject="${resources}" >
<property name="enableSubPackages" value="true" />
</sqlMapGenerator>
<!-- 生成mapxml对应client,也就是接口dao -->
<javaClientGenerator targetPackage="com.luheng.dbcm.web.sys.mapper" targetProject="${project}" type="XMLMAPPER" >
<property name="enableSubPackages" value="true" />
</javaClientGenerator>
<!-- table可以有多个,每个数据库中的表都可以写一个table,tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 -->
<table tableName="RESULT_LOG" domainObjectName="ResultLog"
enableSelectByPrimaryKey="true" enableUpdateByPrimaryKey="true" enableDeleteByPrimaryKey="true"
enableCountByExample="true" enableUpdateByExample="true" enableDeleteByExample="true"
enableInsert="true"
enableSelectByExample="true" selectByExampleQueryId="true">
<property name="useActualColumnNames" value="false" />
<!-- 数据库表主键 -->
<generatedKey column="id" sqlStatement="DB2" identity="true" />
</table>
</context>
</generatorConfiguration>
5、生成代码
点击 generatorConfig.xml
右键运行即可。
四、示例代码
mybatis-generator