Mybatis快速入门(集成SpringBoot)

程序员皮卡秋
361 阅读7分钟

前言

大家好，一直以来我都本着 用最通俗的话理解核心的知识点， 我认为所有的难点都离不开 基础知识 的铺垫

适合人群

  • 学完Java基础
  • 想通过Java快速构建web应用程序
  • 想学习或了解SpringBoot

大佬可以绕过 ~

背景

本节给大家讲讲 Java的SpringBoot框架, 之前我们学习的都是java的基础知识和底层提供的一些能力，我们日常工作都是在写接口。在我们在产品开发中，一般我们都会选择比较稳定的框架来帮我们加速开发，不会自己去造轮子，而在java众多框架中，spring框架表现的非常好，大部分公司都会首选它作为开发框架，而至今，大部分企业都是以springboot来构建项目了~

情景回顾

上一期带大家快速入门了mysql，讲了sql的基本使用，这一切都是为了学MyBatis框架做铺垫, 今天我们就一起来学习一下它，本期内容教大家学会它的一个基本使用。最近github可能会被墙，所以我把源码放到了国内gitee上,本节我们依然使用上期的代码

往期内容

项目源码(持续更新⭐️)

MyBatis是啥

来历

首先它是apache(一个专门运作开源软件项目的非盈利性组织)的一个开源项目iBatis, 2010年这个项目迁移到了google code，并且改名为MyBatis, 后来在2013年11月迁移到Github

干啥的

MyBatis是Java的一个优秀的持久层框架，它对jdbc的操作数据库的过程进行了封装，使开发者只需要关注SQL本身，而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码,总而言之更加的关注业务本身，这就是框架带来的好处。

通过注解或xml配置的方式将需要执行的statement配置起来，并通过Java对象和statement中sql的动态参数进行映射生成最终需要执行的sql语句，最后由Mybatis框架执行sql语句并将结果映射为Java对象并返回

如果你没学过jdbc，没关系，这不影响我们学会使用它，因为它足够简单了。通过它的一个基本介绍，相信大家应该有了一个基本的印象,废话不多说，直接进入正题带大家体会一下~

环境搭建

SpringBoot中集成Mybatis非常简单,这就是SpringBoot自动装配的优势,下边带大家一起体验一下，我们依然沿用上期的项目源码

修改配置

修改pom.xml,添加如下依赖:

 <dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.2.0</version>
</dependency>

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>

修改application.yml,配置链接串

spring:
  application:
    name: app
  datasource:
    url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai&useSSL=false
    username: root
    password: root123 # 替换成自己的密码

mybatis:
  mapper-locations:
    - classpath:mapper/*.xml

简单概述一下:

  • localhost:3306, 这个是mysql的一个链接地址, 如果连远程的话替换成远程地址就好了

  • /test, 这个是数据库名称，我们上期建了一个叫test的数据库

  • ？后边一大串是配置，字符集、时区、是否是ssl的链接

  • classpath:mapper/*.xml 这是我们定义的xml路径,所以要在resources下新建mapper目录

好了之后，启动一下项目,看有没有报错,没有报错说明链接成功了，如果出现Public Key Retrieval is not allowed的报错， 添加一下url配置

&allowPublicKeyRetrieval=true

添加扫描器

@Configuration
@MapperScan({"com.example.app.mapper"})
public class MyBatisConfig {}

它是用来干啥的？它主要是去扫描包，也就是com.example.app.mapper下的接口，然后对这些接口进行实现，提供给外部调用。外部调用后就会去执行内部的逻辑，也就是执行sql返回结果的操作。接口的实现其实是跟我我们的xxxMapper.xml进行定义的,然后会封装和编译。下边我们就来顶一下接口,我们还以上期查询用户角色的小例子来讲

添加接口类

教给大家一个小技巧,当我们需要新建包和类的时候，我们只需要包名+类名就可以快速创建,举个例子,我要创建mapper下的UserRoleMapper这个接口类,只需要在创建类的时候输入mapper.UserRoleMapper选择接口即可

紧接着，我们定义一个查询用户角色的方法,先定义要返回的结果对象，mybatis执行的结果最后会映射到我们定义的这个对象上

public class UserRole implements Serializable {
    private Integer id;

    public Integer getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getRoleName() {
        return roleName;
    }

    public void setRoleName(String roleName) {
        this.roleName = roleName;
    }

    private String name;

    private String roleName;
}

定义接口:

public interface UserRoleMapper {

    // 查询用户角色列表
    List<UserRole> getRoles();
}

添加XML配置

我们需要在resources/mapper目录下添加 UserRoleMapper.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="com.example.app.mapper.UserRoleMapper">

    <resultMap id="userRoleMap" type="com.example.app.model.UserRole">
        <result column="id" property="id"/>
        <result column="name" property="name"/>
        <result column="role_name" property="roleName"/>
    </resultMap>

    <select id="getRoles" resultMap="userRoleMap">
        select * from user_role
    </select>

</mapper>

讲解一下上述的标签含义:

  • 前两行没啥说的，文件描述,直接复制就好了

  • <mapper> 这个最外层，namespace属性指向我们定义的接口类, 字面意思讲就是映射

  • <resultMap>这是关系结果映射, 在这里配置数据库字段和我们代码中返回的实体对象之间的一一对应关系, id是一个它的一个属性，type是指向的实体类型

  • <result column="id" property="id"/> 很好理解，就是数据库字段和实体字段的对应关系也就是我们之前定义的model.UserRole

  • <select>查询标签,id指向我们定义的接口类中的方法, resultMap结果映射，对应我们定义的<resultMap>,通过id进行对应查找, 标签内就是写我们的sql语句

调用接口查询

我们定义一个控制器:

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

    @Autowired
    private UserRoleMapper userRoleMapper;

    @GetMapping("role/list")
    @ResponseBody
    public List<UserRole> getUserRole() {
        return userRoleMapper.getRoles();
    }
}

我们发现导入的时候同样使用@Autowired， 这时候你会发现,之前我们使用的时候, 类上都加了@Component、@Service之类的注解，因为这是我们之前添加的扫描类在作用也就是@MapperScan。

@ResponseBody这个之前没有提，它也很简单，将方法的返回值，以特定的格式写入到response的body区域，进而将数据返回，如果是一个对象，就会返回json

好了之后，我们运行它，在浏览器输入 http://localhost:8080/api/user/role/list返回:

{
    "id": 1,
    "name": "user",
    "roleName": "普通用户"
}

那么恭喜你，已经入门了~

情景复刻

我们以上期为例,给大家演示了基本的增删改查,这里我们使用mybatis进行改写:

查询 Select

之前我们查询了所有数据,那要查询某一条数据怎么办? 这么做就好了,这里就涉及到传参问题了

先修改一下接口, 添加方法

 UserRole getRole(Integer id);

修改xml, 添加查询

<select id="getRole" resultMap="userRoleMap">
    select * from user_role where id=#{id}
</select>

修改控制器

 @GetMapping("role")
    @ResponseBody
    public UserRole getUserRole(@RequestParam Integer id) {
        return userRoleMapper.getRole(id);
    }

修改 Update

添加修改方法

 int updateRole(Integer id);

这里的修改操作返回的是int, 大于0代表成功

添加update

 <update id="updateRole">
    update user_role set name = "普通用户123" where id=#{id}
</update>

修改控制器:


@GetMapping("role/update")
@ResponseBody
public String updateUserRole(@RequestParam Integer id) {
    if(userRoleMapper.updateRole(id) <= 0) {
        return "fail";
    }

    return "success";
}

新增 Insert

添加新增方法

 int addRole(String userRole);

添加insert

<insert id="addRole">
    insert user_role (name) values (#{name})
</insert>

修改控制器

@GetMapping("role/add")
@ResponseBody
public String addUserRole(@RequestParam String name) {
    if(userRoleMapper.addRole(name) <= 0) {
        return "fail";
    }

    return "success";
}

删除 Delete

删除就不举例子了，用的是delete标签,大家可以举一反三，自己试一下。在我们日常开发中，不推荐大家物理删除, 推荐大家使用字段进行标记, 比如is_delete, 1就是删除 0就是未删除, 类似于回收站一样的东西, 因为你物理删掉，后边找你溯源问题，你只能背锅了

结束语

本期mybatis基础教程就到此结束了, 给大家总结一下。我们主要学了mybatis框架与springboot的集成, 如何配置它们,以及它的一个常用的xml标签使用,带大家学习了基本的增删改查，还是那句话，建议大家多写，多总结,不要去背标签背语法

下期预告

下期我依然带大家学习mybatis框架, 本期只是基础的使用，对于真正的业务开发远远不够,平时正常的业务开发要复杂的多，你会遇到各种参数如何传，以及各种判断逻辑,这里所说的是xml的编写，下期我会给大家介绍常用的复杂标签，以及开发小技巧。下期不见不散,关注我，不迷路 ~

avatar
文章
阅读
粉丝