Mybatis属于半自动ORM,在使用这个框架中,工作量最大的就是书写Mapping的映射文件,由于手动书写很容易出错,我们可以利用Mybatis-Generator来帮我们自动生成文件。
研究了一下下,发现mybatis-generator有几种配置及使用方式,下面介绍一下我选择的使用方式,以生成一个verCode类为例:
1、首先,需要用到的依赖有:mysql-connector-java,mybatis-generator-core。
本人使用的是maven构建,首先需要在pom.xml文件添加相关依赖包,配置如下:
dependencies中添加:
```
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.43</version>
<!--生命周期-->
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.5</version>
</dependency>
```
2、在resources下添加mbg.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">
<!-- 配置数据库连接信息 -->
<context id="DB2Tables" targetRuntime="MyBatis3">
<!-- 取消生成注释 -->
<property name="suppressAllComments" value="true" />
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://127.0.0.1:3306/xxx" userId="root"
password="123456">
<!--生成数字时 是否强制使用 bigdecimal 类-->
<property name="forceBigDecimals" value="false" />
<!-- 指定javaBean的生成位置 -->
<javaModelGenerator targetPackage="com.lym.entity"
targetProject=".\src\main\java">
<property name="enableSubPackages" value="true" />
<property name="trimStrings" value="true" />
<!-- 指定 mapper 映射文件生成的位置 -->
<sqlMapGenerator targetPackage="mapper" targetProject=".\src\main\resources">
<property name="enableSubPackages" value="true" />
<!-- 指定dao接口生成的位置,mapper接口 -->
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.lym.dao" targetProject=".\src\main\java">
<property name="enableSubPackages" value="true" />
<!-- 表名 实体类名 -->
<table tableName="vercode" domainObjectName="verCode">
上面配置文件中的: <table tableName="vercode" domainObjectName="verCode"> 的 tableName是数据库中的表名,domainObjectName为项目中的model名。每次需要生成某张表的时候,就将表名和实体类名换成需要生成的对象。
3、配置util类:
package com.lym.util;
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.api.ProgressCallback;
import org.mybatis.generator.api.VerboseProgressCallback;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.exception.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;
import java.io.File;
import java.io.IOException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
/**
* mybatis generator代码自动生成工具
* @author mi
*
*/
public class MybatisGenerator {
public static void main(String[] args)throws IOException, XMLParserException, InvalidConfigurationException, SQLException, InterruptedException{
List warnings =new ArrayList();
boolean overwrite =true;
File configFile =new File("src/main/resources/mbg.xml");
ConfigurationParser cp =new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(configFile);
DefaultShellCallback callback =new DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator =new MyBatisGenerator(config, callback, warnings);
ProgressCallback progressCallback =new VerboseProgressCallback();
// myBatisGenerator.generate(null);
myBatisGenerator.generate(progressCallback);
System.out.println("successful");
}
}
4、注意:需要配置spring-mybatis.xml,我使用的是Druid连接的,也可以使用c3p0等等,我就不详细说了,如图:
<!--数据库连接池druid-->
<groupId>com.alibaba
<artifactId>druid
<version>1.1.10
</dependency>
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd">
<!-- 配置整合mybatis过程 -->
<!-- 1、配置数据库相关参数properties的属性:${url}-->
<context:property-placeholder location="classpath:jdbc.properties"/>
<!-- 2、配置数据库连接池 -->
<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
<!-- 基本属性 url、user、password -->
<property name="url" value="${jdbc.url2}" />
<property name="username" value="${jdbc.user}" />
<property name="password" value="${jdbc.password2}" />
<!-- 配置初始化大小、最小、最大 -->
<property name="initialSize" value="1" />
<property name="minIdle" value="1" />
<property name="maxActive" value="20" />
<!-- 配置获取连接等待超时的时间 -->
<property name="maxWait" value="60000" />
<!-- 配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒 -->
<property name="timeBetweenEvictionRunsMillis" value="60000" />
<!-- 配置一个连接在池中最小生存的时间,单位是毫秒 -->
<property name="minEvictableIdleTimeMillis" value="300000" />
<property name="validationQuery" value="SELECT 'x'" />
<property name="testWhileIdle" value="true" />
<property name="testOnBorrow" value="false" />
<property name="testOnReturn" value="false" />
<!-- 打开PSCache,并且指定每个连接上PSCache的大小 -->
<property name="poolPreparedStatements" value="true" />
<property name="maxPoolPreparedStatementPerConnectionSize" value="20" />
<!-- 配置监控统计拦截的filters -->
<property name="filters" value="stat" />
<!-- 3、配置SqlSessionFactory对象(mybaits与spring整合配置) -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!-- 注入数据库连接池 -->
<property name="dataSource" ref="dataSource"/>
<!-- 配置MyBatis全局配置文件:mybaits-congfig.xml -->
<property name="configLocation" value="classpath:conf/mybatis-config.xml"/>
<!-- 扫描entity包 使用别名 -->
<property name="typeAliasesPackage" value="com.lym.entity"/>
<!-- 扫描sql配置文件mapper -->
<property name="mapperLocations" value="classpath:mapper/*.xml"/>
<!-- 4、配置扫描DAO接口包,动态实现dao接口,注入spring容器中 -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer" >
<!-- 注入SqlSessionFactory -->
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
<!-- 给出扫描DAO接口包 -->
<property name="basePackage" value="com.lym.dao"/>
</beans>
5、到此为止,所有的配置已完毕,运行 MybatisGenerator ,就能得到verCode的实体类,mapper,和dao了。
这种方法好的地方就是:配置好之后很方便,每次只需要修改mgb.xml最后一行的两个参数,再运行一下MybatisGenerator就行了。
缺点是:需要先搭建好项目环境,并且conf、mapper、dao、entity文件里面都需要有东西。也就是说,在第一次使用mgb文件逆向生成的时候,需要先在这些文件夹里面放一些数据。