使用generatorConfig工具自动生成mybatis的实体类以及dao接口和映射文件

Posted 2020-10-18

1：数据准备

创建一个数据库表

1 CREATE TABLE `logininfo` (
2   `id` BIGINT(20) NOT NULL AUTO_INCREMENT,
3   `username` VARCHAR(50) DEFAULT NULL,
4   `password` VARCHAR(200) DEFAULT NULL,
5   `state` TINYINT(4) DEFAULT NULL,
6   PRIMARY KEY (`id`)
7 ) ENGINE=INNODB DEFAULT CHARSET=utf8

 

2：配置generatorConfig.xml

 

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <!DOCTYPE generatorConfiguration
 3   PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
 4 "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
 5 <!-- 配置生成器 -->
 6 <generatorConfiguration>
 7 
 8     <context id="mysql" defaultModelType="hierarchical"    targetRuntime="MyBatis3Simple">
 9 
10         <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表； 一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖 -->
11         <property name="autoDelimitKeywords" value="false" />
12         <!-- 生成的Java文件的编码 -->
13         <property name="javaFileEncoding" value="UTF-8" />
14 
15         <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
16         <property name="beginningDelimiter" value="`" />
17         <property name="endingDelimiter" value="`" />
18         
19         <!-- 注释生成器 -->
20         <commentGenerator>
21             <property name="suppressDate" value="true"/>
22             <property name="suppressAllComments" value="true" />
23         </commentGenerator>
24         
25         <!-- 必须要有的，使用这个配置链接数据库 @TODO:是否可以扩展 -->
26         <jdbcConnection driverClass="com.mysql.jdbc.Driver"
27             connectionURL="jdbc:mysql:///p2p_ssm" userId="root" password="root">
28             <!-- 这里面可以设置property属性，每一个property属性都设置到配置的Driver上 -->
29         </jdbcConnection>
30 
31         <!-- java模型创建器，是必须要的元素 负责：1，key类（见context的defaultModelType）；2，java类；3，查询类 
32             targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制； targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录 -->
33         <javaModelGenerator targetPackage="com.liveyc.eloan.business.domain" targetProject="src/main/java">
34             <!-- for MyBatis3/MyBatis3Simple 自动为每一个生成的类创建一个构造方法，构造方法包含了所有的field；而不是使用setter； -->
35             <property name="constructorBased" value="false" />
36             <!-- for MyBatis3 / MyBatis3Simple 是否创建一个不可变的类，如果为true， 那么MBG会创建一个没有setter方法的类，取而代之的是类似constructorBased的类 -->
37             <property name="immutable" value="false" />
38         </javaModelGenerator>
39 
40 
41         <!-- 生成SQL map的XML文件生成器， 注意，在Mybatis3之后，我们可以使用mapper.xml文件+Mapper接口（或者不用mapper接口）， 
42             或者只使用Mapper接口+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的话，这个元素就必须配置 
43             targetPackage/targetProject:同javaModelGenerator -->
44         <sqlMapGenerator targetPackage="com.liveyc.eloan.business.mapper"
45             targetProject="src/main/java">
46             <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
47             <property name="enableSubPackages" value="true" />
48         </sqlMapGenerator>
49 
50 
51         <!-- 对于mybatis来说，即生成Mapper接口，注意，如果没有配置该元素，那么默认不会生成Mapper接口 targetPackage/targetProject:同javaModelGenerator 
52             type：选择怎么生成mapper接口（在MyBatis3/MyBatis3Simple下）：
53             1，ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），不会生成对应的XML； 
54             2，MIXEDMAPPER：使用混合配置，会生成Mapper接口，并适当添加合适的Annotation，但是XML会生成在XML中； 
55             3，XMLMAPPER：会生成Mapper接口，接口完全依赖XML； 
56             注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER -->
57         <javaClientGenerator targetPackage="com.liveyc.eloan.business.mapper"
58             type="XMLMAPPER" targetProject="src/main/java">
59             <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
60             <property name="enableSubPackages" value="true" />
61 
62             <!-- 可以为所有生成的接口添加一个父接口，但是MBG只负责生成，不负责检查 <property name="rootInterface" 
63                 value=""/> -->
64         </javaClientGenerator>
65         <!-- 要映射的表名 -->
66         <table tableName="logininfo" delimitIdentifiers="true">
67             <!-- 参考 javaModelGenerator 的 constructorBased属性 -->
68             <property name="constructorBased" value="false" />
69             <!-- 主键 -->
70             <generatedKey column="id" sqlStatement="JDBC"/>
71         </table>
72         
73     </context>
74 
75 </generatorConfiguration>

 3:在maven的pom文件中引入jar包

 1     <build>
 2         <plugins>
 3             <plugin>
 4                 <groupId>org.mybatis.generator</groupId>
 5                 <artifactId>mybatis-generator-maven-plugin</artifactId>
 6                 <version>1.3.2</version>
 7                 <configuration>
 8                     <verbose>true</verbose>
 9                     <!-- 代表生成的内容不要覆盖已有的内容 -->
10                     <overwrite>false</overwrite>
11                 </configuration>
12                 <dependencies>
13                     <dependency>
14                         <groupId>mysql</groupId>
15                         <artifactId>mysql-connector-java</artifactId>
16                         <version>5.1.21</version>
17                     </dependency>
18                 </dependencies>
19             </plugin>
20         </plugins>
21     </build>

 

4：运行

  执行命令

1 mybatis-generator:generate

刷新项目  因为项目中原本就有BaseDomain 以及Logininfo类存在 而在pom文件里设置的是不会覆盖所以会产生一个新文件 

PS：如果数据库中表命名方式是loginInfo   生成的实体类也不会把 I 大写的 生成的mapper字段名也是  如果有需要可以把数据库表明设置成 login_info 生成的文件就  loginInfo