MyBatis

一、什么是MyBatis

MyBatis是一款优秀的持久层框架，用于简化JDBC的开发。
MyBatis本身是Apache的一个开源项目iBatis，2010面这个项目由Apache迁移到了Google code，并改名为MyBatis。2013年11月迁移到Github。
官网：MyBatis中文网

二、Mybatis入门

快速入门：使用MyBatis查询所有用户数据
1. 准备工作（创建springboot工程，数据库表user、实体类User）
2. 引入MyBatis相关依赖，配置MyBatis（数据库连接信息）
  1. 在MyBatis的规范中，需要mapper持久化层。
  2. 注意：实体类中的各个字段必须和数据库相对应！
3. 编写SQL语句（注解/xml）
- 重点在于如何在mapper接口中定义sql语句
为什么使用预编译SQL
- 性能更高
- 更加安全（防止SQL注入）

参数占位符
1. #
  - 执行SQL的时候，会将#{…}替换为？，生成预编译SQL，会自动设置参数值
  - 使用时机：参数传递，都使用#
2. $
  - 拼接SQL。直接将参数拼接在SQL语句中，存在SQL注入问题。
  - 使用时机：如果对表名、列表进行动态设置时使用。

三、JDBC介绍

jdbc就是使用java操作关系型数据库的一套API
操作：
- 注册驱动
- 获取连接对象
- 创建执行SQL语句的对象
- 处理结果集对象（逐行）
- 释放资源
原生JDBC的缺陷
- 配置信息不方便修改（写死在代码中，硬编码）
- 封装结果时需要一个个对字段进行解析，真实项目中非常繁琐
- 每次执行SQL语句都需要进行连接和释放资源，造成了性能低下。
MyBatis是如何解决这个问题的
- 将配置写在配置文件中，方便修改
- 不需要对结果进行解析，整个过程自动化完成
- 使用了数据库连接池技术，每一次执行sql语句后会把连接归还连接池。

四、数据库连接池

数据库连接池是一个容器，负责分配，管理数据库连接。
它允许应用程序重复使用一个现有的数据库连接，而不是再重新建立一个。
释放空闲时间超过最大空闲时间的连接，来避免因为没有释放连接而引起的数据库连接遗漏。
优势：
- 资源重用
- 提高系统响应速度
- 避免数据库连接遗漏

五、Lambok

1.Lombok简介

官方介绍
Project Lombok is a java library that automatically plugs into your editor and build tools, spicing up your java.Never write another getter or equals method again, with one annotation your class has a fully featured builder, Automate your logging variables, and much more.

大概的意思：Lombok是一个Java库，能自动插入编辑器并构建工具，简化Java开发。通过添加注解的方式，不需要为类编写getter或eques方法，同时可以自动化日志变量。官网链接

简而言之：Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。
博客及源码GitHub链接

2.Lombok使用

使用Lombok需要的开发环境Java+Maven+IntelliJ IDEA或者Eclipse(安装Lombok Plugin)

2.1添加maven依赖

<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<version>1.18.4</version>
	<scope>provided</scope>
</dependency>
123456

2.2安装插件

使用Lombok还需要插件的配合，我使用开发工具为idea，这里只讲解idea中安装lombok插件，使用eclipse和myeclipse的小伙伴和自行google安装方法。
打开idea的设置，点击Plugins，点击Browse repositories，在弹出的窗口中搜索lombok，然后安装即可。

安装lombok插件

2.3解决编译时出错问题

编译时出错，可能是没有enable注解处理器。Annotation Processors > Enable annotation processing。设置完成之后程序正常运行。

开启注解配置

2.4示例

下面举两个栗子，看看使用lombok和不使用的区别。

创建一个用户类

不使用Lombok

public class User implements Serializable {

    private static final long serialVersionUID = -8054600833969507380L;

    private Integer id;

    private String username;

    private Integer age;

    public User() {
    }

    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 Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

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

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        User user = (User) o;
        return Objects.equals(id, user.id) &&
                Objects.equals(username, user.username) &&
                Objects.equals(age, user.age);
    }

    @Override
    public int hashCode() {
        return Objects.hash(id, username, age);
    }

}
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566

使用Lombok

@Data
public class User implements Serializable {

    private static final long serialVersionUID = -8054600833969507380L;

    private Integer id;

    private String username;

    private Integer age;

}
123456789101112

编译源文件，然后反编译class文件，反编译结果如下图。说明@Data注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

反编译用户类

自动化日志变量

@Slf4j
@RestController
@RequestMapping(("/user"))
public class UserController {

    @GetMapping("/getUserById/{id}")
    public User getUserById(@PathVariable Integer id) {
        User user = new User();
        user.setUsername("风清扬");
        user.setAge(21);
        user.setId(id);

        if (log.isInfoEnabled()) {
            log.info("用户 {}", user);
        }

        return user;
    }

}
1234567891011121314151617181920

通过反编译可以看到@Slf4j注解生成了log日志变量（严格意义来说是常量），无需去声明一个log就可以在类中使用log记录日志。

反编译用户controller类

2.5常用注解

下面介绍一下常用的几个注解：

@Setter 注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。
@Getter 使用方法同上，区别在于生成的是getter方法。
@ToString 注解在类，添加toString方法。
@EqualsAndHashCode 注解在类，生成hashCode和equals方法。
@NoArgsConstructor 注解在类，生成无参的构造方法。
@RequiredArgsConstructor 注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。
@AllArgsConstructor 注解在类，生成包含类中所有字段的构造方法。
@Data 注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。
@Slf4j 注解在类，生成log变量，严格意义来说是常量。private static final Logger log = LoggerFactory.getLogger(UserController.class);

3.Lombok工作原理

在Lombok使用的过程中，只需要添加相应的注解，无需再为此写任何代码。自动生成的代码到底是如何产生的呢？

核心之处就是对于注解的解析上。JDK5引入了注解的同时，也提供了两种解析方式。

运行时解析

运行时能够解析的注解，必须将@Retention设置为RUNTIME，这样就可以通过反射拿到该注解。java.lang.reflect反射包中提供了一个接口AnnotatedElement，该接口定义了获取注解信息的几个方法，Class、Constructor、Field、Method、Package等都实现了该接口，对反射熟悉的朋友应该都会很熟悉这种解析方式。

编译时解析

编译时解析有两种机制，分别简单描述下：

1）Annotation Processing Tool

apt自JDK5产生，JDK7已标记为过期，不推荐使用，JDK8中已彻底删除，自JDK6开始，可以使用Pluggable Annotation Processing API来替换它，apt被替换主要有2点原因：

api都在com.sun.mirror非标准包下
没有集成到javac中，需要额外运行

2）Pluggable Annotation Processing API

JSR 269自JDK6加入，作为apt的替代方案，它解决了apt的两个问题，javac在执行的时候会调用实现了该API的程序，这样我们就可以对编译器做一些增强，javac执行的过程如下：

lombok工作原理

Lombok本质上就是一个实现了“JSR 269 API”的程序。在使用javac的过程中，它产生作用的具体流程如下：

javac对源代码进行分析，生成了一棵抽象语法树（AST）
运行过程中调用实现了“JSR 269 API”的Lombok程序
此时Lombok就对第一步骤得到的AST进行处理，找到@Data注解所在类对应的语法树（AST），然后修改该语法树（AST），增加getter和setter方法定义的相应树节点
javac使用修改后的抽象语法树（AST）生成字节码文件，即给class增加新的节点（代码块）

通过读Lombok源码，发现对应注解的实现都在HandleXXX中，比如@Getter注解的实现在HandleGetter.handle()。还有一些其它类库使用这种方式实现，比如Google Auto、Dagger等等。

4.Lombok的优缺点

优点：

能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，提高了一定的开发效率
让代码变得简洁，不用过多的去关注相应的方法
属性做修改时，也简化了维护为这些属性所生成的getter/setter方法等

缺点：

不支持多种参数构造器的重载
虽然省去了手动创建getter/setter方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度

值得注意的是，@Data注解会调用getClass方法，有时候会导致程序运行报错

  D:\Develop\JavaProgram\MyBatisDemo\src\main\java\com\mybatisdemo\bean\Student.java:17:19
  java: com.mybatisdemo.bean.Student中的getClass()无法覆盖java.lang.Object中的getClass()
    被覆盖的方法为final

六、Mybitis基础操作

需求说明：
- 根据资料中提供的《tlias只能学习辅助系统》页面原型及需求，完成员工管理的需求开发。
  - 条件分页查询
  - 新增员工
  - 修改员工
  - 删除员工
  - 批量删除
准备工作：
- 准备数据表emp
- 创建一个新的springboot工程，选择引入对应的起步依赖（mybatis，mysql）
- application.properties中引入数据库连接信息
- 创建对应的实体类Emp（实体类属性采用驼峰命名）
- 准备Mapper接口EmpMapper
- 可以打开显示日志，在配置文件中加入：
- ```
  mybatis.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
```

删除：

delete from stu2022 where id = 1220204xxx;

      //根据id删除数据
      @Delete("delete from stu2022 where SID = #{id}")
      public int delete(Integer id);

新增：

insert into emp(username,name,gender,image,job,entrydate,dept_id,create_time,update_time) values(“Tim”,“汤姆”,1,“1.jpg”,1,“2005-01-01”,1,now(),now());

  //新增员工操作
  @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);

注意：传入对象时，#{…}中填写的变量名为对象中的属性名

主键返回：

在添加数据成功后，需要返回刚刚插入的主键值。
@Options(KeyProperty = “id” , useGeneratedKeys = true)注解，可以取回id（一定是主键），并赋值给emp对象的id属性

  //新增员工操作(返回主键)
  @Options(KeyProperty = "id" , useGeneratedKeys = true)
  @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);

测试：

  @Autowried
  EmpMapper empMapper;//自动依赖注入
  ...//创建emp对象
  empMapper.insert(emp);
  sout(emp.id);

更新：

更新操作由两步完成：查询数据和修改数据（根据主键ID）

      //更新数据
      @Update("update stu2022 set Name=#{Name},name=#{Name}, sex=#{Sex}, academy=#{Academy}, class=#{Class}, campus=#{Campus}, status=#{Status} where SID = #{SID}")
      public void update(Student stu);

测试：

      @Test
      public void testUpdate(){
          Student stu = new Student(120009,"林槑槑","男","信息与电子工程学院","劲竹327","安吉校区",1);
          stuMapper.update(stu);
      }

ID查询：

      //根据id查询用户信息
      @Select("SELECT sid, name, sex, academy, class, campus, status FROM stu2022 where SID = #{SID}")
      public List<Student> search(Integer SID);

测试：

      @Test
      public void testSearch(){
          List<Student> students = stuMapper.search(120009);
          students.forEach(System.out::println);
      }

条件查询：

姓名，性别，入职时间。

  SELECT * FROM stu2022 WHERE name LIKE '%张%' AND gender = 1 AND entrydate BETWEEN '2010-10-01' AND '2022-01-02' ORDER BY update_time DESC;

  //条件查询用户信息
  @select("SELECT * FROM stu2022 WHERE name LIKE '%${name}%' AND gender = #{gender} AND entrydate BETWEEN #{begin} AND #{end} ORDER BY update_time DESC;")
  public List<Emp> list(String name, Short gender, LocalDate begin, LocalDate end);

值得注意的是？占位符不能出现在’…'中，所以使用${…}来拼接字符串
可以使用concat来拼接字符串。
‘%张%’ 可以替换为：concat(‘%’ , ‘#{name}’ , ‘%’)

  //条件查询用户信息2
  @select("SELECT * FROM stu2022 WHERE name LIKE concat('%' , '#{name}' , '%') AND gender = #{gender} AND entrydate BETWEEN #{begin} AND #{end} ORDER BY update_time DESC;")
  public List<Emp> list(String name, Short gender, LocalDate begin, LocalDate end);

参数名说明：
- 在SpringBoot的2.x版本中，我们只需要将参数名和接口的形参相对应。
- 在SpringBoot1.x或者单独使用mybatis框架时，我们需要使用Param注解为形参指定一个参数名。
- ```
      //根据id查询用户信息2
      @Select("SELECT sid, name, sex, academy, class, campus, status FROM stu2022 where SID = #{id}")
      public List<Student> search(@Param("id")Integer SID);
```
- 在我们使用1.x版本和单独使用mybatis时，在接口编译之后不会保留形参的名称，而是var1，var2…所以需要额外添加注解。
- 在2.x之后，内置了编译插件，会保留形参名称在字节码文件中。

XML映射文件

使用xml配置，可以降低耦合度，提高代码的可维护性。
规范
- XML映射文件的名称与Mapper接口名称保持一致，并且将XML映射文件和Mapper接口放置在相同的包下（同包同名）。
- XML映射文件的namespace属性为Mapper接口全限定名一致。
- XML映射文件中sql语句的id与Mapper接口中的方法名一致，并保持返回类型一致。

<?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.itheima.mapper.EmpMapper">
    <select id="list" resultType="com.itheima.pojo.Emp">
    	SELECT sid, name, sex, academy, class, campus, status FROM stu2022 where SID = #{id}
    </select>
</mapper>

注意这里的resultType指定的是单条记录的类型
使用注解来配置简单的SQL语句，会使代码显得更加简洁，但对于复杂一点的语句，Java注解力不从心，还会使你本就复杂的SQL语句更加混乱不堪，因此。如果你需要做一些复杂的操作，最好使用XML来映射语句。
使用何种方式定义SQL语句，完全取决于你和你的团队，当然也可以两种方式一起使用。

MyBatisX

动态SQL

随着用户输入或外部条件的变化而变化的SQL语句，我们称为动态SQL
在mybatis中提供一个条件判断接口if，使用xml配置时可以使用if标签来动态拼接sql。

<if>
1. 用于判断条件是否成立。使用test属性进行条件判断，如果为true，则拼接sql，如果为false，则不拼接。
2. where标签会自动去除多余的and或or
3. set标签会自动删除多余的逗号

    <?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.itheima.mapper.EmpMapper">
    <select id="list" resultType="com.itheima.pojo.Emp">
    	SELECT *
        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>
    </select>
</mapper>

动态更新员工信息：

<?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.mybatisdemo.mapper.StuMapper">
    <update id="update">
        update stu2022
        <set>
            <if test="username != null">Name=#{Name},</if>
            <if test="name != null">name=#{Name},</if>
            <if test="sex != null">sex=#{Sex},</if>
            <if test="academy != null">academy=#{Academy},</if>
            <if test="class != null">class=#{Class},</if>
            <if test="campus != null">campus=#{Campus},</if>
            <if test="status != null">status=#{Status}</if>
            where SID = #{SID}
        </set>
    </update>
</mapper>

<foeach>标签

用于挨个循环。例如批量删除

    //批量删除数据
    public void deleteByIds(List<Integer> ids);

<!--  批量删除的sql  -->
<!--    collection：要遍历的元素
        item：遍历时的元素
        separator：分隔符
        open：遍历开始前拼接的sql
        close：遍历结束后拼接的sql
-->
    <delete id="deleteByIds">
        delete from stu2022 where SID in
                            <foreach collection="ids" item="id" separator=", " open="(" close=")">
                                #{id}
                            </foreach>
    </delete>

<sql> & <include>
1. 提高代码的复用性。
2. sql标签用于抽取sql片段，需要定义id为唯一属性。
3. include标签用于引入sql片段，需要ref指定片段id。

如果觉得文章对你有用，请随意赞赏

javaStudy 教程学习总结

MyBatis入门

https://qc-blog.zust.online/archives/mybatisstudy

作者

前程QCQCQC

发布于

2023-06-02

更新于

2024-01-28

许可协议

CC BY 4.0