MyBatis 是一个优秀的持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
MyBatis 简介
MyBatis 遵循约定优于配置( Convention Over Configuration)的原则,这意味着你只需要在少数几个地方配置你的数据库连接和映射,然后你就可以使用 MyBatis 来操作数据库了。
MyBatis 的优势
- 简单易用:MyBatis 的配置和映射文件非常简单,易于学习和使用。
- 灵活的映射:MyBatis 支持复杂的映射,包括关联、嵌套查询等。
- 支持自定义 SQL:MyBatis 允许你编写自定义的 SQL 语句,以实现复杂的数据库操作。
- 插件支持:MyBatis 支持插件,如分页插件、日志插件等,可以扩展其功能。
快速入门
1. 环境搭建
首先,你需要安装 Java 开发环境(JDK)和 Maven 构建工具。
2. 创建 Maven 项目
在 Maven 中创建一个新的项目,并添加以下依赖:
<dependencies>
<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>
</dependencies>
3. 配置 MyBatis
在 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/your_database"/>
<property name="username" value="your_username"/>
<property name="password" value="your_password"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/example/mapper/UserMapper.xml"/>
</mappers>
</configuration>
4. 创建映射文件
在 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="selectById" resultType="com.example.entity.User">
SELECT * FROM user WHERE id = #{id}
</select>
</mapper>
5. 编写接口
在 com.example.mapper 包下创建 UserMapper 接口:
package com.example.mapper;
import com.example.entity.User;
public interface UserMapper {
User selectById(Integer id);
}
6. 测试
在 com.example.service 包下创建 UserService 类,使用 MyBatis 操作数据库:
package com.example.service;
import com.example.mapper.UserMapper;
import com.example.entity.User;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
public class UserService {
private final SqlSessionFactory sqlSessionFactory;
public UserService(SqlSessionFactory sqlSessionFactory) {
this.sqlSessionFactory = sqlSessionFactory;
}
public User getUserById(Integer id) {
try (SqlSession session = sqlSessionFactory.openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
return mapper.selectById(id);
}
}
}
在 com.example.Application 类中,创建 SqlSessionFactory:
package com.example;
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(
Resources.getResourceAsStream("mybatis-config.xml"));
UserService userService = new UserService(sqlSessionFactory);
User user = userService.getUserById(1);
System.out.println(user);
}
}
运行 Application 类,输出用户信息。
实战案例
以下是一个简单的用户信息查询案例:
package com.example.entity;
public class User {
private Integer id;
private String name;
private String email;
// 省略 getter 和 setter 方法
}
package com.example.mapper;
import com.example.entity.User;
public interface UserMapper {
User selectById(Integer id);
}
package com.example.service;
import com.example.mapper.UserMapper;
import com.example.entity.User;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
public class UserService {
private final SqlSessionFactory sqlSessionFactory;
public UserService(SqlSessionFactory sqlSessionFactory) {
this.sqlSessionFactory = sqlSessionFactory;
}
public User getUserById(Integer id) {
try (SqlSession session = sqlSessionFactory.openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
return mapper.selectById(id);
}
}
}
package com.example;
import com.example.service.UserService;
public class Application {
public static void main(String[] args) {
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(
Resources.getResourceAsStream("mybatis-config.xml"));
UserService userService = new UserService(sqlSessionFactory);
User user = userService.getUserById(1);
System.out.println(user);
}
}
运行 Application 类,输出用户信息。
总结
通过以上步骤,你已经成功入门了 MyBatis。MyBatis 是一个功能强大的持久层框架,可以帮助你轻松实现数据库操作。在实际项目中,你可以根据需求进行扩展和定制,以适应不同的场景。
