MyBatis框架

前言

本章介绍了MyBatis框架，包括它的概念，框架搭建，注意事项等，以新增数据为例，其他相关操作，重点地方会说明，一般的代码将会在代码示例里一并展示。

一、MyBatis的概念

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

可能会有人疑惑，这个项目总是换公司，是否是因为它不好呢？其实不然，他所属公司的替换原因可能是公司定位的改变，可能是其它什么原因，但是这个项目确实一个非常好的。下面，我们就来认识一下它----MyBatis。

MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Ordinary Java Object,普通的 Java对象)映射成数据库中的记录。

MyBatis的优势在于它的轻量级，简单易学，使得代码和sql分离，支持对象与数据库的orm字段关系映射，可编写动态sql，没有任何第三方依赖等。

二、框架搭建

这里，我们将搭建一个纯MyBatis框架。

2.1 导包

需要导入三个包。
mybatis用于搭建mybatis框架。
ojdbc14是Oracle驱动。
junit是用于做测试使用。

<dependencies>
  	<dependency>
  		<groupId>org.mybatis</groupId>
  		<artifactId>mybatis</artifactId>
  		<version>3.4.5</version>
  	</dependency>
  	<dependency>
  		<groupId>com.oracle</groupId>
  		<artifactId>ojdbc14</artifactId>
  		<version>10.2.0.5.0</version>
  	</dependency>
  	<dependency>
  		<groupId>junit</groupId>
  		<artifactId>junit</artifactId>
  		<version>4.12</version>
  	</dependency>
  </dependencies>

2.2 创建MyBaits的配置文件

这是mybatis的配置文件，其中涉及mybatis的连接池配置和映射文件路径配置。
连接池是mybatis自带的，因此我们以后就不需要单独再去配置连接池了。
映射文件路径是配置mybatis的映射文件（mapper）的路径。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>
    <!--环境配置，连接的数据库，这里使用的是Oracle-->
    <environments default="myOracle">
        <environment id="myOracle">
            <!--指定事务管理的类型，这里简单使用Java的JDBC的提交和回滚设置-->
            <transactionManager type="JDBC"></transactionManager>
            <!--dataSource 指连接源配置，POOLED是JDBC连接对象的数据源连接池的实现-->
            <dataSource type="POOLED">
                <property name="driver" value="oracle.jdbc.driver.OracleDriver"></property>
                <property name="url" value="jdbc:oracle:thin:@localhost:1521:orcl"></property>
                <property name="username" value="zdl"></property>
                <property name="password" value="zhangdl"></property>
            </dataSource>
        </environment>
    </environments>
    <mappers>        
    	<!--这是告诉Mybatis去哪找持久化类的映射文件，对于在src下的文件直接写文件名，如果在某包下，则要写明路径,如：mapper/DeptMapper.xml-->
        <mapper resource="mapper/DeptMapper.xml"></mapper>
    </mappers>
</configuration>

2.3 创建实体

这是一个部门的实体类。该类有三个属性，分别表示部门编号、部门名称、人员数量。
还有各属性的set/get方法及重写的toString方法。

package entity;

public class Dept {
	private String deptno;
	private String deptname;
	private String num;
	public String getDeptno() {
		return deptno;
	}
	public String getDeptname() {
		return deptname;
	}
	public String getNum() {
		return num;
	}
	public void setDeptno(String deptno) {
		this.deptno = deptno;
	}
	public void setDeptname(String deptname) {
		this.deptname = deptname;
	}
	public void setNum(String num) {
		this.num = num;
	}
	@Override
	public String toString() {
		return "Dept [deptno=" + deptno + ", deptname=" + deptname + ", num=" + num + "]";
	}
	
}

2.4 配置映射文件

映射文件可根据自己的情况放到你所喜欢的位置，不过建议先同意放入一个mapper文件夹中，方便管理。如下面的mapper的地址为：/MyBatisTest/src/main/resources/mapper/DeptMapper.xml。

namespace为命名空间，目前可以随意写一个，后面有了mapper映射器后就必须是映射器的全限定名了。
因为是新增方法，因此未insert标签，标签中id必须唯一，不能和其他方法重复，当然了，不同的namespace下是可以有重复id的。
parameterType是参数类型，这里是entity.Dept，也可以是int、String等。
resultType是返回值类型。此处暂时没有。
#{}为参数，其中的字段必须是参数类中有的，比如，deptno是entity.Dept的属性。

本案例以新增为例，其他方法会在示例中记录。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="dao.DeptDao">
    <insert id="insertOne" parameterType="entity.Dept">
        insert into dept(deptno,deptname,num)values(#{deptno},#{deptname},#{num})
    </insert>
</mapper>

2.5 junit测试

要想使用mybatis需要获取org.apache.ibatis.session.SqlSession。它需要通过SqlSessionFactory获得。而SqlSessionFactory则需要SqlSessionFactoryBuilder加载mybatis配置文件得到。
这里我将获取SqlSession封装成了一个方法。
每当完成DML操作后都需要提交事务，并关闭连接。代码如下。

package test;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;
import entity.Dept;

public class MybatisTest1 {

	private SqlSession session;
	
	@Before
	public void initObejct(){
		SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
		SqlSessionFactory factory= builder.build(MybatisTest1.class.getClassLoader().getResourceAsStream("mybatis-config.xml"));
		session = factory.openSession();
	}
	
	@Test
	public void test1(){
		Dept dept = new Dept();
		dept.setDeptno("5");
		dept.setDeptname("售后部");
		dept.setNum("30");
		int i = session.insert("dao.DeptDao.insertOne",dept);
		session.commit();//提交事务
		session.close();//关闭连接
		System.out.println(i);
	}
}

2.6 测试结果

此处我打印的是insert的返回结果，它表示操作的记录条数。因此，console中打印的是1。表示新增成功了一条数据。

2.7 Mapper映射器

符合映射文件的接口。
注：mybatis会自动实现一个符合该接口要求的对象，所以我们就不需要写该接口的实现类了。

该接口需要符合如下规范：
a. 接口的全限定名是mapper映射文件的namespace
b. 接口的方法名是mapper映射文件对应标签的id
c. 接口的方法形参类型是mapper映射文件的parameterType
d. 接口的方法返回值类型是mapper映射文件的resultType

上面说了那么多，其实这个接口就是dao接口，对应关系都是mapper映射文件根据接口去编写的。
这里记录一下我写的接口：

package dao;

import java.util.List;
import entity.Dept;

public interface DeptDao {
	public void insertOne(Dept dept);
	public void deleteOne(String id);
	public void UpdateOne(Dept dept);
	public List<Dept> findAll();
	public Dept findById(String id);
}

测试代码修改为通过DeptDao dao = session.getMapper(DeptDao.class);获取dao的方式。然后通过调用方法实现。

package test;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;

import dao.DeptDao;
import entity.Dept;

public class MybatisTest1 {
	
	private SqlSession session;
	
	@Before
	public void initObejct(){
		SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
		SqlSessionFactory factory= builder.build(MybatisTest1.class.getClassLoader().getResourceAsStream("mybatis-config.xml"));
		session = factory.openSession();
	}
	
	@Test
	public void test1(){
		DeptDao dao = session.getMapper(DeptDao.class);
		Dept dept = new Dept();
		dept.setDeptno("6");
		dept.setDeptname("测试部");
		dept.setNum("28");
		dao.insertOne(dept);
		session.commit();
		session.close();
	}
}

三、代码示例

这里将新增、删除、修改、根据id查询、查询全部信息的映射sql记录下来。
这都是一些记错的sql，没有难度，只需要按照mybatis的要求写出来就好。

注意：findAll的返回值类型为entity.Dept，而不是List。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="dao.DeptDao">
    <insert id="insertOne" parameterType="entity.Dept">
        insert into dept(deptno,deptname,num)values(#{deptno},#{deptname},#{num})
    </insert>
    <delete id="deleteOne" parameterType="String">
        delete from dept where deptno=#{deptno}
    </delete>
    <update id="updateOne" parameterType="entity.Dept">
        update dept set deptname=#{deptname},num=#{num} where deptno=#{deptno}
    </update>
    <select id="findById" resultType="entity.Dept">
        select * from dept where deptno=#{deptno}
    </select>
    <select id="findAll" resultType="entity.Dept">
        select * from dept
    </select>
</mapper>

四、特殊情况

4.1 字段名和属性名不一致

mybatis要求返回的字段必须和实体的属性一致，如果不一致，有两种解决办法。如下。
新建一个实体dept2：
该类将deptno换成了id，deptname换成了name。如果使用上面的方法是不能将数据查询出来的。

package entity;

public class Dept2 {
	private String id;
	private String name;
	private String num;
	public String getId() {
		return id;
	}
	public String getName() {
		return name;
	}
	public String getNum() {
		return num;
	}
	public void setId(String id) {
		this.id = id;
	}
	public void setName(String name) {
		this.name = name;
	}
	public void setNum(String num) {
		this.num = num;
	}
	@Override
	public String toString() {
		return "Dept2 [id=" + id + ", name=" + name + ", num=" + num + "]";
	}
	
}

4.1.1使用别名

当表的字段名和实体的属性名不一致时，可以采取使用别名的方式。

	<select id="findById2" resultType="entity.Dept">
        select deptno id,deptname name,num from dept where deptno=#{deptno}
    </select>

可见，将deptno用id作为别名，name作为deptname的别名，num一致可以不用别名。

4.1.2 使用resultMap

使用resutMap将字段和属性名对应。type为转换的实体类名，id唯一。
property为属性名，column为字段名。

注意：使用resultMap后，需要设定select的返回为resultMap，而不是resultType，它的值为resultMap的id。

	<select id="findById3" resultMap="deptMap">
        select * from dept where deptno=#{deptno}
    </select>
    
    <resultMap type="entity.Dept2" id="deptMap">
        <result property="id" column="deptno" />
        <result property="name" column="deptname" />
    </resultMap>

4.2 返回类型为Map

如果我们需要返回一个java.util.map，resultType需要为map。

	<select id="findById4" resultType="map">
        select * from dept where deptno=#{deptno}
    </select>

测试代码：

注意：map.get(“DEPTNAME")中字段名必须是大写，否者获取不到对应的参数

	@Test
	public void test8(){
		DeptDao dao = session.getMapper(DeptDao.class);
		Map map  = dao.findById4("1");
		System.out.println(map);
		String name = (String) map.get("DEPTNAME");
		System.out.println(name);
		session.close();
	}