Mybatis的介绍与入门（1）
1、Mybatis介绍
MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。2013年11月迁移到Github。
MyBatis是一个优秀的持久层框架，它对jdbc的操作数据库的过程进行封装，使开发者只需要关注 SQL 本身，而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。
Mybatis通过xml或注解的方式将要执行的各种statement（statement、preparedStatemnt、CallableStatement）配置起来，并通过java对象和statement中的sql进行映射生成最终执行的sql语句，最后由mybatis框架执行sql并将结果映射成java对象并返回。
2、Mybatis入门
2.1 使用jdbc编程问题总结
2.1.1 jdbc编程步骤：
2、创建并获取数据库链接
3、创建jdbc statement对象
4、设置sql语句
5、设置sql语句中的参数(使用preparedStatement)
6、通过statement执行sql并获取结果
7、对sql执行结果进行解析处理
8、释放资源(resultSet、preparedstatement、connection)
public static void main(String[] args) {
Connection connection = null;
PreparedStatement preparedStatement = null;
ResultSet resultSet = null;
try {
// 1、加载数据库驱动
Class.forName("com.mysql.jdbc.Driver");
// 2、通过驱动管理类获取数据库链接
connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8", "root", "root");
// 3、定义sql语句 ?表示占位符
String sql = "select * from user where username = ?";
// 4、获取预处理statement
preparedStatement = connection.prepareStatement(sql);
// 5、设置参数，第一个参数为sql语句中参数的序号（从1开始），第二个参数为设置的参数值
preparedStatement.setString(1, "王五");
// 6、向数据库发出sql执行查询，查询出结果集
resultSet = preparedStatement.executeQuery();
// 7、遍历查询结果集
while (resultSet.next()) {
System.out.println(resultSet.getString("id") + " " + resultSet.getString("username"));
}
} catch (Exception e) {
e.printStackTrace();
} finally {
// 8、释放资源
if (resultSet != null) {
try {
resultSet.close();
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
if (preparedStatement != null) {
try {
preparedStatement.close();
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
if (connection != null) {
try {
connection.close();
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
}1、数据库连接创建、释放频繁造成系统资源浪费，从而影响系统性能。如果使用数据库连接池可解决此问题。
2、Sql语句在代码中硬编码，造成代码不易维护，实际应用中sql变化的可能较大，sql变动需要改变java代码。
3、使用preparedStatement向占有位符号传参数存在硬编码，因为sql语句的where条件不一定，可能多也可能少，修改sql还要修改代码，系统不易维护。
4、对结果集解析存在硬编码（查询列名），sql变化导致解析代码变化，系统不易维护，如果能将数据库记录封装成pojo对象解析比较方便。
2.2 mybatis构架
1、mybatis配置
SqlMapConfig.xml，此文件作为mybatis的全局配置文件，配置了mybatis的运行环境等信息。mapper.xml文件即sql映射文件，文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中加载。
2、通过mybatis环境等配置信息构造SqlSessionFactory即会话工厂
3、由会话工厂创建sqlSession即会话，操作数据库需要通过sqlSession进行。
4、mybatis底层自定义了Executor执行器接口操作数据库，Executor接口有两个实现，一个是基本执行器、一个是缓存执行器。
5、Mapped Statement也是mybatis一个底层封装对象，它包装了mybatis配置信息及sql映射信息等。mapper.xml文件中一个sql对应一个Mapped Statement对象，sql的id即是Mapped statement的id。
6、Mapped Statement对sql执行输入参数进行定义，包括HashMap、基本类型、pojo，Executor通过Mapped Statement在执行sql前将输入的java对象映射至sql中，输入参数映射就是jdbc编程中对preparedStatement设置参数。
7、Mapped Statement对sql执行输出结果进行定义，包括HashMap、基本类型、pojo，Executor通过Mapped Statement在执行sql后将输出结果映射至java对象中，输出结果映射过程相当于jdbc编程中对结果的解析处理过程。
2.3 mybatis入门程序
2.3.1业务需求
使用MyBatis实现以下功能：根据用户id查询一个用户
根据用户名称模糊查询用户列表
添加用户、更新用户、删除用户
2.3.2 环境搭建
1、创建java工程
2、导入jar包
mybatis依赖包、数据库驱动包
3、创建log4j.properties和SqlMapConfig.xml配置文件
创建log4j.properties
# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
root" />
SqlMapConfig.xml是mybatis核心配置文件，配置文件内容为数据源、事务管理。
4、创建pojo
pojo类作为mybatis进行sql映射使用
Public class User {
private int id;
private String username;// 用户姓名
private String sex;// 性别
private Date birthday;// 生日
private String address;// 地址
// get/set方法5、sql映射文件
创建sql映射文件User.xml：
6、加载映射文件
mybatis框架需要加载Mapper.xml映射文件，将users.xml添加在SqlMapConfig.xml
7、创建db.properties文件
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=root8、目录结构
2.3.3 实现业务需求
2.3.3.1 在user.xml中添加select、insert、update、delete标签，编写sql：
parameterType="com.hciot.mybatis.pojo.User">
resultType="Integer" order="AFTER">
select LAST_INSERT_ID()
insert into user (username,birthday,address,sex)
values (#{username},#{birthday},#{address},#{sex})
parameterType="com.hciot.mybatis.pojo.User">
update user
set username = #{username}, sex = #{sex}, birthday = #{birthday}, address = #{address}
where id = #{id}
parameterType="Integer">
delete from user
where id = #{id}
parameterType：指定输入参数类型，mybatis通过ognl从输入对象中获取参数值拼接在sql中。
resultType：指定输出结果类型，mybatis将sql查询结果的一行记录数据映射为resultType指定类型的对象。如果有多条数据，则分别进行映射，并把对象放到容器List中
2.3.3.2 测试程序：测试程序步骤：
1. 创建SqlSessionFactoryBuilder对象
2. 加载SqlMapConfig.xml配置文件
3. 创建SqlSessionFactory对象
4. 创建SqlSession对象
5. 执行SqlSession对象执行查询，获取结果User
6. 打印结果
7. 释放资源
MybatisFirstTest编写测试程序如下：
package com.hciot.mybatis.test;
import java.io.InputStream;
import java.util.Date;
import java.util.List;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test;
import com.hciot.mybatis.pojo.User;
public class MybatisFirstTest {
@Test
public void testMybatis() throws Exception{
//通过ID查询一个用户
//1. 加载核心配置文件
String resource = "SqlMapConfig.xml";
InputStream in = Resources.getResourceAsStream(resource);
//2. 创建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
//3. 创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
//4. 执行Sql语句
User user = sqlSession.selectOne("test.findUserById",16);
System.out.println(user);
}
@Test
public void testfindUserByUsername() throws Exception{
//模糊查询用户
//1. 加载核心配置文件
String resource = "SqlMapConfig.xml";
InputStream in = Resources.getResourceAsStream(resource);
//2. 创建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
//3. 创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
//4. 执行Sql语句
List user = sqlSession.selectList("test.findUserByUsername","五");
for (User user2 : user) {
System.out.println(user2);
}
}
@Test
public void testInsertUser() throws Exception{
//增加用户
//1. 加载核心配置文件
String resource = "SqlMapConfig.xml";
InputStream in = Resources.getResourceAsStream(resource);
//2. 创建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
//3. 创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
//4. 执行Sql语句
User user=new User();
user.setUsername("麦迪");
user.setBirthday(new Date());
user.setAddress("美国");
user.setSex("男");
int i = sqlSession.insert("test.insertUser",user);
sqlSession.commit();
System.out.println(user.getId());
}
@Test
public void testUpdateUser() throws Exception{
//更新用户
//1. 加载核心配置文件
String resource = "SqlMapConfig.xml";
InputStream in = Resources.getResourceAsStream(resource);
//2. 创建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
//3. 创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
//4. 执行Sql语句
User user=new User();
user.setId(29);
user.setUsername("麦mai");
user.setBirthday(new Date());
user.setAddress("美国haha");
user.setSex("男");
int i = sqlSession.update("test.updateUserById",user);
sqlSession.commit();
}
@Test
public void testDelete() throws Exception{
//删除用户
//1. 加载核心配置文件
String resource = "SqlMapConfig.xml";
InputStream in = Resources.getResourceAsStream(resource);
//2. 创建SqlSessionFactory
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
//3. 创建SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
//4. 执行Sql语句
sqlSession.delete("test.deleteUserById",31);
sqlSession.commit();
}
}
selectOne：查询一条记录，如果使用selectOne查询多条记录则抛出异常：
org.apache.ibatis.exceptions.TooManyResultsException: Expected one result (or null) to be returned by selectOne(), but found: 3at org.apache.ibatis.session.defaults.DefaultSqlSession.selectOne(DefaultSqlSession.java:70)
selectList：可以查询一条或多条记录。2.4 Mybatis解决jdbc编程的问题
1、数据库连接创建、释放频繁造成系统资源浪费从而影响系统性能，如果使用数据库连接池可解决此问题。解决：在SqlMapConfig.xml中配置数据连接池，使用连接池管理数据库链接。
2、Sql语句写在代码中造成代码不易维护，实际应用sql变化的可能较大，sql变动需要改变java代码。
解决：将Sql语句配置在XXXXmapper.xml文件中与java代码分离。
3、向sql语句传参数麻烦，因为sql语句的where条件不一定，可能多也可能少，占位符需要和参数一一对应。
解决：Mybatis自动将java对象映射至sql语句，通过statement中的parameterType定义输入参数的类型。
4、对结果集解析麻烦，sql变化导致解析代码变化，且解析前需要遍历，如果能将数据库记录封装成pojo对象解析比较方便。
解决：Mybatis自动将sql执行结果映射至java对象，通过statement中的resultType定义输出结果的类型。
3、Dao开发
使用MyBatis开发Dao，通常有两个方法，即原始Dao开发方法和Mapper动态代理开发方法。
3.1 需求
使用MyBatis开发DAO实现以下的功能：根据用户id查询一个用户信息
3.2 SqlSession的使用范围
SqlSession中封装了对数据库的操作，如：查询、插入、更新、删除等。
SqlSession通过SqlSessionFactory创建。
SqlSessionFactory是通过SqlSessionFactoryBuilder进行创建。
3.2.1 SqlSessionFactoryBuilder
SqlSessionFactoryBuilder用于创建SqlSessionFacoty，SqlSessionFacoty一旦创建完成就不需要SqlSessionFactoryBuilder因为SqlSession是通过SqlSessionFactory创建的。所以可以将SqlSessionFactoryBuilder当成一个工具类使用，最佳使用范围是方法范围即方法体内局部变量。
3.2.2 SqlSessionFactory
SqlSessionFactory是一个接口，接口中定义了openSession的不同重载方法，SqlSessionFactory的最佳使用范围是整个应用运行期间，一旦创建后可以重复使用，通常以单例模式管理SqlSessionFactory。
3.2.3 SqlSession
SqlSession是一个面向用户的接口，sqlSession中定义了数据库操作方法。每个线程都应该有它自己的SqlSession实例。SqlSession的实例不能共享使用，它也是线程不安全的。因此最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态字段或实例字段中。打开一个 SqlSession；使用完毕就要关闭它。通常把这个关闭操作放到 finally块中以确保每次都能执行关闭。如下：
SqlSession session = sqlSessionFactory.openSession();
try {
// do work
} finally {
session.close();
}3.3 原始Dao开发
原始Dao开发方法需要开发人员编写Dao接口和Dao实现类
3.3.1映射文件
编写映射文件如下：（也可以使用2.3.3.1完成的映射文件）
select LAST_INSERT_ID()
insert into user (username,birthday,address,sex)
values (#{username},#{birthday},#{address},#{sex})
3.3.2 Dao接口
先进行DAO的接口开发，编码如下：
package com.hciot.mybatis.Dao;
import java.util.List;
import com.hciot.mybatis.pojo.User;
public interface UserDao {
//通过用户ID查询一个用户
public User selectUserById(Integer id);
//根据用户名模糊查询用户
List queryUserByUsername(String username);
// 保存用户
void saveUser(User user);
} 3.3.3 Dao实现类
编写的Dao实现类如下
package com.hciot.mybatis.Dao;
import java.util.List;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import com.hciot.mybatis.pojo.User;
public class UserDaoImpl implements UserDao {
//注入SqlSessionFactory
private SqlSessionFactory sqlSessionFactory;
public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
this.sqlSessionFactory = sqlSessionFactory;
}
//通过用户ID查询一个用户
public User selectUserById(Integer id){
SqlSession sqlSession = sqlSessionFactory.openSession();
return sqlSession.selectOne("test.findUserById", id);
}
@Override
public List queryUserByUsername(String username) {
SqlSession sqlSession = sqlSessionFactory.openSession();
return sqlSession.selectList("test.findUserByUsername", username);
}
@Override
public void saveUser(User user) {
SqlSession sqlSession = sqlSessionFactory.openSession();
sqlSession.insert("test.insertUser", user);
}
}
3.3.4 Dao测试
创建一个JUnit的测试类，对UserDao进行测试，测试代码如下：
package com.hciot.mybatis.test;
import java.io.InputStream;
import java.util.Date;
import java.util.List;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;
import com.hciot.mybatis.Dao.UserDao;
import com.hciot.mybatis.Dao.UserDaoImpl;
import com.hciot.mybatis.pojo.User;
public class MybatisDaoTest {
private SqlSessionFactory sqlSessionFactory;
@Before
public void before() throws Exception{
//1. 加载核心配置文件
String resource = "SqlMapConfig.xml";
InputStream in = Resources.getResourceAsStream(resource);
//2. 创建SqlSessionFactory
sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
}
@Test
//根据id查询用户
public void testDao() throws Exception{
UserDao userDao=new UserDaoImpl(sqlSessionFactory);
User user = userDao.selectUserById(26);
System.out.println(user);
}
@Test
//根据用户名模糊查询用户
public void testQueryUserByUsername() throws Exception{
UserDao userDao = new UserDaoImpl(sqlSessionFactory);
List list = userDao.queryUserByUsername("张");
for (User user : list) {
System.out.println(user);
}
}
@Test
//保存用户
public void testSaveUser() {
UserDao userDao = new UserDaoImpl(sqlSessionFactory);
User user = new User();
user.setUsername("刘备");
user.setBirthday(new Date());
user.setSex("1");
user.setAddress("蜀国");
userDao.saveUser(user);
System.out.println(user);
}
}
3.3.5 问题
原始Dao开发中存在以下问题：
1. Dao方法体存在重复代码：通过SqlSessionFactory创建SqlSession，调用SqlSession的数据库操作方法
2. 调用sqlSession的数据库操作方法需要指定statement的id，这里存在硬编码，不得于开发维护。
3.4 Mapper动态代理方式
3.4.1 开发规范
Mapper接口开发方法只需要开发人员编写Mapper接口（相当于Dao接口），由Mybatis框架根据接口定义创建接口的动态代理对象，代理对象的方法体同上边Dao接口实现类方法。Mapper接口开发需要遵循以下规范：
1、Mapper.xml文件中的namespace与mapper接口的类路径相同。
2、Mapper接口方法名和Mapper.xml中定义的每个statement的id相同
3、Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同
4、Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同
3.4.2 UserMapper.xml(映射文件)
定义mapper映射文件UserMapper.xml，UserMapper.xml配置文件内容：
select LAST_INSERT_ID()
insert into user (username,birthday,address,sex)
values (#{username},#{birthday},#{address},#{sex})
3.4.3 UserMapper(接口文件)
创建UserMapper接口代码如下：
package com.hciot.mybatis.mapper;
import java.util.List;
import com.hciot.mybatis.pojo.User;
public interface UserMapper {
/*
1、Mapper.xml文件中的namespace与mapper接口的类路径相同。
2、接口方法名和User.xml中定义的每个statement的id相同
3、接口方法的输入参数类型和User.xml中定义的每个sql 的parameterType的类型相同
4、接口方法的输出参数类型和User.xml中定义的每个sql的resultType的类型相同
*/
//根据id查询
public User findUserById(Integer id);
//根据用户名查询用户
List findUserByUsername(String username);
//保存用户
void insertUser(User user);
} 3.4.4 加载UserMapper.xml文件
修改SqlMapConfig.xml文件，添加以下所示的内容：
3.4.5 测试
编写的测试方法如下
package com.hciot.mybatis.test;
import java.io.InputStream;
import java.util.Date;
import java.util.List;
import org.apache.ibatis.io.Resources;
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 com.hciot.mybatis.mapper.UserMapper;
import com.hciot.mybatis.pojo.User;
public class MybatisMapperTest2 {
private SqlSessionFactory sqlSessionFactory;
@Before
public void before() throws Exception {
//1. 加载核心配置文件
String resource = "SqlMapConfig.xml";
InputStream in = Resources.getResourceAsStream(resource);
//2. 创建SqlSessionFactory
sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
}
@Test
public void testFindUserById() {
// 获取sqlSession，和spring整合后由spring管理
SqlSession sqlSession = sqlSessionFactory.openSession();
// 从sqlSession中获取Mapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 执行查询方法
User user = userMapper.findUserById(24);
System.out.println(user);
// 和spring整合后由spring管理
sqlSession.close();
}
@Test
public void testFindUserByUsername() {
// 获取sqlSession，和spring整合后由spring管理
SqlSession sqlSession = this.sqlSessionFactory.openSession();
// 从sqlSession中获取Mapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 执行查询方法
List list = userMapper.findUserByUsername("张");
for (User user : list) {
System.out.println(user);
}
// 和spring整合后由spring管理
sqlSession.close();
}
@Test
public void testSaveUser() {
// 获取sqlSession，和spring整合后由spring管理
SqlSession sqlSession = this.sqlSessionFactory.openSession();
// 从sqlSession中获取Mapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 创建保存对象
User user = new User();
user.setUsername("刘备");
user.setBirthday(new Date());
user.setSex("1");
user.setAddress("蜀国");
// 执行查询方法
userMapper.insertUser(user);
System.out.println(user);
// 和spring整合后由spring管理
sqlSession.commit();
sqlSession.close();
}
}
代码下载：http://download.csdn.net/download/linshaoduoge/10236094