J2EE MyBatis使用

MyBatis 本是 apache的一个开源项目 iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。2013年11月迁移到Github。

iBATIS一词来源于“internet”和“abatis”的组合，是一个基于Java的 持久层框架。iBATIS提供的持久层框架包括SQL Maps和Data Access Objects（DAO）。

 

MyBatis 是支持普通 SQL查询， 存储过程和高级映射的优秀 持久层框架。MyBatis 消除了几乎所有的 JDBC代码和参数的手工设置以及 结果集的检索 。MyBatis 使用简单的 XML或注解用于配置和原始映射，将接口和 Java 的POJOs（Plain Old Java Objects，普通的 Java对象）映射成数据库中的记录。

每个MyBatis应用程序主要都是使用Sql SessionFactory实例的，一个SqlSessionFactory实例可以通过SqlSessionFactoryBuilder获得。SqlSessionFactoryBuilder可以从一个xml配置文件或者一个预定义的配置类的实例获得。

用xml文件构建SqlSessionFactory实例是非常简单的事情。推荐在这个配置中使用类路径资源（classpath resource)，但你可以使用任何Reader实例，包括用文件路径或file://开头的url创建的实例。MyBatis有一个实用类----Resources，它有很多方法，可以方便地从类路径及其它位置加载资源。

 

 

 

 

mybatis自动生成:

mybatis-generator有三种用法：命令行、eclipse插件、maven插件。个人觉得maven插件最方便，可以在eclipse/intellij idea等ide上可以通用。

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.2</version>

<!--
mybatis-generator-maven-plugin会默认读取src/main/resources的generatorConfig.xml文件，

<configuration>
<configurationFile>src/main/resources/mybatis-generator/generatorConfig.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.2</version>
        </dependency>
    </dependencies>
</plugin>

plugin要放在<pluginManagement> 之内。

一张表：

CREATE TABLE `test`.`teacher` (

`id` bigint NOT NULL DEFAULT 0 COMMENT '主键id',

`name` varchar(40) NOT NULL DEFAULT '' COMMENT '名称',

`age` smallint NOT NULL DEFAULT 0 COMMENT '年龄',

PRIMARY KEY (`id`)

) COMMENT= '教师表';

 

需求1:为数据库中的表teacher生成Teacher.java, TeacherMapper.java, TeacherMapper.xml

 

在resources下新建一个文件database.properties.

 内容如下;

# 数据库驱动jar 路径
drive.class.path=F:/xampp/tomcat/webapps/mybatisuse/target/mybatisuse/WEB-INF/lib/mysql-connector-java-5.1.25.jar
 
 
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://192.168.1.156:3306/game_central
jdbc.username=root
jdbc.password=0987abc123
 
# 包路径配置
model.package=com.data.model
dao.package=com.data.dao
xml.mapper.package=com.data.dao

target.project=src/main/java
Œ…

在resoucess下新建: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>
<!-- 配置文件路径 -->
<properties resource="database.properties"/>
 
<!--数据库驱动包路径 -->
<classPathEntry location="${drive.class.path}"/>
 
<context id="MySQLTables" targetRuntime="MyBatis3">
<!--关闭注释 -->
<commentGenerator>
<property name="suppressDate" value="true"/>
</commentGenerator>
 
<!--数据库连接信息 -->
<jdbcConnection driverClass="${jdbc.driver}" connectionURL="${jdbc.url}" userId="${jdbc.username}"
password="${jdbc.password}">
</jdbcConnection>
 
<!--生成的model 包路径 -->
<javaModelGenerator targetPackage="${model.package}" targetProject="${target.project}">
<property name="enableSubPackages" value="ture"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>
 
<!--生成xml mapper文件 路径 -->
<sqlMapGenerator targetPackage="${xml.mapper.package}" targetProject="${target.project}">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
 
<!-- 生成的Dao接口 的包路径 -->
<javaClientGenerator type="XMLMAPPER" targetPackage="${dao.package}" targetProject="${target.project}">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
 
<!--对应数据库表名 -->
<table tableName="teacher">
 
</table>
</context>
</generatorConfiguration>

 根节点<generatorConfiguration>

generatorConfiguration节点没有任何属性，直接写节点即可，如下：

<generatorConfiguration>
    <!-- 具体配置内容 -->
</generatorConfiguration>  

3. <generatorConfiguration>子元素

从这段开始，就是配置的主要内容，这些配置都是generatorConfiguration元素的子元素。

包含以下子元素（有严格的顺序）：

1. <properties> (0个或1个)

2. <classPathEntry> (0个或多个)

3. <context> (1个或多个)

3.1 <properties> 元素

这个元素用来指定外部的属性元素，不是必须的元素。

元素用于指定一个需要在配置中解析使用的外部属性文件，引入属性文件后，可以在配置中使用 ${property}这种形式的引用，通过这种方式引用属性文件中的属性值。 对于后面需要配置的**jdbc信息**和targetProject属性会很有用。

这个属性可以通过resource或者url来指定属性文件的位置，这两个属性只能使用其中一个来指定，同时出现会报错。

• resource：指定**classpath**下的属性文件，使用类似com/myproject/generatorConfig.properties这样的属性值。

• url：可以指定文件系统上的特定位置，例如file:///C:/myfolder/generatorConfig.properties

3.2 <classPathEntry> 元素

这个元素可以0或多个，不受限制。

最常见的用法是通过这个属性指定驱动的路径，例如：

<classPathEntry location="E:\mysql\mysql-connector-java-5.1.29.jar"/>

重点提醒：本文之前在这里有误导，特别强调。

 

注意，classPathEntry只在下面这两种情况下才有效：

• 当加载 JDBC 驱动内省数据库时
• 当加载根类中的 JavaModelGenerator 检查重写的方法时

因此，如果你需要加载其他用途的jar包， classPathEntry起不到作用，不能这么写，解决的办法就是将你用的jar包添加到类路径中，在Eclipse等IDE中运行的时候，添加jar包比较容易。当从命令行执行的时候，需要用java -cp xx.jar,xx2.jar xxxMainClass这种方式在-cp后面指定来使用(注意-jar会导致-cp无效)。

 

使用方式：

mvn mybatis-generator:generate

就可以在我们配置的路径看到生成的java文件和xml文件了。

加参数：

mvn  mybatis-generator:generate -Dmybatis.generator.overwrite=true

表示强制重载已经存在了的同名文件。

 

 建表时，字段名称建议用"_"分隔多个单词，比如:AWB_NO、REC_ID...，这样生成的entity，属性名称就会变成漂亮的驼峰命名，即：awbNo、recId

 

 

参考：

MyBatis-Generator最佳实践

MyBatis Generator 详解