在应用 mybatis 过程中, 当手写 JavaBean和XML 写的越来越多的时候, 就越来越批准出错。这种重复性的工作, 咱们当然不心愿做那么多。
还好, mybatis 为咱们提供了弱小的代码生成--MybatisGenerator。
通过简略的配置, 咱们就能够生成各种类型的实体类, Mapper接口, MapperXML文件, Example对象等。 通过这些生成的文件, 咱们就能够不便的进行单表进行增删改查的操作。
以下的工具应用的都是 IDEA
1、创立代码生成器
1.1 创立Maven我的项目
1.1.1 菜单上抉择新建我的项目
File | New | Project
1.1.2 抉择左侧的Maven
因为咱们只是创立一个一般的我的项目, 此处点击 Next
即可。
1.1.3 输出GroupId
和ArtifactId
在我的我的项目中,
GroupId 填 com.homejim.mybatisArtifactId 填 mybatis-generator
点击 Next
。
1.1.4 Finish
通过以上步骤, 一个一般的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>
须要留神的是 configurationFile 中的文件指的是 generator.xml。 因而门路写的是该文件的相对路径, 名称也跟该文件雷同。
到此, mybatis-generator 就能够应用啦。
1.4 应用及测试
1.4.1 关上 Maven Projects 视图
在 IDEA 上, 关上:
View | Tools | Windwos | Maven Projects
1.4.2 Maven Projects 中双击 mybatis-generator
在右侧此时能够看到 Maven Projects 了。找到 mybatis-generator 插件。
mybatis-generator | Plugins | mybatis-generator | mybatis-generator
1.4.3 双击运行
运行正确后, 生成代码, 失去如下的构造:
2、XML 配置详解
仅仅是下面那么简略的应用还不够爽。 那么咱们就能够通过更改 generator.xml 配置文件的形式进行生成的配置。
2.1 优先
举荐查看官网的文档。
2.2 官网没有的
2.2.1 property 标签
该标签在官网中只是说用来指定元素的属性, 至于怎么用没有具体的解说。
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 标签
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>
suppressAllComments: 阻止生成正文, 默认值是false。
suppressDate: 阻止生成的正文蕴含工夫戳, 默认为false。
addRemarkComments: 正文中增加数据库的正文, 默认为 false。
还有一个就是咱们能够通过 type 属性指定咱们自定义的注解实现类, 生成咱们本人想要的注解。 自定义的实现类须要实现 org.mybatis.generator.api.CommentGenerator
。
最初,关注公众号Java技术栈,在后盾回复:面试,能够获取我整顿的 Java 系列面试题和答案,十分齐全。
作者:阿进的写字台\
出处:https://www.cnblogs.com/homejim/\
本文版权归作者和博客园共有,欢送转载,但未经作者批准必须保留此段申明,且在文章页面显著地位给出原文连贯,否则保留查究法律责任的权力。
近期热文举荐:
1.Java 15 正式公布, 14 个新个性,刷新你的认知!!
2.终于靠开源我的项目弄到 IntelliJ IDEA 激活码了,真香!
3.我用 Java 8 写了一段逻辑,共事直呼看不懂,你试试看。。
4.吊打 Tomcat ,Undertow 性能很炸!!
5.《Java开发手册(嵩山版)》最新公布,速速下载!
感觉不错,别忘了顺手点赞+转发哦!