Spring Boot 整合 MyBatis 快速入门指南

Spring Boot 整合 MyBatis 快速入门指南

本指南基于 ShawnyXiao 的 SpringBoot-MyBatis 开源项目，旨在帮助您快速理解和搭建一个基于 Spring Boot 和 MyBatis 的后台服务。

1. 项目目录结构及介绍

以下是项目的高级别目录结构及其主要组成部分：

.
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── shawn
│   │   │           ├── constant        # 常量类存放
│   │   │           ├── model            # 模型类，包括DTO与Entity
│   │   │           ├── monitor          # 监控相关
│   │   │           ├── repository       # 数据访问接口
│   │   │           ├── service          # 业务逻辑层
│   │   │           ├── security         # Spring Security配置
│   │   │           ├── util              # 工具类
│   │   │           └── web               # 控制器、异常处理等
│   │   └── resources
│   │       ├── application.properties # 主配置文件
│   │       ├── com
│   │       │   └── shawn
│   │       │       └── repository      # MyBatis映射文件
│   │       └── db                    # 数据初始化脚本（如HSQLDB）
│   └── test
└── ...

• src/main/java: 包含了所有的Java源代码文件，按照分层架构组织。
• com.shawn.model: 分为dto和entity子包，分别用于定义传输对象和业务实体。
• com.shawn.web: 包括控制器、异常处理器等，是项目与外部交互的主要界面。
• application.properties: 项目的核心配置文件，包括数据库连接配置等。
• resources: 存放配置文件、资源文件和MyBatis的映射XML文件。

2. 项目的启动文件介绍

在本项目中，启动文件通常是位于com.shawn包下的主应用程序类，可能命名为Application.java或类似的名称，含有以下标志性代码：

package com.shawn;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

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

}

@SpringBootApplication注解是Spring Boot的便利注解，结合了@SpringBootConfiguration, @EnableAutoConfiguration, 和 @ComponentScan，它使您的应用成为Spring容器的起点，并自动配置应用。

3. 项目的配置文件介绍

application.properties 示例

项目的核心配置主要位于src/main/resources/application.properties。以下是一些关键配置示例：

# 数据源配置
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/your_database_name?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=your_password

# MyBatis配置
mybatis.mapper-locations=classpath:mapper/*.xml

# Spring Boot常规设置
server.port=8080

• 数据源配置: 包括数据库驱动、URL、用户名、密码等，确保与您的数据库环境匹配。
• MyBatis配置: 指定映射文件的位置，这里假设映射文件存放在类路径下的mapper目录。
• 服务器端口: 可自定义应用监听的端口号，默认为8080。

通过以上三个步骤，您可以快速了解并准备运行基于Spring Boot和MyBatis的项目。记得在运行前，根据实际情况调整数据库配置，确保已正确安装Git和Maven，并执行相应的克隆和构建命令。