当前位置：首页 > article >正文

Spring Boot 整合 MyBatis 与 PostgreSQL 实战指南

article 2025/2/28 22:19:25

Spring Boot 整合 MyBatis 与 PostgreSQL 实战指南

- 一、环境搭建与准备
- 二、创建 Spring Boot 项目
- 三、数据源与 MyBatis 配置
- 四、实体类与 Mapper 接口定义
- 五、编写 Mapper XML 文件
- 六、业务层与控制层实现
- 七、测试与验证

在当今的企业级 Java 开发场景中，Spring Boot 凭借其便捷的配置、快速启动能力，结合强大的持久层框架 MyBatis 以及开源关系型数据库 PostgreSQL，能够高效构建出稳定且高性能的应用系统。本文将详细介绍如何一步步完成这三者的无缝整合，助力开发者快速上手项目开发。

一、环境搭建与准备

JDK 安装：确保本地环境已安装 JDK 8 及以上版本，通过在命令行输入 java -version 来验证安装情况及版本信息，确保 JDK 环境变量正确配置，以便后续项目编译与运行。
Maven 配置：安装并配置好 Maven，这是 Java 项目依赖管理与构建的利器。可在 settings.xml 文件中设置国内镜像源，如阿里云镜像，加速依赖包的下载速度，减少项目初始化时间。
PostgreSQL 数据库安装：前往 PostgreSQL 官方网站下载对应操作系统的安装包，依安装向导完成数据库服务的安装。安装过程中需牢记设置的超级用户（通常为 postgres）密码，后续连接数据库时会用到。创建好项目所需的数据库实例，例如名为 your_database，并记录下连接地址，格式一般为 jdbc:postgresql://localhost:5432/your_database，其中 5432 为默认端口号，依实际配置调整。

二、创建 Spring Boot 项目

借助 Spring Initializr 快速搭建项目基础架构，多数主流集成开发环境（如 IDEA、Eclipse 等）均内置此功能。创建新项目时，勾选 Web、MyBatis Framework 以及 PostgreSQL Driver 依赖项，Spring Initializr 会自动生成包含必要目录结构与初始配置文件的项目骨架，关键目录有 src/main/java（用于存放 Java 源代码）、src/main/resources（放置配置文件、静态资源以及 MyBatis 的映射文件等）。

三、数据源与 MyBatis 配置

在 src/main/resources/application.properties 文件中精确配置 PostgreSQL 数据源信息：

spring.datasource.url=jdbc:postgresql://localhost:5432/your_database
spring.datasource.username=postgres
spring.datasource.password=your_password
spring.datasource.driver-class-name=org.postgresql.Driver

注意将 your_password 替换为实际数据库密码，确保连接配置准确无误。

紧接着配置 MyBatis，设置实体类别名扫描包路径，方便在 XML 映射文件中简洁引用实体类，同时指定 Mapper XML 文件的位置：

mybatis.type-aliases-package=com.example.demo.entity
mybatis.mapper-locations=classpath:mapper/*.xml

四、实体类与 Mapper 接口定义

在 com.example.demo.entity 包下精心构建与数据库表结构对应的实体类，例如创建 User 实体类：

import lombok.Data;

@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
}

此处借助 Lombok 的 @Data 注解简化了常规的 get、set、equals、hashCode 等方法编写，若未引入 Lombok，需手动生成这些方法。

于 com.example.demo.mapper 包内创建 UserMapper 接口，用 @Mapper 注解标记（若 Spring Boot 启动类所在包及其子包下的 Mapper 接口，可省略该注解，Spring 会自动扫描），定义数据库操作方法，像查询所有用户的方法签名：

import com.example.demo.entity.User;
import org.apache.ibatis.annotations.Mapper;
import java.util.List;

@Mapper
public interface UserMapper {
    List<User> getAllUsers();
}

五、编写 Mapper XML 文件

在 src/main/resources/mapper 目录下新建 UserMapper.xml，精心编写 SQL 语句与 UserMapper 接口方法相呼应：

<?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.example.demo.mapper.UserMapper">
    <select id="getAllUsers" resultMap="BaseResultMap">
        SELECT * FROM users_table
    </select>
    <resultMap id="BaseResultMap" type="com.example.demo.entity.User">
        <id property="id" column="id"/>
        <result property="name" column="name"/>
        <result property="age" column="age"/>
    </resultMap>
</mapper>

需留意 SELECT 语句中的表名 users_table 要与实际数据库中的表名一致，resultMap 精准映射数据库列与实体类属性。

六、业务层与控制层实现

业务层 com.example.demo.service 包定义 UserService 接口及具体实现类 UserServiceImpl，业务逻辑层负责协调数据访问层（Mapper）与控制层间交互，在实现类中通过 @Autowired 注解注入 UserMapper 实例：

import com.example.demo.entity.User;
import java.util.List;

public interface UserService {
    List<User> getAllUsers();
}


import com.example.demo.mapper.UserMapper;
import com.example.demo.entity.User;
import org.springframework.stereotype.Service;
import java.util.List;
import javax.annotation.Resource;

@Service
public class UserServiceImpl implements UserService {
    @Resource
    private UserMapper userMapper;

    @Override
    public List<User> getAllUsers() {
        return userMapper.getAllUsers();
    }
}

控制层 com.example.demo.controller 包创建 UserController，利用 @RestController 与 @RequestMapping 注解对外暴露

import com.example.demo.entity.User;
import com.example.demo.service.UserService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
import javax.annotation.Resource;

@RestController
@RequestMapping("/users")
public class UserController {
    @Resource
    private UserService userService;

    @GetMapping
    public List<User> getUsers() {
        return userService.getAllUsers();
    }
}

七、测试与验证

启动 Spring Boot 项目主类 DemoApplication，待项目成功启动后，在浏览器或 Postman 等工具中访问 http://localhost:8080/users（端口号依 application.properties 中 server.port 配置而定，路径依 @RequestMapping 设定），若数据库 your_database 的 users_table 表中有数据，此时应能看到以 JSON 格式返回的用户信息列表，这意味着整合大功告成。

后续可依据项目实际需求进一步拓展复杂业务逻辑，深入探索 MyBatis 的高级特性如动态 SQL、缓存机制，以及 Spring Boot 的诸多实用功能，像安全认证、性能调优等，持续优化应用系统性能与功能完整性，开启高效稳健的后端开发征程。

上述代码片段仅为基础整合示例，实际项目开发中需紧密贴合业务场景灵活调整优化，愿此教程成为您技术进阶路上的得力助手。

查看全文

http://www.kler.cn/a/565098.html