SpringBoot整合Mybatis

时间:2022-09-29 爱敲代码的杜晓帅~ 人气:0

前言

为什么要学SpringBoot和Mybatis呢，我觉得作为一个合格的后端程序员增删改查（CRUD）肯定是要会的，而且是最基本的一项技能，不然怎么完成给你分配的需求呢；而为什么选择SpringBoot和Mybatis呢，首先选择SpringBoot是可以理解的，毕竟作为一款轻量型的框架，集成了很多组件和Tomcat服务器，让我们的开发更简便，当然最主要的还是因为博主只会SpringBoot 。好了开个玩笑，下面说为啥用SpringBoot加Mybatis，因为除了Mybatis还有Mybatis-Plus和Hibernate可以选择，而且这两个封装了CRUD方法，都不用自己写sql语句，开发起来更加快捷；而Mybatis则是要自己编写sql语句的，对于当时的我来说我觉得还是学的基础点，毕竟后面这两个可以用来进阶，也学起来毕竟简单，所以让我们开始用SpringBoot整合Mybatis吧！

第一：创建MySQL数据库

首先我们应该先创建一个数据库，用于操作我们CRUD的数据（可以使用可视化工具进行创建，也可以使用SQL命令进行创建），数据库的名字可以自己定义，创建完数据库之后，我们就要创建表进行数据的存储了，表的名字叫’ user ‘表，字段可以自己设置，只要和后边自己创建的实体对应就好了。

CREATE TABLE `user` (
  `userId` bigint NOT NULL AUTO_INCREMENT,
  `userName` varchar(255) COLLATE utf8mb4_bin NOT NULL,
  `userAddress` varchar(255) COLLATE utf8mb4_bin NOT NULL,
  PRIMARY KEY (`userId`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;

第二：创建SpringBoot项目，引入需要的依赖包

用IDEA创建SpringBoot项目：

1、选择Spring Initializr创建，然后JDK选择1.8，Java8版本。
2、初始化组件选择Spring Web、JDBC API、Mybatis Framework、MySQL Driver，Lombok也可以选择一下，可能会用到。
3、选择好了之后点击Finish创建就好了。
4、创建好了SpringBoot之后看看自己的Maven有没用配置好，如果没有配置好去查询如何配置Maven，不然你的pom依赖是加载不了的，就下载一下Maven，如何换个阿里源镜像地址和本地仓库，然后IDEA选择一下Maven的xml文件和本地仓库地址就好了，不过我觉得能搜索这篇文章的朋友这些基础的东西应该是配置好了的。

以上是所需要的依赖包，如果忘记引入的，可以直接添加即可，不用再重新创建项目了

第三：创建程序目录和配置核心application.xml文件

首先需要创建四个文件夹，分别是：Entity（用户实体）、Controller、Service、Dao，然后还需要在 resource 目录下新建 Mapper 目录，这个 Mapper 目录是用来存放 SQL 语句的地方。到这里我觉得需要理解一下MVC模式，由于我们的访问一层调用一层，然后查询到数据之后再返回过去的，所以我们的层级应该是：Controller（控制层，也是接收前端传递参数的层） -> Service（业务层，我们所有的业务，如判断和一些循环语句就需要写到这个层当中） -> Dao（持久层，这个层主要是和数据库打交道的，主要负责数据的操作，也就是CRUD操作） -> 数据库，

如下图所示：

没有啥好的画图工具，就随便画了一下，反正数据的流向就是这样的，大家可以凑合看一下。

在resources文件夹下创建yml文件，并输入如下内容：

server:
  port: 8080    //本机的端口号
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/自己数据库的名称?useUnicode=true & characterEncoding=utf-8 &
      useSSL=true & serverTimezone=Asia/Shanghai
    username: root      //数据库的用户名
    password: xxxxxx    //数据库的密码

mybatis:
  mapper-locations: classpath:/Mapper/*.xml
  type-aliases-package: com.example.test.Entity    //这个是扫描到Entity实体包的路径，可根据自己的配置

配置好yml文件之后，我们去看右侧的Databases去看看能不能连接自己本地的MySQL数据库：

依次分别填，数据表名字（这里我们的表是user表），用户名和密码、还有数据库名

第四：依次编写Entity、Dao、Service、Controller层，还有创建mapper.xml文件

Entity包：创建一个UserEntity类，内容如下：

public class UserEntity {
    private Integer userId;
    private String userName;
    private String userAddress;

    public Integer getUserId() {
        return userId;
    }

    public void setUserId(Integer userId) {
        this.userId = userId;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getUserAddress() {
        return userAddress;
    }

    public void setUserAddress(String userAddress) {
        this.userAddress = userAddress;
    }
}

Dao包：创建一个UserDao接口，内容如下：

import com.example.test.Entity.UserEntity;
import org.apache.ibatis.annotations.Mapper;

import java.util.List;

@Mapper
public interface UserDao {
     List<UserEntity> queryLimit(Integer currentPage, Integer pageSize);

     Integer addUser(UserEntity user);

     Integer updateUser(UserEntity user);

     Integer deleteUser(UserEntity user);
}

Service包：创建一个UserService类，内容如下：

import com.example.test.Dao.UserDao;
import com.example.test.Entity.UserEntity;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service("UserService")
public class UserService {
    @Autowired
    private UserDao userDao;

    public List<UserEntity> queryLimit(Integer currentPage,Integer pageSzie){
        return userDao.queryLimit(currentPage,pageSzie);
    }

    public Integer addUser(UserEntity user){
        return userDao.addUser(user);
    }

    public Integer updateUser(UserEntity user){
        return userDao.updateUser(user);
    }

    public Integer deleteUser(UserEntity user){
        return userDao.deleteUser(user);
    }
}

Controller包：创建一个UserController类，内容为：

import com.example.test.Entity.UserEntity;
import com.example.test.Service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("user")
public class UserController {
    @Autowired
    private UserService userService;

    String message = "";
    @RequestMapping("/queryLimit")
    public List<UserEntity> queryLimit(@RequestParam("currentPage") Integer currentPage,@RequestParam("pageSize") Integer pageSize){
        return userService.queryLimit(currentPage,pageSize);
    }

    @PostMapping("/addUser")
    public String addUer(@RequestBody UserEntity user){
        //用Mybatis执行insert语句的时候，插入成功会返回1，不成功则会抛出异常，捕获一下异常就好
        try {
            userService.addUser(user);
            message = "增加用户成功";
        }catch (Exception exception){
            message = "增加用户异常";
        }
        return message;
    }

    @PutMapping("/updateUser")
    public String updateUser(@RequestBody UserEntity user){
        //Mybatis的更新操作成功返回1，用户不存在返回0，失败则抛异常
        try {
            message = userService.updateUser(user) == 1?"更新用户成功":"用户不存在，更新失败";
        }catch (Exception exception){
            message = "更新异常";
        }
        return message;
    }

    @DeleteMapping("/deleteUser")
    public String deleteUser(@RequestBody UserEntity user){
        //Mybatis的删除操作和更新返回值一样，成功返回1，用户不存在返回0，失败则抛异常
        try {
            message = userService.deleteUser(user) == 1?"删除用户成功":"用户不存在，删除失败";
        }catch (Exception exception){
            message = "删除异常";
        }
        return message;
    }
}

编写完上面的内容之后我们需要在Mapper文件夹下创建mapper.xml文件，如下图：

mapper.xml文件内容如下：需要注意的地方是namespace：这个路径是你的UserDao接口的路径，因为你传过来的数据需要和xml进行一个绑定，这样你编写的SQL语句才能接收到你前端传过来的数据（大体意思可以这么理解），而id则是和你UserDao中的接口方法相对应，比如我的UserDao接口中的查找方法命名是queryLimit，那么我在xml文件中的查询语句的id就应该和queryLimit想对应，即：id=“queryLimit”。
resultType是返回数据的类型
parameterType则是传入的数据类型

<?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.test.Dao.UserDao">
    <select id="queryLimit" resultType="UserEntity">
        select * from user limit #{currentPage},#{pageSize};
    </select>

    <insert id="addUser" parameterType="UserEntity">
        insert into user(userName,userAddress) values(#{userName},#{userAddress});
    </insert>

    <update id="updateUser" parameterType="UserEntity">
        update user set userName=#{userName},userAddress=#{userAddress} where userId=#{userId};
    </update>

    <delete id="deleteUser" parameterType="UserEntity">
        delete from user where userId=#{userId};
    </delete>
</mapper>