正文

新手必看：MyBatis开源框架入门攻略，从搭建到实战案例详解

/0 浏览量
0903

引言

在Java开发领域，持久层框架是开发中不可或缺的一部分。MyBatis作为一款优秀的持久层框架，以其简洁的配置和灵活的映射方式，深受开发者喜爱。本文将带你从搭建MyBatis环境开始，逐步深入到实战案例，帮助你快速掌握MyBatis的使用。

一、MyBatis简介

MyBatis是一款优秀的持久层框架，它对JDBC的操作进行了封装，简化了数据库操作的过程。与Hibernate等全表映射框架相比，MyBatis采用了半自动映射的方式，既保证了数据的一致性，又提高了开发效率。

二、搭建MyBatis环境

1. 创建Maven项目

首先，你需要创建一个Maven项目。在IDE中，选择“新建Maven项目”，然后填写项目信息。

2. 添加依赖

在项目的pom.xml文件中，添加以下依赖：

<dependencies>
    <!-- MyBatis核心依赖 -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>
    <!-- 数据库驱动依赖 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.26</version>
    </dependency>
    <!-- 数据库连接池依赖 -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.2.8</version>
    </dependency>
</dependencies>

3. 配置数据库连接

在项目的src/main/resources目录下，创建一个名为application.properties的文件，用于配置数据库连接信息：

# 数据库连接信息
jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis_db?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
jdbc.username=root
jdbc.password=root

三、编写Mapper接口和XML文件

1. 编写Mapper接口

在项目的src/main/java目录下，创建一个与数据库表对应的Mapper接口：

package com.example.mapper;

import com.example.entity.User;

public interface UserMapper {
    int insert(User record);
    int insertSelective(User record);
    User selectByPrimaryKey(Integer id);
    int updateByPrimaryKeySelective(User record);
    int updateByPrimaryKey(User record);
}

2. 编写XML文件

在项目的src/main/resources目录下，创建一个与Mapper接口同名的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">
    <insert id="insert" parameterType="User">
        INSERT INTO user (name, age) VALUES (#{name}, #{age})
    </insert>
    <select id="selectByPrimaryKey" parameterType="int" resultType="User">
        SELECT id, name, age FROM user WHERE id = #{id}
    </select>
    <!-- 其他操作 -->
</mapper>

四、配置SqlSessionFactory

在项目的src/main/resources目录下，创建一个名为mybatis-config.xml的文件，用于配置SqlSessionFactory：

<?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_db?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

五、使用MyBatis进行数据库操作

1. 创建SqlSessionFactoryBuilder

String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

2. 使用SqlSessionFactory获取SqlSession

SqlSession sqlSession = sqlSessionFactory.openSession();

3. 使用Mapper接口进行数据库操作

UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
User user = userMapper.selectByPrimaryKey(1);
System.out.println(user.getName());

4. 提交事务

sqlSession.commit();
sqlSession.close();

六、实战案例

以下是一个简单的用户信息管理系统的案例，展示了如何使用MyBatis进行增删改查操作。

1. 创建User实体类

package com.example.entity;

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

    // 省略getter和setter方法
}

2. 创建UserMapper接口

package com.example.mapper;

import com.example.entity.User;

public interface UserMapper {
    int insert(User record);
    int deleteByPrimaryKey(Integer id);
    int updateByPrimaryKey(User record);
    User selectByPrimaryKey(Integer id);
}

3. 创建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">
    <insert id="insert" parameterType="User">
        INSERT INTO user (name, age) VALUES (#{name}, #{age})
    </insert>
    <delete id="deleteByPrimaryKey" parameterType="int">
        DELETE FROM user WHERE id = #{id}
    </delete>
    <update id="updateByPrimaryKey" parameterType="User">
        UPDATE user SET name = #{name}, age = #{age} WHERE id = #{id}
    </update>
    <select id="selectByPrimaryKey" parameterType="int" resultType="User">
        SELECT id, name, age FROM user WHERE id = #{id}
    </select>
</mapper>

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

// 省略创建SqlSessionFactory和获取SqlSession的代码

UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

// 添加用户
User user = new User();
user.setName("张三");
user.setAge(20);
userMapper.insert(user);

// 删除用户
userMapper.deleteByPrimaryKey(1);

// 更新用户
user = new User();
user.setId(1);
user.setName("李四");
user.setAge(21);
userMapper.updateByPrimaryKey(user);

// 查询用户
user = userMapper.selectByPrimaryKey(1);
System.out.println(user.getName());

// 提交事务
sqlSession.commit();
sqlSession.close();

通过以上步骤，你就可以使用MyBatis进行数据库操作了。希望本文能帮助你快速入门MyBatis，并在实际项目中发挥其优势。

-- 展开阅读全文 --