保姆级Mybatis入门的基础操作

1、简介

1.1、什么是 MyBatis？

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

• 它支持自定义 SQL、存储过程以及高级映射。

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

• MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

1.2、持久化

数据持久化

• 持久化：是将数据从瞬时状态向持久状态转化的过程

• 内存：断电即失

• 数据库（jdbc），IO文件持久化

为什么需要持久化

有一些对象不能让他丢掉

内存太贵了

1.3、持久层

Dao层，Service层，Controller层。。。。

完成持久化工作的代码块

层界限十分明显

1.4、为什么需要Mybatis？

• 帮助程序员将数据存入到数据库中

• 方便

• 传统的JDBC代码太复杂。Mybatis代码更加简化，使用框架更加自动化。

• 简单易学：本身就很小且简单。没有任何第三方依赖，最简单安装只要两个jar文件+配置几个sql映射文件易于学习，易于使用，通过文档和源代码，可以比较完全的掌握它的设计思路和实现。

• 灵活：mybatis不会对应用程序或者数据库的现有设计强加任何影响。 sql写在xml里，便于统一管理和优化。通过sql语句可以满足操作数据库的所有需求。

• 解除sql与程序代码的耦合：通过提供DAO层，将业务逻辑和数据访问逻辑分离，使系统的设计更清晰，更易维护，更易单元测试。sql和代码的分离，提高了可维护性。

• 提供映射标签，支持对象与数据库的orm字段关系映射

• 提供对象关系映射标签，支持对象关系组建维护

• 提供xml标签，支持编写动态sql。

2、使用

2.1、配置环境

要使用 MyBatis， 只需将 mybatis-x.x.x.jar 文件置于类路径（classpath）中即可。

如果使用 Maven 来构建项目，则需将下面的依赖代码置于 pom.xml 文件中：

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

2.2、从 XML 中构建 SqlSessionFactory

每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。

从 XML 文件中构建 SqlSessionFactory 的实例非常简单，建议使用类路径下的资源文件进行配置。 但也可以使用任意的输入流（InputStream）实例，比如用文件路径字符串或 file:// URL 构造的输入流。MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，使得从类路径或其它位置加载资源文件更加容易。

String resource = "org/mybatis/example/mybatis-config.xml";//根据自己的文件路径和名字配置
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

XML 配置文件中包含了对 MyBatis 系统的核心设置，包括获取数据库连接实例的数据源（DataSource）以及决定事务作用域和控制方式的事务管理器（TransactionManager）。后面会再探讨 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">
    //数据库配置根据自己的使用数据库的实际情况来配置
    //注意一点：从mysql 8.0以后驱动的地址要加上cj
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/shop?userSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8&amp;serverTimezone=GMT"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    //下面是经常出现问题的一点
<!--    每一个Mapper.xml文件都需要在Mybatis核心配置文件中注册！！-->
    <mappers>
        <mapper resource="com/ajie/demo/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

当然，还有很多可以在 XML 文件中配置的选项，上面的示例仅罗列了最关键的部分。 注意 XML 头部的声明，它用来验证 XML 文档的正确性。environment 元素体中包含了事务管理和连接池的配置。mappers 元素则包含了一组映射器（mapper），这些映射器的 XML 映射文件包含了 SQL 代码和映射定义信息。

这里只介绍了使用xml文件来构建SQLSessionFactory的方式，也是最常用的方式。

2.3、SqlSessionFactoryBuilder

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

2.4、SqlSessionFactory

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

2.5、SqlSession

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

3、CRUD

3.1、namespace

UserMapping.xml中的namespace的地址要指向自己实体类创建的位置

<mapper namespace="com.ajie.demo.dao.UserDao">

3.2、流程

1.创建实体类User

package com.ajie.demo.pojo;

public class User {
    private int id;
    private String name;
    private String pwd;

    public User() {
    }
    public User(int id, String name, String pwd) {
        this.id = id;
        this.name = name;
        this.pwd = pwd;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPwd() {
        return pwd;
    }

    public void setPwd(String pwd) {
        this.pwd = pwd;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", pwd='" + pwd + '\'' +
                '}';
    }
}

1.在UserDao接口类中编写自己的接口

 //查询全部用户
    List<User> getUserList();
    //查询对应用户
    User getUserById(int id);
    User getUser2(Map<String,Object> map);
    //添加用户
    int saveUser(User user);
    int saveUser2(Map<String,Object> map);
    //删除一个用户
    int deleteUserById(int id);
    //更新一个用户
    int updateUser(User user);

2.在UserMapper.xml文件中编写对应的SQL语句

注意：UserMapper.xml文件中的id要对应编写的方法，不要写错。resultType指的是返回结果的类型，例如第一个返回结果是User类型，所以就指明User类 ，parameterType指的是方法需要的参数的类型。

<!--    select查询全部用户-->
    <select id="getUserList" resultType="com.ajie.demo.pojo.User">
        select * from shop.mtsuser;
    </select>
<!--    根据ID查询指定用户1-->
    <select id="getUserById" resultType="com.ajie.demo.pojo.User" parameterType="int">
        select * from shop.mtsuser where id = #{id};
    </select>
<!--    根据ID查询指定用户2-->
    <select id="getUser2" resultType="com.ajie.demo.pojo.User" parameterType="map">
        select * from shop.mtsuser where id = #{userid} and name = #{username};
    </select>
<!--    添加一个用户-->
    <insert id="saveUser" parameterType="com.ajie.demo.pojo.User">
        insert into shop.mtsuser (id,name,pwd) values (#{id},#{name},#{pwd});
    </insert>
<!--    添加一个用户2-->
    <insert id="saveUser2" parameterType="map">
        insert into shop.mtsuser (id,name,pwd) values (#{userid},#{username},#{userpwd});
    </insert>
<!--    删除一个用户-->
    <delete id="deleteUserById" parameterType="int">
        delete from shop.mtsuser where id = #{id};
    </delete>
<!--    更新一个用户-->
    <update id="updateUser" parameterType="com.ajie.demo.pojo.User">
        update shop.mtsuser set name = #{name},pwd = #{pwd} where id = #{id};
    </update>

3、测试：创建自己的测试类。

测试类所在的结构，尽量与自己上面的代码结构保持一致，防止不必要的错误。

@Test
    public void getUserList() {
        //第一步：获取SQLSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        try {
            //方式一(常用)：getMapper
            UserDao userDao = sqlSession.getMapper(UserDao.class);
            List<User> userList = userDao.getUserList();
​
            for (User user : userList) {
                System.out.println(user);
            }
        } finally {
            //用完之后关闭sqlSession
            sqlSession.close();
        }
    }
​
    @Test
    public void getUserById() {
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        try {
            UserDao mapper = sqlSession.getMapper(UserDao.class);
            User user = mapper.getUserById(1);
            System.out.println(user);
        } finally {
            sqlSession.close();
        }
    }
​
    //增删改需要提交事务
    @Test
    public void saveUser() {
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        try {
            UserDao mapper = sqlSession.getMapper(UserDao.class);
            int i = mapper.saveUser(new User(4, "说的是", "456"));
            if (i == 1) {
                System.out.println("用户添加成功！");
            }else {
                System.out.println("用户添加失败！");
            }
        } finally {
            sqlSession.commit();
            sqlSession.close();
        }
    }
​
    @Test
    public void deleteUserById() {
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        try {
            UserDao mapper = sqlSession.getMapper(UserDao.class);
            int i = mapper.deleteUserById(4);
            if (i == 1) {
                System.out.println("成功删除用户");
            }else {
                System.out.println("删除用户失败");
            }
        } finally {
            sqlSession.commit();
            sqlSession.close();
        }
    }
​
    @Test
    public void updateUser() {
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        try {
            UserDao mapper = sqlSession.getMapper(UserDao.class);
            int i = mapper.updateUser(new User(3, "反反复复", "33333"));
            if (i == 1) {
                System.out.println("更新用户成功！");
            }else {
                System.out.println("更新用户失败！");
            }
        } finally {
            sqlSession.commit();
            sqlSession.close();
        }
    }
​
    @Test
    public void getUser2() {
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        try {
            UserDao mapper = sqlSession.getMapper(UserDao.class);
            Map<String, Object> map = new HashMap<>();
            map.put("userid","2");
            map.put("username","李四");
            User user = mapper.getUser2(map);
            System.out.println(user);
        } finally {
            sqlSession.close();
        }
    }
​
    @Test
    public void saveUser2() {
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        try {
            UserDao mapper = sqlSession.getMapper(UserDao.class);
            Map<String,Object> map = new HashMap<>();
            map.put("userid",5);
            map.put("username","map添加方法1");
            map.put("userpwd","567");
            int i = mapper.saveUser2(map);
        } finally {
            sqlSession.commit();
            sqlSession.close();
        }
    }

注意：编写测试的时候

1、增加、删除、修改的操作一定要在代码里加上事务提交-------》sqlSession.commit();否则数据库中看不到数据的变化。

2、官方推荐在代码加上try finally 以保证最后能够提交事务和关闭连接。