使用MyBatis完成CURD的实现

概述

• MyBatis 是一款优秀的持久层框架；
• 它支持自定义 SQL、存储过程以及高级映射。
• MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。
• MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。
• MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。
• 2013年11月迁移到Github。

为什么需要Mybatis

• Mybatis就是帮助程序猿将数据存入数据库中 , 和从数据库中取数据 .

• 传统的jdbc操作 , 有很多重复代码块 .比如 : 数据取出时的封装 , 数据库的建立连接等等… , 通过框架可以减少重复代码,提高开发效率 .

• MyBatis 是一个半自动化的ORM框架 (Object Relationship Mapping) -->对象关系映射

所有的事情，不用Mybatis依旧可以做到，只是用了它，所有实现会更加简单！

MyBatis的优点

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

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

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

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

…

参考文档

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

入门级MyBatis程序搭建

1、建表以及数据插入

-- 建表语句
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,'oldou','123456'),
(2,'zhangsan','abcdef'),
(3,'李四','987654');

2、建立Mavne工程，导入Jar包

新建一个Maven工程进行测试，并且在pom文件中导入以下三个包。

<dependencies>
    <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.3</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.47</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/junit/junit -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
    </dependency>
</dependencies>

3、编写MyBatis核心配置文件mybatis-config.xml

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">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/数据库名?useSSL=true&useUnicode=true&characterEncoding=utf8"/>
                <property name="username" value="用户名"/>
                <property name="password" value="密码"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
    	//这里暂时不写，用于后面扩展会出现的错误
        <mapper resource=""/>
    </mappers>
</configuration>

4、编写MyBatis工具类 MyBatisUtils

每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。
而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。
从 XML 文件中构建 SqlSessionFactory 的实例非常简单，建议使用类路径下的资源文件进行配置。 但也可以使用任意的输入流（InputStream）实例，比如用文件路径字符串或 file:// URL 构造的输入流。MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，使得从类路径或其它位置加载资源文件更加容易。

/**
 * 工具类
 */
public class MyBatisUtils {
    private static SqlSessionFactory sqlSessionFactory = null;
    static{
        try{
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        }catch(Exception e){
            e.printStackTrace();
        }
    }
    //通过工厂获取sqlSession对象。
    // 既然有了sq1sessionFactory，顾名思义，我们就可以从中获得sq1session的实例了.
    //sqlsession完全包含了面向数据库执行sQL命令所需的所有方法。
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }
}

5、创建一个实体类User

这里要注意，属性名要和字段名一致。

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

    //带参无参构造、get/set方法、toString方法    
}

6、编写UserMapper接口类以及方法

public interface UserMapper {
    //查询用户
    List<User> selectUser();
}

7、编写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">
<mapper namespace="com.mybatis.mapper.UserMapper">
    <!--resultType中指的是返回的类型，这里是返回User类型-->
    <select id="selectUser" resultType="com.mybatis.pojo.User">
         select * from user
    </select>
</mapper>

8、编写测试类

import com.mybatis.mapper.UserMapper;
import com.mybatis.pojo.User;
import com.mybatis.utils.MyBatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import java.util.List;

public class MyTest {
    @Test
    public void selectUser(){
        //获取sqlSession对象
        SqlSession sqlSession = MyBatisUtils.getSqlSession();

        //获取Mapper对象,使用和指定语句的参数和返回值相匹配的接口
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        //通过mapper对象调用对应的方法，并且获取结果
        List<User> user = mapper.selectUser();

        //处理结果集
        for (User u : user) {
            System.out.println(u);
        }
        //释放资源，关闭连接
        sqlSession.close();
    }
}

代码测试以及错误提示

错误1

开始代码的测试，运行程序，会出现以下错误：
org.apache.ibatis.binding.BindingException: Type interface com.mybatis.mapper.UserMapper is not known to the MapperRegistry.
意思是UserMapper未注册，这是为什么呢？因为在启动的时候，UserMapper.xml文件需要进行注册，不然UserMapper.xml文件中的sql语句就不能进行执行调用，接下来便是进行配置。

出现以上错误，需要配置如下所示代码：

<mappers>
    <!--加载UserMapper.xml配置文件-->
    <mapper resource="com/mybatis/mapper/UserMapper.xml"/>
</mappers>

然后我们再运行，就会报出以下错误：

错误2

org.apache.ibatis.exceptions.PersistenceException: 
### Error building SqlSession.
### The error may exist in com/mybatis/mapper/UserMapper.xml
### Cause: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: java.io.IOException: Could not find resource com/mybatis/mapper/UserMapper.xml
       
Caused by: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: java.io.IOException: Could not find resource com/mybatis/mapper/UserMapper.xml
        ... 25 more
Caused by: java.io.IOException: Could not find resource com/mybatis/mapper/UserMapper.xml
        ... 27 more

以上错误的原因就是，Maven由于它的约定大于配置，导致我们所写的配置文件的资源无法被导出或者是生效（这里的原因是UserMapper.xml文件放在了Java目录下了，而没有放在Maven的默认存放配置文件的resources目录下），这是使用Maven常见的问题，我们需要进行以下配置才能解决，在pom文件中进行以下代码的添加。意思其实就是将java下的.properties文件和.xml文件能够被导出进行开启。

解决方法

在pom文件中添加资源拷贝插件：

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

添加成功之后我们再运行就可以了：
输出结果为：

使用MyBastis实现增删改查（CURD）

以上代码使用MyBatis实现了基础的查询，接下来便是使用以上搭建的环境实现CURD。

MyBatis的配置文件UserMapper.xml文件中的标签解释

（1）namespace：命名空间，namespace中的包名要和Dao/Mapper接口中的包名一致，包名+类名
（2）select：选择，查询语句。

• id：就是对应的namespace中的接口中的方法名；
• resultType：Sql语句执行的返回值；
• parameterType：参数类型，如果有参数要进行传递，就配置该项。

（3）Insert：插入数据语句
（4）Update：更新数据语句
（5）Delete：删除数据语句

根据ID查询用户

1、在UserMapper接口中添加方法

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

    //根据ID查询用户信息
    User selectUserByID(int id);
}

2、在UserMapper.xml中添加对应的Select语句

    <select id="selectUserByID" resultType="com.mybatis.pojo.User">
        select * from user where id = #{id};
    </select>

3、在测试代码中书写测试代码

@Test
    public void selectUserByID(){
        //获取sqlSession对象
        SqlSession sqlSession = MyBatisUtils.getSqlSession();

        //获取Mapper对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User user = mapper.selectUserByID(3);
        System.out.println(user);
        //释放资源，关闭连接
        sqlSession.close();
    }

结果为：

注意：查询不需要事务，但是增删改需要事务的提交。

增加用户

1、在UserMapper接口中添加方法

    //增加用户信息
    int addUser(User user);

2、在UserMapper.xml中添加对应的Insert语句

    <insert id="addUser" parameterType="com.mybatis.pojo.User">
        insert into user (id,name,pwd) values(#{id},#{name},#{pwd});
    </insert>

3、在测试代码中书写测试代码

@Test
    public void addUser(){
        //获取sqlSession对象
        SqlSession sqlSession = MyBatisUtils.getSqlSession();

        //获取Mapper对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        int flag = mapper.addUser(new User(4, "xiaoou", "abcdefg"));
        if(flag>0){
            System.out.println("数据插入成功。");
        }
        //提交事务
        sqlSession.commit();
        //释放资源，关闭连接
        sqlSession.close();
    }

更新用户信息

1、在UserMapper接口中更新方法

    //更新用户信息
    int updateUser(User user);

2、在UserMapper.xml中添加对应的Update语句

    <update id="updateUser" parameterType="com.mybatis.pojo.User">
        update user set name = #{name}, pwd = #{pwd} where id = #{id};
    </update>

3、在测试代码中书写测试代码

@Test
    public void updateUser(){
        //获取sqlSession对象
        SqlSession sqlSession = MyBatisUtils.getSqlSession();

        //获取Mapper对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        int flag = mapper.updateUser(new User(4,"wangwu","123456"));
        if(flag>0){
            System.out.println("数据更新成功。");
        }
        //提交事务
        sqlSession.commit();
        //释放资源，关闭连接
        sqlSession.close();
    }

删除用户信息

1、在UserMapper接口中删除方法

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

2、在UserMapper.xml中添加对应的Delete语句

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

3、在测试代码中书写测试代码

@Test
    public void deleteUser(){
        //获取sqlSession对象
        SqlSession sqlSession = MyBatisUtils.getSqlSession();

        //获取Mapper对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        int flag = mapper.deleteUser(4);

        if(flag>0){
            System.out.println("数据删除成功。");
        }
        //提交事务
        sqlSession.commit();
        //释放资源，关闭连接
        sqlSession.close();
    }

总结：当框架搭建好之后，只需要在UserMapper接口、UserMapper.xml添加对应的业务逻辑代码，然后在测试中进行调用就可以了。然后还有就是查询业务不需要进行事务的提交，但是增删改业务需要进行业务的提交，如果不进行业务的提交，那么相应操作就不会提交到数据库执行。