正文

Java开源框架MyBatis入门与应用实战指南

/0 浏览量
0420

引言

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

本文将带您从入门到实战，深入了解 MyBatis 的基本概念、配置、使用方法，并通过一个简单的示例项目来展示如何将 MyBatis 应用于实际的 Java 应用中。

MyBatis 简介

什么是 MyBatis？

MyBatis 是一个半自动化的持久层框架，它将 SQL 映射成 Java 对象，从而实现数据库操作的自动化。

MyBatis 的核心组件

  • SqlSession：MyBatis 的核心接口，用于执行 SQL 语句，管理事务。
  • Executor：MyBatis 的执行器，负责执行 SQL 语句，并返回结果。
  • MappedStatement：MyBatis 的内部对象，用于存储 SQL 语句和参数。
  • SqlSource：MyBatis 的内部对象，用于生成 SQL 语句。

MyBatis 入门

环境搭建

  1. 下载 MyBatis：从 MyBatis 官网下载最新版本的 MyBatis 框架。
  2. 添加依赖：在项目的 pom.xml 文件中添加 MyBatis 的依赖。
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.6</version>
</dependency>
  1. 配置文件：创建 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.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis_db"/>
                <property name="username" value="root"/>
                <property name="password" value=""/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

编写 Mapper 接口

创建一个 Mapper 接口，定义数据库操作的方法。

package com.example.mapper;

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

编写 Mapper XML

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

使用 MyBatis

  1. 创建 SqlSessionFactory：通过 SqlSessionFactoryBuilder 创建 SqlSessionFactory。
  2. 获取 SqlSession：通过 SqlSessionFactory 获取 SqlSession。
  3. 执行 Mapper 接口方法：通过 SqlSession 执行 Mapper 接口方法。
public class Main {
    public static void main(String[] args) {
        try {
            // 创建 SqlSessionFactory
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(new FileInputStream("mybatis-config.xml"));
            // 获取 SqlSession
            SqlSession sqlSession = sqlSessionFactory.openSession();
            // 执行 Mapper 接口方法
            User user = sqlSession.selectOne("com.example.mapper.UserMapper.getUserById", 1);
            System.out.println(user);
            // 关闭 SqlSession
            sqlSession.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

MyBatis 实战

创建示例项目

  1. 创建 Maven 项目：使用 Maven 创建一个 Java Web 项目。
  2. 添加依赖：添加 MyBatis、数据库驱动等依赖。
  3. 配置文件：配置 mybatis-config.xml 文件。

定义实体类

创建一个实体类 User，表示数据库中的用户表。

package com.example.entity;

public class User {
    private Integer id;
    private String name;
    private String email;

    // 省略 getter 和 setter 方法
}

编写 Mapper 接口

创建一个 Mapper 接口 UserMapper，定义数据库操作的方法。

package com.example.mapper;

public interface UserMapper {
    User getUserById(Integer id);
    List<User> getAllUsers();
    int addUser(User user);
    int updateUser(User user);
    int deleteUser(Integer id);
}

编写 Mapper XML

创建一个 Mapper XML 文件 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.example.mapper.UserMapper">
    <select id="getUserById" resultType="com.example.entity.User">
        SELECT * FROM user WHERE id = #{id}
    </select>
    <select id="getAllUsers" resultType="com.example.entity.User">
        SELECT * FROM user
    </select>
    <insert id="addUser" parameterType="com.example.entity.User">
        INSERT INTO user (name, email) VALUES (#{name}, #{email})
    </insert>
    <update id="updateUser" parameterType="com.example.entity.User">
        UPDATE user SET name = #{name}, email = #{email} WHERE id = #{id}
    </update>
    <delete id="deleteUser" parameterType="int">
        DELETE FROM user WHERE id = #{id}
    </delete>
</mapper>

使用 MyBatis

  1. 创建 SqlSessionFactory：通过 SqlSessionFactoryBuilder 创建 SqlSessionFactory。
  2. 获取 SqlSession：通过 SqlSessionFactory 获取 SqlSession。
  3. 执行 Mapper 接口方法：通过 SqlSession 执行 Mapper 接口方法。
public class Main {
    public static void main(String[] args) {
        try {
            // 创建 SqlSessionFactory
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(new FileInputStream("mybatis-config.xml"));
            // 获取 SqlSession
            SqlSession sqlSession = sqlSessionFactory.openSession();
            // 执行 Mapper 接口方法
            User user = sqlSession.selectOne("com.example.mapper.UserMapper.getUserById", 1);
            System.out.println(user);
            // 关闭 SqlSession
            sqlSession.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

总结

本文介绍了 MyBatis 的基本概念、配置、使用方法，并通过一个简单的示例项目展示了如何将 MyBatis 应用于实际的 Java 应用中。希望本文能帮助您快速入门 MyBatis，并在实际项目中发挥其优势。

-- 展开阅读全文 --