在本篇文章中，我们将深入探讨如何新建一个基于 MyBatis 的项目。MyBatis 是一款流行的持久层框架，能够帮助开发者更简便地进行数据库操作。通过本教程，你将掌握从创建项目到配置数据库的基本步骤。
1. 操作前的准备
在开始之前，确保你已准备好以下环境：
- Java JDK 1.8+ – 确保已安装 Java，并配置了环境变量。
- Maven – 项目管理工具，用于依赖管理。
- 一个数据库 – 本教程将以 MySQL 为例，确保你有一个可用的数据库服务器。
- IDE – 如 IntelliJ IDEA 或 Eclipse，便于进行代码开发。
2. 新建 Maven 项目
2.1 使用命令行创建项目
首先，通过命令行创建一个新的 Maven 项目。在你的终端中执行以下命令：
mvn archetype:generate -DgroupId=com.example.mybatistutorial -DartifactId=mybatis-demo -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false在这个命令中：
- groupId：组织的唯一标识符。
- artifactId：项目的名称。
2.2 使用 IDE 创建项目
如果你选择在 IDE 中创建项目，可以按照以下步骤操作：
- 打开你的 IDE。
- 选择创建新项目，选择 Maven 项目类型。
- 输入 Group Id 和 Artifact Id，并选择项目保存路径。
- 点击完成，项目会被创建。
3. 添加 MyBatis 依赖
在项目创建后，需要在 pom.xml 文件中添加 MyBatis 相关依赖。打开 pom.xml，并在 <dependencies> 标签内添加：
org.mybatis
mybatis
3.5.7
org.mybatis
mybatis-spring
2.0.6
mysql
mysql-connector-java
8.0.25
保存 pom.xml 文件并更新 Maven 项目以下载依赖。
4. 配置 MyBatis
4.1 创建 MyBatis 配置文件
在项目的 src/main/resources 目录下创建一个名为 mybatis-config.xml 的文件，配置如下：
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
4.2 创建 SQL 映射文件
在 src/main/resources 下创建一个名为 mapper 的文件夹，并在其中创建 UserMapper.xml 文件，内容如下：
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
SELECT * FROM users WHERE id = #{id}
4.3 创建模型类
创建一个名为 User.java 的模型类，路径为 src/main/java/com/example/mybatistutorial/model，代码如下：
package com.example.mybatistutorial.model;
public class User {
private int id;
private String name;
private String email;
// Getters and Setters
}
4.4 创建 DAO 接口
接下来，创建一个 DAO 接口 UserMapper.java，路径为 src/main/java/com/example/mybatistutorial/mapper，代码如下：
package com.example.mybatistutorial.mapper;
import com.example.mybatistutorial.model.User;
public interface UserMapper {
User getUser(int id);
}
5. 配置数据源
为了连接数据库，需要配置数据源。可以使用 Apache DBCP 或 HikariCP，这里以 HikariCP 为例。首先，添加依赖：
com.zaxxer
HikariCP
5.0.1
在 mybatis-config.xml 中添加数据源配置：
...
6. 编写主程序
创建一个主程序 Application.java，路径为 src/main/java/com/example/mybatistutorial，代码如下：
package com.example.mybatistutorial;
import com.example.mybatistutorial.mapper.UserMapper;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.mybatis.io.Resources;
import java.io.IOException;
import java.io.InputStream;
public class Application {
public static void main(String[] args) throws IOException {
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
try (SqlSession session = sqlSessionFactory.openSession()) {
UserMapper userMapper = session.getMapper(UserMapper.class);
User user = userMapper.getUser(1);
System.out.println("User: " + user.getName());
}
}
}
7. 运行项目
确保数据库中有名为 users 的数据表，并插入了一些数据，然后在 IDE 中运行 Application.java。如果一切正常，你将看到用户的名称输出到控制台。
8. 常见问题和注意事项
- 数据库连接失败：请检查数据库 URL、用户名及密码是否正确。
- MyBatis 映射失败：确保 XML 和 Java 文件路径及命名一致。
- 没有相关依赖：检查 pom.xml 中的依赖是否已经更新。
9. 总结
通过以上步骤，你已经成功创建了一个简单的 MyBatis 项目，并连接了 MySQL 数据库。你可以根据需求进一步扩展该项目，添加更多的数据库操作和业务逻辑。
希望这篇教程能帮助你快速上手 MyBatis，进行项目开发！
