mybatis3入门学习笔记

MyBatis 的前身就是iBatis，是一个数据持久层(ORM)框架。  MyBatis 是支持普通 SQL 查询，存储过程和高级映射的优秀持久层框架。MyBatis对JDBC进行了一次很浅的封装。

 

以前也学过iBatis，因为MyBatis是iBatis的升级版本，最初以为改动应该不大，实际结果是MyBatis对配置文件进行了一些大的改动，使整个框架更加方便人性化。

 

如果需要学习MyBatis，建议大家去MyBatis Google Code下载最新的API:http://code.google.com/p/mybatis/

注意api是有中文的，我想这对广大中国同行们是一个很不错的消息。

 

• configuration配置文件

与hibernate一样，MyBatis也需要一个核心配置文件来指定数据源、连接池和ORM映射文件等等基础数据。下面是一个简单的配置：

<?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">

<!-- 注意：每个标签必须按顺序写，不然蛋疼的DTD会提示错误：The content of element type "configuration" must match "(properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,plugins?,environments?,mappers?)". -->
<configuration>
	<!-- 属性配置 -->
	<properties resource="com/mybatisdemo/config/mysql-jdbc-connection.properties">
		<!-- 相同属性:最高优先级的属性是那些作为方法参数的，然后是资源/url 属性，最后是 properties元素中指定的属性 -->
		<property name="username" value="root"/>
		<property name="password" value="sa"/>
	</properties>
	
	<!-- 设置缓存和延迟加载等等重要的运行时的行为方式 -->
	<settings>
		<!-- 设置超时时间，它决定驱动等待一个数据库响应的时间  -->
		<setting name="defaultStatementTimeout" value="25000"/>
	</settings>
	
	<!-- 别名 -->
	<typeAliases>
		<typeAlias alias="UserInfo" type="com.mybatisdemo.entity.UserInfo"/>
	</typeAliases>
	
	<environments default="development">
		<!-- environment 元素体中包含对事务管理和连接池的环境配置 -->
		<environment id="development">
			<transactionManager type="JDBC" />
			<!-- type分三种：
					UNPOOLED是每次被请求时简单打开和关闭连接 
					UNPOOLED的数据源仅仅用来配置以下 4 种属性driver，url，username，password
					POOLED ：JDBC连接对象的数据源连接池的实现，不直接支持第三方数据库连接池
			-->
			<dataSource type="POOLED">
				<property name="driver" value="${driver}" />
				<property name="url" value="${url}" />
				<property name="username" value="${username}" />
				<property name="password" value="${password}" />
			</dataSource>
		</environment>
	</environments>
	
	<!-- ORM映射文件 -->
	<mappers>
		<mapper resource="com/mybatisdemo/entity/config/UserInfoSqlMap.xml" />
	</mappers>
	
	
</configuration> 

 注意：

①xml中的标签顺序不能随便调换，否则会提示错误

②MyBatis使用自带的数据库连接池，不直接支持第三方连接池，不过网上有创建第三方连接池的方法

③以前别名（<typeAliases>）可以在sqlMap标签中创建，但现在需要在configuration标签中创建

④该配置文件可随意取名，在读取配置文件时指定该XML文件路径即可：

//读取核心配置文件
Reader reader = Resources.getResourceAsReader("com/mybatisdemo/config/Configuration.xml");
//创建SessionFactory实例
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);

 

 

• SQL 映射的 XML 文件

此文件类似于iBatis的<sqlMap>文件，但现在使用的标签为<mapper>。官方是这样形容mapper文件作用的：当然如果你将它们和对等功能的 JDBC 代码来比较，你会发现映射文件节省了大约 95%的代码量。个人认为mapper文件的主要作用就是把SQL统一存放，方便开发人员复用和维护。下面是一段简单的配置：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper     
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"     
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">     
   
<!-- namespace用于java代码调用时识别指定xml的mapper文件 -->
<mapper namespace="com.mybatisdemo.entity.UserInfo">
	<!-- 配置ORM映射 -->
	<resultMap type="UserInfo" id="user_orm">
		<id property="id" column="id"/>
		<result property="code" column="code"/>
		<result property="name" column="name"/>
		<result property="sex" column="sex"/>
		<result property="phone" column="phone"/>
		<result property="money" column="money"/>
	</resultMap>
	
	<!-- 用来定义可重用的SQL代码段 -->
	<sql id="demo_sql">
		code,name,sex,phone,money
	</sql>
	
	<insert id="inser_userInfo" parameterType="UserInfo">
		<!-- include 引用可重用的SQL代码段 -->
		INSERT INTO USERINFO(<include refid="demo_sql"/>) VALUES(#{code},#{name},#{sex},#{phone},#{money})
	</insert>
	
	<update id="update_userInfo" parameterType="UserInfo">
		UPDATE USERINFO SET code=#{code} ,name=#{name} ,sex=#{sex} ,phone=#{phone} ,money=#{money} WHERE id=#{id}
	</update>
  
    <select id="selectAll_userInfo" useCache="false" flushCache="true" resultMap="user_orm">
    	SELECT * FROM USERINFO
  	</select>
  	
  	<select id="selectById_userInfo" parameterType="int" resultType="UserInfo">
    	SELECT * FROM USERINFO WHERE id= #{id}
  	</select>
</mapper>  

 

注意：

①resultType表示查询结果放到什么对象中，上面resultType="UserInfo"使用的是com.mybatisdemo.entity.UserInfo的别名，别名是在前面核心配置文件中设置的。

②还是resultType，用户会好奇：MyBatis怎么把每个值放到UserInfo这个javabean中，实际上在查询出数据后，MyBaits会去UserInfo中查找每个属性，如果属性与表中列名对应，则会把该列的数据赋给该属性。

③如果javabean与数据库表字段不对应，可以创建resultMap来实现ORM映射

 

 

•  MyBatis API

前面XML文件已经实现了数据库连接配置和SQL配置，现在就需要用java代码去调用xml配置文件的sql即可实现数据库查询。

与hibernate类似，MyBatis也有两个核心对象：SqlSessionFactory和SqlSession。SqlSessionFactory顾名思义就是获取SqlSession对象的工厂，功能类似于jdbc中加载数据库驱动、创建connection连接，所以SqlSessionFactory资源非常重要，推荐该对象保持静态，一直存在，尽量不去销毁。而SqlSession其实就类似于jdbc的connection对象，SqlSession对象就能执行数据库的增删改查操作，大家知道每个数据库连接都是非常珍贵的，所以在使用后尽量及时关闭。

为了方便获取SqlSession对象，我写了一个Util类：

package com.mybatisdemo.demo;

import java.io.IOException;
import java.io.Reader;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class SessionFactoryUtil {
	
	private static final String RESOURCE = "com/mybatisdemo/config/Configuration.xml";
	private static SqlSessionFactory sqlSessionFactory = null;
	private static ThreadLocal<SqlSession> threadLocal = new ThreadLocal<SqlSession>();

	static {
		Reader reader = null;
		try {
			reader = Resources.getResourceAsReader(RESOURCE);
		} catch (IOException e) {
			throw new RuntimeException("Get resource error:"+RESOURCE, e);
		}

		sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
	}
	
	/**
	 * Function  : 获得SqlSessionFactory
	 * @author   : bless<[e-mail]>
	 * @return
	 */
	public static SqlSessionFactory getSqlSessionFactory(){   
        return sqlSessionFactory;   
    }
	
	/**
	 * Function  : 重新创建SqlSessionFactory
	 * @author   : bless<[e-mail]>
	 */
	public static void rebuildSqlSessionFactory(){
		Reader reader = null;
		try {
			reader = Resources.getResourceAsReader(RESOURCE);
		} catch (IOException e) {
			throw new RuntimeException("Get resource error:"+RESOURCE, e);
		}

		sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
	}
	
	/**
	 * 
	 * Function  : 获取sqlSession
	 * @author   : bless<[e-mail]>
	 * @return   : SqlSession
	 */
	public static SqlSession getSession(){
		SqlSession session = threadLocal.get();
		
		if(session==null){
			if(sqlSessionFactory == null){
				rebuildSqlSessionFactory();
			}
			//如果sqlSessionFactory不为空则获取sqlSession，否则返回null
			session = (sqlSessionFactory!=null) ? sqlSessionFactory.openSession(): null;
		}
		
		return session;
	}
	
	/**
	 * Function  : 关闭sqlSession
	 * @author   : bless<[e-mail]>
	 */
	public static void closeSession(){
		SqlSession session = threadLocal.get();
		threadLocal.set(null);
		if(session!=null){
			session.close();
		}
	}
}

 

那么所有准备就绪以后，我们来看我们的重头戏，调用sql：

 

package com.mybatisdemo.demo;


import java.util.List;

import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.session.SqlSession;
import com.mybatisdemo.entity.UserInfo;

public class UserInfoDao {
		
	@SuppressWarnings("unchecked")
	public List<UserInfo> findAll(){
		SqlSession session = SessionFactoryUtil.getSqlSessionFactory().openSession();
		List<UserInfo> lstUser = null;
		lstUser = session.selectList("com.mybatisdemo.entity.UserInfo.selectAll_userInfo");
		session.close();
		return lstUser;
	}
	
	@SuppressWarnings("unchecked")
	public List<UserInfo> findList(int pageNo,int pageSize){
		SqlSession session = SessionFactoryUtil.getSqlSessionFactory().openSession();
		List<UserInfo> lstUser = null;
		lstUser = session.selectList("com.mybatisdemo.entity.UserInfo.selectAll_userInfo", null, new RowBounds((pageNo-1)*pageSize, pageSize));
		session.close();
		return lstUser;
	}
	
	public UserInfo findById(int id){
		SqlSession session = SessionFactoryUtil.getSqlSessionFactory().openSession();
		UserInfo user =  (UserInfo) session.selectOne("selectById_userInfo", id);
		session.close();
		return user;
	}
	
	public void insert(UserInfo user){
		SqlSession session = SessionFactoryUtil.getSqlSessionFactory().openSession();
		session.insert("com.mybatisdemo.entity.UserInfo.inser_userInfo", user);
		session.commit();
		session.close();
	}
	
	public void update(UserInfo user){
		SqlSession session = SessionFactoryUtil.getSqlSessionFactory().openSession();
		session.update("com.mybatisdemo.entity.UserInfo.update_userInfo", user);
		session.commit();
		session.close();
	}
	
	public static void main(String[] args) {
		List<UserInfo> lst = new UserInfoDao().findList(3,2);
		for (UserInfo userInfo : lst) {
			System.out.println(userInfo.getId()+" "+userInfo.getName());
		}
	}
}

 

如果没有学过MyBatis的同学可能会疑问：selectList中传入的参数是什么东西？平常大家都传入的sql语句，这个xx.xx完全看不懂的样子。其实这个"com.mybatisdemo.entity.UserInfo.selectAll_userInfo"就是从前面mapper配置文件中去找对应的sql语句，"com.mybatisdemo.entity.UserInfo"表示配置文件的namespace，"selectAll_userInfo"表示配置文件具体的select标签，update和insert类似。

 

这里只是简单介绍一下MyBatis，我也是初步学习，随后会研究与spring整合以及复杂sql的处理。

最后附上demo源码，希望对大家有所帮助。

评论

7 楼 kohaku 2014-05-02  

SqlSession session = SessionFactoryUtil.getSqlSessionFactory().openSession();

你DAO的每个方法中都重新open一个session，那你之前写的ThreadLocal不就白写了？
应该这样写吧：
SqlSession session = SessionFactoryUtil.getSession();

6 楼 shdxiahui 2013-12-29  

5 楼 q769073309 2012-09-03  

zhangyou1010 写道

if(session==null){ 
            if(sqlSessionFactory == null){ 
                getSqlSessionFactory(); 
            } 


如果sqlSessionFactory 为null，应该调用rebuild方法吧？

应该是这样的

4 楼 zhangyou1010 2012-09-01  

if(session==null){ 
            if(sqlSessionFactory == null){ 
                getSqlSessionFactory(); 
            } 


如果sqlSessionFactory 为null，应该调用rebuild方法吧？

3 楼 白糖_ 2012-08-30  

q769073309 写道

sqlSession的 工厂方法中 getSession方法的if判断是不是应该为 session==null

嗯，看样子应该错了

2 楼 q769073309 2012-08-29  

sqlSession的 工厂方法中 getSession方法的if判断是不是应该为 session==null

1 楼 tracyyr 2012-03-27  

讲的很好啊