Ibatis快速上手案例解析

本博文代码均来自 http://xdwangiflytek.iteye.com/blog/1332520# ,并在原文基础上进行了较详细的解释,修正了一个小BUG

iBatis 是apache 的一个开源项目,一个O/R Mapping 解决方案,iBatis 最大的特点就是小巧,上手很快。如果不需要太多复杂的功能,iBatis 是能够满足你的要求又足够灵活的最简单的解决方案,现在的iBatis 已经改名为Mybatis 了。

官网为:http://www.mybatis.org/

为什么使用Ibatis(摘自百度百科):

目前主流

所谓“半自动”,可能理解上有点生涩。纵观目前主流的 ORM,无论 Hibernate 还是Apache OJB,都对数据库结构提供了较为完整的封装,提供了从POJO到数据库表的全套映射机制。程序员往往只需定义好了POJO 到数据库表的映射关系,即可通过 Hibernate或者OJB 提供的方法完成持久层操作。程序员甚至不需要对 SQL 的熟练掌握,Hibernate/OJB 会根据制定的存储逻辑,自动生成对应的 SQL 并调用 JDBC 接口加以执行。

开发

大多数情况下(特别是对新项目,新系统的开发而言),这样的机制无往不利,大有一统天下的势头。但是,在一些特定的环境下,这种一站式的解决方案却未必灵光。
在笔者的系统咨询工作过程中,常常遇到以下情况:
1. 系统的部分或全部数据来自现有数据库,处于安全考虑,只对开发团队提供几条Select SQL(或存储过程)以获取所需数据,具体的表结构不予公开。
2. 开发规范中要求,所有牵涉到业务逻辑部分的数据库操作,必须在数据库层由存储过程实现(就笔者工作所面向的金融行业而言,工商银行中国银行交通银行,都在开发规范中严格指定)
3. 系统数据处理量巨大,性能要求极为苛刻,这往往意味着我们必须通过经过高度优化的SQL语句(或存储过程)才能达到系统性能设计指标。
面对这样的需求,再次举起 Hibernate 大刀,却发现刀锋不再锐利,甚至无法使用,奈何?恍惚之际,只好再摸出JDBC 准备拼死一搏……,说得未免有些凄凉,直接使用 JDBC进行数据库操作实际上也是不错的选择,只是拖沓的数据库访问代码,乏味的字段读取操作令人厌烦。

搭建iBatis 开发环境:

1 、导入相关的jar 包,ibatis-2.3.0.677.jar 、mysql-connector-java-5.1.6-bin.jar

2 、编写配置文件:

Jdbc 连接的属性文件

总配置文件, SqlMapConfig.xml

关于每个实体的映射文件(Map 文件)



以一个学生信息的增删改查功能为例,讲述IBatis的结构。
1、    Student.java类
实体类,对应数据库中的tbl_student表

package pojo;

import java.sql.Date;

/**
* @author xudongwang 2011-12-31
*
* Email:[email protected]
*
*/
public class Student {
// 注意这里需要保证有一个无参构造方法,因为包括Hibernate在内的映射都是使用反射的,如果没有无参构造可能会出现问题
private int id;
private String name;
private Date birth;
private float score;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Date getBirth() {
return birth;
}
public void setBirth(Date birth) {
this.birth = birth;
}
public float getScore() {
return score;
}
public void setScore(float score) {
this.score = score;
}
@Override
public String toString() {
return "id=" + id + "\tname=" + name + "\tmajor=" + birth + "\tscore="
+ score + "\n";
}
} 


2、StudentDao.java接口
接口中声明了数据操作的方法,方法如下:
(1)public boolean deleteStudentById(int id);
(2)public boolean updateStudent(Student student);
(3)public List<Student> selectAllStudent();
(4)public List<Student> selectStudentByName(String name);
(5)public Student selectStudentById(int id);

package dao;



import java.util.List;

import pojo.Student;


/**
 * @author xudongwang 2011-12-31
 * 
 *         Email:[email protected]
 * 
 */
public interface StudentDao {

	/**
	 * 添加学生信息
	 * 
	 * @param student
	 *            学生实体
	 * @return 返回是否添加成功
	 */
	public boolean addStudent(Student student);

	/**
	 * 根据学生id删除学生信息
	 * 
	 * @param id
	 *            学生id
	 * @return 删除是否成功
	 */
	public boolean deleteStudentById(int id);

	/**
	 * 更新学生信息
	 * 
	 * @param student
	 *            学生实体
	 * @return 更新是否成功
	 */
	public boolean updateStudent(Student student);

	/**
	 * 查询全部学生信息
	 * 
	 * @return 返回学生列表
	 */
	public List<Student> selectAllStudent();

	/**
	 * 根据学生姓名模糊查询学生信息
	 * 
	 * @param name
	 *            学生姓名
	 * @return 学生信息列表
	 */
	public List<Student> selectStudentByName(String name);

	/**
	 * 根据学生id查询学生信息
	 * 
	 * @param id
	 *            学生id
	 * @return 学生对象
	 */
	public Student selectStudentById(int id);

}



3、StudentDaoImpl.java类
    是接口StudentDao的实现类,并且加载了SqlMapConfig.xml配置文件,得到SqlMapClient接口实现类的对象,调用此对象的insert,delete,update, queryForLis, queryForObjec等方法实现增删改查。
部分核心代码:
// 读取配置文件
private static SqlMapClient sqlMapClient = null;
    static {
        try {
            Reader reader = Resources.
                    getResourceAsReader("pojo/SqlMapConfig.xml");
            sqlMapClient = SqlMapClientBuilder.buildSqlMapClient(reader);
            reader.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

//增加学生信息
public boolean addStudent(Student student) {
        Object object = null;
        boolean flag = false;
        try {
            object = sqlMapClient.insert("addStudent", student);
            System.out.println("添加学生信息的返回值:" + object);
        } catch (SQLException e) {
            e.printStackTrace();
        }
        if (object != null) {
            flag = true;
        }
        return flag;
    }
//根据姓名查询学生信息
public List<Student> selectStudentByName(String name) {
        List<Student> students = null;
        try {
            students = sqlMapClient.queryForList("selectStudentByName",name);
        } catch (SQLException e) {
            e.printStackTrace();
        }
        return students;
    }

同理,简写其他方法:
//根据id删除学生
sqlMapClient.delete("deleteStudentById", id);
//更新学生
sqlMapClient.update("updateStudent", student);
//查询全部学生
sqlMapClient.queryForList("selectAllStudent");
//根据id查询学生
(Student) sqlMapClient.queryForObject("selectStudentById", id);

package dao;



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

import java.sql.SQLException;
import java.util.List;

import pojo.Student;

import com.ibatis.common.resources.Resources;
import com.ibatis.sqlmap.client.SqlMapClient;
import com.ibatis.sqlmap.client.SqlMapClientBuilder;


/**
 * @author xudongwang 2011-12-31
 * 
 *         Email:[email protected]
 * 
 */
public class StudentDaoImpl implements StudentDao {

	private static SqlMapClient sqlMapClient = null;

	// 读取配置文件
	static {
		try {
			Reader reader = Resources
					.getResourceAsReader("pojo/SqlMapConfig.xml");
			sqlMapClient = SqlMapClientBuilder.buildSqlMapClient(reader);
			reader.close();
		} catch (IOException e) {
			e.printStackTrace();
		}
	}

	public boolean addStudent(Student student) {
		Object object = null;
		boolean flag = false;
		try {
			object = sqlMapClient.insert("addStudent", student);
			System.out.println("添加学生信息的返回值:" + object);
		} catch (SQLException e) {
			e.printStackTrace();
		}
		if (object != null) {
			flag = true;
		}
		return flag;
	}

	public boolean deleteStudentById(int id) {
		boolean flag = false;
		Object object = null;
		try {
			object = sqlMapClient.delete("deleteStudentById", id);
			System.out.println("删除学生信息的返回值:" + object + ",这里返回的是影响的行数");
		} catch (SQLException e) {
			e.printStackTrace();
		}
		if (object != null) {
			flag = true;

		}
		return flag;

	}

	public boolean updateStudent(Student student) {
		boolean flag = false;
		Object object = false;
		try {
			object = sqlMapClient.update("updateStudent", student);
			System.out.println("更新学生信息的返回值:" + object + ",返回影响的行数");
		} catch (SQLException e) {
			e.printStackTrace();
		}
		if (object != null) {
			flag = true;
		}
		return flag;
	}

	public List<Student> selectAllStudent() {
		List<Student> students = null;
		try {
			students = sqlMapClient.queryForList("selectAllStudent");
		} catch (SQLException e) {
			e.printStackTrace();
		}
		return students;
	}

	public List<Student> selectStudentByName(String name) {
		List<Student> students = null;
		try {
			students = sqlMapClient.queryForList("selectStudentByName",name);
		} catch (SQLException e) {
			e.printStackTrace();
		}
		return students;
	}

	public Student selectStudentById(int id) {
		Student student = null;
		try {
			student = (Student) sqlMapClient.queryForObject(
					"selectStudentById", id);
		} catch (SQLException e) {
			e.printStackTrace();
		}
		return student;
	}
}



4、Student.xml实体关系映射文件
    当调用StudentDaoImpl 类中的sqlMapClient 对象的某个方法时,例如,调用sqlMapClient.queryForObject("selectStudentById", id);那么会自动找到映射文件中的id值为selectStudentById的select标签,传递一个int类型的参数id,而方法的返回值是Student类型的对象。(id="selectStudentById" parameterClass="int" resultClass="Student")

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE sqlMap PUBLIC "-//ibatis.apache.org//DTD SQL Map 2.0//EN"
"http://ibatis.apache.org/dtd/sql-map-2.dtd">
<sqlMap>
	<!-- 通过typeAlias使得我们在下面使用Student实体类的时候不需要写包名 -->
	<typeAlias alias="Student" type="pojo.Student" />
	<!-- 这样以后改了sql,就不需要去改java代码了 -->
	<!-- id表示select里的sql语句,resultClass表示返回结果的类型 -->
	<select id="selectAllStudent" resultClass="Student">
		select * from
		tbl_student
	</select>
	<!-- parameterClass表示参数的类型 -->
	<!-- #表示这是一个外部调用的需要传进的参数,可以理解为占位符 -->
	<select id="selectStudentById" parameterClass="int" resultClass="Student">
		select * from tbl_student where id=#id#
	</select>
	<!-- 注意这里的resultClass类型,使用Student类型取决于queryForList还是queryForObject -->
	<select id="selectStudentByName" parameterClass="String"
		resultClass="Student">
		select id, name,birth,score from tbl_student where name like<!-- 如果select之后没有写id,那么查询结果id就为0 -->
		'%$name$%'
	</select>
	<insert id="addStudent" parameterClass="Student">
		insert into
		tbl_student(name,birth,score) values
		(#name#,#birth#,#score#);<!-- 会从Student类中找相应的属性 -->
		<selectKey resultClass="int" keyProperty="id">
			select @@identity as inserted
<!-- 这里需要说明一下不同的数据库主键的生成,对各自的数据库有不同的方式: -->
<!-- mysql:SELECT LAST_INSERT_ID() AS VALUE -->
<!-- mssql:select @@IDENTITY as value -->
<!-- oracle:SELECT STOCKIDSEQUENCE.NEXTVAL AS VALUE FROM DUAL -->
<!-- 还有一点需要注意的是不同的数据库生产商生成主键的方式不一样,有些是预先生成 (pre-generate)主键的,如Oracle和PostgreSQL。
有些是事后生成(post-generate)主键的,如MySQL和SQL Server 所以如果是Oracle数据库,则需要将selectKey写在insert之前 -->
		</selectKey>
	</insert>
	<delete id="deleteStudentById" parameterClass="int">
	<!-- #id#里的id可以随意取,但是上面的insert则会有影响,因为上面的name会从Student里的属性里去查找 -->
	<!-- 我们也可以这样理解,如果有#占位符,则ibatis会调用parameterClass里的属性去赋值 -->
		delete from tbl_student where id=#id#
	</delete>
	<update id="updateStudent" parameterClass="Student">
		update tbl_student set
		name=#name#,birth=#birth#,score=#score# where id=#id#
	</update>
</sqlMap>



5、SqlMap.properties配置文件
配置数据库连接属性:

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/ibatis
username=root
password=root



6、SqlMapConfig.xml配置文件
    此文件中引用了JDBC配置文件SqlMap.properties和实体关系映射文件Student.xml。此文件在StudentDaoImpl类中进行了加载。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sqlMapConfig PUBLIC "-//ibatis.apache.org//DTD SQL Map Config 2.0//EN"
"http://ibatis.apache.org/dtd/sql-map-config-2.dtd">
<sqlMapConfig>
<!-- 引用JDBC属性的配置文件 -->
<properties resource="pojo/SqlMap.properties" />
<!-- 使用JDBC的事务管理 -->
<transactionManager type="JDBC">
<!-- 数据源 -->
<dataSource type="SIMPLE">
<property name="JDBC.Driver" value="${driver}" />
<property name="JDBC.ConnectionURL" value="${url}" />
<property name="JDBC.Username" value="${username}" />
<property name="JDBC.Password" value="${password}" />
</dataSource>
</transactionManager>
<!-- 这里可以写多个实体的映射文件 -->
<sqlMap resource="pojo/Student.xml" />
</sqlMapConfig>




猜你喜欢

转载自blog.csdn.net/qinchaozengh/article/details/17010371