MyBatis Generator(MBG):
作用:根据数据库表自动生成Bean对象、Java接口及SqlMapper.xml配置文件;
官方文档:http://www.mybatis.org/generator/
下载地址:https://github.com/mybatis/generator/releases
1、搭建MBG项目;
(1)下载MBG核心包
mybatis-generator-core-1.3.7.jar
(2)创建java项目;
(3)从官方文档获取配置表、实例代码;
实例代码:
public class GeneratorTest {
public static void main(String[] args) throws Exception {
List<String> warnings = new ArrayList<String>();
boolean overwrite = true;
//generatorConfig.xml 配置文件
File configFile = new File("src/generatorConfig.xml");
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(configFile);
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
myBatisGenerator.generate(null);
}
}
配置表:具体功能见注释
<?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>
<!-- 配置数据库连接的包 -->
<!-- <classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" /> -->
<context id="MyGenerator" targetRuntime="MyBatis3">
<!-- 去掉注释等的标签 -->
<commentGenerator>
<!-- 去掉注释 -->
<property name="suppressAllComments" value="true"/>
<!-- 去掉时间戳 -->
<property name="suppressDate" value="true"/>
</commentGenerator>
<!-- 数据库连接信息 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/ssm_mybatis"
userId="root"
password="root">
</jdbcConnection>
<!-- java jdbc 数据类型转换 -->
<javaTypeResolver >
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>
<!-- javaModelGenerator java bean配置
targetPackage 输出包名 输出路径
targetProject 输出项目位置-->
<javaModelGenerator targetPackage="com.dunka.bean" targetProject="src">
<!-- enableSubPackages 是否开启子包名称,是否在包名后边加上scheme名称 -->
<property name="enableSubPackages" value="false" />
<!--trimStrings 在SET方法中加入.trim 以去掉空格 -->
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!-- Mapper.xml -->
<sqlMapGenerator targetPackage="com.dunka.mapper" targetProject="src">
<property name="enableSubPackages" value="false" />
</sqlMapGenerator>
<!-- dao层文件 java接口-->
<javaClientGenerator type="XMLMAPPER" targetPackage="com.dunka.mapper" targetProject="src">
<property name="enableSubPackages" value="false" />
</javaClientGenerator>
<!-- 数据表 要根据数据库中的表生成 -->
<table tableName="user"/>
<table tableName="country"/>
<!-- <table schema="DB2ADMIN" tableName="ALLTYPES" domainObjectName="Customer" >
<property name="useActualColumnNames" value="true"/>
<generatedKey column="ID" sqlStatement="DB2" identity="true" />
<columnOverride column="DATE_FIELD" property="startDate" />
<ignoreColumn column="FRED" />
<columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" />
</table>
-->
</context>
</generatorConfiguration>
(4)导入依赖包
2、MBG配置以及根据数据库表生成所需文件(Bean\Interface\mapper.xml);
运行实例代码之后,会自动生成bean层代码、mapper层代码,如果没有在配置文件上表名以下两行代码,会在bean文件中出现注释以及时间戳
<!-- 去掉注释等的标签 -->
<commentGenerator>
<!-- 去掉注释 -->
<property name="suppressAllComments" value="true"/>
<!-- 去掉时间戳 -->
<property name="suppressDate" value="true"/>
</commentGenerator>
3、使用自动生成的文件操作数据库;
@Test
public void Test() throws IOException {
String resource = "SqlMapperConfig.xml";
SqlSessionFactory ssf = new SqlSessionFactoryBuilder().
build(Resources.getResourceAsStream(resource));
SqlSession sqlSession = ssf.openSession();
UserMapper uMapper = sqlSession.getMapper(UserMapper.class);
UserExample example = new UserExample();
//将对象封装到createCriteria集合中去
example.createCriteria().andUSexEqualTo("1").andUUsernameLike("%王%");
//条件查询
List<User> list = uMapper.selectByExample(example);
for (User user : list) {
System.out.println(user);
}
}
有个需要说明的,在其中出现的错误:mybatis generator自动生成代码报The error occurred while processing mapper_resultMap[BaseResultMap]
解决办法:由于在运行实例代码生成代码时,运行了两次,但是对于mapper.xml文件,并不是覆盖了原来的文件,而是将新的文件接在文档后,所以文件变大,并且报错;这时需要将生成的代码删除,然后重新生成并测试。问题解决。