快捷導(dǎo)航

SpringBoot3整合Mybatis完整版實(shí)例

更新時(shí)間：2025年01月25日 11:47:34 作者：m0_74824574

本文詳細(xì)介紹了SpringBoot3整合MyBatis的完整步驟,包括添加數(shù)據(jù)庫(kù)驅(qū)動(dòng)和MyBatis依賴(lài)、配置數(shù)據(jù)源和MyBatis、創(chuàng)建表和Bean類(lèi)、編寫(xiě)Mapper接口和XML文件、創(chuàng)建Controller類(lèi)以及配置掃描包,通過(guò)這些步驟,可以實(shí)現(xiàn)SpringBoot3與MyBatis的成功整合,并進(jìn)行功能測(cè)試

1. 添加數(shù)據(jù)庫(kù)驅(qū)動(dòng)依賴(lài)

以 MySQL 為例。

當(dāng)不指定依賴(lài)版本的時(shí)候，會(huì) 由 springboot 自動(dòng)管理。

<dependency>
    <groupId>com.mysql</groupId>
    <artifactId>mysql-connector-j</artifactId>
    <!-- <version>8.0.32</version> -->
</dependency>

2. 添加 MyBatis 依賴(lài)

第三方的依賴(lài)庫(kù)，需要明確的指定版本號(hào)。推薦使用最新的即可。

<!-- 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>3.0.3</version>
</dependency>

3. 配置數(shù)據(jù)源信息

在 application.yaml 文件中添加數(shù)據(jù)源的信息

spring:
  datasource:
    # 數(shù)據(jù)庫(kù)連接驅(qū)動(dòng)
    driver-class-name: com.mysql.cj.jdbc.Driver
    # 數(shù)據(jù)源類(lèi)型： 默認(rèn)的是 Hikari
    type: com.zaxxer.hikari.HikariDataSource
    # 數(shù)據(jù)庫(kù)連接地址
    url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
    # 數(shù)據(jù)庫(kù)連接用戶名
    username: root
    # 數(shù)據(jù)庫(kù)連接密碼
    password: 12345678

4. 配置 mybatis

在 application.yaml 文件中添加mybatis的相關(guān)配置。

# mybatis 的配置
mybatis:
  # 配置 mybatis 的xml文件的掃描路徑
  mapper-locations: classpath:mybatis/**/*.xml
  # 配置實(shí)體類(lèi)的掃描路徑
  type-aliases-package: com.testabc.demo.ssmtest
  configuration:
    # 開(kāi)啟駝峰命名轉(zhuǎn)換
    map-underscore-to-camel-case: true
    # 開(kāi)啟日志
    #log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
    log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpl

# 指定日志級(jí)別 : 對(duì)mybatis的日志輸出
logging:
  level:
    com.testabc.demo.ssmtest: debug

5. 功能開(kāi)發(fā)

5.1 建表

簡(jiǎn)單創(chuàng)建一張表。包含了普通屬性，標(biāo)準(zhǔn)的下劃線屬性。

CREATE TABLE `test`.`student`  (
  `id` int NOT NULL,
  `name` varchar(20) NOT NULL,
  `age` int NOT NULL,
  `other_message` varchar(100) NULL,
  PRIMARY KEY (`id`)
);

5.2 創(chuàng)建普通的bean類(lèi)

結(jié)合表結(jié)構(gòu)，創(chuàng)建普通的一個(gè)bean類(lèi)。此時(shí)屬性用標(biāo)準(zhǔn)的駝峰命名。

package com.testabc.demo.ssmtest;

public class Student {
    private int id;
    private String name;
    private int age;
    private String otherMessage;

    。。。。。。
    構(gòu)造方法
    getter/setter
    toString 方法

}

5.3 創(chuàng)建mapper接口

注意：此處的接口用到了 @Mapper 注解。先寫(xiě)上吧，沒(méi)有副作用。

package com.testabc.demo.ssmtest;

import org.apache.ibatis.annotations.Param;
import org.springframework.stereotype.Repository;

@Mapper
public interface StudentMapper {
    // 根據(jù)id查詢(xún)student的方法
    Student getStudentById(@Param("id") int id);
}

5.4 創(chuàng)建xml文件

在 classpath:/resources/mybatis/ 目錄下新增 StudentMapper.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.testabc.demo.ssmtest.StudentMapper">


    <select id="getStudentById" resultType="com.testabc.demo.ssmtest.Student">
        select * from student where id = #{id}
    </select>
  
</mapper>

5.5 創(chuàng)建controller類(lèi)

package com.testabc.demo.ssmtest;

@RestController
public class StudentController {

    /**
     * 通過(guò)構(gòu)造方法的方式注入 StudentMapper
     */
    private final StudentMapper studentMapper;

    public StudentController(StudentMapper studentMapper) {
        this.studentMapper = studentMapper;
    }

    @GetMapping("/getStudentById/{id}")
    public Student getStudentById(@PathVariable("id") int id){
        Student student = null;
        student = studentMapper.getStudentById(id);
        return student;
    }
}

5.6 配置掃描的包

在項(xiàng)目的啟動(dòng)類(lèi)上添加注解 MapperScan(xxxx), 指定要掃描的 mapper 接口的包路徑。

package com.testabc.demo;

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

@SpringBootApplication
@MapperScan("com.testabc.demo.ssmtest")
public class DemoApplication {

    public static void main(String[] args) {

        // 這個(gè)工具會(huì)返回一個(gè) ApplicationContext 的對(duì)象
        var ioc = SpringApplication.run(DemoApplication.class, args);

    }

}