Mybatis

回顾:需要了解JDBC,MySQL,Java基础,Maven,Junit

简介

MyBatis 是一款优秀的持久层框架

MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。

持久化

内存断电即失,数据库jdbc,io文件持久化

为什么需要持久化——有些对象不能丢弃,内存太贵

持久层就是完成持久化工作的代码,每个层之间的界限十分明显

其他

中文文档地址: https://mybatis.org/mybatis-3/zh/index.html

优点:简单,sql写在xml文件中,与java代码解耦

第一个Mybatis程序

流程:搭建环境–导入Mybatis–编写代码–测试

  1. 搭建数据库

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    CREATE DATABASE `mybatis`;

    USE `mybatis`;

    DROP TABLE IF EXISTS `user`;

    CREATE TABLE `user` (
    `id` int(20) NOT NULL,
    `name` varchar(30) DEFAULT NULL,
    `pwd` varchar(30) DEFAULT NULL,
    PRIMARY KEY (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

    insert into `user`(`id`,`name`,`pwd`) values
    (1,'狂神','123456'),
    (2,'张三','abcdef'),
    (3,'李四','987654');
  2. 删除新建工程下面的src文件夹

  3. 导入Mybatis相关的jar包

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    <dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.2</version>
    </dependency>
    <dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.47</version>
    </dependency>
  4. 编写Mybatis核心配置文件,放入resource下方

    查看帮助文档,默认命名为mybatis-config.xml

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    <?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>
    <!--可以配置多个环境,default用以选择默认环境-->
    <environments default="development">
    <environment id="development">
    <transactionManager type="JDBC"/>
    <dataSource type="POOLED">
    <property name="driver" value="com.mysql.jdbc.Driver"/>
    <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=utf8"/>
    <property name="username" value="root"/>
    <property name="password" value="123456"/>
    </dataSource>
    </environment>
    </environments>
    <!--这个是将后面的map配置注册到核心配置文件里-->
    <mappers>
    <mapper resource="com/kuang/dao/userMapper.xml"/>
    </mappers>
    </configuration>
  5. 编写Mybatis工具类

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    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 java.io.IOException;
    import java.io.InputStream;

    //sqlSessionFactory--sqlSession
    public class MybatisUtils {

    private static SqlSessionFactory sqlSessionFactory;

    static {//初始即加载
    try {
    //总的意思是使用Mybatis获取sqlSessionFactory对象
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);//读取配置文件
    sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);//用建造者加载工厂
    } catch (IOException e) {
    e.printStackTrace();
    }
    }

    //获取SqlSession连接
    public static SqlSession getSession(){
    return sqlSessionFactory.openSession();
    }
    }
  6. 编写实体类

    pojo包下,User.java文件

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    public class User {

    private int id; //id
    private String name; //姓名
    private String pwd; //密码

    //构造,有参,无参
    //set/get
    //toString()

    }
  7. 编写Mapper接口类

    dao或者controller包下,UserMapper.java

    1
    2
    3
    4
    5
    6
    import com.kuang.pojo.User;
    import java.util.List;

    public interface UserMapper {
    List<User> selectUser();//查找所有用户
    }
  8. 编写Mapper配置文件

    UserMapper.xml

    注意:namespace十分重要,不能写错

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    <?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">
    <!--namespace绑定一个对应的dao或者mapper接口-->
    <mapper namespace="com.kuang.dao.UserMapper">
    <select id="selectUser" resultType="com.kuang.pojo.User">
    select * from user
    </select>
    </mapper>
  9. 编写测试类

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    public class MyTest {
    @Test
    public void selectUser() {
    //获得sqlsession对象
    SqlSession session = MybatisUtils.getSession();
    //方法一:不推荐
    //List<User> users = session.selectList("com.kuang.mapper.UserMapper.selectUser");
    //方法二:
    UserMapper mapper = session.getMapper(UserMapper.class);//得到接口的实现类即可返回接口对应的类型
    List<User> users = mapper.selectUser();//执行接口中方法

    for (User user: users){
    System.out.println(user);
    }
    session.close();
    }
    }

    可能会出现的问题,读不到配置文件或者mapper文件,在pom中加入一下语句,排除Maven静态资源过滤问题

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    <resources>
    <resource>
    <directory>src/main/java</directory>
    <includes>
    <include>**/*.properties</include>
    <include>**/*.xml</include>
    </includes>
    <filtering>false</filtering>
    </resource>
    <resource>
    <directory>src/main/resources</directory>
    <includes>
    <include>**/*.properties</include>
    <include>**/*.xml</include>
    </includes>
    <filtering>false</filtering>
    </resource>
    </resources>

    没有将mapper注册

    每一个mapper.xml都需要在Mybatis核心配置文件中注册,里面文件中路径格式“/”,不可以用”.”

其他

作用域(Scope)和生命周期

理解我们之前讨论过的不同作用域和生命周期类别是至关重要的,因为错误的使用会导致非常严重的并发问题。


提示 对象生命周期和依赖注入框架

依赖注入框架可以创建线程安全的、基于事务的 SqlSession 和映射器,并将它们直接注入到你的 bean 中,因此可以直接忽略它们的生命周期。 如果对如何通过依赖注入框架使用 MyBatis 感兴趣,可以研究一下 MyBatis-Spring 或 MyBatis-Guice 两个子项目。


SqlSessionFactoryBuilder

这个类可以被实例化、使用和丢弃,一旦创建了 SqlSessionFactory,就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域(也就是局部方法变量)。 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例,但最好还是不要一直保留着它,以保证所有的 XML 解析资源可以被释放给更重要的事情。

SqlSessionFactory

SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次,多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到,最简单的就是使用单例模式或者静态单例模式。

SqlSession

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域,甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中,比如 Servlet 框架中的 HttpSession。 如果你现在正在使用一种 Web 框架,考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。 换句话说,每次收到 HTTP 请求,就可以打开一个 SqlSession,返回一个响应后,就关闭它。 这个关闭操作很重要,为了确保每次都能执行关闭操作,你应该把这个关闭操作放到 finally 块中。 下面的示例就是一个确保 SqlSession 关闭的标准模式:

1
2
3
try (SqlSession session = sqlSessionFactory.openSession()) {
// 你的应用逻辑代码
}

在所有代码中都遵循这种使用模式,可以保证所有数据库资源都能被正确地关闭。

映射器实例

映射器是一些绑定映射语句的接口。映射器接口的实例是从 SqlSession 中获得的。虽然从技术层面上来讲,任何映射器实例的最大作用域与请求它们的 SqlSession 相同。但方法作用域才是映射器实例的最合适的作用域。 也就是说,映射器实例应该在调用它们的方法中被获取,使用完毕之后即可丢弃。 映射器实例并不需要被显式地关闭。尽管在整个请求作用域保留映射器实例不会有什么问题,但是你很快会发现,在这个作用域上管理太多像 SqlSession 的资源会让你忙不过来。 因此,最好将映射器放在方法作用域内。就像下面的例子一样:

1
2
3
4
try (SqlSession session = sqlSessionFactory.openSession()) {
BlogMapper mapper = session.getMapper(BlogMapper.class);
// 你的应用逻辑代码
}