从零开始搭建基于 Maven 和 MyBatis 的 Java 项目

公告

View Post

1.修改IDEA中Maven的配置 （安转目录 本地仓库）
2.创建Maven工程
3.修改pom.xml文件中的配置信息 主要是 Maven 编译器插件（maven-compiler-plugin）
4.导入相关依赖坐标
5.创建pojo JavaBean 书写实体类
6.根据 实体类 编写SQL语句 建库建表 插入数据
7.创建mybatis-config核心配置文件 配置相关信息
8.创建外部资源文件 由mybatis核心配置文件关联 降低耦合性 硬编码的问题
9.创建接口映射文件XXXMapper.xml 书写SQL代码 由mybatis核心配置文件关联
10.书写SqlSessionUtils工具类 打开会话（是否自动提交事务）提交/回滚事务释放资源 释放资源
11.创建测试类 测试映射接口中的方法 释放资源

在现代 Java 开发中，Maven 和 MyBatis 是两个非常重要的工具。Maven 用于项目构建和依赖管理，而 MyBatis 则是一个优秀的持久层框架，能够简化数据库操作。本文将详细介绍如何从零开始，基于 Maven 和 MyBatis 搭建一个 Java 项目，并逐步完成项目的开发流程。

1. 配置 Maven 环境

在开始项目开发之前，首先需要确保 Maven 环境配置正确。以下是配置步骤：

1.1 修改 IDEA 中的 Maven 配置

打开 IDEA，进入 File -> Settings -> Build, Execution, Deployment -> Build Tools -> Maven。
配置 Maven 的安装目录（如 D:\apache-maven-3.8.6）。
配置本地仓库路径（如 D:\maven-repository）。

1.2 验证 Maven 配置

打开终端，输入 mvn -v，确保 Maven 版本信息正确显示。

2. 创建 Maven 工程

在 Maven 配置完成后，接下来创建一个 Maven 工程。

2.1 使用 IDEA 创建 Maven 工程

打开 IDEA，选择 New Project -> Maven。
输入 GroupId（如 com.example）和 ArtifactId（如 mybatis-demo）。
选择项目保存路径，点击 Finish。

2.2 检查 Maven 工程结构

确保项目结构如下：

mybatis-demo
├── src
│   ├── main
│   │   ├── java
│   │   └── resources
│   └── test
│       └── java
└── pom.xml

3. 修改 `pom.xml` 文件

在创建 Maven 工程后，需要配置 pom.xml 文件，确保项目能够正确编译和运行。

3.1 配置 Maven 编译器插件

在 pom.xml 中添加以下内容：

<properties>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
</properties>

3.2 导入相关依赖

添加 MyBatis、MySQL 驱动等依赖：

<dependencies>
    <!-- MyBatis 依赖 -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.9</version>
    </dependency>
    <!-- MySQL 驱动依赖 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.28</version>
    </dependency>
    <!-- JUnit 测试依赖 -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.13.2</version>
        <scope>test</scope>
    </dependency>
</dependencies>

4. 创建实体类（POJO）

实体类是数据库表的映射，通常包含属性和对应的 getter/setter 方法。

4.1 创建 `User` 实体类

在 src/main/java/com/example/pojo 目录下创建 User.java：

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

    // Getter 和 Setter 方法
}

5. 数据库设计和初始化

根据实体类，创建数据库表并插入测试数据。

5.1 创建数据库和表

使用以下 SQL 语句创建数据库和表：

CREATE DATABASE mybatis_demo;
USE mybatis_demo;

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

INSERT INTO user (username, password) VALUES ('admin', '123456');

6. 配置 MyBatis 核心文件

创建 MyBatis 的核心配置文件，配置数据库连接和映射器。

6.1 创建 `mybatis-config.xml`

在 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_demo"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

7. 创建映射文件

映射文件用于将 SQL 语句与 Java 方法映射。

7.1 创建 `UserMapper.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.pojo.User">
        SELECT * FROM user WHERE id = #{id}
    </select>
</mapper>

8. 创建工具类和测试类

8.1 创建 `SqlSessionUtils` 工具类

在 src/main/java/com/example/utils 目录下创建 SqlSessionUtils.java：

public class SqlSessionUtils {
    public static SqlSession getSqlSession() {
        return new SqlSessionFactoryBuilder().build(
            Resources.getResourceAsStream("mybatis-config.xml")
        ).openSession();
    }
}

8.2 创建测试类

在 src/test/java/com/example 目录下创建 UserMapperTest.java：

public class UserMapperTest {
    @Test
    public void testGetUserById() {
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User user = mapper.getUserById(1);
        System.out.println(user);
        sqlSession.close();
    }
}

总结

通过以上步骤，我们成功搭建了一个基于 Maven 和 MyBatis 的 Java 项目。从环境配置到数据库操作，每一步都紧密相连，确保项目能够顺利运行。希望本文能够帮助你快速上手 Maven 和 MyBatis，开启你的 Java 开发之旅！

参考资料

如果你有任何问题或建议，欢迎在评论区留言！

posted on 2024-12-15 21:14 周政然阅读(402) 评论(0) 收藏举报

刷新页面返回顶部

奋斗的软件工程师

公告

View Post