Mybatis基础教程及使用细节

本篇主要对Mybatis基础使用进行总结，包括Mybatis的基础操作，使用注解进行增删改查的练习；详细介绍xml映射文件配置过程并且使用xml映射文件进行动态sql语句进行条件查询；为了简化java开发提高效率，介绍一下依赖，例如lombok依赖等。后续会对Mybatisplus进行总结。

一、什么是Mybatis：

二、小细节：

三、Mybatis基础操作：

使用注解实现增删改查操作：

删除操作：

插入操作：

更新操作：

查询操作：

四、xml映射文件的使用

如何配置xml映射文件：

第一条规范：

第二条规范：

五、动态sql语句

动态查询操作：

动态更新操作：

批量删除操作：

一、什么是Mybatis：

Mybatis是持久层框架，也就是前面篇章讲的DAO层框架，用于简化JDBC的开发，前面介绍过jdbc，使用起来比较复杂：需要导入依赖然后创建连接，编写sql语句，创建载具（传输sql）然后对结果进行解析等操作，引入Mybatis极大简化了对数据的操作。
MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的实体类映射成数据库中的记录。

二、小细节：

数据库连接池更换：

springboot中自带的数据库连接池是HikariDataSource，如果想更换的话，例如Druid，只需要将这个依赖的坐标配置到pom.xml文件中即可；

lombok依赖：

当我们获取数据库数据的时候，需要用一个实体类与数据库的数据去对应，然后将数据封装在实体类对象中，但是自己去实现这个类的时候发现代码量也比较多，get、set方法以及无参数的构造器和有参数的构造器等等需要自己去生成，整体上比较臃肿，所以可以音符一个依赖，然后使用相应注解去简化这个操作：

lombok是一个实用的java类库，能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，并且可以自动化生成日志变量，简化开发，提高效率。注解如下：

在pom.xml文件中引入如下依赖：

<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
</dependency>

更改后：下面各种方法就不用自己手动实现了。

package com.springboot_mybatis.pojo;

import lombok.*;

//pojo这个包专门用来放实体类
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private Integer id;
    private String name;
    private Short age;
    private Short gender;
    private String phone;
//    public User() {
//    }
//
//    public User(Integer id, String name, Short age, Short gender, String phone) {
//        this.id = id;
//        this.name = name;
//        this.age = age;
//        this.gender = gender;
//        this.phone = phone;
//    }

//    public Integer getId() {
//        return id;
//    }
//
//    public String getName() {
//        return name;
//    }
//
//    public Short getAge() {
//        return age;
//    }
//
//    public Short getGender() {
//        return gender;
//    }
//
//    public String getPhone() {
//        return phone;
//    }
//
//    @Override
//    public String toString() {
//        return "User{" +
//                "id=" + id +
//                ", name='" + name + '\'' +
//                ", age=" + age +
//                ", gender=" + gender +
//                ", phone='" + phone + '\'' +
//                '}';
//    }
//
//    public void setId(Integer id) {
//        this.id = id;
//    }
//
//    public void setName(String name) {
//        this.name = name;
//    }
//
//    public void setAge(Short age) {
//        this.age = age;
//    }
//
//    public void setGender(Short gender) {
//        this.gender = gender;
//    }
//
//    public void setPhone(String phone) {
//        this.phone = phone;
//    }
}

三、Mybatis基础操作：

使用注解实现增删改查操作：

准备工作：

准备数据库表：emp。
创建一个新的springboot工程，然后引入起步依赖：mybatis、mysql驱动、lombok依赖等。
application.properties中配置数据库连接信息，包括user，password，数据库名称等。
创建实体类Emp用来封装数据库数据。
准备Mapper接口EmpMapper对数据库进行操作，要知道Mapper中是写sql语句的，需要给里面传递参数，来进行数据库操作；
创建好数据库表后，连接数据库：点击右侧Database然后点击+号：
选择Mysql：
填上对应的信息，user、password、数据库表名称等即可完成。

工程整体结构如下：

删除操作：

EmpMapper代码：方法前要添加Delete注解，表示删除操作，然后里面写具体的sql代码。

@Mapper
public interface EmpMapper {
    //TODO 根据ID删除数据操作：此处删除的话需要指定id，所以此处需要传入一个id；
    @Delete("delete from emp where id=#{id}")
//    public void delete(Integer id);
    public int delete(Integer id);

在test文件中进行测试：此处进行依赖注入EmpMapper类的对象，然后调用delete方法并传入参数，即可对该数据库进行操作。

//在定义好了接口以及数据库的数据以及对应的User类后，需要进行测试，测试需要在test文件中进行；
@SpringBootTest//这个就是springboot整合单元测试的注解
class SpringbootMybatisCrudApplicationTests {
    //注意在UserMapper接口中注解了Mapper，所以在容器中已经有了实现这个接口的对象，所以只需要依赖注入即可使用；
    @Autowired
    private EmpMapper empMapper;
    @Test
    public void testDelete(){
        int delete = empMapper.delete(17);//此处别忘了传递参数；
        System.out.println("删除的行数："+delete);
    }

在进行例如删除操作后，并不知道执行的过程，可以在配置文件中进行配置：在application.properties文件中配置日志输出，配置好后，可以在控制台中输出日志信息：

#配置mybatis的日志，指定输出到控制台
mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

配置好后完成删除操作后会控制台会显示如下信息：

插入操作：

主键回显：

为什么要获取主键：在一个表中添加数据之后，一般还需要维护其关系表数据，所以要获取到主键，然后再对其关系表数据进行操作。

在数据插入成功后，需要获取插入数据库数据的主键，例如，id为主键，刚插入的id为12，想获取12这个值，一般主键是自增的，所以不用手动写（下方代码也没有传入id这个值），所以想获取主键可以用这个注解的方法来实现；

获取方法：

在insert注解前面再添加一个注解：@Options(keyProperty=”id”,userGeneratedKeys=true),这样就会自动将生成的主键值赋值给emp对象的id属性，否则不会给id属性赋值；

EmpMapper中代码：会直接从对象中的属性取值：

//TODO 新增员工：注意如果在values里面添加值的话，这样就写死了，复用性差，所以想直接传递一个对象；注意这里的#{}里面的参数是属性，要和属性名一样
    @Options(useGeneratedKeys = true,keyProperty = "id")//主键回显，自动将主键值赋值给该对象的id属性；这样就可以拿到主键值了；
    @Insert("insert into emp(username,name,gender,image,job,entrydate,dept_id,create_time,update_time) values(#{username},#{name},#{gender},#{image},#{job},#{entrydate},#{deptId},#{createTime},#{updateTime})")
    public void insert(Emp emp);

test文件中测试：将对象属性赋值，然后调用insert方法

@Test
    public void testInsert(){
        Emp emp=new Emp();
        emp.setUsername("Tom1");
        emp.setName("汤姆1");
        emp.setImage("1.jpg");
        emp.setGender((short)1);
        emp.setJob((short)1);
        emp.setEntrydate(LocalDate.of(2000,1,1));
        emp.setCreateTime(LocalDateTime.now());
        emp.setUpdateTime(LocalDateTime.now());
        emp.setDeptId(1);

        empMapper.insert(emp);
        //测试是否能拿到主键值：
        System.out.println(emp.getId());
    }

更新操作：

EmpMapper中代码：

@Update("update emp set username=#{username},name=#{name},gender=#{gender},image=#{image},job=#{job},entrydate=#{entrydate},dept_id=#{deptId},update_time=#{updateTime} where id=#{id}")
    public void update(Emp emp);

test测试：注意此处有点缺陷，是新创建了一个Emp对象，并且调用update方法并传入这个对象作为参数，所以更新的话需要全部属性都要更新，如果少对emp对象属性赋值的话，那么数据库中的相应属性也会为null。后续会采用动态sql。

@Test//测试更新方法
    public void testUpdate(){
        Emp emp=new Emp();
        emp.setId(22);
        emp.setUsername("Jerry");
        emp.setName("杰瑞");
        emp.setImage("1.jpg");
        emp.setGender((short)1);
        emp.setJob((short)1);
        emp.setEntrydate(LocalDate.of(2000,1,1));
        emp.setCreateTime(LocalDateTime.now());
        emp.setUpdateTime(LocalDateTime.now());
        emp.setDeptId(1);
        empMapper.update(emp);
    }

查询操作：

查询操作有一点坑：

如果采用第一种方法，在数据库中属性名为dept_id,而实体类对象中的属性名为deptId，二者名称不同，会导致mybatis从数据库查询到的数据不会自动封装到对应属性当中；采用第三种方法，在properties文件中进行配置，如下代码即可自动将dept_id封装到驼峰命名deptId：

#开启mybatis的驼峰命名自动映射开关---可以将数据库中属性a_dan自动封装到实体类的属性aDan；
mybatis.configuration.map-underscore-to-camel-case=true

EmpMapper中代码：

//TODO 查询指定数据：（查询所有数据在前面项目中已经展示，返回类型为对象集合）
    //下面这个方法是不合理的，因为如果数据库中的属性名和实体类的属性名不相同的话mybatis不会自动封装也就是这几个值不会自动给类的属性赋值，所以这几个属性的值为null；
//    @Select("select *from emp where id=#{id}")
//    public Emp select(Integer id);

    //通过@Result注解，手动进行映射封装：（不推荐这种方法，比较复杂）
//    @Results({
//            //一个@Result代表将一列映射到一个属性；有三个属性和数据库列不一致，所以要写三个：
//            @Result(column = "dept_id",property = "deptId"),
//            @Result(column = "create_time",property = "createTime"),
//            @Result(column = "update_time",property = "updateTime")
//    })
//    @Select("select*from emp where id=#{id}")
//    public Emp select(Integer id);
//！！！推荐的方法：开启mybatis的驼峰命名自动映射开关---可以将数据库中属性a_dan自动封装到实体类的属性aDan；
// 需要在resources资源文件中的配置文件中进行配置：配置好后，原来的代码怎么写现在就怎么写：
    @Select("select *from emp where id=#{id}")
    public Emp select(Integer id);

test测试：

public void testSelect(){
        Emp emp = empMapper.select(1);
        System.out.println(emp);
    }

四、xml映射文件的使用

通过完成上述增删改查操作后，发现有一个很大的缺陷就是更新的时候必须全部属性更新，无法对个别属性进行更新，查询操作也同样如此，无法随意指定属性作为条件进行查询，因为EmpMapper中查询的条件写死了，必须按照那几个属性进行查询，少传或者多传参数会报错，因此为了解决这个缺陷采用xml映射文件：

如何配置xml映射文件：

有三条规范：

第一条规范：

首先根据mapper包创建配置文件：（必须要用/来分隔，这样就可以创建多级目录）注意名称需要和项目包名com.springboot_test1以及mapper包名mapper一致.

如下图：此处创建file名为com/springboot_test1/mapper，然后再创建一个名为EmpMapper.xml的文件即可。

然后复制如下代码到刚创建的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">

第二条规范：

xml映射文件中的namespace属性与Mapper接口的全限定名一致：获取接口的全限定名：copy reference

第三条规范：

sql语句中的id与Mapper接口中的方法名一致，并且ResultType为单条记录所封装的类型；select中的id就是接口中的方法名，对于resultType将这个实体类copy reference即可；

整体上就是当调用EmpMapper接口中的方法的时候，先去查找xml映射文件中namespace属性与这个接口全限定名相同的，然后找到id属性与方法名相同的sql语句，然后执行这条sql语句返回结果；

这样就配置完成xml映射文件。

五、动态sql语句

像如下这种的sql语句，直接就写死了，必须要传进去这些参数。但是如果想传递部分参数然后进行条件查询的话，此时就是动态sql语句(在xml映射文件中编写sql语句)；

可以用以下方式来实现：<if> <where>（查询） <set>（更新）标签的使用：<where>是用于去除冗余的逗号等，可以进行自动判断；

<if>标签用于判断条件是否成立，使用test属性进行条件判断，如果条件为true那么则拼接sql。

动态查询操作：

EmpMapper中代码：注意有了xml映射文件，EmpMapper中方法前面就无需加响应注解了，只需要在xml映射文件中对应上方法名称以及resultType即可。想根据哪些属性查询就传入哪些属性。

//TODO 通过xml映射文件配置条件查询：就不用带注解了!!!；
    public List<Emp> list1(String name, Short gender, LocalDate begin,LocalDate end);

xml映射文件中代码：

<select id="list1" resultType="com.springboot_test1.pojo.Emp">
         select id, username, password, name, gender, image, job, entrydate, dept_id, create_time, update_time
         from emp
        <where>
            <if test="name!=null">
                name like concat('%',#{name},'%')
            </if>
            <if test="gender!=null">
                and gender=#{gender}
            </if>
            <if test="begin!=null and end!=null">
                and entrydate between #{begin} and #{end}
            </if>
        </where>
        order by update_time desc

    </select>

test测试：用<where>标签的原因如下：

@Test
    public void testSelect_tiaojian1() {
//        List<Emp> list=empMapper.list1("张",null,null,null);
        //但是如果将name设置为null之后，就会报错，因为用if语句，有了就拼接，没有就舍弃，
        // 这样name舍弃之后where后面多了一个and：select *from emp where and gender=? order by update_time desc
        //为了解决这个问题，引入mybatis中的标签：<where>;将xml映射文件中的select语句里面的where替换为<where>,会自动删除and；
//        List<Emp> list=empMapper.list1(null,(short)1,null,null);
//此时相当于查询全部数据：
        List<Emp> list=empMapper.list1(null,null,null,null);
        System.out.println(list);

    }

动态更新操作：

EmpMapper中：

//TODO 动态更新员工信息，在xml映射文件中配置
    public void update2(Emp emp);//可以Alt加回车然后点击generate自动在xml文件中配置；

xml映射文件中：

<update id="update2">
# update emp where id=1,name="tom"......
        update emp
        <set>
            <if test="username!=null">
                username=#{username},
            </if>
            <if test="name!=null">
            name=#{name},
            </if>
        <if test="gender!=null">
            gender=#{gender},
        </if>
        <if test="image!=null">
            image=#{image},
        </if>
        <if test="job!=null">
            job=#{job},
        </if>
        <if test="entrydate!=null">
            entrydate=#{entrydate},
        </if>
        <if test="deptId!=null">
            dept_id=#{deptId},
        </if>
        <if test="updateTime!=null">
            update_time=#{updateTime}
        </if>
        </set>
        where id = #{id}
    </update>

test测试：

@Test//测试更新方法，要求是id为22号数据username更新为Jerrygood，name更新为杰瑞棒，gender更新为2；
    // 采用xml映射文件以及动态更新sql语句，可以发现后面不需要更改的属性没有变成null；
    public void testUpdate2(){
        Emp emp=new Emp();
        emp.setId(22);
        emp.setUsername("Jerrygood");
        emp.setName("杰瑞棒");
        emp.setGender((short)2);
        emp.setUpdateTime(LocalDateTime.now());//这个是要更新的，每次改动数据要改成现在的时间；
        empMapper.update2(emp);

    }

批量删除操作：

此处使用<foreach>标签：

EmpMapper中：

//TODO 批量删除操作：是根据id号来删除，因为是多个id，所以一般用数组或者集合来接收；
    public void deleteByIds(List<Integer> ids);

xml映射文件中：

<!--批量删除员工操作：(18,19,20)
collection:所要遍历的集合:ids要和接口中定义的方法的参数相同
item：遍历出来的元素
separator：分隔符：用，分隔
open：遍历开始前拼接的sql片段:(
close：遍历开始后拼接的sql片段:)
-->
    <delete id="deleteByIds">
delete from emp where id in
<foreach collection="ids" item="id" separator="," open="(" close=")">
#{id}
</foreach>
    </delete>
</mapper>

test测试：

@Test //测试批量删除方法：
    public void testDeleteByIds(){
        List<Integer>ids=Arrays.asList(13,14,15);
        empMapper.deleteByIds(ids);

    }

以上就是mybatis基础用法以及细节。