Mybatis入门教程：从零开始搭建项目-原创手记-慕课网

概述

Mybatis是一个优秀的持久层框架，支持自定义SQL查询、存储过程及高级映射，简化了数据访问层的开发。Mybatis具有灵活性、轻量级和强大的映射功能等优势，并通过配置文件将SQL语句与查询从Java代码中分离。本文将详细介绍Mybatis的基本概念、优势应用场景、环境搭建、核心配置、数据库操作以及与Spring的整合等内容。

Mybatis简介

Mybatis的基本概念

Mybatis是一个优秀的持久层框架，它支持自定义SQL查询，存储过程以及高级性能优化的SQL查询。Mybatis避免了几乎所有的JDBC代码和手动设置参数以及获取返回结果集。通过XML或注解的方式将Pojos(Plain Old Java Objects)映射成数据库中的记录，将面向数据库的编程变成了面向对象的编程，大大简化了数据访问层的开发。

Mybatis的优势和应用场景

Mybatis的优势包括：

灵活性：Mybatis允许在SQL语句中使用自定义的SQL、存储过程以及高级性能优化的SQL查询。
轻量级：Mybatis没有过多依赖于其他框架，使得其架构更轻量。
强大的映射功能：Mybatis支持复杂对象的一对一、一对多和多对多的映射关系，支持延迟加载，提供了丰富的api供扩展。
可配置性：通过配置文件，可以将SQL语句和查询从Java代码中分离，使得开发人员不用关心数据库结构。

Mybatis适合以下场景：

项目需要高度自定义SQL的场景。
需要处理复杂查询的场景。
需要快速开发、简化数据库操作的场景。

Mybatis环境搭建

开发环境准备

在开始使用Mybatis之前，您需要准备好开发环境。以下为基本的开发环境配置步骤：

安装JDK：确保您的机器安装了Java开发工具包（JDK），版本建议使用JDK 8及以上。
安装IDE：推荐使用IntelliJ IDEA或Eclipse，这些IDE提供了丰富强大的开发工具支持。
配置Maven：确保您的IDE中已经配置了Maven构建工具。Maven是一个项目管理和构建工具，可以方便地管理和构建Java项目。
数据库环境：安装并配置数据库环境，如MySQL、Oracle等。这里以MySQL为例。

在IDE中创建Maven项目并引入Mybatis依赖的具体步骤如下：

创建Maven项目：打开IDE，选择创建Maven项目，填写项目名称、组织ID等基本信息。注意选择创建一个基本的Java项目，无需添加web模块。
引入Mybatis依赖：在项目的pom.xml文件中，添加Mybatis的相关依赖，如下：

<dependencies>
    <!-- Mybatis核心依赖 -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
    </dependency>

    <!-- MySQL驱动依赖 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.23</version>
    </dependency>

    <!-- Java Util依赖 -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
    </dependency>
</dependencies>

Mybatis核心配置详解

mybatis-config.xml文件配置

Mybatis的核心配置文件是mybatis-config.xml，该文件中包含了数据库的连接信息、配置Mybatis的运行环境以及其他一些全局配置。

<configuration>
    <properties>
        <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/mydb"/>
        <property name="username" value="root"/>
        <property name="password" value="password"/>
    </properties>

    <settings>
        <!-- 设置Mybatis的日志实现 -->
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>

    <!-- 映射文件 -->
    <mappers>
        <mapper resource="com/example/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

数据库连接配置包括数据库驱动、连接URL、用户名和密码。这些信息一般配置在mybatis-config.xml文件的<properties>标签中。例如，上述代码片段中的<properties>标签就包含了数据库连接所需的属性。

Mybatis操作数据库

CRUD操作详解

Mybatis支持基本的CRUD操作，包括创建（Create）、读取（Read）、更新（Update）和删除（Delete）。

创建（Insert）操作：在UserMapper.xml中定义插入操作的SQL语句，并映射到对应的Java方法。

<mapper namespace="com.example.mapper.UserMapper">
    <insert id="insertUser" parameterType="com.example.model.User">
        INSERT INTO users (name, age) VALUES (#{name}, #{age})
    </insert>
</mapper>

Java代码中调用这个方法：

public class UserService {
    private SqlSessionFactory sqlSessionFactory;
    private SqlSession sqlSession;

    public UserService(SqlSessionFactory sqlSessionFactory) {
        this.sqlSessionFactory = sqlSessionFactory;
    }

    public void addUser(User user) {
        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper mapper = session.getMapper(UserMapper.class);
            mapper.insertUser(user);
            session.commit();
        }
    }
}

读取（Select）操作：定义查询操作的SQL语句，并映射到对应的Java方法。

<select id="selectUserById" resultType="com.example.model.User" parameterType="int">
    SELECT * FROM users WHERE id = #{id}
</select>

Java代码中调用这个方法：

public User getUserById(int id) {
    try (SqlSession session = sqlSessionFactory.openSession()) {
        UserMapper mapper = session.getMapper(UserMapper.class);
        return mapper.selectUserById(id);
    }
}

更新（Update）操作：定义更新操作的SQL语句，并映射到对应的Java方法。

<update id="updateUser" parameterType="com.example.model.User">
    UPDATE users SET name = #{name}, age = #{age} WHERE id = #{id}
</update>

Java代码中调用这个方法：

public void updateUser(User user) {
    try (SqlSession session = sqlSessionFactory.openSession()) {
        UserMapper mapper = session.getMapper(UserMapper.class);
        mapper.updateUser(user);
        session.commit();
    }
}

删除（Delete）操作：定义删除操作的SQL语句，并映射到对应的Java方法。

<delete id="deleteUserById" parameterType="int">
    DELETE FROM users WHERE id = #{id}
</delete>

Java代码中调用这个方法：

public void deleteUser(int id) {
    try (SqlSession session = sqlSessionFactory.openSession()) {
        UserMapper mapper = session.getMapper(UserMapper.class);
        mapper.deleteUserById(id);
        session.commit();
    }
}

完整用户案例

为了更好地理解这些操作的实际应用，这里提供一个完整的用户案例，包括创建用户、查询用户、更新用户和删除用户。

创建用户：

public class UserService {
    private SqlSessionFactory sqlSessionFactory;
    private SqlSession sqlSession;

    public UserService(SqlSessionFactory sqlSessionFactory) {
        this.sqlSessionFactory = sqlSessionFactory;
    }

    public void addUser(User user) {
        try (SqlSession session = sqlSessionFactory.openSession()) {
            UserMapper mapper = session.getMapper(UserMapper.class);
            mapper.insertUser(user);
            session.commit();
        }
    }
}

查询用户：

public User getUserById(int id) {
    try (SqlSession session = sqlSessionFactory.openSession()) {
        UserMapper mapper = session.getMapper(UserMapper.class);
        return mapper.selectUserById(id);
    }
}

更新用户：

public void updateUser(User user) {
    try (SqlSession session = sqlSessionFactory.openSession()) {
        UserMapper mapper = session.getMapper(UserMapper.class);
        mapper.updateUser(user);
        session.commit();
    }
}

删除用户：

public void deleteUser(int id) {
    try (SqlSession session = sqlSessionFactory.openSession()) {
        UserMapper mapper = session.getMapper(UserMapper.class);
        mapper.deleteUserById(id);
        session.commit();
    }
}

Mybatis与Spring整合

使用Spring管理Mybatis

将Mybatis与Spring整合，可以利用Spring的依赖注入功能将SqlSessionFactory注入到需要的类中，从而简化代码。

配置Spring的SqlSessionFactoryBean：在Spring的配置文件中配置SqlSessionFactoryBean，它会初始化SqlSessionFactory。

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
    <property name="configLocation" value="classpath:mybatis-config.xml"/>
</bean>

配置数据源：使用Spring的DataSource配置数据库连接信息。

<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
    <property name="driverClassName" value="com.mysql.cj.jdbc.Driver"/>
    <property name="url" value="jdbc:mysql://localhost:3306/mydb"/>
    <property name="username" value="root"/>
    <property name="password" value="password"/>
</bean>

配置Mapper接口：将Mapper接口注册为Spring的Bean。

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.example.mapper"/>
</bean>

完整Spring项目实例

为了更好地展示整合过程，这里提供一个完整的Spring项目实例，包括如何配置SqlSessionFactoryBean和Mapper接口。

在Spring配置文件中，除了上文提到的DataSource和SqlSessionFactoryBean配置，还可以配置事务管理器，以便更好地管理事务。

<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
    <property name="dataSource" ref="dataSource"/>
</bean>

Mybatis常见问题解决

常见错误解析

SqlSession无法获取：
```
SqlSession sqlSession = sqlSessionFactory.openSession();
```
如果获取SqlSession时遇到问题，确保SqlSessionFactory已经正确初始化，并且配置文件中的数据库连接信息正确无误。
Mapper接口方法未映射：

确保在UserMapper.xml中已经定义了对应的方法，并且方法名和返回类型与Mapper接口中的方法一致。

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUserById" resultType="com.example.model.User" parameterType="int">
        SELECT * FROM users WHERE id = #{id}
    </select>
</mapper>

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

结果映射问题：

如果查询结果与Java对象不匹配，检查resultType是否正确设置，并确保对象的属性名称与数据库表的列名一致。

性能优化技巧

启用二级缓存：在全局配置文件中启用二级缓存可以提高查询性能。

<cache/>

批量处理：对于大量数据的操作，可以使用批量插入、更新和删除，减少数据库交互次数。

public void batchProcess(List<User> users) {
    try (SqlSession session = sqlSessionFactory.openSession()) {
        UserMapper mapper = session.getMapper(UserMapper.class);
        for (User user : users) {
            mapper.insertUser(user);
        }
        session.commit();
    }
}

使用动态SQL：利用动态SQL可以根据不同的条件生成不同的SQL语句，提高查询的灵活性和性能。

<select id="selectUserByCondition" resultType="com.example.model.User">
    SELECT * FROM users
    <where>
        <if test="name != null">
            AND name = #{name}
        </if>
        <if test="age != null">
            AND age = #{age}
        </if>
    </where>
</select>

通过以上步骤，您可以快速搭建一个简单的Mybatis项目，并利用Mybatis的强大功能进行数据库操作。对于更复杂的场景，还可以进一步学习Mybatis的高级用法，如插件开发、分页处理等。