(本文参考 MyBatis v.3.1.1 User Guide 中的代码)
mybatis是一个持久层框架,用来替代JDBC实现对数据库访问。
一、主配置文件
既然是对数据库的访问,就需要配置数据库相关的信息,以供连接使用。
因此mybatis需要一个配置文件,来描述数据库的连接参数。MyBatis中这个配置文件是xml格式的,参照MyBatis V3.1.1 User Guide 命名为 mybatis-config.xml
这个文件是主配置文件,还有一些辅助的配置文件在下面细说。为了区分这两类配置文件,下面把mybatis-config.xml称为主配置文件。
mybatis-config.xml文件内容如下:
<?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>
<environments default="development">
<environment id="development">
<transactionManager type="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>
<mappers>
<mapper resource="org/mybatis/example/BlogMapper.xml"/>
</mappers>
</configuration>
配置文件的根元素是configuration,包含environments和mappers;environments又分解为environment;mappers分解为mapper。
environment元素包含transactionManager和dataSource,数据库的配置信息被包含在dataSource元素中。
mapper描述了执行SQL的语句的配置文件,这些文件文中称为辅助的配置文件,或mapper配置文件。这个后面具体说。
对应的schema图,这只是针对上面的xml文件的解释,是部分schema 。
二、主配置文件的使用和SqlSessionFactoryBuilder
1、主配置文件的用法
主配置文件由一个 SqlSessionFactoryBuilder 类实例使用。
String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
把mybatis-config.xml 放到类路径下,将文件路径作为字符串传给Resources类,Resources可以把类路径下的文件转换为InputStream。
这样就获得了SqlSessionFactory的类实例 sqlSessionFactory 。
这样就完成了mybatis 主配置文件的加载,让mybatis知道相关的数据库资源等信息,然后就可以通过mybatis与数据库交互了。
2、SqlSessionFactoryBuilder作用和使用范围
SqlSessionFactoryBuilder的作用是加载并解析配置文件,生成SqlSessionFactory的实例。
SqlSessionFactory生成后,通常不需要再次加载主配置文件,SqlSessionFactoryBuilder就没用了。
因此SqlSessionFactoryBuilder的作用范围可以考虑在局部方法内。(SqlSessionFactory后面再说)举个例子:
public class MyFactory {
public SqlSessionFactory buildSQLSessionFactory(String resource) {
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
return sqlSessionFactory;
}
}
三、SqlSessionFactory 与 SqlSession
1、SqlSessionFactory
SqlSessionFactory 是由 SqlSessionFactoryBuilder 通过主配置文件生成的。mybatis与数据库交互需要用到SqlSession的实例session,每个session完成一个请求的SQL操作。通过sqlSessionFactory实例的openSession()方法可以获得一个SqlSession实例。
SqlSession session = sqlSessionFactory.openSession();
因为每一个请求的SQL操作都需要一个独立的session,sqlSessionFactory要非常频繁的使用,所以sqlSessionFactory要考虑设置为整个应用都可以唯一使用的范围。
上面的代码改写一下:import java.io.IOException;
import java.io.InputStream;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import com.ibatis.common.resources.Resources;
public class MyFactory {
private static SqlSessionFactory sqlSessionFactory = null;
private String resource = null;
public MyFactory(String config) {
resource = config;
}
public SqlSessionFactory getSessionFactory() throws IOException {
if (sqlSessionFactory == null) {
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
}
return sqlSessionFactory;
}
}
2、SqlSession
SqlSession提供了操作数据库的方法。select、insert、update、delete、commit、rollback以及close和getConnection等。
执行数据库的CRUD就涉及到了SQL语句,这就引出了上面提过的辅助的配置文件,这些文件称为mapper配置文件。
mapper元素描述了SqlSession需要执行的SQL语句。
mybatis-config.xml中的mapper
<mapper resource="org/mybatis/example/BlogMapper.xml"/>
对应的BlogMapper.xml文件的内容
<?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="org.mybatis.example.BlogMapper">
<select id="selectBlog" parameterType="int" resultType="Blog">
select * from Blog where id = #{id}
</select>
</mapper>
3、Mapper的用法
对应每个Mapper可以在代码中这样用:
Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);
代码中org.mybatis.example.BlogMapper.selectBlog分为两部分:
org.mybatis.example.BlogMapper对应mapper配置文件中的namespace的值,selectBlog对应select元素中的id的值.
当然,还需要定义一个Blog的POJO类,
public class Blog{
private String id = null;
private String title = null;
public void setId (String blogId){
id = blogId;
}
public void setTitle(String blogTitle){
title = blogTitle;
}
public String getTitle(){
return this.title;
}
public String getId(){
return this.id;
}
}
四、SqlSessionFactoryBuilder、SqlSessionFactory 和SqlSession的关系
五、完整的config schema,不包含mapper的schema