Mybatis入门（一）------基本概念操作

Mybatis简介

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

Mybatis入门

1、安装

一种方式是将mybatis-x.x.x.jar直接置于ClassPath下

另一种方式是使用Maven下载管理jar

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>x.x.x</version>
</dependency>

2、构建SqlSessionFactory

Mybatis的应用是以SqlSessionFactory的一个实例为核心的，SqlSessionFactory 的实例可以通过SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先定制的 Configuration 的实例构建出 SqlSessionFactory 的实例。

基本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>
  <!-- 引入外部配置文件，也可不引入，直接在下面的配置文件中写死 -->
  <!-- <properties resource="database.xml"></properties>  -->
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <!-- Mybatis自带数据库连接池，POOLED代表使用数据库连接池 -->
      <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>

也可以不使用XML配置，直接在Java程序中构建SqlSessionFactory，具体实现方式见Mybatis官方说明

3、配置Mapper.xml

Mapper.xml中存储由用户配置的sql语句，Mybatis支持配置多个Mapper.xml，其中每条sql语句由id唯一标识(同一Mapper.xml中不可重复)，不同Mapper.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.xml中出现重复的id -->
<mapper namespace="com.mybatis.mapper.UserMapper">
  <!-- id唯一的标识了这条语句，因此可以使用namespace+id来映射这条语句 -->
  <!-- resultType给出返回bean的完整类名 -->
  <select id="selectUser" resultType="com.mybatis.model.User">
    select * from Users where id = #{id}
  </select>
</mapper>

4、编码调用sql语句

/**
*Mybatis快速入门，从查询开始
*/
public class DbTest1 {
    private SqlSessionFactory sqlSessionFactory;

    @Before
    public void init() throws IOException {
        //通过mybatis提供的资源加载类加载配置文件
        Reader reader = Resources.getResourceAsReader("Configuration.xml");
        //获取SqlSessionFactoryBuilder
        SqlSessionFactoryBuilder sqlSessionFactroyBuilder = new SqlSessionFactoryBuilder();
        //根据XML配置文件构建SqlSessionFactory
        SqlSessionFactory sqlSessionFactory = sqlSessionFactroyBuilder.build(reader);
        this.sqlSessionFactory = sqlSessionFactory;
    }

    @Test
    public void testQuery1() {
        SqlSession session = sqlSessionFactory.openSession();
        try {
            //sqlsession封装了所有对数据库的操作，包括connection的获取、statement的拼装、resultset的解析
            //第一个参数为mapper.xml中的namespace+id，第二个参数为sql参数
            User user = session.selectOne("com.mybatis.mapper.UserMapper.selectUser", 2);
        } finally {
            //使用完后必须关闭
            session.close();
        }
    }
}

对应的Bean为

public class User {
    //ID
    private String id;
    //用户名
    private String username;
    //密码
    private String password;
    //年龄
    private String age;
    //邮箱
    private String email;
    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id;
    }
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public String getAge() {
        return age;
    }
    public void setAge(String age) {
        this.age = age;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
}

数据库为

范围和生命周期(以下摘自Mybatis官方文档)

理解我们目前已经讨论过的不同范围和生命周期类是很重要的。 不正确的使用它们会导 致严重的并发问题。

1、SqlSessionFactoryBuilder

这个类可以被实例化,使用和丢弃。一旦你创建了 SqlSessionFactory 后,这个类就不需 要存在了。 因此SqlSessionFactoryBuilder 实例的最佳范围是方法范围 (也就是本地方法变量)。 你可以重用SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例, 但是最好的方式是 不需要保持它一直存在来保证所有 XML 解析资源,因为还有更重要的事情要做。

2、SqlSessionFactory

一旦被创建,SqlSessionFactory 应该在你的应用执行期间都存在。没有理由来处理或重 新创建它。 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次。 这样的 操作将被视为是非常糟糕的。 因此 SqlSessionFactory 的最佳范围是应用范围。 有很多方法可 以做到, 最简单的就是使用单例模式或者静态单例模式。

3、SqlSession

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不能被共享,也是线程 不安全的。因此最佳的范围是请求或方法范围。绝对不能将 SqlSession 实例的引用放在一个 类的静态字段甚至是实例字段中。 也绝不能将 SqlSession 实例的引用放在任何类型的管理范 围中, 比如 Serlvet 架构中的 HttpSession。 如果你现在正用任意的 Web 框架, 要考虑 SqlSession 放在一个和 HTTP 请求对象相似的范围内。换句话说,基于收到的 HTTP 请求,你可以打开 了一个 SqlSession,然后返回响应,就可以关闭它了。关闭 Session 很重要,你应该确保使 用 finally 块来关闭它。下面的示例就是一个确保 SqlSession 关闭的基本模式:

SqlSession session = sqlSessionFactory.openSession();
try {
  // do work
} finally {
  session.close();
}

在你的代码中一贯地使用这种模式, 将会保证所有数据库资源都正确地关闭 (假设你没 有通过你自己的连接关闭,这会给 MyBatis 造成一种迹象表明你要自己管理连接资源) 。

4、Mapper 实例

映射器是你创建绑定映射语句的接口。映射器接口的实例可以从 SqlSession 中获得。那 么从技术上来说,当被请求时,任意映射器实例的最宽范围和 SqlSession 是相同的。然而, 映射器实例的最佳范围是方法范围。也就是说,它们应该在使用它们的方法中被请求,然后 就抛弃掉。它们不需要明确地关闭,那么在请求对象中保留它们也就不是什么问题了,这和 SqlSession 相似。你也许会发现,在这个水平上管理太多的资源的话会失控。保持简单,将 映射器放在方法范围内。下面的示例就展示了这个实践:

SqlSession session = sqlSessionFactory.openSession();
try {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  // do work
} finally {
  session.close();
}

5、重要 Object lifecycle and Dependency Injection Frameworks

Dependency Injection frameworks can create thread safe, transactional SqlSessions and mappers and inject them directly into your beans so you can just forget about their lifecycle. You may want to have a look at MyBatis-Spring or MyBatis-Guice sub-projects to know more about using MyBatis with DI frameworks.