使用MyBatis框架实现增删改查操作（CRUD）

一、准备工作

1、创建一个Maven工程（这里以IDEA为例）

2、在pom.xml文件中配置：打包方式、导入Mybatis依赖、 MySQL依赖、log4j日志依赖、junit单元测试依赖，加入如下xml代码

<!-- 打包方式（jar包） -->
<packaging>jar</packaging>

<dependencies>
    <!-- 导入Mybatis依赖 -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.5</version>
    </dependency>
    <!-- 导入MySQL依赖 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.20</version>
    </dependency>
    <!-- 导入log4j日志依赖 -->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.17</version>
    </dependency>
    <!-- 导入单元测试依赖 -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.10</version>
        <scope>test</scope>
    </dependency>
</dependencies>

3、新建一张user表（建表SQL语句如下）

CREATE TABLE `user` (
  `id` INT(11) NOT NULL auto_increment,
  `username` VARCHAR(32) NOT NULL COMMENT '用户名称',
	`sex` CHAR(6) DEFAULT NULL COMMENT '性别',
  `birthday` datetime DEFAULT NULL COMMENT '生日',
  `address` VARCHAR(256) DEFAULT NULL COMMENT '地址',
  PRIMARY KEY  (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

4、插入一些测试数据

INSERT INTO `user` VALUES (1, '张三', '男', '2020-09-14 15:21:50', '遵义市-红花岗区');
INSERT INTO `user` VALUES (2, '李四', '男', '2020-09-14 15:23:58', '遵义市-汇川区');
INSERT INTO `user` VALUES (3, '丽丽', '女', '2020-09-14 15:25:48', '遵义市-播州区');
INSERT INTO `user` VALUES (4, '王五', '男', '2020-09-14 15:26:29', '贵阳市-南明区');
INSERT INTO `user` VALUES (5, '小红', '女', '2020-09-14 15:27:11', '贵阳市-观山湖区');

二、编写业务逻辑代码及做好相关配置

1、创建实体类User并实现Serializable接口，创建user表中的所有属性并生成他们的Getter() and Setter()方法与toString()方法

package com.demo.domain;

import java.io.Serializable;
import java.util.Date;

public class User implements Serializable {
    private Integer id;
    private String username;
    private String sex;
    private Date birthday;
    private String address;

    public Integer getId() {
        return id;
    }

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

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    public String getAddress() {
        return address;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", username='" + username + '\'' +
                ", sex='" + sex + '\'' +
                ", birthday=" + birthday +
                ", address='" + address + '\'' +
                '}';
    }
}

2、创建UserDao接口，提供一个查询所有方法findAll()

package com.demo.dao;

import com.demo.domain.User;

import java.util.List;

/**
 * 用户的持久层接口
 */
public interface UserDao {

    /**
     * 保存用户
     * @param user
     */
    void saveUser(User user);

    /**
     * 查询所有用户
     * @return
     */
    List<User> findAll();

    /**
     * 根据id查询用户
     * @param id
     * @return
     */
    User findById(Integer id);

    /**
     * 根据名称模糊查询用户信息
     * @param username
     * @return
     */
    List<User> findByName(String username);

    /**
     * 更新用户
     * @param user
     */
    void updateUser(User user);

    /**
     * 根据id删除用户
     * @param id
     */
    void deleteUser(Integer id);

}

3、在resources目录下创建jdbcConfig.properties文件，用户配置数据库连接的相关信息

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?useUnicode=ture&characterEncoding=UTF-8&serverTimezone=GMT%2B8
jdbc.username=root
jdbc.password=123456

4、在resources目录下创建一个SqlMapConfig.xml文件，并加入如下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">
<!-- mybatis的主配置文件 -->
<configuration>
    <!-- 配置properties（引入jdbcConfig.properties） -->
    <properties resource="jdbcConfig.properties"></properties>
    <!-- 配置环境 -->
    <environments default="mysql">
        <!-- 配置mysql的环境 -->
        <environment id="mysql">
            <!-- 配置事务类型 -->
            <transactionManager type="JDBC"/>
            <!-- 配置数据源（连接池） -->
            <dataSource type="POOLED">
                <!-- 配置连接数据库的4个基本信息，从jdbcConfig.properties中获取 -->
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>
    <!-- 指定映射配置文件的位置，映射配置文件指的是每个dao独立的配置文件 -->
    <mappers>
        <mapper resource="com/uanin/dao/UserMapper.xml"/>
    </mappers>
</configuration>

5、在resources目录下面创建一个与java目录下面同名同层级的目录结构，并在其下新建一个UserMapper.xml的映射配置文件

6、在其UserMapper.xml映射配置文件中加入如下代码

<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<!-- namespace属性的值为UserDao接口的全限定类名 -->
<mapper namespace="com.demo.dao.UserDao">

    <!-- 查询所有用户信息 -->
    <select id="findAll" resultType="com.demo.domain.User">
        select * from user
    </select>

    <!-- 保存用户 -->
    <insert id="saveUser" parameterType="com.demo.domain.User">
        <selectKey keyProperty="id" keyColumn="id" resultType="int" order="AFTER">
            select last_insert_id()
        </selectKey>
        insert into user(username, birthday, sex, address) value(#{username}, #{birthday}, #{sex}, #{address})
    </insert>

    <!-- 根据用户id更新用户信息 -->
    <update id="updateUser" parameterType="com.demo.domain.User">
        update user set username=#{username}, birthday=#{birthday}, sex=#{sex}, address=#{address} where id=#{id}
    </update>

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

    <!-- 根据id查询用户 -->
    <select id="findById" parameterType="Integer" resultType="com.demo.domain.User">
        select * from user where id=#{id}
    </select>

    <!-- 根据名称模糊查询用户信息 -->
    <select id="findByName" parameterType="string" resultType="com.demo.domain.User">
        select * from user where username like #{username}
    </select>

</mapper>

注意事项：

Mybatis的映射配置文件位置必须和dao接口的包结构相同；

映射配置文件的mapper标签的namespace属性的取值必须是dao接口的全限定类名;

映射配置文件的操作配置标签（select、insert、delete、update）的id属性的取值必须是dao接口里的方法名。

7、在resources目录下面创建log4j.properties文件（用于配置日志log4j输出的相关信息）

# Set root category priority to INFO and its only appender to CONSOLE.
#log4j.rootCategory=INFO, CONSOLE            debug   info   warn error fatal
log4j.rootCategory=debug, CONSOLE, LOGFILE

# Set the enterprise logger category to FATAL and its only appender to CONSOLE.
log4j.logger.org.apache.axis.enterprise=FATAL, CONSOLE

# CONSOLE is set to be a ConsoleAppender using a PatternLayout.
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n

# LOGFILE is set to be a File appender using a PatternLayout.
log4j.appender.LOGFILE=org.apache.log4j.FileAppender
#指定日志文件的输出路径
log4j.appender.LOGFILE.File=d:\\axis.log
log4j.appender.LOGFILE.Append=true
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
log4j.appender.LOGFILE.layout.ConversionPattern=%d{ISO8601} %-6r [%15.15t] %-5p %30.30c %x - %m\n

三、准备测试工作

1、快捷键 Ctrl + Shift + T 弹出自动创建测试类窗口，勾选要测试的方法

2、勾选好要测试的方法后，点击OK即可生成测试类

3、由于测试方法执行前都需要获取dao接口的代理对象，所以我们将获取dao代理对象的流程放到初始化方法 init()中，并在 init()上加@Before注解（表示在测试方法执行之前执行）

private InputStream inputStream;
private SqlSession sqlSession;
private UserDao userDao;

@Before // 表示在测试方法执行之前执行
public void init() throws Exception {
    // 1、读取配置文件，生成字节输入流
    inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
    // 2、获取SqlSessionFactory
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    // 3、获取SqlSession对象
    sqlSession = sqlSessionFactory.openSession();
    // 4、获取dao的代理对象
    userDao = sqlSession.getMapper(UserDao.class);
}

3、由于测试方法执行后都需要释放资源，所以我们将释放资源的流程放到销毁方法destroy()中，并在 destroy()上加@After注解（表示在测试方法执行之后执行）

@After // 表示在测试方法执行之后执行
public void destroy() throws Exception {
    // 6、提交事务（Mybatis的插入、删除、更新等采用了事务管理）
    sqlSession.commit();
    // 7、释放资源
    sqlSession.close();
    inputStream.close();
}

四、开始CRUD单元测试

1、增加：执行saveUser()方法保存用户

@Test
public void saveUser() {
    User user = new User();
    user.setUsername("王二");
    user.setBirthday(new Date());
    user.setSex("男");
    user.setAddress("遵义市-红花岗区");
    // 5、执行保存用户方法
    userDao.saveUser(user);
}

2、检索：

1）执行findAll()查询所有用户信息

@Test
public void findAll() {
    // 5、执行查询所有方法
    List<User> users = userDao.findAll();
    for (User user:users) {
        System.out.println(user);
    }
}

2）执行findById()方法，根据用户id查找用户信息

@Test
public void findById() {
    // 5、执行根据用户id查找用户信息方法
    User user = userDao.findById(3);
    System.out.println(user);
}

3）执行findByName()方法，根据名称模糊查询用户信息

@Test
public void findByName() {
    // 5、执行根据名称模糊查询用户信息方法
    List<User> users = userDao.findByName("%王%");
    for (User user : users) {
        System.out.println(user);
    }
}

3、更新：执行updateUser()方法，根据用户id更新用户信息

@Test
public void updateUser() {
    User user = new User();
    user.setId(1);
    user.setUsername("小王");
    user.setBirthday(new Date());
    user.setSex("男");
    user.setAddress("贵阳市-云岩区");
    // 5、执行更新用户信息方法
    userDao.updateUser(user);
}

4、删除：执行deleteUser()方法，根据用户id删除用户信息

@Test
public void deleteUser() {
    // 5、执行删除用户信息方法（根据用户id）
    userDao.deleteUser(2);
}

5、UserDaoTest.java 代码如下

package com.demo.dao;

import com.demo.domain.User;
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 org.junit.After;
import org.junit.Before;
import org.junit.Test;

import java.io.InputStream;
import java.util.Date;
import java.util.List;

public class UserDaoTest {

    private InputStream inputStream;
    private SqlSession sqlSession;
    private UserDao userDao;

    @Before // 用于在测试方法执行之前执行
    public void init() throws Exception {
        // 1、读取配置文件，生成字节输入流
        inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
        // 2、获取SqlSessionFactory
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        // 3、获取SqlSession对象
        sqlSession = sqlSessionFactory.openSession();
        // 4、获取dao的代理对象
        userDao = sqlSession.getMapper(UserDao.class);
    }

    @After // 用于在测试方法执行之后执行
    public void destroy() throws Exception {
        // 6、提交事务（Mybatis的插入、删除、更新等采用了事务管理）
        sqlSession.commit();
        // 7、释放资源
        sqlSession.close();
        inputStream.close();
    }

    @Test
    public void saveUser() {
        User user = new User();
        user.setUsername("黄瑾晨");
        user.setBirthday(new Date());
        user.setSex("男");
        user.setAddress("遵义市-红花岗区");
        // 5、执行保存用户方法
        userDao.saveUser(user);
    }

    @Test
    public void findAll() {
        // 5、执行查询所有方法
        List<User> users = userDao.findAll();
        for (User user:users) {
            System.out.println(user);
        }
    }

    @Test
    public void updateUser() {
        User user = new User();
        user.setId(1);
        user.setUsername("小王");
        user.setBirthday(new Date());
        user.setSex("男");
        user.setAddress("贵阳市-云岩区");
        // 5、执行更新用户信息方法
        userDao.updateUser(user);
    }

    @Test
    public void deleteUser() {
        // 5、执行删除用户信息方法（根据用户id）
        userDao.deleteUser(2);
    }

    @Test
    public void findById() {
        // 5、执行根据用户id查找用户信息方法
        User user = userDao.findById(3);
        System.out.println(user);
    }

    @Test
    public void findByName() {
        // 5、执行根据名称模糊查询用户信息方法
        List<User> users = userDao.findByName("%王%");
        for (User user : users) {
            System.out.println(user);
        }
    }
}
 // 5、执行更新用户信息方法
        userDao.updateUser(user);
    }

    @Test
    public void deleteUser() {
        // 5、执行删除用户信息方法（根据用户id）
        userDao.deleteUser(2);
    }

    @Test
    public void findById() {
        // 5、执行根据用户id查找用户信息方法
        User user = userDao.findById(3);
        System.out.println(user);
    }

    @Test
    public void findByName() {
        // 5、执行根据名称模糊查询用户信息方法
        List<User> users = userDao.findByName("%王%");
        for (User user : users) {
            System.out.println(user);
        }
    }
}

以上为Mybatis简单的CRUD操作！