Java?Mybatis框架應用怎么配置

Java Mybatis框架應用怎么配置

1. 引言

MyBatis 是一個優秀的持久層框架，它支持定制化 SQL、存儲過程以及高級映射。MyBatis 避免了幾乎所有的 JDBC 代碼和手動設置參數以及獲取結果集。MyBatis 可以使用簡單的 XML 或注解來配置和映射原生信息，將接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java對象)映射成數據庫中的記錄。

本文將詳細介紹如何在 Java 項目中配置和使用 MyBatis 框架。

2. 環境準備

在開始配置 MyBatis 之前，確保你已經具備以下環境：

• JDK 1.8 或更高版本
• Maven 或 Gradle 構建工具
• 一個支持 Java 的 IDE（如 IntelliJ IDEA 或 Eclipse）
• 一個數據庫（如 MySQL、PostgreSQL 等）

3. 創建 Maven 項目

首先，我們需要創建一個 Maven 項目。如果你已經有一個現成的項目，可以跳過這一步。

3.1 使用命令行創建 Maven 項目

mvn archetype:generate -DgroupId=com.example -DartifactId=mybatis-demo -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

3.2 使用 IDE 創建 Maven 項目

在 IntelliJ IDEA 或 Eclipse 中，選擇創建新項目，然后選擇 Maven 項目模板，填寫 GroupId 和 ArtifactId，完成項目創建。

4. 添加 MyBatis 依賴

在 pom.xml 文件中添加 MyBatis 和相關依賴。

<dependencies>
    <!-- MyBatis 核心依賴 -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.7</version>
    </dependency>

    <!-- 數據庫驅動依賴 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.26</version>
    </dependency>

    <!-- 日志依賴 -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.32</version>
    </dependency>
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.6</version>
    </dependency>

    <!-- 測試依賴 -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.13.2</version>
        <scope>test</scope>
    </dependency>
</dependencies>

5. 配置 MyBatis

5.1 創建 MyBatis 配置文件

在 src/main/resources 目錄下創建一個名為 mybatis-config.xml 的文件，用于配置 MyBatis 的核心設置。

<?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>
    <settings>
        <setting name="logImpl" value="SLF4J"/>
    </settings>

    <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?useSSL=false&amp;serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="password"/>
            </dataSource>
        </environment>
    </environments>

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

5.2 創建數據庫表

在 MySQL 中創建一個簡單的用戶表。

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

5.3 創建實體類

在 src/main/java/com/example/model 目錄下創建一個 User 類。

package com.example.model;

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

    // Getters and Setters
    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", email='" + email + '\'' +
                '}';
    }
}

5.4 創建 Mapper 接口

在 src/main/java/com/example/mapper 目錄下創建一個 UserMapper 接口。

package com.example.mapper;

import com.example.model.User;

import java.util.List;

public interface UserMapper {
    User selectUserById(int id);
    List<User> selectAllUsers();
    void insertUser(User user);
    void updateUser(User user);
    void deleteUser(int id);
}

5.5 創建 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="selectUserById" resultType="com.example.model.User">
        SELECT * FROM user WHERE id = #{id}
    </select>

    <select id="selectAllUsers" resultType="com.example.model.User">
        SELECT * FROM user
    </select>

    <insert id="insertUser" parameterType="com.example.model.User">
        INSERT INTO user (name, email) VALUES (#{name}, #{email})
    </insert>

    <update id="updateUser" parameterType="com.example.model.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>

6. 使用 MyBatis

6.1 創建 MyBatis 工具類

在 src/main/java/com/example/util 目錄下創建一個 MyBatisUtil 類，用于獲取 SqlSession。

package com.example.util;

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 MyBatisUtil {
    private static SqlSessionFactory sqlSessionFactory;

    static {
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
    }
}

6.2 測試 MyBatis

在 src/test/java/com/example 目錄下創建一個 MyBatisTest 類，用于測試 MyBatis 的功能。

package com.example;

import com.example.mapper.UserMapper;
import com.example.model.User;
import com.example.util.MyBatisUtil;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

import java.util.List;

public class MyBatisTest {
    @Test
    public void testSelectUserById() {
        try (SqlSession sqlSession = MyBatisUtil.getSqlSession()) {
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            User user = mapper.selectUserById(1);
            System.out.println(user);
        }
    }

    @Test
    public void testSelectAllUsers() {
        try (SqlSession sqlSession = MyBatisUtil.getSqlSession()) {
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            List<User> users = mapper.selectAllUsers();
            users.forEach(System.out::println);
        }
    }

    @Test
    public void testInsertUser() {
        try (SqlSession sqlSession = MyBatisUtil.getSqlSession()) {
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            User user = new User();
            user.setName("John Doe");
            user.setEmail("john.doe@example.com");
            mapper.insertUser(user);
            sqlSession.commit();
        }
    }

    @Test
    public void testUpdateUser() {
        try (SqlSession sqlSession = MyBatisUtil.getSqlSession()) {
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            User user = mapper.selectUserById(1);
            user.setName("Jane Doe");
            mapper.updateUser(user);
            sqlSession.commit();
        }
    }

    @Test
    public void testDeleteUser() {
        try (SqlSession sqlSession = MyBatisUtil.getSqlSession()) {
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            mapper.deleteUser(1);
            sqlSession.commit();
        }
    }
}

7. 運行測試

在 IDE 中運行 MyBatisTest 類中的測試方法，確保 MyBatis 配置正確并且能夠正常操作數據庫。

8. 總結

通過本文的介紹，你已經學會了如何在 Java 項目中配置和使用 MyBatis 框架。MyBatis 提供了靈活的 SQL 映射和強大的數據庫操作能力，使得開發者能夠更加高效地進行數據庫操作。希望本文對你有所幫助，祝你在使用 MyBatis 的過程中取得成功！