MyBatis学习随笔（1）

前言

本篇文章是跟随遇见狂神说学习MyBatis的第一篇随笔。在跟随遇见狂神说的视频学习的过程中，学会了如何学习MyBatis，明白了MyBatis的本质是什么。同时狂神根据文档的教学也让我有深刻的学习体会。
MyBatis系列文章将根据MyBatis的中文文档以及我的学习心得拼接完成，文档链接如下：MyBatis中文文档

MyBatis是什么

MyBatis是一款优秀的持久层框架，它支持自定义SQL、存储过程以及高级映射。MyBatis免除了几乎所有的JDBC代码以及设置参数和获取结果集的工作。MyBatis可以通过简单的XML或注解来配置和映射原始类型、接口和Java POJO（JavaBean，即Java对象）为数据库中的记录。
上述的描述出自MyBatis中文文档的简介部分，从描述中我们可以得出以下信息：

• MyBatis是一个框架，框架说明MyBatis在开发中并不是必须的，即可有可无，但是使用MyBatis框架能够优化项目，降低项目的复杂度，便于维护
• MyBatis优点就在于免除了JDBC中复杂的参数设置和获取结果集、处理结果集的过程，使得在开发过程中程序员只用专注于业务层面的代码，不用反复的写相同的结果集处理代码
• MyBatis通过XML文件来配置数据库，完成SQL语句、接口和实体类之间的映射

第一个MyBatis项目

前置准备

创建数据库

MyBatis是Java处理数据库的框架，所以首先应该创建一个数据库，用来做练习。

CREATE TABLE user(
	id int PRIMARY KEY,
	name VARCHAR(50),
	pwd VARCHAR(50)
)ENGINE=INNODB DEFAULT CHARSET=utf8;

INSERT INTO user(id, name, pwd) VALUES 
(1, '张三', '123456'),
(2, '李四', '123456'),
(3, '轩五', '123456')

MyBatis依赖

在使用MyBatis前需要先导入MyBatis的依赖

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

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.1</version>
        </dependency>
    </dependencies>

SqlSession

Sqlsession提供了在数据库执行SQL命令的所有方法，可以通过Sqlsession实例来调用已经完成SQL映射的接口方法，以完成对数据库的操作。
而Sqlsession是通过SqlSessionFactory创建实例出来的，每一个基于MyBatis的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 则是由 SqlSessionFactoryBuilder 通过MyBatis的XML核心配置文件创建出来的实例，具体的创建方法下面会有代码展示

package util;

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;

public class MybatisUtils {
    static  SqlSessionFactory sqlSessionFactory;
    //这里使用static代码块的原因是想让代码一运行就创建一个SqlSessionFactory实例
    static{
        String resources = "mybatis-config.xml";
        InputStream inputStream = null;
        try {
            inputStream = Resources.getResourceAsStream(resources);
        } catch (IOException e) {
            e.printStackTrace();
        }
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }

    //获取SqlSession的方法，每当需要执行SQL语句的时候都要调用这个方法
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }
}

从上述代码中可以知道SqlSessionFactoryBuilder()通过build()方法可以创建出SqlSessionFactory实例，然后SqlSessionFactory实例在通过openSession()方法创建出sqlSession实例，之后每次要执行SQL语句时，只需要使用sqlSession调用其内置的方法即可。
但是SqlSessionFactoryBuilder()依凭的XML文件——mybatis-config.xml在哪里呢？

Mybatis核心配置文件

在sqlSession模块的代码中有一个文件mybatis-config.xml，这个文件就是MyBatis的核心配置文件，文件中可以配置MyBatis的属性、设置、类型别名、环境配置等等，配置文件后续会说。
在这里我们只需要知道，该核心配置文件目前的功能就是配置连接数据库的信息，让 SqlSessionFactoryBuilder() 能够读取到信息从而创建 SqlSessionFactory 实例。
核心配置文件目前的代码如下：

<?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"></transactionManager>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://127.0.0.1:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value="2222"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

有细心的可能会发现在url中的&变成了&，这是xml中&较为特殊，所以需要转义。

MyBatis代码实现查询

目前前置准备已经完成，那么就让我们使用MyBatis来完成第一个查询语句吧。
首先需要创建实体类，实体类属性要求和数据库命名一致。

package 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;
    }
}

第二步则是要创建一个接口，用来定义方法以便后续执行SQL语句时调用。

package com.mybatis.dao;
import com.mybatis.pojo.User;
import java.util.List;

public interface userMapper {
    public List<User> getUserList();
}

第三步也就是最重要的一步，实现SQL语句的userMapper.xml文件，该文件就是SQL语句的代码。到这里就体现了和JavaWeb学习中的区别，JavaWeb中是创建了一个类实现接口的方法，同时还要处理结果集等等。而在userMapper.xml中不需要处理结果集，只需要处理好xml文件、接口和实体类之间的映射，就可以只关注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">

<mapper namespace="com.mybatis.dao.userMapper">
    <select id="getUserList" resultType="com.mybatis.pojo.User">
        select * from user;
    </select>
</mapper>

在上述的代码中可能会让大家疑惑，id指的是接口文件中对应的方法名，resultType则表示的是返回类型，注意这个返回类型要填写完全限定名，虽然麻烦，但是后续会有别名来替代，这个后续再说。
在实现userMapper.xml文件的代码后，不要忘记在核心配置文件——mybatis-config.xml中注册userMapper.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://127.0.0.1:3306/mybatis?useSSL=false&amp;useUnicode=false&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value="2222"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper resource="com/mybatis/dao/userMapper.xml"/>
    </mappers>
</configuration>

测试

到此为止，一个简单的mybatis查询就算完成了，接下来测试一下是否会出现错误，以下为测试代码：

import com.mybatis.dao.userMapper;
import com.mybatis.pojo.User;
import com.mybatis.util.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import java.util.List;

public class MybatisTest {

    @Test
    public void Test(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        userMapper mapper = sqlSession.getMapper(userMapper.class);
        List<User> userList = mapper.getUserList();

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

可能会出现的错误

在执行测试文件的过程中，我出现了一些错误。这一小节讲一下我再执行中出现的错误以及可能出现的错误。

习惯错误

### Error building SqlSession.
### Cause: org.apache.ibatis.builder.BuilderException: Error creating document instance.  Cause: org.xml.sax.SAXParseException; lineNumber: 11; columnNumber: 104; 对实体 "useUnicode" 的引用必须以 ';' 分隔符结尾。

这个错误的出现往往是习惯所致，在Javaweb的学习中，连接数据库时使用的是&，而在xml中应该使用&

                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://127.0.0.1:3306/mybatis?useSSL=false&amp;useUnicode=false&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value="2222"/>

找不到userMapper.xml文件

## Error building SqlSession.
### The error may exist in com/mybatis/dao/userMapper.xml
### Cause: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: java.io.IOException: Could not find resource com/mybatis/dao/userMapper.xml

这个错误可能是系统扫描不到非resource中的xml文件，解决问题的方式就是在pom.xml文件中加入以下代码，使文件扫描时注意到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>

当然引起这个的原因也有可能是没有在核心配置文件中注册uerMapper.xml文件，没有注册，mybatis在扫描时自然不会注意了。

    <mappers>
        <mapper resource="com/mybatis/dao/userMapper.xml"/>
    </mappers>

总结

到此为止，完成了一个简单mybatis查询语句，只要勤加练习，就会发现mybatis并不复杂，后续会讲述配置文件的功能，这样在书写配置文件的时候也不会感到吃力了。
那么总结以下本篇文章的重点：

1. Mybatis是一个优秀的框架，使得程序员在进行JDBC操作时减少了重复代码的书写
2. 应用Mybatis的项目，需要添加mybatis和mysql-connector-java依赖
3. Mybatis项目中进行SQL语句操作需要SqlSession实例，一般情况下会创建一个类来获取SqlSession实例和能够创建SqlSession实例的SqlSessionFactory实例
4. 应用Mybatis的项目需要创建核心配置文件——mybatis-config.xml
5. Mybatis替换了JDBC的接口实现类，核心就是处理实体类、接口和实现SQL的xml文件之间的映射关系
6. userMapper.xml(实现SQL的xml文件)中实现SQL代码中mapper标签中的namespace对应的是接口文件，mapper标签下的SQL标签中的id是对应接口的对应方法，而resultType则是返回类型
7. 在完成userMApper.xml的实现后，要在核心配置文件中注册