SpringBoot与MyBatis的整合与综合实例

SpringBoot是Spring框架的扩展，其设计目的是用来简化Spring应用的初始搭建以及开发过程，使得开发变得更快、更高效、更自动化。MyBatis是一款优秀的持久层框架，它支持定制化SQL、存储过程、以及高级映射。MyBatis3提供的注解可以取代XML。例如，使用注解@Select直接编写SQL完成数据查询。

下面将介绍SpringBoot与MyBatis的整合步骤。

1、创建数据表

在MySQL数据库中创建用户信息表（tb_user），并添加数据。

-- 判断数据表是否存在，存在则删除
DROP TABLE IF EXISTS tb_user;
 
-- 创建“用户信息”数据表
CREATE TABLE IF NOT EXISTS tb_user
( 
	user_id INT AUTO_INCREMENT PRIMARY KEY COMMENT '用户编号',
	user_account VARCHAR(50) NOT NULL COMMENT '用户账号',
	user_password VARCHAR(50) NOT NULL COMMENT '用户密码',
	blog_url VARCHAR(50) NOT NULL COMMENT '博客地址',
	blog_remark VARCHAR(50) COMMENT '博客备注'
) COMMENT = '用户信息表';
 
-- 添加数据
INSERT INTO tb_user(user_account,user_password,blog_url,blog_remark) VALUES('pan_junbiao的博客','123456','https://blog.csdn.net/pan_junbiao','您好，欢迎访问 pan_junbiao的博客');

2、创建项目

（1）创建SpringBoot项目，项目结构如下图：

（2）添加pom.xml配置信息

在pom.xml配置文件中添加MyBatis、 MySQL的JDBC数据库驱动、Thymeleaf等依赖。

<!-- MyBatis与SpringBoot整合依赖 -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.3</version>
</dependency>

<!-- MySQL的JDBC数据库驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.20</version>
</dependency>

<!-- 引入Thymeleaf模板引擎 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

（3）配置相关信息

将默认的application.properties文件的后缀修改为“.yml”，即配置文件名称为：application.yml，并配置以下信息：

spring:
  #DataSource数据源
  datasource:
    url: jdbc:mysql://localhost:3306/db_admin?useSSL=false&amp
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
  #使用Thymeleaf模板引擎
  thymeleaf:
    mode: HTML5
    encoding: UTF-8
    cache: false  #使用Thymeleaf模板引擎，关闭缓存
    servlet:
      content-type: text/html

#MyBatis配置
mybatis:
  type-aliases-package: com.pjb.entity #别名定义
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #指定 MyBatis 所用日志的具体实现，未指定时将自动查找
    map-underscore-to-camel-case: true #开启自动驼峰命名规则（camel case）映射
    lazy-loading-enabled: true #开启延时加载开关
    aggressive-lazy-loading: false #将积极加载改为消极加载（即按需加载）,默认值就是false
    lazy-load-trigger-methods: "" #阻挡不相干的操作触发，实现懒加载
    cache-enabled: true #打开全局缓存开关（二级环境），默认值就是true

2.1 创建实体类（Entity层）

在com.pjb.entity包中，创建UserInfo类（用户信息实体类）。

package com.pjb.entity;

/**
 * 用户信息实体类
 * @author pan_junbiao
 **/
public class UserInfo
{
    private int userId; //用户编号
    private String userAccount; //用户账号
    private String userPassword; //用户密码
    private String blogUrl; //博客地址
    private String blogRemark; //博客备注

    //省略getter与setter方法...
}

2.2 数据库映射层（Mapper层）

在com.pjb.mapper包中，创建UserMapper接口（用户信息Mapper动态代理接口）。

package com.pjb.mapper;

import com.pjb.entity.UserInfo;
import org.apache.ibatis.annotations.*;
import org.springframework.stereotype.Repository;

/**
 * 用户信息Mapper动态代理接口
 * @author pan_junbiao
 **/
@Repository
public interface UserMapper
{
    /**
     * 新增用户，并获取自增主键
     */
    @Insert("INSERT INTO tb_user(user_account,user_password,blog_url,blog_remark) VALUES(#{userAccount},#{userPassword},#{blogUrl},#{blogRemark})")
    @Options(useGeneratedKeys = true, keyColumn = "user_id", keyProperty = "userId")
    //或者：@SelectKey(statement = "SELECT LAST_INSERT_ID()", keyColumn = "user_id", keyProperty = "userId",before = false, resultType = Integer.class)
    public int insertUser(UserInfo userInfo);

    /**
     * 修改用户
     */
    @Update("UPDATE tb_user SET user_account = #{userAccount} ,user_password = #{userPassword} ,blog_url=#{blogUrl} ,blog_remark=#{blogRemark} WHERE user_id = #{userId}")
    public int updateUser(UserInfo userInfo);

    /**
     * 删除用户
     */
    @Delete("DELETE FROM tb_user WHERE user_id = #{userId}")
    public int deleteUser(int userId);

    /**
     * 根据用户ID，获取用户信息
     */
    @Select("SELECT * FROM tb_user WHERE user_id = #{userId}")
    public UserInfo getUserById(int userId);
}

2.3 实现实体和数据表的映射关系

实现实体和数据表的映射关系可以在Mapper类上添加@Mapper注解，如下代码：

/**
 * 用户信息Mapper动态代理接口
 * @author pan_junbiao
 **/
@Mapper
@Repository
public interface UserMapper
{
    //省略其他代码...
}

但是建议以后直接在SpringBoot启动类中加 @MapperScan("com.pjb.mapper") 注解，这样会比较方便，不需要对每个Mapper都添加@Mapper注解。

package com.pjb;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * SpringBoot启动类
 * @author pan_junbiao
 **/
@MapperScan("com.pjb.mapper")
@SpringBootApplication
public class SpringbootMybatisDemoApplication
{
    public static void main(String[] args)
    {
        SpringApplication.run(SpringbootMybatisDemoApplication.class, args);
    }
}

2.4 业务逻辑层（Service层）

在com.pjb.service包下，创建UserService接口（用户信息业务逻辑接口）。

package com.pjb.service;

import com.pjb.entity.UserInfo;

/**
 * 用户信息业务逻辑接口
 * @author pan_junbiao
 **/
public interface UserService
{
    /**
     * 新增用户，并获取自增主键
     */
    public int insertUser(UserInfo userInfo);

    /**
     * 修改用户
     */
    public int updateUser(UserInfo userInfo);

    /**
     * 删除用户
     */
    public int deleteUser(int userId);

    /**
     * 根据用户ID，获取用户信息
     */
    public UserInfo getUserById(int userId);
}

在com.pjb.service.impl包下，创建UserServiceImpl类（用户信息业务逻辑类）。

package com.pjb.service.impl;

import com.pjb.entity.UserInfo;
import com.pjb.mapper.UserMapper;
import com.pjb.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * 用户信息业务逻辑类
 * @author pan_junbiao
 **/
@Service
public class UserServiceImpl implements UserService
{

    @Autowired
    private UserMapper userMapper;

    /**
     * 新增用户，并获取自增主键
     */
    public int insertUser(UserInfo userInfo)
    {
        return userMapper.insertUser(userInfo);
    }

    /**
     * 修改用户
     */
    public int updateUser(UserInfo userInfo)
    {
        return userMapper.updateUser(userInfo);
    }

    /**
     * 删除用户
     */
    public int deleteUser(int userId)
    {
        return userMapper.deleteUser(userId);
    }

    /**
     * 根据用户ID，获取用户信息
     */
    public UserInfo getUserById(int userId)
    {
        return userMapper.getUserById(userId);
    }
}

2.5 控制器方法（Controller层）

在com.pjb.controller包中，创建UserController类（用户控制器），实现用户数据的查询、新增、修改、删除，并实现数据的返回。

package com.pjb.controller;

import com.pjb.entity.UserInfo;
import com.pjb.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;

/**
 * 用户控制器
 * @author pan_junbiao
 **/
@Controller
@RequestMapping("/user")
public class UserController
{
    @Autowired
    private UserService userService;

    /**
     * 新增用户
     */
    @RequestMapping("/insertUser")
    @ResponseBody
    public boolean insertUser()
    {
        boolean result = false;

        //创建新用户
        UserInfo userInfo = new UserInfo();
        userInfo.setUserAccount("pan_junbiao的博客");
        userInfo.setUserPassword("123456");
        userInfo.setBlogUrl("https://blog.csdn.net/pan_junbiao");
        userInfo.setBlogRemark("您好，欢迎访问 pan_junbiao的博客");
        int count = userService.insertUser(userInfo);

        //返回结果
        result = count > 0 ? true : false;
        return true;
    }

    /**
     * 修改用户
     */
    @RequestMapping("/updateUser")
    @ResponseBody
    public boolean updateUser(int userId)
    {
        boolean result = false;

        //创建修改用户
        UserInfo userInfo = new UserInfo();
        userInfo.setUserId(userId);
        userInfo.setUserAccount("pan_junbiao的博客_02");
        userInfo.setUserPassword("123456");
        userInfo.setBlogUrl("https://blog.csdn.net/pan_junbiao");
        userInfo.setBlogRemark("您好，欢迎访问 pan_junbiao的博客");
        int count = userService.updateUser(userInfo);

        //返回结果
        result = count > 0 ? true : false;
        return true;
    }

    /**
     * 删除用户
     */
    @RequestMapping("/deleteUser")
    @ResponseBody
    public boolean deleteUser(int userId)
    {
        boolean result = false;

        //执行删除用户
        int count = userService.deleteUser(userId);

        //返回结果
        result = count > 0 ? true : false;
        return true;
    }


    /**
     * 根据用户ID，获取用户信息
     */
    @RequestMapping("/getUserById")
    public ModelAndView getUserById(int userId)
    {
        UserInfo userInfo = userService.getUserById(userId);

        //返回结果
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("userInfo", userInfo);
        modelAndView.setViewName("userInfo.html");
        return modelAndView;
    }
}

3、综合实例

【实例】实现用户信息的查询、新增、修改、删除操作。

3.1 查询用户

查询用户信息，执行结果如下图：

在resources/templates目录下，创建 userInfo.html 用户信息显示页面。

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>用户信息</title>
    <meta name="author" content="pan_junbiao的博客">
    <style>
        table { border-collapse: collapse; margin-bottom: 10px}
        table,table tr th, table tr td { border:1px solid #000000; padding: 5px 10px;}
    </style>
</head>
<body>
<div align="center">
    <table>
        <caption>用户信息</caption>
        <tr>
            <th>用户ID：</th>
            <td th:text="${userInfo.userId}"></td>
        </tr>
        <tr>
            <th>用户姓名：</th>
            <td th:text="${userInfo.userAccount}"></td>
        </tr>
        <tr>
            <th>博客地址：</th>
            <td th:text="${userInfo.blogUrl}"></td>
        </tr>
        <tr>
            <th>博客信息：</th>
            <td th:text="${userInfo.blogRemark}"></td>
        </tr>
    </table>
</div>
</body>
</html>

编写控制器方法：

@Autowired
private UserService userService;

/**
 * 根据用户ID，获取用户信息
 * @author pan_junbiao
 */
@RequestMapping("/getUserById")
public ModelAndView getUserById(int userId)
{
    UserInfo userInfo = userService.getUserById(userId);

    //返回结果
    ModelAndView modelAndView = new ModelAndView();
    modelAndView.addObject("userInfo", userInfo);
    modelAndView.setViewName("userInfo.html");
    return modelAndView;
}

执行结果： 

控制台打印的SQL语句与执行结果如下图：

3.2 新增用户

新增用户信息，编写控制器方法：

@Autowired
private UserService userService;

/**
 * 新增用户
 * @author pan_junbiao
 */
@RequestMapping("/insertUser")
@ResponseBody
public boolean insertUser()
{
    boolean result = false;

    //创建新用户
    UserInfo userInfo = new UserInfo();
    userInfo.setUserAccount("pan_junbiao的博客");
    userInfo.setUserPassword("123456");
    userInfo.setBlogUrl("https://blog.csdn.net/pan_junbiao");
    userInfo.setBlogRemark("您好，欢迎访问 pan_junbiao的博客");
    int count = userService.insertUser(userInfo);

    //返回结果
    result = count > 0 ? true : false;
    return true;
}

执行结果：

控制台打印的SQL语句与执行结果如下图：

3.3 修改用户

修改用户信息，编写控制器方法：

@Autowired
private UserService userService;

/**
 * 修改用户
 * @author pan_junbiao
 */
@RequestMapping("/updateUser")
@ResponseBody
public boolean updateUser(int userId)
{
    boolean result = false;

    //创建修改用户
    UserInfo userInfo = new UserInfo();
    userInfo.setUserId(userId);
    userInfo.setUserAccount("pan_junbiao的博客_02");
    userInfo.setUserPassword("123456");
    userInfo.setBlogUrl("https://blog.csdn.net/pan_junbiao");
    userInfo.setBlogRemark("您好，欢迎访问 pan_junbiao的博客");
    int count = userService.updateUser(userInfo);

    //返回结果
    result = count > 0 ? true : false;
    return true;
}

执行结果：

控制台打印的SQL语句与执行结果如下图：

3.4 删除用户

删除用户信息，编写控制器方法：

@Autowired
private UserService userService;

/**
 * 删除用户
 * @author pan_junbiao
 */
@RequestMapping("/deleteUser")
@ResponseBody
public boolean deleteUser(int userId)
{
    boolean result = false;

    //执行删除用户
    int count = userService.deleteUser(userId);

    //返回结果
    result = count > 0 ? true : false;
    return true;
}

执行结果：

控制台打印的SQL语句与执行结果如下图：

源代码下载：https://github.com/kevinpanjunbiao/SpringBootMyBatisDemo

原文地址：https://blog.csdn.net/pan_junbiao/article/details/106718204