MyBatis-Spring-Boot-Starter 教程

MyBatis-Spring-Boot-Starter 教程

spring-boot-starterMyBatis integration with Spring Boot项目地址:https://gitcode.com/gh_mirrors/sp/spring-boot-starter

1. 项目目录结构及介绍

MyBatis-Spring-Boot-Starter 是一个方便地将 MyBatis 集成到 Spring Boot 应用中的启动器。下面是一般项目的典型目录结构：

mybatis-spring-boot-starter/
├── src/
│   ├── main/
│   │   ├── java/            # 包含核心 Java 源代码
│   │   │   └── org/
│   │   │       └── mybatis/
│   │   │           └── spring/
│   │   └── resources/      # 资源文件，如配置文件
│   └── test/                # 测试代码
└── pom.xml                 # Maven 项目配置文件

• src/main/java: 主要的 Java 代码源目录，包含了 MyBatis 和 Spring Boot 的集成实现。
• src/main/resources: 存放应用资源，如 SQL 映射文件（mapper.xml）和配置文件（application.properties 或 application.yml）。
• pom.xml: Maven 构建文件，定义了依赖关系和构建设置。

2. 项目的启动文件介绍

在 Spring Boot 中，主入口类通常标记有 @SpringBootApplication 注解，用于启动整个应用程序。对于 MyBatis-Spring-Boot-Starter，这个启动类可能是这样的：

package com.example.springbootmybatis;

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

@SpringBootApplication
@MapperScan("com.example.springbootmybatis.mapper") // 扫描你的 Mapper 接口包
public class MybatisSpringbootStarterApplication {

    public static void main(String[] args) {
        SpringApplication.run(MybatisSpringbootStarterApplication.class, args);
    }

}

@SpringBootApplication 继承了 @SpringBootConfiguration、@EnableAutoConfiguration 和 @ComponentScan，意味着 Spring Boot 将自动配置应用，包括 MyBatis 的相关组件。

@MapperScan 注解扫描指定包下的所有带有 @Mapper 注解的接口，这些接口将在运行时被代理以执行 SQL 查询。

3. 项目的配置文件介绍

MyBatis-Spring-Boot-Starter 支持两种主要的配置方式：application.properties 和 application.yml。以下是在 application.properties 文件中配置 MyBatis 的示例：

# 数据库连接配置
spring.datasource.url=jdbc:mysql://localhost:3306/testdb?useUnicode=true&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=password
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

# MyBatis 配置
mybatis.config-location=classpath:mybatis-config.xml     # 可选，自定义 MyBatis 全局配置文件
mybatis.mapper-locations=classpath:mapper/*.xml          # 必须，MyBatis 的映射文件位置

# MyBatis-Spring-Boot 自动配置
mybatis.type-aliases-package=com.example.springbootmybatis.model    # 类别名包，可选
mybatis.type-handlers-package=com.example.springbootmybatis.typehandlers  # 类型处理器包，可选

或者使用 YAML 格式：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/testdb?useUnicode=true&characterEncoding=utf8
    username: root
    password: password
    driver-class-name: com.mysql.jdbc.Driver

mybatis:
  config-location: classpath:mybatis-config.xml         # 可选，MyBatis全局配置文件路径
  mapper-locations: classpath:mapper/*.xml               # 必须，MyBatis 映射文件位置
  type-aliases-package: com.example.springbootmybatis.model  # 可选，类别名包
  type-handlers-package: com.example.springbootmybatis.typehandlers  # 可选，类型处理器包

通过以上配置，MyBatis-Spring-Boot-Starter 将能够连接数据库并执行相关的 SQL 查询。

这就是 MyBatis-Spring-Boot-Starter 的基本介绍和配置。现在你可以根据这个模板开始搭建自己的 MyBatis 与 Spring Boot 结合的应用了。

spring-boot-starterMyBatis integration with Spring Boot项目地址:https://gitcode.com/gh_mirrors/sp/spring-boot-starter