在之前的例子中,需要手动编写dao层,bean,mapper配置文件,为了解决这个繁琐的过程,mybatis提供了帮助开发者生成这些文件、并且生成增删改查相关的sql语句的功能。
mybatis generator工具
mybatis generator工具可以帮助我们实现逆向工程生成上面的那些代码和配置文件,使用方式有多种,这里以maven为例进行介绍。
首先要在maven项目中添加依赖,当然你得确保在你的maven中已经添加了mybatis相关的其他依赖jar包:
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.5</version>
</dependency>
添加generator的插件:
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.5</version>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.46</version>
</dependency>
</dependencies>
<configuration>
<!--配置文件的路径-->
<configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
<overwrite>true</overwrite>
</configuration>
</plugin>
</plugins>
在resources目录中创建一个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>
<!--如果不需要生成example的话将targetRuntime设置为MyBatis3Simple即可-->
<context id="test" targetRuntime="MyBatis3">
<commentGenerator>
<!-- 生成的注释是否包含生成的时间,一般设置为true,不生成时间 -->
<property name="suppressDate" value="true" />
<!-- 是否去除自动生成的注释 true:是 : false:否 -->
<property name="suppressAllComments" value="true" />
</commentGenerator>
<!--数据库链接URL,用户名、密码 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/ssmteam" userId="root"
password="monkey1024">
</jdbcConnection>
<javaTypeResolver>
<!-- 是否将数据库中的decimal类型转换为java的BigDecimal类型 -->
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>
<!-- 生成模型的包名和位置 -->
<javaModelGenerator targetPackage="com.monkey1024.bean"
targetProject="\monkey1024\ssm\mybatisgenerator\src\main\java">
<property name="enableSubPackages" value="true" />
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!-- 生成映射文件的包名和位置 -->
<sqlMapGenerator targetPackage="com.monkey1024.dao"
targetProject="\monkey1024\ssm\mybatisgenerator\src\main\java">
<property name="enableSubPackages" value="true" />
</sqlMapGenerator>
<!-- 生成DAO的包名和位置 -->
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.monkey1024.dao"
targetProject="\monkey1024\ssm\mybatisgenerator\src\main\java">
<property name="enableSubPackages" value="true" />
</javaClientGenerator>
<!-- 要生成哪些表 -->
<table tableName="t_user" domainObjectName="User"></table>
</context>
</generatorConfiguration>
添加完毕之后,在idea的maven中执行下面命令即可:
mybatis-generator:generate
如果成功了,在你项目的目录中可以看到dao、bean、mapper全部生成了。
注意:
这里面只会根据单表来生成文件,并不会生成表之间的关系
倘若Mapper文件已经存在时,如果进行重新生成mapper文件时,内容不被覆盖而是进行内容追加,结果导致mybatis解析失败。
解决方法:删除原来已经生成的mapper文件之后再进行生成。
Mybatis自动生成的bean及dao文件不是内容而是直接覆盖没有此问题。
Example类
在逆向工程生成的文件中有一个UserExample文件,该文件的作用就是帮我们实现多条件的查询,代码示例,根据id查询用户:
public User selectUserById(int id) {
UserExample.Criteria criteria = example.createCriteria();
criteria.andIdEqualTo(id);
List<User> users = userDao.selectByExample(example);
if (users != null){
return users.get(1);
}else{
return null;
}
}