MyBatis 入门之核心配置文件

在 Java 开发中，MyBatis 是一个非常流行的持久层框架，它可以帮助我们更方便地进行数据库操作。本文将介绍 MyBatis 的核心配置文件，帮助你快速入门。

一、MyBatis 简介

MyBatis 是一个基于 Java 的持久层框架，它通过将 SQL 语句与 Java 代码分离，使得数据库操作更加灵活和可维护。MyBatis 提供了一种简单而强大的方式来执行 SQL 语句、映射结果集和管理数据库连接。

二、核心配置文件的作用

MyBatis 的核心配置文件通常命名为mybatis-config.xml，它是 MyBatis 框架的核心配置文件，用于配置数据库连接信息、事务管理、映射器文件等。通过配置文件，我们可以轻松地管理和配置 MyBatis 的各种属性，而无需在代码中硬编码这些信息。

三、核心配置文件的结构

1. 配置文件头部

<?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">

这是配置文件的头部，指定了 XML 的版本和编码，以及引用了 MyBatis 的 DTD（Document Type Definition）文件。

2. 配置环境（environments）

<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/mydb"/>
			<property name="username" value="root"/>
			<property name="password" value="password"/>
		</dataSource>
	</environment>
</environments>

• environments元素用于配置 MyBatis 的运行环境，可以配置多个环境，但只能有一个是默认环境。
• environment元素表示一个具体的环境，id属性用于唯一标识该环境。
• transactionManager元素用于配置事务管理器，这里使用了 JDBC 事务管理器。
• dataSource元素用于配置数据源，这里使用了连接池数据源（POOLED），并配置了数据库驱动、连接 URL、用户名和密码等信息。

3. 配置映射器（mappers）

<mappers>
	<mapper resource="com/example/dao/UserMapper.xml"/>
</mappers>

mappers元素用于配置映射器文件，可以通过resource属性指定映射器文件的路径，也可以通过class属性指定映射器接口的全限定名。

四、代码实现

1. 创建项目并导入依赖

创建一个 Maven 项目，并在pom.xml文件中添加 MyBatis 的依赖：

<dependency>
	<groupId>org.mybatis</groupId>
	<artifactId>mybatis</artifactId>
	<version>3.5.10</version>
</dependency>

2. 创建数据库表和实体类

创建一个名为user的数据库表，包含id、name和age三个字段。然后创建一个对应的 Java 实体类User：

public class User {
	private int id;
	private String name;
	private int age;
	// 省略 getter 和 setter 方法
}

3. 创建映射器接口和映射器文件

创建一个映射器接口UserMapper：

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

并创建一个对应的映射器文件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.dao.UserMapper">
	<select id="getUserById" resultType="com.example.entity.User">
	SELECT * FROM user WHERE id = #{id}
	</select>
</mapper>

在映射器文件中，通过namespace属性指定映射器接口的全限定名，通过select元素定义了一个查询方法，id属性用于唯一标识该方法，resultType属性指定查询结果的类型。

4. 使用 MyBatis 进行数据库操作

在 Java 代码中，使用 MyBatis 进行数据库操作：

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.IOException;
import java.io.InputStream;
public class Main {
	public static void main(String[] args) {
		try {
			// 加载核心配置文件
			InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
			SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
			// 获取 SqlSession
			SqlSession sqlSession = sqlSessionFactory.openSession();
			// 获取映射器对象
			UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
			// 调用映射器方法进行数据库操作
			User user = userMapper.getUserById(1);
			System.out.println(user.getName() + " " + user.getAge());
			// 关闭 SqlSession
			sqlSession.close();
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
}

在上述代码中，首先加载核心配置文件mybatis-config.xml，创建SqlSessionFactory对象。然后通过SqlSessionFactory对象获取SqlSession对象，SqlSession是 MyBatis 中进行数据库操作的主要接口。接着通过SqlSession对象获取映射器对象，调用映射器方法进行数据库操作。最后关闭SqlSession。

五、总结

本文介绍了 MyBatis 的核心配置文件mybatis-config.xml的作用、结构和代码实现。通过配置文件，我们可以轻松地管理和配置 MyBatis 的各种属性，使得数据库操作更加灵活和可维护。希望本文对你学习 MyBatis 有所帮助。