MyBatis 是一款优秀的持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
MyBatis 简介
MyBatis 最初是由原 iBATIS 框架的创始人提出,在 2010 年正式发布。它旨在简化 Java 开发中对数据库的操作,减少编码量,提高开发效率。MyBatis 的核心是 SQL 映射文件,它定义了 SQL 语句与 Java 对象之间的映射关系。
入门准备
环境搭建
- Java 开发环境:确保你的电脑上安装了 Java Development Kit (JDK),并配置好环境变量。
- IDE:推荐使用 IntelliJ IDEA 或 Eclipse 作为开发工具。
- Maven:用于构建和管理项目依赖,确保你的项目中已经添加了 MyBatis 的依赖。
基本概念
- Mapper:MyBatis 的核心,用于封装 SQL 语句,返回结果集等。
- SQL 映射文件:定义 SQL 语句和结果集的映射关系。
- POJO:Plain Old Java Objects,用于映射数据库表中的记录。
- Session:MyBatis 提供的数据库会话,用于执行 SQL 语句。
高效入门
步骤一:创建项目
- 使用 Maven 创建一个 Java 项目。
- 添加 MyBatis 依赖到项目的
pom.xml文件中。
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.6</version>
</dependency>
步骤二:配置 MyBatis
- 在项目目录下创建
src/main/resources文件夹。 - 在
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.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/testdb"/>
<property name="username" value="root"/>
<property name="password" value=""/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/example/mapper/UserMapper.xml"/>
</mappers>
</configuration>
步骤三:编写 Mapper 接口和 XML 映射文件
- 在
src/main/java文件夹下创建一个com.example.mapper包。 - 在
com.example.mapper包下创建UserMapper.java接口。
package com.example.mapper;
import com.example.entity.User;
public interface UserMapper {
User getUserById(int id);
}
- 在
src/main/resources文件夹下创建com/example/mapper/UserMapper.xml文件,编写 SQL 映射语句。
<?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.entity.User">
SELECT * FROM users WHERE id = #{id}
</select>
</mapper>
步骤四:使用 MyBatis
- 在
src/main/java文件夹下创建一个com.example.service包。 - 在
com.example.service包下创建UserService.java类。
package com.example.service;
import com.example.entity.User;
import com.example.mapper.UserMapper;
public class UserService {
private UserMapper userMapper;
public UserService(UserMapper userMapper) {
this.userMapper = userMapper;
}
public User getUserById(int id) {
return userMapper.getUserById(id);
}
}
- 在
src/main/java文件夹下创建一个com.example.Application.java类。
package com.example;
import com.example.mapper.UserMapper;
import com.example.service.UserService;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
public class Application {
public static void main(String[] args) {
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build();
SqlSession sqlSession = sqlSessionFactory.openSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
UserService userService = new UserService(userMapper);
User user = userService.getUserById(1);
System.out.println(user);
sqlSession.close();
}
}
运行 Application 类,输出结果如下:
User{id=1, username='John Doe', email='john@example.com', age=30}
实战技巧
1. 使用注解代替 XML
MyBatis 支持使用注解来代替 XML 映射文件,使得代码更加简洁。
package com.example.mapper;
import com.example.entity.User;
import org.apache.ibatis.annotations.Select;
public interface UserMapper {
@Select("SELECT * FROM users WHERE id = #{id}")
User getUserById(int id);
}
2. 使用动态 SQL
MyBatis 提供了动态 SQL 功能,可以方便地编写复杂的 SQL 语句。
package com.example.mapper;
import com.example.entity.User;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.SelectProvider;
import org.apache.ibatis.jdbc.SQL;
public interface UserMapper {
@SelectProvider(type = SqlProvider.class, method = "getUserByCondition")
User getUserByCondition(@Param("username") String username, @Param("email") String email);
class SqlProvider {
public String getUserByCondition(@Param("username") String username, @Param("email") String email) {
return new SQL() {{
SELECT("*");
FROM("users");
if (username != null) {
WHERE("username = #{username}");
}
if (email != null) {
WHERE("email = #{email}");
}
}}.toString();
}
}
}
3. 使用缓存
MyBatis 支持使用一级缓存和二级缓存来提高查询效率。
package com.example.mapper;
import com.example.entity.User;
import org.apache.ibatis.annotations.CacheNamespace;
import org.apache.ibatis.annotations.CacheNamespaceRef;
import org.apache.ibatis.annotations.Select;
@CacheNamespaceRef(User.class)
public interface UserMapper {
@Select("SELECT * FROM users WHERE id = #{id}")
User getUserById(int id);
}
4. 使用插件
MyBatis 插件可以扩展 MyBatis 的功能,例如,可以自定义日志、分页等。
package com.example.plugin;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.plugin.*;
import java.sql.Connection;
import java.util.Properties;
@Intercepts({
@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class})
})
public class PaginationInterceptor implements Interceptor {
@Override
public Object intercept(Invocation invocation) throws Throwable {
// 自定义分页逻辑
return invocation.proceed();
}
@Override
public Object plugin(Object target) {
return Plugin.wrap(target, this);
}
@Override
public void setProperties(Properties properties) {
// 设置插件配置
}
}
在 mybatis-config.xml 文件中添加插件配置:
<plugins>
<plugin interceptor="com.example.plugin.PaginationInterceptor"/>
</plugins>
总结
MyBatis 是一款功能强大的持久层框架,通过使用 MyBatis,你可以更加高效地开发 Java 应用程序。在本篇文章中,我们介绍了 MyBatis 的基本概念、入门步骤、实战技巧等内容。希望这些内容能够帮助你更好地学习和使用 MyBatis。
