万字 MyBatis 带你从入门到精通！！！

MyBatis

首先，什么是 MyBatis ？

官方介绍的很清楚：MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

1. 入门使用

在 Maven 项目中的使用。

先看下结构，避免一些不必要的问题。

1.1 导入相关 Maven 依赖

    <!--导入依赖-->
    <dependencies>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>
        <!--mybatis-->
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.2</version>
        </dependency>
        <!--junit-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
    </dependencies>

1.2 创建并配置核心文件

在 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核心配置文件 -->
<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/mybatis?useSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value="1024"/>
            </dataSource>
        </environment>
    </environments>
<!-- Mapper 配置文件的位置 -->
    <mappers>
        <mapper resource="com/yuanxion/dao/UserMapper.xml"/>
    </mappers>
</configuration>

1.3 编写 MyBatis 工具类

编写 MyBatis 工具类可以方便我们使用 MyBatis ，就不需要我们每次都去写这一堆代码。

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();
        }

    }
    //有了 SqlSessionFactory 之后，我们就可以从中获得 SqlSession 的实例了。
    // SqlSession 完全包含了面向数据库执行 SQL 命令所需的所有方法。
    public static SqlSession getSqlSession(){
   
        return sqlSessionFactory.openSession();
    }
}

1.4 编写实体类

这个实体类是数据库中所要操作表的对应的实体类。
类名、字段名，都要和数据库表中的一样，并提供相应的 get、set 方法。

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.5 编写实体类对应的 Mapper 接口

编写实体类对应的 Mapper 接口，并在这个借口中添加需要进行的操作，比如查询出表中所有的数据。

public interface UserMapper {
   
    //查询所有用户信息
    List<User> getUserList();
}

1.6 编写 Mapper 配置文件

原来是要实现上面的Mapper接口，现在在 Mapper 配置文件绑定和配置。

<?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.yuanxion.dao.UserMapper">
    
    <!-- select查询语句 -->
    <select id="getUserList" resultType="com.yuanxion.pojo.User">
       select * from user
   </select>
    
</mapper>

select 标签中：

• id : 对应的 namespace 绑定的接口中的方法名。

• resultType：Sql 语句执行之后的返回值。

1.7 测试

测试一下数据库连接和查询：

@Test
    public void test() {
   
        
        //1. 得SqlSession对象
        //因为前面已经写好了工具类，直接使用工具类来获取即可。
        SqlSession sqlSession = MyBatisUtils.getSqlSession();

        //2. 从 sqlSession 中获取所需实体类的 Mapper 
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        
        //3. 使用该 Mapper 调用我们在 Mapper 配置文件中配置的查询方法
        List<User> userList = userMapper.getUserList();

        //4. 遍历我们的查询结果并输出
        for (User user : userList) {
   
            System.out.println(user);
        }

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

    }

如果没什么问题，我们就可以链接并查询成功了。

1.8 一些可能的问题

如果发生了异常，可能是如下原因中的一种：

1. 核心配置文件中的数据库连接信息没有改成自己的。
2. 核心配置文件中的 Mapper 配置文件的位置 没有改成自己的。
3. 方法名或返回类型写错了。
4. 没有导入相应的 Maven 资源。
5. 字符集问题。
6. 配置文件中的写了中文注释。
   虽然我写了中文注释并没有什么问题，但是发现有些人报错的原因在这里。可以删除试试。
7. 更多可能的问题，根据报错信息可以去百度、谷歌等查询解决办法。

2. CRUD

2.1 Select

2.1.1 在对应 Mapper 类 UserMapper 中添加接口

//根据用户 ID 查询用户
User getUserById(int id);

2.1.2 在 Mapper 配置文件中编写 SQL 语句

<!-- 根据 ID 查询用户 -->
    <select id="getUserById" parameterType="int"  resultType="com.yuanxion.pojo.User">
       select * from user where id = #{id}
    </select>

select 标签中的：

• id : 对应的 namespace 绑定的接口中的方法名。
• resultType：Sql 语句执行之后的返回值。
• parameterType：这个SQL所对应方法传入的参数的类型。

方法传入的参数用 #{参数名} 接收，类似于一个占位符。

比如这个方法中传入的是 id，那这里就使用 #{id} 接收。

2.1.3 测试

@Test
public void testSelect() {
    //第一步：获得SqlSession对象
    SqlSession sqlSession = MyBatisUtils.getSqlSession();

    //方式一：getMapper
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    User user = userMapper.getUserById(1);

    System.out.println(user);

    //关闭SqlSession
    sqlSession.close();

}

2.2 Update、Delete、Insert —（增删改需要提交事务）

**注意：**增删改这3个操作需要提交事务！！（sqlSession.commit();）

2.2.1 在对应 Mapper 类 UserMapper 中添加接口

public interface UserMapper {
   
    //根据用户 ID 查询用户
    User getUserById(int id);

    //新增一个用户
    void addUser(User user);

    //修改一个用户
    void updateUser(User user);

    //根据 id 删除一个用户
    void deleteUser(int id);

}

2.2.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接口 -->
    <mapper namespace="com.yuanxion.dao.UserMapper">

    <!-- 新增一个用户 -->
    <insert id="addUser"  parameterType="com.yuanxion.pojo.User">
       insert into user (id, name, pwd) values (#{id}, #{name}, #{pwd});
    </insert>

    <!-- 修改一个用户 -->
    <update id="updateUser" parameterType="com.yuanxion.pojo.User">
        update user set name=#{name},pwd=#{pwd}  where id = #{id} ;
    </update>

    <!-- 根据 id 删除一个用户 -->
    <delete id="deleteUser" parameterType="int">
       delete from user where id = #{id};
    </delete>

</mapper>

• parameterType 传入的参数类型可以是一个对象，#{参数} 可以直接从传入的对象中获取。

  比如例子中传入的是 User 对象，#{id} 就可以直接获取传入 User 对象的 id。

2.2.3 测试

我们前面两步写好之后，增、删、改 这些操作都差不多。

但是一定要注意的是：增、删、改 之后要提交事务。（sqlSession.commit();）

    @Test
    public void testAddUser() {
   
        //第一步：获得SqlSession对象
        SqlSession sqlSession = MyBatisUtils.getSqlSession();

        //方式一：getMapper
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

        //创建一个 User 对象
        User user = new User(33, "3333", "3333");
        //添加一个User对象
        userMapper.addUser(user);

        //注意：增、删、改 之后，要提交事务。
        sqlSession.commit();

        //关闭SqlSession
        sqlSession.close();

    }


@Test
    public void testUpdateUser() {
   
        //第一步：获得SqlSession对象
        SqlSession sqlSession = MyBatisUtils.getSqlSession();

        //方式一：getMapper
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);