正文

学会MyBatis：高效Java开源框架应用指南与实战案例

/0 浏览量
0606

MyBatis 是一个优秀的持久层框架，它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的过程。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射，将接口和 Java 的 POJOs（Plain Old Java Objects，普通的 Java 对象）映射成数据库中的记录。

MyBatis 简介

MyBatis 本是 Apache 的一个开源项目，后来被代码托管平台 GitHub 收录。它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的过程。

MyBatis 的特点

  • 半自动化处理：MyBatis 需要手动编写 SQL 语句，但自动处理了参数设置和结果集获取。
  • 灵活的映射：MyBatis 支持复杂的映射，包括关联映射、集合映射等。
  • 支持多种数据库：MyBatis 支持多种数据库，如 MySQL、Oracle、SQL Server 等。
  • 易于集成：MyBatis 可以与 Spring 等其他框架集成。

MyBatis 的基本使用

1. 添加依赖

在 Maven 项目中，添加以下依赖：

<dependencies>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis.caches</groupId>
        <artifactId>mybatis-redis</artifactId>
        <version>1.0.0</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>5.3.10</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>5.3.10</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.26</version>
    </dependency>
</dependencies>

2. 配置 MyBatis

在 src/main/resources 目录下创建 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_example?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

3. 编写 Mapper 接口

在 com.example.mapper 包下创建 UserMapper.java 接口：

package com.example.mapper;

import com.example.entity.User;

public interface UserMapper {
    User getUserById(int id);
}

4. 编写 Mapper XML

在 src/main/resources/com/example/mapper 目录下创建 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.mapper.UserMapper">
    <select id="getUserById" resultType="com.example.entity.User">
        SELECT * FROM user WHERE id = #{id}
    </select>
</mapper>

5. 使用 MyBatis

在 Spring Boot 项目中，创建一个 MyBatisConfig.java 配置类：

package com.example.config;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@MapperScan("com.example.mapper")
public class MyBatisConfig {
}

在控制器中注入 UserMapper 并使用：

package com.example.controller;

import com.example.entity.User;
import com.example.mapper.UserMapper;
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 UserMapper userMapper;

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

MyBatis 实战案例

以下是一个简单的 MyBatis 实战案例，演示如何创建、读取、更新和删除（CRUD）操作。

1. 创建表

CREATE TABLE user (
    id INT PRIMARY KEY AUTO_INCREMENT,
    username VARCHAR(50),
    password VARCHAR(50)
);

2. 创建实体类

package com.example.entity;

public class User {
    private int id;
    private String username;
    private String password;

    // getters and setters
}

3. 创建 Mapper 接口

package com.example.mapper;

import com.example.entity.User;

public interface UserMapper {
    int insert(User user);
    User getUserById(int id);
    int update(User user);
    int delete(int id);
}

4. 创建 Mapper 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.mapper.UserMapper">
    <insert id="insert" parameterType="User">
        INSERT INTO user (username, password) VALUES (#{username}, #{password})
    </insert>
    <select id="getUserById" resultType="User">
        SELECT * FROM user WHERE id = #{id}
    </select>
    <update id="update" parameterType="User">
        UPDATE user SET username = #{username}, password = #{password} WHERE id = #{id}
    </update>
    <delete id="delete" parameterType="int">
        DELETE FROM user WHERE id = #{id}
    </delete>
</mapper>

5. 使用 MyBatis

在控制器中注入 UserMapper 并使用：

package com.example.controller;

import com.example.entity.User;
import com.example.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserMapper userMapper;

    @PostMapping
    public User addUser(@RequestBody User user) {
        userMapper.insert(user);
        return user;
    }

    @GetMapping("/{id}")
    public User getUserById(@PathVariable int id) {
        return userMapper.getUserById(id);
    }

    @PutMapping("/{id}")
    public User updateUser(@PathVariable int id, @RequestBody User user) {
        userMapper.update(user);
        return user;
    }

    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable int id) {
        userMapper.delete(id);
    }
}

通过以上步骤，您已经成功地学习了 MyBatis 的基本使用和实战案例。希望这篇文章能够帮助您更好地理解和使用 MyBatis。

-- 展开阅读全文 --