Java Spring 框架下利用 MyBatis 实现请求 MySQL 数据库的存储过程

请添加图片描述

Java Spring 框架下利用 MyBatis 实现请求 MySQL 数据库的存储过程

- 环境准备与前置知识
- 1. 创建 MySQL 存储过程
- 2. 配置数据源
- 3. 创建实体类
- 4. 创建 Mapper 接口
- 5. 创建 Mapper XML 文件
- 6. 创建 Service 接口及Impl实现类
- 7. 创建 Controller 类
- 8. 测试与总结

在现代的 Web 应用开发中，我们经常需要与数据库交互。Java Spring 框架搭配 MyBatis 可以方便地实现对 MySQL 数据库的操作，特别是调用存储过程。本文将深入探讨如何在 Spring + MyBatis 的环境中调用 MySQL 存储过程并获取查询结果。

环境准备与前置知识

在开始之前，确保已经安装了 Java、Maven、MySQL，并且有一个基本的 Spring Boot 项目。此外，还需要了解以下知识点：

Spring Framework：依赖注入、声明式事务管理等核心概念。
MyBatis：一个优秀的持久层框架，它提供了 SQL 映射和事务管理。
MySQL：关系型数据库管理系统，存储过程是其高级功能之一。

1. 创建 MySQL 存储过程

首先，我们需要在 MySQL 数据库中创建一个名为 CJWDemoFunction 的存储过程。以下是一个简单的存储过程示例，它接受两个输入参数 param1 和 param2：

DELIMITER //
CREATE PROCEDURE CJWDemoFunction(IN param1 INT, IN param2 INT, OUT result INT)
BEGIN
    -- 在这里执行你的业务逻辑
    SET result = param1 + param2;
END //
DELIMITER ;

注意：需要根据实际需求修改存储过程的名称和参数。

2. 配置数据源

在 application.properties 文件或yml中，配置数据源和 MyBatis 相关信息：

spring.datasource.url=jdbc:mysql://localhost:3306/test?useSSL=false&serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=your_password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

mybatis.type-aliases-package=com.example.demo.entity
mybatis.mapper-locations=classpath:mapper/*.xml
mybatis.configuration.map-underscore-to-camel-case=true

3. 创建实体类

创建一个 User 实体类，用于映射数据库中的 users 表：

public class User {
    private Integer id;
    private String name;
    private String email;
    // getter and setter methods
}

4. 创建 Mapper 接口

创建一个 UserMapper 接口，用于调用存储过程：

import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Procedure;
import java.util.List;

@Mapper
public interface UserMapper {
    @Procedure("CJWDemoFunction")
    int cjwDemoFunction(@Param("param1") int param1, @Param("param2") int param2);
}

5. 创建 Mapper XML 文件

创建一个 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.example.demo.mapper.UserMapper">
    <procedure id="cjwDemoFunction" statementType="CALLABLE">
        { call CJWDemoFunction(#{param1, mode=IN}, #{param2, mode=IN, jdbcType=INTEGER}), mode=OUT }
    </procedure>
</mapper>

6. 创建 Service 接口及Impl实现类

创建一个 UserService 接口及其实现类 UserServiceImpl，用于调用 UserMapper：

public interface UserService {
    int cjwDemoFunction(int param1, int param2);
}

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

    @Override
    public int cjwDemoFunction(int param1, int param2) {
        return userMapper.cjwDemoFunction(param1, param2);
    }
}

7. 创建 Controller 类

创建一个 UserController 类，用于处理 HTTP 请求：

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

    @GetMapping("/cjwDemoFunction")
    public ResponseEntity<Integer> cjwDemoFunction(@RequestParam("param1") int param1, @RequestParam("param2") int param2) {
        int result = userService.cjwDemoFunction(param1, param2);
        return new ResponseEntity<>(result, HttpStatus.OK);
    }
}