在 SpringBoot 中初步使用 MyBatis

最新推荐文章于 2024-05-23 18:09:42 发布

Naion

最新推荐文章于 2024-05-23 18:09:42 发布

阅读量2.3k

点赞数 5

分类专栏： JavaEE spring 文章标签： mybatis java mysql

本文链接：https://blog.csdn.net/Naion/article/details/128629364

版权

JavaEE spring 专栏收录该内容

6 篇文章 0 订阅

订阅专栏

这篇文章简单介绍如何初步使用MyBatis框架。MyBatis官网：mybatis – MyBatis 3 | 简介。本文中介绍MyBatis使用在SpringBoot中，Spring帮我们进行了管理，省去了获取sql的步骤。

什么是 MyBatis？

MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

接下来，就开始使用MyBatis。

使用MyBatis

创建数据库和表

先创建一个数据库和表。表的创建可以创建一个学生表，包含id，姓名，年龄，性别，班级。

drop table if exists student;
create table student
(
    id   int primary key auto_increment,
    name varchar(100) not null,
    age  int,
    sex  int, # 1表示男，0表示女;
    class int
) default charset 'utf8mb4';

desc student;

添加框架支持

如果是SpringBoot项目，可以使用插件来快速添加框架。

在pom.xml文件中，点击该页面中的任意内容，然后 Alt + insert，就可以看到该插件。

使用该插件。

配置文件

如果是SpringBoot，在resources目录下创建application.yml文件，这个文件中存放mybaits的相关配置信息。

下面的配置中使用了一些别的日志框架，为了可以正常使用，你可以添加成一样的框架，虽然有的框架不起作用，比如SpringWeb，是用来web开发的，本文章用不到。

# 配置数据库的连接字符串
spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/你的数据库?characterEncoding=utf8
    username: 你的数据库用户名
    password: 你的数据库密码
    driver-class-name: com.mysql.cj.jdbc.Driver
    
# 设置 Mybatis 的 xml 保存路径
mybatis:
  mapper-locations: classpath:mapper/*Mapper.xml
  configuration: # 配置打印 MyBatis 执行的 SQL
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #需要lombok框架支持，可以添加
    
# 配置打印 MyBatis 执行的 SQL
logging:
  level:
    com:
      example:
        demo: debug

添加实体类

创建了一个student的表，要在java代码中创建相对应的实体类。

@Data // 需要lombok支持
public class studentInfo {

    private int id;
    private String name;
    private int age;
    private int sex;
}

@Data注解是lombok提供的快速开发的注解，添加该注解，相当于自动添加了setter和getter方法，添加了toString方法，添加了equal和hashcode方法，添加了无参构造方法和相关参数的构造方法。

实体类中的字段名需要和数据库中的字段名保持一致，不然就会出现没有映射的情况。

xml保存路径

我们在配置文件中注释了xml的保存路径。要在相关的resources目录下添加mapper目录。

在java目录中创建调用方法的接口，比如写成StudentMaper.java，然后在resources的mapper目录下创建StudentMaper.xml。

需要注意的是上面图片中红框标识出来的部分，最好不要改，不然会找不到文件。MyBatis 的 XML 中保存是查询数据库的具体操作 SQL，通过*Mapper.xml，就可以在找到在 resources/mapper 创建所有表的 xml ⽂件。

刚刚的操作我们创建了一个StudentMapper接口和StudentMapper.xml的xml文件。需要在接口中添加@Maper注解，在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="你的mapper接口位置">
    
</mapper>

<mapper>标签：需要指定 namespace 属性，表示命名空间，值为 mapper 接⼝的全限定名，包括全包名.类名。

Mybatis跳转的插件

你可能看到了我的代码中出现了一个图标，这是安装了插件。该插件可以进行接口和xml文件的跳转。代码中，如果你的namespace是正确的路径，那么就会出现该图片，点击就可以跳转到相关的接口上，可以使用它来判断代码是否无误。

相关sql语句

insert

在学生表中插入学生信息，需要先在接口中定义该方法，然后在xml中编写sql语句。

@Mapper
public interface StudentMapper {

    //插入
    Integer add(@Param("studentInfo") StudentInfo studentInfo);

}

@Param注解：如果你的映射方法接受多个参数，就可以使用这个注解自定义每个参数的名
字。简单来说，使用该注解，就相当于重新将参数名进行了定义。

后序的使用，只能使用重新定义的参数名，否则就会报找不到相关参数的异常。

如果你安装了插件，就会发现方法上报红。这也不是问题，可以alt+回车快速生成相关sql语句，或者在xml中自己手动添加。

insert标签：是⽤来执行数据库的查询操作的；

id：是和 Interface（接⼝）中定义的方法名称⼀样的，表示对接⼝的具体实现方法。

    <insert id="add">
        insert into student(name, age, sex)
        values (#{studentInfo.name},
                #{studentInfo.age},
                #{studentInfo.sex})
    </insert>

#{}这里先不介绍。

写完了相关的sql语句，判断是否成功，需要进行单元测试。在接口中alt+insert，就可以看到test，点击test，跳出相关界面，勾选需要测试的add方法即可。

进入相关代码后第一件事就是添加@SpringBootTest注解，表示确定如何装载Spring应用程序的上下文资源，否则会报空指针异常，原因是没有装载Spring上下文资源。

引入studentMapper和studentInfo，就可以进行测试了。

@SpringBootTest
class StudentMapperTest {

    @Autowired
    private StudentMapper studentMapper;
    StudentInfo studentInfo = new StudentInfo();

    @Test
    void add() {
        studentInfo.setName("1");
        studentInfo.setAge(1);
        studentInfo.setSex(1);
        Integer result = studentMapper.add(studentInfo);
        System.out.println(result);
    }
}

说明成功。如果你按照配置中的进行了配置，就可以看到sql语句的打印。否则是没有sql语句的打印的。

现在，将add中的@Param改动一下。

发现报错了。如果在insert中改成studnet：

在这里是需要格外注意的。

insert返回自增主键

默认情况下，返回的是受影响的行数。要返回自增主键，需要格外的属性。

useGeneratedKeys：这会令 MyBatis 使⽤ JDBC 的 getGeneratedKeys 方法法来取出由数据库内部⽣成的主键（比如：像 MySQL 和 SQL Server 这样的关系型数据库管理系统自动递增字段），默认值：false。
keyColumn：设置⽣成键值在表中的列名，在某些数据库（像 PostgreSQL）中，当主键列不是表中的第⼀列的时候，是必须设置的。如果生成列不止一个，可以⽤逗号分隔多个属性名称。
keyProperty：指定能够唯⼀识别对象的属性，MyBatis 会使⽤ getGeneratedKeys 的返回值或 insert 语句的 selectKey ⼦元素设置它的值，默认值：未设置（unset）。如果生成列不止一个，可以用逗号分隔多个属性名称。

要注意的是，自增主键使用需要传入对象。

    <insert id="add" useGeneratedKeys="true" keyProperty="id">
        insert into student(name, age, sex)
        values (#{student.name},
                #{student.age},
                #{student.sex})
    </insert>

@SpringBootTest
class StudentMapperTest {

    @Autowired
    private StudentMapper studentMapper;
    StudentInfo studentInfo = new StudentInfo();

    @Test
    void add() {
        studentInfo.setName("1");
        studentInfo.setAge(1);
        studentInfo.setSex(1);
        studentMapper.add(studentInfo);

        //通过该方法获取
        System.out.println(studentInfo.getId());
    }
}

数据库情况。这里插入了两次1，1，1。代码中又插入了一次1，1，1。预期结果是返回第三次的自增主键3。

#{} 与 ${}

#{}：预编译处理。MyBatis 在处理#{}时，会将 SQL 中的 #{} 替换为?，后序MyBatis使用 PreparedStatement 的 set 方法来赋值。

${}：字符直接替换。MyBatis 在处理 ${} 时，就是把 ${} 替换成变量的值。

update

    <update id="update">
        update student
        set name = #{name}
        where id = #{id}
    </update>

    @Test
    void update() {
        //将id为1的name改为2
        Integer result = studentMapper.update("2", 1);
        System.out.println(result);
    }

alt+insert的时候进入test界面，勾选相关的方法后生成。如果遇到error，直接点击ok即可。

delete

    <delete id="delete">
        delete
        from userinfo
        where id = #{id}
    </delete>

    @Test
    void delete() {
        //删除id为1的记录
        System.out.println(studentMapper.delete(1));
    }

select

    <select id="select" resultType="com.example.java011001.model.StudentInfo">
        select *
        from student;
    </select>

select标签中有一个resultType属性，表示返回的数据类型，也就是开头我们定义的实体类StudentInfo。

接口中的语句：

    List<StudentInfo> select();

xml中的语句：

    <select id="select" resultType="com.example.java011001.model.StudentInfo">
        select *
        from student;
    </select>

Test中的语句：

    @Test
    void select() {
        System.out.println(studentMapper.select());
    }

resultType 和 resultMap

resultType表示返回的数据类型。

有的时候，我们会遇到java实体类和数据表中的字段不一致的情况。这个时候需要resultMap标签。

    <resultMap id="resultMap" type="com.example.java011001.model.StudentInfo">
        <id column="id" property="id"></id>
        <result column="name" property="nameStudent"></result>
        <result column="age" property="ageStudent"></result>
        <result column="sex" property="sexStudent"></result>
    </resultMap>

    <select id="select" resultMap="resultMap">
        select *
        from student;
    </select>