Mybatis

1.简介

Mybatis定义：
MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。
MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。
MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO为数据库中的记录。
它前身是iBatis，2013年迁移到github。
如何获得：
maven仓库: https://mvnrepository.com/artifact/org.mybatis/mybatis

<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.4.6</version>
</dependency>

github:https: //github.com/mybatis/mybatis-3/releases

中文文档：https://mybatis.org/mybatis-3/zh/index
持久化：
持久化是一个把程序的数据在持久状态和瞬时状态转换的过程。
内存：断电即失。
类似于数据库(jdbc)，io文件持久化。
为什么需要持久化：1. 有些对象不能丢失 2. 内存太贵了
持久层：
完成持久化工作的代码块，层界限十分明显。
为什么需要Mybatis
传统jdbc太复杂，简化，框架。帮助程序员把数据存入到数据库。很容易上手。解除sql和程序代码的耦合。

2.Mybatis程序

搭建环境-----导入Mybatis-----编写代码-----测试

2.1 搭建环境

1）搭建数据库

2）新建项目

• 新建一个普通的maven项目
• 删除src目录（父工程）
• 导入依赖

 <!--  导入依赖  -->
    <dependencies>
        <!--  mysql驱动  -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>
        <!--  mybatis  -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>
        <!--  junit  -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.11</version>
        </dependency>
    </dependencies>

2.2 创建子模块

• 编写mybatis的核心配置文件：在resources文件夹下新建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="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/jdbc?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

• 编写mybatis的工具类

SqlSession:类似于PrepareStatement，用于执行已经映射的sql语句

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;

//取自中文手册 https://mybatis.org/mybatis-3/zh/getting-started.html
//sqlSessionFactory--->sqlSession
public class MybatisUtils {

    private static SqlSessionFactory sqlSessionFactory;

    static {
        try {
            //使用mybatis的第一步：获取sqlSessionFactory对象
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    //既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。
    // SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。例如：

    public static SqlSession getSqlSession(){
        SqlSession sqlSession = sqlSessionFactory.openSession();
        return sqlSession;//类似于connection，其实指代数据库
    }
}

2.3 编写代码

• 实体类

• Dao接口

• 接口实现类：UserMapper.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">
<!--namespace绑定一个对应的Dao/Mapper接口
它的原理相当于实现这个Dao接口-->
<mapper namespace="com.yyz.dao.UserDao">
<!-- select查询语句标签
     id对应原来方法名字
     -->
    <select id="getUserList" resultType="com.yyz.pojo.User">
    select * from mybatis.user
  </select>
</mapper>

2.4 测试

package com.yyz.dao;

import com.yyz.pojo.User;
import com.yyz.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

import java.util.List;

public class UserDaoTest {

    @Test
    public void test(){
        //1.获得sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();

        //方式一：getMapper()
        //2.执行sql,getMapper()是为了获取dao的代理对象，可以理解为反射使用dao的方法
        UserDao userDao = sqlSession.getMapper(UserDao.class);
        List<User> userList = userDao.getUserList();

        for (User user: userList) {
            System.out.println(user.toString());
        }

        //关闭SqlSession
        sqlSession.close();
    }
}

注意点：org.apache.ibatis.binding.BindingException: Type interface com.yyz.dao.UserDao is not known to the MapperRegistry. 配置文件加入：

<mappers>
        <mapper resource="com/yyz/dao/UserMapper.xml"/>
</mappers>

另外，如果配置文件没有放在resources文件夹中，就无法查到。这时需要在pom.xml文件中加入如下代码：

    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

可能遇到的问题：

• 配置文件没有注册
• 绑定接口错误
• 方法名不对
• 返回类型不对
• Maven导出资源问题

总结：

1. 首先写MybatisUtils.java，建造工厂获取sqlSessionFactory的实例，借此获得SqlSession的实例。它就代表了数据库。

2. 然后写配置文件mybatis-config.xml，它连接了数据库，是固定代码。

3. 写pojo里的实体类user，根据数据库的表写。

4. 写dao里的接口getUserList

5.  写实现dao的mapper文件，包含了sql语句。namespace绑定接口，里面的标签id绑定方法，返回类型对应于返回值，标签体专注于sql。（最终测试的时候直接调用方法就行了）

注：关于UserDao userDao = sqlSession.getMapper(UserDao.class);涉及到反射知识！

3.CRUD

namespace

namespace中的包名要和mapper接口的包名一致

• id就是对应的namespace中的方法
• resultType是sql语句执行的返回值
• parameterType：参数类型

步骤：

1）编写接口

public interface UserMapper {
    //查询全部用户
    List<User> getUserList();

    //根据id查询用户,对应where id = #{id}
    User getUserById(int id);

    //insert用户
    int addUser(User user);

    //修改用户
    int updateUser(User user);

    //删除用户
    int deleteUser(int id);

}

2）编写对应的mapper中的sql语句

<?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接口
它的原理相当于实现这个Dao接口-->
<mapper namespace="com.yyz.dao.UserMapper">
<!-- select查询语句标签
     id对应原来方法名字
     -->
  <select id="getUserList" resultType="com.yyz.pojo.User">
    select * from mybatis.user
  </select>

  <select id="getUserById" resultType="com.yyz.pojo.User" parameterType="int">
    select * from mybatis.user where id = #{id}
  </select>

    <!-- 对象中的属性可以直接取出来 insert没有resultType-->
  <insert id="addUser" parameterType="com.yyz.pojo.User">
    insert into mybatis.user (id, NAME, pwd) value (#{id}, #{NAME}, #{pwd});
  </insert>

  <!-- 左边的pwd这些就是User里的属性-->
  <update id="updateUser" parameterType="com.yyz.pojo.User">
    update mybatis.user set NAME = #{NAME}, pwd = #{pwd} where id = #{id};
  </update>

  <delete id="deleteUser" parameterType="int">
    delete from mybatis.user where id = #{id};
  </delete>
</mapper>

3）测试：增删改需要提交事务

public class UserMapperTest {
    @Test
    public void testGetUserList(){
        //1.获得sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();

        //方式一：getMapper()
        //2.执行sql,getMapper()是为了获取dao的代理对象，可以理解为反射使用dao的方法
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> userList = userMapper.getUserList();

        for (User user: userList) {
            System.out.println(user.toString());
        }

        //关闭SqlSession
        sqlSession.close();
    }

    @Test
    public void testGetUserById(){
        //1.获得sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();

        //方式一：getMapper()
        //2.执行sql,getMapper()是为了获取dao的代理对象，可以理解为反射使用dao的方法。在jdbc中，要实现一个impl才行
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        User user = userMapper.getUserById(1);

        System.out.println(user.toString());

        //关闭SqlSession
        sqlSession.close();
    }

    //增删改需要提交事务
    @Test
    public void testAddUser(){
        //1.获得sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        //2.执行sql,getMapper()是为了获取dao的代理对象，可以理解为反射使用dao的方法。在jdbc中，要实现一个impl才行
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        int i = userMapper.addUser(new User(2, "公孙离1", "12333333"));
        if (i > 0) {
            System.out.println("插入成功");
        }
        //提交事务
        sqlSession.commit();
        //关闭SqlSession
        sqlSession.close();
    }

    @Test
    public void testUpdateUser(){
        //1.获得sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        userMapper.updateUser(new User(2,"suuuuuu","DWDADADSA"));

        //提交事务
        sqlSession.commit();
        //关闭SqlSession
        sqlSession.close();
    }

    @Test
    public void testDeleteUser(){
        //1.获得sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        userMapper.deleteUser(2);
        //提交事务
        sqlSession.commit();
        //关闭SqlSession
        sqlSession.close();
    }
}

4.万能的Map

假设我们的实体类，数据库中表或者参数过多，我们应当考虑Map。

 //万能的map
    int addUser2(Map<String,Object> map);

<insert id="addUser2" parameterType="map">
    insert into mybatis.user (id, NAME, pwd) value (#{userId}, #{userName}, #{userPwd});
</insert>

 @Test
    public void testAddUser2(){
        //1.获得sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

        HashMap<String, Object> map = new HashMap<String, Object>();
        map.put("userId",5);
        map.put("userName","xx");
        map.put("userPwd","sssss");
        //提交事务
        sqlSession.commit();
        //关闭SqlSession
        sqlSession.close();
    }

• map传递参数，直接在sql中取出key即可：parameterType="map"
• 对象传递参数，直接在sql中取出对象属性即可：parameterType="object"
• 只有一个基本类型参数的情况下，可以直接在sql中取到
• 多个参数用Map，或者注解。

5.模糊查询

• Java代码执行的时候传递通配符%%，但可能会引起sql注入。可以使用concat

sql注入问题：

select * from mybatis.user where NAME = ？；用户传入”1 or 1=1“会查出全部

select * from mybatis.user where NAME like "%"#{value}"%";
//或者
List<User> userLike = userMapper.getUserLike("%孙%");

6.配置解析

mybatis-config.xml

• 环境配置（environments）

不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。想连接两个数据库，就需要创建两个 SqlSessionFactory 实例，每个数据库对应一个 SqlSessionFactory 实例

mybatis默认的事务管理器就是JDBC，连接池是POOLED。

数据源可能是mysql也肯能是oracle，这样可以换着来，但最终只能实现一个。

• 属性（properties）

我们可通过properties属性来实现引用配置文件。

编写一个配置文件，在核心配置文件中引入：

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/jdbc?useSSL=false&useUnicode=true&characterEncoding=UTF-8

<configuration>
    <!--  引入web配置文件(优先使用外部配置文件)  -->
    <properties resource="db.properties">
        <property name="username" value="root"/>
        <property name="password" value="123456"/>
    </properties>

    <environments default="development">
        <environment id="development">
            <!--   JDBC/MANAGED   -->
            <transactionManager type="JDBC"/>
            <!--   数据源有哪些：dbcp/c3p0/druid  作用：连接数据库  类型：UNPOOLED/POOLED/JNDI
                   池：用完可以回收，这次用完还能接着用
             -->
            <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="com/yyz/dao/UserMapper.xml"/>
    </mappers>
</configuration>

• 在xml中，所有标签都可以规定顺序，而properties标签就规定了，只能放在指定位置。
• 优先使用外部配置文件的属性。

• 类型别名（typeAliases）

类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写。

实体类少的时候：可以diy别面

<typeAliases>
        <typeAlias alias="User" type="com.yyz.pojo.User"/>
</typeAliases>

实体类多的时候：在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名

    <typeAliases>
        <typeAlias alias="User" type="com.yyz.pojo.User"/>
        <package name="com.yyz.pojo"/>
    </typeAliases>

如果第二种非要改，也可以在实体类增加注解

@Alias("user")
public class User {}

• 设置（settings）

mapUnderscoreToCamelCase

是否开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。（last_name   ->  lastName）

true | false

False

logImpl

指定 MyBatis 所用日志的具体实现，未指定时将自动查找。

SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING(日志实现)

未设置

cacheEnabled	全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。	true | false	true
lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。（提高效率）	true | false	false

• 映射器（mappers）

1）使用相对于类路径的资源引用 （推荐使用）

<!-- 使用相对于类路径的资源引用 -->
<mappers>
  <mapper resource="com/yyz/dao/UserMapper.xml"/>
</mappers>

2）使用映射器接口实现类的完全限定类名（使用class文件绑定注册）

<mappers>
  <mapper class="com.yyz.dao.UserMapper"/>
</mappers>

注意点：

• 接口和它的Mapper配置文件必须同名。
• 接口和它的Mapper配置文件必须在同一个包下。

3）将包内的映射器接口实现全部注册为映射器（类似于typeAliases里的package）。

<mappers>
  <package name="com.yyz.dao"/>
</mappers>

注意点：和方式二的注意点是一样的。

7.作用域（Scope）和生命周期

错误的使用作用域和生命周期会导致非常严重的并发问题。

1）SqlSessionFactoryBuilder

• 这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。
• 局部变量

2）SqlSessionFactory

• SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例（浪费资源）。
• 因此 SqlSessionFactory 的最佳作用域是应用作用域（全局application，程序开始就开始，结束就结束）。
• 有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。保证全局只有一个变量。
• 说白了可以想象为数据连接池。

3）SqlSession

• 每个线程都应该有它自己的 SqlSession 实例。理解为连接到连接池的一个请求。需要开启和关闭。
• SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 
• 用完之后需要赶紧关闭，否则资源会被占用。
• 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。
• 如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。 换句话说，每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。
• 这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。

• 上图中，每个mapper代表一个具体的业务（CRUD）

• 小结：