正文

Java开源框架MyBatis快速入门：从搭建环境到实战应用详解

/0 浏览量
0411

引言

MyBatis 是一个优秀的持久层框架，它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射，将接口和 Java 的 POJOs（Plain Old Java Objects，简单的 Java 对象）映射成数据库中的记录。本文将带领您从搭建环境到实战应用，全面了解 MyBatis。

一、MyBatis 简介

1.1 MyBatis 的优势

  • 简化数据库操作：通过 XML 或注解的方式，简化了 JDBC 编程，提高了开发效率。
  • 灵活的映射规则：支持复杂的 SQL 映射，满足各种业务需求。
  • 支持自定义查询：可以自定义 SQL 语句，实现复杂的查询需求。
  • 可扩展性强：支持插件扩展，如分页插件、缓存插件等。

1.2 MyBatis 的应用场景

  • 单表查询：适用于简单的单表查询操作。
  • 多表查询：适用于复杂的多表查询操作。
  • 关联查询：适用于关联查询操作，如一对一、一对多、多对多。
  • 存储过程：适用于需要调用存储过程的业务场景。

二、搭建 MyBatis 环境和配置

2.1 创建 Maven 项目

  1. 打开 Maven 官网（https://maven.apache.org/）下载 Maven 安装包。
  2. 解压安装包，配置环境变量。
  3. 打开命令行窗口，执行 mvn -version 验证 Maven 是否安装成功。

2.2 添加依赖

在项目的 pom.xml 文件中添加以下依赖：

<dependencies>
    <!-- MyBatis 依赖 -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.7</version>
    </dependency>
    <!-- MySQL 驱动依赖 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.22</version>
    </dependency>
    <!-- 数据库连接池依赖 -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.1.22</version>
    </dependency>
</dependencies>

2.3 配置数据库

  1. 下载 MySQL 安装包，并安装 MySQL 数据库。
  2. 创建数据库和数据表，并导入相关数据。

2.4 配置 MyBatis

  1. 在项目的 src/main/resources 目录下创建 mybatis-config.xml 文件。
  2. 在 mybatis-config.xml 文件中配置数据源、事务管理器和映射器。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!-- 配置数据源 -->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis_db?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <!-- 配置映射器 -->
    <mappers>
        <mapper resource="com/mybatis/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

三、编写 MyBatis 映射文件

3.1 创建 Mapper 接口

在项目的 src/main/java/com/mybatis/example/mapper 目录下创建 UserMapper.java 接口，定义所需的 SQL 映射方法。

package com.mybatis.example.mapper;

import com.mybatis.example.entity.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user WHERE id = #{id}")
    User getUserById(Integer id);
}

3.2 编写 Mapper 映射文件

在项目的 src/main/resources/com/mybatis/example/mapper 目录下创建 UserMapper.xml 文件，定义 SQL 映射语句。

<?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.mybatis.example.mapper.UserMapper">
    <select id="getUserById" resultType="com.mybatis.example.entity.User">
        SELECT * FROM user WHERE id = #{id}
    </select>
</mapper>

四、MyBatis 实战应用

4.1 编写 Service 层

在项目的 src/main/java/com/mybatis/example/service 目录下创建 UserService.java 服务接口，定义所需的业务方法。

package com.mybatis.example.service;

import com.mybatis.example.entity.User;

public interface UserService {
    User getUserById(Integer id);
}

4.2 实现 Service 层

在项目的 src/main/java/com/mybatis/example/service/impl 目录下创建 UserServiceImpl.java 服务实现类，实现 UserService 接口。

package com.mybatis.example.service.impl;

import com.mybatis.example.entity.User;
import com.mybatis.example.mapper.UserMapper;
import com.mybatis.example.service.UserService;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

public class UserServiceImpl implements UserService {
    private SqlSessionFactory sqlSessionFactory;

    public UserServiceImpl(SqlSessionFactory sqlSessionFactory) {
        this.sqlSessionFactory = sqlSessionFactory;
    }

    @Override
    public User getUserById(Integer id) {
        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper userMapper = session.getMapper(UserMapper.class);
            return userMapper.getUserById(id);
        }
    }
}

4.3 编写 Controller 层

在项目的 src/main/java/com/mybatis/example/controller 目录下创建 UserController.java 控制器类，处理用户请求。

package com.mybatis.example.controller;

import com.mybatis.example.entity.User;
import com.mybatis.example.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping("/user/{id}")
    public User getUserById(@PathVariable Integer id) {
        return userService.getUserById(id);
    }
}

4.4 启动 Spring Boot 应用

在项目的 src/main/java/com/mybatis/example 目录下创建 Application.java 启动类，并启动 Spring Boot 应用。

package com.mybatis.example;

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);
    }
}

五、总结

通过本文的介绍，您已经了解了 MyBatis 的基本概念、搭建环境、配置和实战应用。MyBatis 是一个优秀的持久层框架，能够帮助您快速开发高效、可维护的数据库应用程序。希望本文能对您的学习和实践有所帮助。

-- 展开阅读全文 --