[Java知识库]SpringBoot基础学习之整合Mybatis框架

前言：

小伙伴们，大家好，我是狂奔の蜗牛rz，当然你们可以叫我蜗牛君，我是一个学习Java半年多时间的小菜鸟，同时还有一个伟大的梦想，那就是有朝一日，成为一个优秀的Java架构师。
这个SpringBoot基础学习系列用来记录我学习SpringBoot框架基础知识的全过程 (这个系列是参照B站狂神的SpringBoot最新教程来写的，由于是之前整理的，但当时没有发布出来，所以有些地方可能有错误，希望大家能够及时指正！)
之后我将会以一天一更的速度更新这个系列，还没有学习SpringBoot的小伙伴可以参照我的博客学习一下；当然学习过的小伙伴，也可以顺便跟我一起复习一下基础。
最后，希望能够和大家一同进步吧！加油吧！少年们！

废话不多说，让我们开始今天的学习内容吧，由于今天我们来到了SpringBoot基础学习的第八站：整合Mybatis框架！

6.3 整合Mybatis框架

6.3.1 搭建项目基本环境

1.创建Spring Boot项目

• 创建Spring Initializr项目

• 设置项目基本信息，设置Group、Artifact和Java Vesrion等

• 引入项目资源依赖，Spring Web、JDBC API和MySQL Driver等

• 选择项目存放位置

• 新建项目成功

• 删除多余文件，项目结构如下

2.引入Mybatis和Lombok资源依赖

• 引入MyBatis资源依赖、

 <!-- 第三方提供的启动器 -->
 <!-- Mybatis-SpringBoot的启动器 -->
 <!-- https://mvnrepository.com/artifact/org.mybatis.spring.boot/mybatis-spring-boot-starter -->
 <dependency>
     <groupId>org.mybatis.spring.boot</groupId>
     <artifactId>mybatis-spring-boot-starter</artifactId>
     <version>2.1.3</version>
 </dependency>

• 引入Lombok资源依赖

<!-- lombok资源依赖 -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.16.10</version>
</dependency>

• 引入相关资源依赖后的pom.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.5</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.kuang</groupId>
    <artifactId>springboot-05-mybatis</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-05-mybatis</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        
        <!-- Spring官方提供的启动器 -->  
        <!-- Spring Boot的JDBC启动器 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <!-- Spring Boot的Web启动器 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- SpringBoot的测试启动器 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- MySQL数据库驱动资源依赖 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
            <version>5.1.46</version>
        </dependency>
        
        <!-- 第三方提供的启动器 -->
        <!-- Mybatis-SpringBoot的启动器 -->
        <!-- https://mvnrepository.com/artifact/org.mybatis.spring.boot/mybatis-spring-boot-starter -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.3</version>
        </dependency>
        <!-- lombok资源依赖 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.10</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

• 查看项目资源依赖

3.连接MySQL数据库

3-1 编写applicationContext核心配置文件

• 使用properties格式编写配置文件

# 配置数据库相关属性
# 数据库用户登录名
spring.datasource.username=root
# 数据库登录密码
spring.datasource.password=123456
# 数据库url连接
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf-8&useSSL=true
# 数据库驱动名
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

# 配置Tomcat服务器端口号
server.port=8888

• 使用yml格式编写配置文件

# 设置数据库驱动
spring:
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf-8&useSSL=true
    # com.mysql.jdbc.Driver是8.0以下版本的数据库
    driver-class-name: com.mysql.jdbc.Driver
# 设置服务器端口号
server:
  port: 8888

3-2 连接MySQL数据库

• 添加数据源，选择MySQL数据库

• 设置数据库登录用户名和密码，进行测试连接

• 选择要连接的具体数据库

• 连接成功，右侧显示数据库表

3-3 数据库连接失败解决方案

测试连接过程中遇到了：

解决方法：设置MySQL数据库的时区

1.连接mysql

mysql  -u root -p

2.查看系统默认的时区

show variables like'%time_zone';

3.设置新的时区

set global time_zone = '+8:00'; 

4.查看修改后的时区

这里注意要退出命令窗口后重新进入才可以看到修改成功后的时区

show variables like'%time_zone';

4.查看默认数据源和连接

• 修改Springboot的测试类

package com.kuang;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import javax.sql.DataSource;
import java.sql.SQLException;

@SpringBootTest
class Springboot05MybatisApplicationTests {

    //将DataSource数据源自动装配到Spring容器中
    @Autowired
    private DataSource dataSource;

    @Test
    void contextLoads() throws SQLException {
        //打印数据源的类信息
        System.out.println(dataSource.getClass());
        //打印数据源连接信息
        System.out.println(dataSource.getConnection());
    }

}

• 查看默认数据源和连接

6.3.2 完善项目基本环境

1.项目基本结构和修改配置文件

1-1 项目基本结构

1-2 修改核心配置文件

# 配置数据库相关属性
# 数据库用户登录名
spring.datasource.username=root
# 数据库登录密码
spring.datasource.password=123456
# 数据库url连接
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf-8&useSSL=true
# 数据库驱动名
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

# 配置Tomcat服务器端口号
server.port=8888

# 配置mybatis相关属性
# 通过包设置别名
mybatis.type-aliases-package=com.kuang.pojo
# 设置mapper映射文件的位置
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml
# 不要再mybatis/mapper/*.xml前加上/,否则将会到项目根目录下开始找
# mybatis.mapper-locations=classpath:/mybatis/mapper/*.xml

2.编写User实体类和UserMapper接口

2-1 编写User实体类

package com.kuang.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data // 引入无参构造，get和set方法，以及toString方法
@AllArgsConstructor // 引入有参构造
@NoArgsConstructor // 再次引入无参构造，防止引入有参构造时无参构造被覆盖
// User实体类
public class User {
    
    private Integer id;
    private String name;
    private String pwd;
    
}

2-2 编写UserMapper接口

package com.kuang.mapper;

import com.kuang.pojo.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.springframework.stereotype.Repository;
import java.util.List;
import java.util.Map;

// 使用@Mapper注解，表明该接口是Mybatis的一个Mapper类
@Mapper
// 使用@Repository注解，将Dao接口交由Spring管理
@Repository
public interface UserMapper {
    
    // 获取所有用户信息
    public List<User> getUserList();
    
    // 通过Id获取指定用户信息
    public User getUserById(int id);
    
    // 添加用户信息
    public int addUser(User user) ;
    
    // 删除用户信息
    public int deleteUser(int id);
    
    // 修改用户信息
    public int updateUser(User user);
    
}

2-3 编写UserMapper.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.kuang.mapper.UserMapper">

    <!-- 获取所有用户信息 -->
    <!-- resultType表示返回值类型，getUserList方法返回值为User对象 -->
    <select id="getUserList" resultType="com.kuang.pojo.User">
       Select * from mybatis.user
    </select>

    <!-- 通过Id获取指定用户信息 -->
    <!-- resultType表示返回值类型，getUserById方法返回值为User对象
         parameterType表示参数类型，默认就是int型，所以此属性可以不进行设置 -->
    <select id="getUserById" resultType="com.kuang.pojo.User"  parameterType="int">
       Select * from mybatis.user where id = #{id}
    </select>

    <!-- 增加用户信息 -->
    <!-- parameterType表示参数类型，addUser方法的参数类型为User -->
    <insert id="addUser" parameterType="User">
        Insert into mybatis.user(id, name, pwd)
        values (#{id}, #{name}, #{pwd})
    </insert>

    <!-- 删除用户信息-->
    <!-- parameterType表示参数类型，deleteUser方法的参数类型为int -->
    <delete id="deleteUser" parameterType="int">
        Delete from mybatis.user where id = #{id}
    </delete>

    <!-- 修改用户信息 -->
    <!-- parameterType表示参数类型，updateUser方法的参数类型为User -->
    <update id="updateUser" parameterType="User">
        Update mybatis.user set name=#{name}, pwd=#{pwd}
        where id = #{id}
    </update>

</mapper>

3.编写UserMapper映射文件和UserController控制器

3-1 编写UserMapper.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.kuang.mapper.UserMapper">

    <!-- 获取所有用户信息 -->
    <!-- resultType表示返回值类型，getUserList方法返回值为User对象 -->
    <select id="getUserList" resultType="com.kuang.pojo.User">
       Select * from mybatis.user
    </select>

    <!-- 通过Id获取指定用户信息 -->
    <!-- resultType表示返回值类型，getUserById方法返回值为User对象
         parameterType表示参数类型，默认就是int型，所以此属性可以不进行设置 -->
    <select id="getUserById" resultType="com.kuang.pojo.User"  parameterType="int">
       Select * from mybatis.user where id = #{id}
    </select>

    <!-- 增加用户信息 -->
    <!-- parameterType表示参数类型，addUser方法的参数类型为User -->
    <insert id="addUser" parameterType="User">
        Insert into mybatis.user(id, name, pwd)
        values (#{id}, #{name}, #{pwd})
    </insert>

    <!-- 删除用户信息 -->
    <!-- parameterType表示参数类型，deleteUser方法的参数类型为int -->
    <delete id="deleteUser" parameterType="int">
        Delete from mybatis.user where id = #{id}
    </delete>

    <!-- 修改用户信息 -->
    <!-- parameterType表示参数类型，updateUser方法的参数类型为User -->
    <update id="updateUser" parameterType="User">
        Update mybatis.user set name=#{name}, pwd=#{pwd}
        where id = #{id}
    </update>

</mapper>

3-2 编写UserController控制器类

package com.kuang.controller;

import com.kuang.mapper.UserMapper;
import com.kuang.pojo.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

// 使用@RestController注解，实现Controller接口并且使返回结果为字符串
@RestController
public class UserController {

    // 使用@Autowired注解，将userMapper自动装配到Spring容器中
    @Autowired
    private UserMapper userMapper;

    // 查询所有用户信息
    /** 
     * 真实访问路径：http://localhost:8080/getList
     * 使用@GetMapping注解，设置请求映射路径
     * 使用@RequestMapping注解也可以，它们都是使用get请求方式
     */
//    @RequestMapping("/getList")
    @GetMapping("/getList")
    public List<User> getUserList() {
        //调用Dao层的getUserList方法，获取所有用户信息列表
        List<User> users = userMapper.getUserList();
        //遍历用户信息列表
        for (User user : users) {
            //打印用户信息
            System.out.println(user);
        }
        //返回用户信息列表
        return users;
    }
    
    /**
     * 通过Id查询指定用户信息(提前指定用户Id，这种方式不推荐)
     */   
    /**
     * 真实访问路径：http://localhost:8080/getUser
     * 使用@GetMapping注解，设置请求映射路径
     */
    @GetMapping("/getUser2")
    public User getUserById() {
        // 调用Dao层的getUserById方法，通过Id获取指定的用户信息
        User user = userMapper.getUserById(1);
        // 打印指定的用户信息
        System.out.println(user);
        // 返回user对象
        return user;
    }

    /**
     * 通过Id查询指定用户信息(使用常规风格)
     */
    /**
     * 真实访问路径：http://localhost:8080/getUser/?id=1
     * 使用@GetMapping注解，设置请求映射路径
     */
    @GetMapping("/getUser")
    public User getUserById2(int id) {
        // 调用Dao层的getUserById方法，通过Id获取指定的用户信息
        User user = userMapper.getUserById(id);
        // 打印指定的用户信息
        System.out.println(user);
        // 返回user对象
        return user;
    }

    /** 
     * 通过Id查询指定用户信息
     * 使用restful风格，推荐使用这种方式
     */
    /**
     * 真实访问路径：http://localhost:8080/getUser/1
     * 使用@GetMapping注解，设置请求映射路径：使用restful风格
     */
    @GetMapping("/getUser/{userId}")
    // 使用@PathVariable注解：让方法值对应到URL模板变量上
    public User getUserById3(@PathVariable("userId") int id) {
        // 调用Dao层的getUserById方法，通过Id获取指定的用户信息
        User user = userMapper.getUserById(id);
        // 打印指定的用户信息
        System.out.println(user);
        // 返回user对象
        return user;
    }

    // 增加用户信息
    /**
     * 真实访问路径：http://localhost:8080/addUser
     * 使用@GetMapping注解，设置请求映射路径
     */
    @GetMapping("/addUser")
    public String addUser() {
         // 获取user对象
         User user = new User();
         // 设置用户信息
         user.setId(6);
         user.setName("张碧晨");
         user.setPwd("zbc123456");
        // 调用Dao层的addUser2方法，添加用户信息
         userMapper.addUser(user);
        // 返回添加成功字符串
        return "addUser-OK";
    }

    // 通过Id删除用户信息
    /**
     * 真实访问路径：http://localhost:8080/deleteUser/2
     * 使用@GetMapping注解，设置请求映射路径：使用restful风格
     */
    // 使用@PathVariable注解，将方法变量绑定到URL模板上
    @GetMapping("/deleteUser/{userId}")
    public String deleteUser(@PathVariable("userId") int id) {
        userMapper.deleteUser(id);
        return "deleteUser-OK";
    }

    // 修改用户信息
    /**
     * 真实访问路径：http://localhost:8080/updateUser/2
     * 使用@GetMapping注解，设置请求映射路径：使用restful风格
     */
    @GetMapping("/updateUser/{userId}")
    // 使用@PathVariable注解，将方法变量绑定到URL模板上
    public String updateUser(@PathVariable("userId") int id) {
        // 获取user对象
        User user = new User();
        // 设置用户信息
        user.setName("薛之谦");
        user.setPwd("xzq123456");
        user.setId(id);
        // 调用Dao层的updateUser2方法，修改用户信息
        userMapper.updateUser(user);
        // 返回修改成功字符串
        return "updateUser-OK";
    }

}

4.增删改查操作和测试结果

4-1 查询所有用户信息

• 页面请求

• 控制台输出

4-2 通过Id查询指定用户信息

• 页面请求

  使用常规风格：

  

  使用RestFul风格：

• 控制台输出

4-3 增加用户信息

• 页面请求

• 数据库信息

4-4 删除用户信息

• 页面请求

• 数据库信息

4-5 修改用户信息

• 页面请求

• 数据库信息

好了，今天的有关 SpringBoot基础学习之整合Mybatis框架 的学习就到此结束啦，欢迎小伙伴们积极学习和讨论，喜欢的可以给蜗牛君点个关注，顺便来个一键三连，我们下期见，拜拜啦！

参考视频链接：https://www.bilibili.com/video/BV1PE411i7CV(【狂神说Java】SpringBoot最新教程IDEA版通俗易懂)