mybatis 入门篇： CURD

了解 mybatis

MyBatis 是一款优秀的持久层框架（ORM:OBJECT/RELATIONALMAPPING），它支持定制化SQL、存储过程以及高级映射。MyBatis 避免了几乎 所有的 JDBC代码和手动设置参数以及获取结果集，它可以使用简单的XML或注解来配置和映射SQL信 息，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。

项目搭建

1、创建maven项目，在pox.xml文件中引入依赖包。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>mybatsiDemo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>

        <!-- mybatis依赖 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>
        <!-- mysql依赖 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.21</version>
        </dependency>

        <!-- 单元测试 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>

        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.16</version>
        </dependency>

        <!-- log4j -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>

    </dependencies>

</project>

2、创建SqlMapConfig.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>
    <!-- 加载类路径下的属性文件 -->
    <properties resource="phase01/db.properties"></properties>
    <!--typeAliases 顺序很重要，不然会报错-->
    <typeAliases>
        <package name="com.tedrain.mybatis"/>
    </typeAliases>
    
    <!-- 设置一个默认的连接环境信息 -->
    <environments default="development">
        <!-- 连接环境信息，取一个任意唯一的名字 -->
        <environment id="development">
            <!-- mybatis使用jdbc事务管理方式 -->
            <transactionManager type="JDBC"/>
            <!-- mybatis使用连接池方式来获取连接 -->
            <dataSource type="POOLED">
                <!-- 配置与数据库交互的4个必要属性 -->
                <property name="driver" value="${db.driver}"/>
                <property name="url" value="${db.url}"/>
                <property name="username" value="${db.username}"/>
                <property name="password" value="${db.password}"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <!--将配置文件和映射文件关联起来-->
        <mapper resource="phase01/UserMapper.xml"/>
    </mappers>
</configuration>

3、创建 log4j.properties 文件。

log4j.rootLogger=debug, stdout, R
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=example.log

log4j.appender.R.MaxFileSize=100KB
# Keep one backup file
log4j.appender.R.MaxBackupIndex=5

log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n

4、创建数据库配置文件 db.properties, 这个需要和SqlMapConfig.xml的 resource 文件名称一致。

# mysql8及其以后版本的驱动
db.driver = com.mysql.cj.jdbc.Driver  
db.url=jdbc:mysql://127.0.0.1:3306/tedrain?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC&useSSL=false
db.username=root
db.password=123456

5、创建映射器文件 UserMapper.xml, 之后有关的User的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="user">
</mapper>

6、创建po文件夹，创建dao文件夹，po中创建User类，这里主键使用userId, 数据库使用id,主要是为了后面resultMap的运用的体现，User类和数据库中的字段除Id外，其他的都是一样的。

package com.tedrain.mybatis.po;

import lombok.Data;
import java.util.Date;

@Data
public class User {
    private int userId;
    private String username;
    private Date birthday;
    private String sex;
    private String address;

    public User(){}

    public User(String username, Date birthday, String sex, String address) {
        this.username = username;
        this.birthday = birthday;
        this.sex = sex;
        this.address = address;
    }

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

7、创建 BaseDao.java, 主要封装常用的CURD规范接口。

package com.tedrain.mybatis.dao;

import java.util.List;
import java.util.Map;

public interface BaseDao<T> {

    /**
     * 新增
     *
     * @param model 新增对象
     * @return 返回对应的主键
     */
    void add(T model);

    /**
     * 删除
     * @param id 主键
     */
    void delete(int id);

    /**
     * 批量删除
     * @param ids
     */
    void batchDelete(int... ids);

    /**
     * 修改
     * @param map 修改属性集合
     */
    void update(Map<String,Object> map);

    /**
     * 根据Id查询
     * @param id 主键
     * @return 返回实体对象
     */
    T findById(int id);

    /**
     * 多条件查询
     * @param w 多条件对象
     * @return 结果
     */
    List<T> findByConditon(Map<String,Object> map);

    /**
     * 分页查询
     * @param w 查询条件
     * @return 查询结果
     */
    List<T> pagination(Map<String,Object> map);
}

8、创建UserDao.java,继承BaseDao.java

package com.tedrain.mybatis.dao;

import com.tedrain.mybatis.po.User;

public interface UserDao extends BaseDao<User> {

}

9、创建 UserDaoImpl.java 实现 UserDao.java,使用构造函数注入SqlSessionFactory

package com.tedrain.mybatis.dao;

import com.tedrain.mybatis.po.User;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

import java.util.List;
import java.util.Map;

public class UserDaoImpl implements UserDao {
    private SqlSessionFactory sqlSessionFactory;
    // 注入sqlSessionFactory
    public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
        this.sqlSessionFactory = sqlSessionFactory;
    }
}

准备工作做好了，接下来就是CURD了。

CURD

1、新增用户，UserMapper.xml 编写SQL。

<!-- 注意事项： -->
    <!-- 1：如果parameterType为简单类型（基本类型+String类），#{}中的参数名称可以任意 -->
    <!-- 2：如果parameterType为POJO类型，#{}中的参数名称必须和POJO中的属性名称一致 -->
    <!-- 3：如果resultType为POJO类型，SELECT中的列名和POJO中的属性名称一致 -->
    <!-- 注意： 修改User的Id为UserId, 查询出来的Id找不到对应的属性，所以id为默认值0-->
<!--useGeneratedKeys=true 表示使用数据库自动增长的主键-->
<!--keyProperty 设置自增主键返回字段(用户在插入数据之后获取相应主键)-->
<!--keyColumn 用于指定数据库table中的主键-->
<insert id="addUser" parameterType="User" useGeneratedKeys="true" keyProperty="userId" keyColumn="id">
  INSERT INTO user(username,birthday,sex,address) values(#{username},#{birthday},#{sex},#{address});
</insert>

在 UserDaoImpl.java 中编写新增逻辑,为了不赘述，把CURD的内容都写出来。

package com.tedrain.mybatis.dao;

import com.tedrain.mybatis.po.User;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

import java.util.List;
import java.util.Map;

public class UserDaoImpl implements UserDao {
    private SqlSessionFactory sqlSessionFactory;
    // 注入sqlSessionFactory
    public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
        this.sqlSessionFactory = sqlSessionFactory;
    }

    public void add(User model) {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        sqlSession.insert("user.addUser", model);
        sqlSession.commit();
    }

    public void delete(int id) {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        sqlSession.delete("user.deleteUser", id);
        sqlSession.commit();
    }

    public void batchDelete(int... ids) {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        sqlSession.delete("user.batchDeleteUser", ids);
        sqlSession.commit();
    }

    public void update(Map<String, Object> map) {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        sqlSession.update("user.updateUser", map);
        sqlSession.commit();
    }

    public User findById(int id) {
        // sqlSessionFactory 工厂类去创建 sqlsession 会话
        SqlSession sqlSession = sqlSessionFactory.openSession();
        // sqlsession接口，开发人员使用它对数据库进行增删改查操作
        User user = sqlSession.selectOne("user.findById", id);
        return user;
    }

    public List<User> findByConditon(Map<String, Object> map) {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        return sqlSession.selectList("user.findByCondition", map);
    }

    public List<User> pagination(Map<String, Object> map) {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        return sqlSession.selectList("user.pagination", map);
    }
}

创建测试类 UserTest.java, 测试添加用户

package com.tedrain.mybatis;

import com.tedrain.mybatis.dao.UserDao;
import com.tedrain.mybatis.dao.UserDaoImpl;
import com.tedrain.mybatis.po.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.apache.log4j.PropertyConfigurator;
import org.junit.Before;
import org.junit.Test;

import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.*;

public class UserTest {

    private SqlSessionFactory sqlSessionFactory;

    @Before
    public void init() throws Exception {
        initLog();
        // 加载全局配置文件（同时把映射文件也加载了）
        InputStream inputStream = Resources.getResourceAsStream("phase01/SqlMapConfig.xml");
        // sqlsessionFactory需要通过sqlsessionFactoryBuilder读取全局配置文件信息之后
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }
    
    @Test
    public void testAddUser() {
        UserDao dao = new UserDaoImpl(sqlSessionFactory);
        User user = new User("凤凰" + new Random().nextInt(100), new Date(), "女", "天宫里层");
        dao.add(user);
        System.out.println("新增用户的ID" + user.getUserId());
    }
}

2、删除用户，根据Id删除和批量删除，UserMapper.xml 编写SQL。

<!--根据ID删除-->
<delete id="deleteUser" parameterType="int">
	DELETE FROM user WHERE id = #{id}
</delete>
<!--批量删除-->
<!-- foreach 用于迭代数组元素
        open 表示开始符号
        close 表示结束符合
        separator 表示元素间的分隔符
        item 表示迭代的数组，属性值可以任意，但提倡与方法的数组名相同
        #{ids} 表示数组中的每个元素值
    -->
<delete id="batchDeleteUser" parameterType="int">
    DELETE FROM user WHERE id IN
    <foreach collection="array" open="(" close=")" separator="," item="ids">
        #{ids}
    </foreach>
</delete>

在测试类中测试：

 @Test
    public  void  testDeleteUser(){
        UserDao dao = new UserDaoImpl(sqlSessionFactory);
        dao.delete(8);
    }

    @Test
    public void testBatchDelete(){
        UserDao dao = new UserDaoImpl(sqlSessionFactory);
        dao.batchDelete(6,7,9);
    }

3、修改用户，UserMapper.xml 编写SQL。

 	<!--动态更新-->
    <!--不要忘了逗号-->
    <update id="updateUser" parameterType="map">
        update user
        <set>
            <if test="username !=null">
                username=#{username},
            </if>
            <if test="birthday != null">
                birthday=#{birthday},
            </if>
            <if test="sex != null ">
                sex = #{sex},
            </if>
            <if test="address != null">
                address = #{address},
            </if>
        </set>
        where id = #{id}
    </update>

编写测试类

    @Test
    public void testUpdate(){
        UserDao dao = new UserDaoImpl(sqlSessionFactory);
        Map<String,Object> map = new HashMap<String, Object>();
        map.put("id",2);
        map.put("username","凤凰女");
        map.put("address","祥云");
        dao.update(map);
    }

4、查询，根据用户Id查询，分页条件查询，UserMapper.xml 编写SQL。

<!-- 注意事项： -->
    <!-- 1：如果parameterType为简单类型（基本类型+String类），#{}中的参数名称可以任意 -->
    <!-- 2：如果parameterType为POJO类型，#{}中的参数名称必须和POJO中的属性名称一致 -->
    <!-- 3：如果resultType为POJO类型，SELECT中的列名和POJO中的属性名称一致 -->
    <!-- 注意： 修改User的Id为UserId, 查询出来的Id找不到对应的属性，所以id为默认值0-->
    <select id="findById" parameterType="int"
            resultType="User">
		SELECT * FROM user WHERE id = #{id}
	</select>
    
     <!-- resultMap标签:映射实体与表
        type属性：表示实体全路径名
        id属性：为实体与表的映射取一个任意的唯一的名字
   -->
    <resultMap id="userMap" type="User">
        <!-- id标签:映射主键属性
                 result标签：映射非主键属性
                 property属性:实体的属性名
                 column属性：表的字段名
            -->
        <id property="userId" column="id"/>
        <result property="username" column="username"/>
        <result property="birthday" column="birthday"/>
        <result property="sex" column="sex"/>
        <result property="address" column="address"/>
    </resultMap>
    <select id="findByCondition" resultMap="userMap" parameterType="map">
        select * from user
        <where>
            <if test="username != null and username != '' ">
                and username LIKE CONCAT('%',#{username},'%')
            </if>
            <if test="birthday != null and birthday != ''">
                and birthday = #{birthday}
            </if>
            <if test="sex != null and sex != ''">
                and sex = #{sex}
            </if>
            <if test="address !=null and address != ''">
                and address = #{address}
            </if>
        </where>
    </select>

    <!--从 start 开始，但不包括 start 取 limit 条数据-->
    <select id="pagination" parameterType="map" resultMap="userMap">
        select * from user
        <where>
            <if test="username != null and username != '' ">
                and username LIKE CONCAT('%',#{username},'%')
            </if>
            <if test="birthday != null and birthday != ''">
                and birthday = #{birthday}
            </if>
            <if test="sex != null and sex != ''">
                and sex = #{sex}
            </if>
            <if test="address !=null and address != ''">
                and address = #{address}
            </if>
        </where>
        order by id ASC
        limit #{start},#{limit}
    </select>
    

编写测试方法：

    @Test
    public void testFindByCondition(){
        UserDao dao = new UserDaoImpl(sqlSessionFactory);
        Map<String,Object> map = new HashMap<String, Object>();
        map.put("username","凤凰");
        List<User> users = dao.findByConditon(map);
        System.out.println(users);
    }

    @Test
    public void testPagination(){
        UserDao dao = new UserDaoImpl(sqlSessionFactory);
        Map<String,Object> map = new HashMap<String, Object>();
        map.put("username","凤凰");
        map.put("start",0);
        map.put("limit",5);
        System.out.println(dao.pagination(map));
    }

OK,完成了入门，但是都没有做异常捕获，虽然是学习测试，但下次注意哦。加油！ 路漫漫其修远兮，吾将上下而求索。