引言
MyBatis 是一个优秀的持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
MyBatis 简介
MyBatis 核心特性
- 映射接口方法直接调用 SQL 语句:MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的工作。
- 灵活的映射文件:MyBatis 使用 XML 文件来配置 SQL 语句,使得 SQL 语句的编写和配置更加灵活。
- 支持自定义 SQL、存储过程以及高级映射:MyBatis 支持自定义 SQL 语句,存储过程,以及复杂的映射关系。
- 支持自定义类型处理器:MyBatis 支持自定义类型处理器,以处理特殊的数据类型。
MyBatis 的工作原理
MyBatis 主要通过以下几个步骤来执行数据库操作:
- 读取配置文件:MyBatis 首先读取配置文件(XML 或注解),获取 SQL 语句和相关配置信息。
- 构建 SQL 语句:根据配置信息,MyBatis 构建完整的 SQL 语句。
- 执行 SQL 语句:MyBatis 使用 JDBC 执行 SQL 语句。
- 处理结果集:MyBatis 将结果集转换为 Java 对象。
MyBatis 快速入门
环境搭建
- 添加依赖:在项目的
pom.xml文件中添加 MyBatis 的依赖。
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.6</version>
</dependency>
- 配置 MyBatis:在项目的
resources目录下创建mybatis-config.xml文件,配置数据源、事务管理器等。
<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/mydb"/>
<property name="username" value="root"/>
<property name="password" value=""/>
</dataSource>
</environment>
</environments>
</configuration>
- 编写 Mapper 接口:定义一个 Mapper 接口,其中包含数据库操作的 SQL 语句。
public interface UserMapper {
List<User> selectAll();
}
- 编写 Mapper XML:在
resources目录下创建对应的 Mapper XML 文件,配置 SQL 语句。
<mapper namespace="com.example.mapper.UserMapper">
<select id="selectAll" resultType="com.example.entity.User">
SELECT * FROM user
</select>
</mapper>
- 使用 MyBatis:在代码中,通过 MyBatis 的
SqlSessionFactory创建SqlSession,然后使用SqlSession执行数据库操作。
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsInputStream("mybatis-config.xml"));
try (SqlSession session = sqlSessionFactory.openSession()) {
UserMapper mapper = session.getMapper(UserMapper.class);
List<User> users = mapper.selectAll();
for (User user : users) {
System.out.println(user.getName());
}
}
MyBatis 项目实战
实战项目概述
以下是一个使用 MyBatis 进行数据库操作的简单项目示例:
- 项目结构:包含实体类、Mapper 接口、Mapper XML、Service 层、Controller 层等。
- 功能模块:用户管理、角色管理、权限管理等。
实战项目步骤
- 创建数据库:创建一个数据库,并创建相应的表。
- 创建实体类:根据数据库表结构,创建对应的实体类。
- 创建 Mapper 接口:定义 Mapper 接口,包含数据库操作的 SQL 语句。
- 创建 Mapper XML:配置 SQL 语句和相关配置信息。
- 创建 Service 层:实现业务逻辑。
- 创建 Controller 层:处理 HTTP 请求。
实战项目示例
以下是一个简单的用户管理模块示例:
- 实体类:
public class User {
private Integer id;
private String name;
private String password;
// 省略 getter 和 setter 方法
}
- Mapper 接口:
public interface UserMapper {
List<User> selectAll();
User selectById(Integer id);
int insert(User user);
int update(User user);
int delete(Integer id);
}
- Mapper XML:
<mapper namespace="com.example.mapper.UserMapper">
<select id="selectAll" resultType="com.example.entity.User">
SELECT * FROM user
</select>
<select id="selectById" resultType="com.example.entity.User">
SELECT * FROM user WHERE id = #{id}
</select>
<insert id="insert">
INSERT INTO user (name, password) VALUES (#{name}, #{password})
</insert>
<update id="update">
UPDATE user SET name = #{name}, password = #{password} WHERE id = #{id}
</update>
<delete id="delete">
DELETE FROM user WHERE id = #{id}
</delete>
</mapper>
- Service 层:
public class UserService {
private final UserMapper userMapper;
public UserService(UserMapper userMapper) {
this.userMapper = userMapper;
}
public List<User> getAllUsers() {
return userMapper.selectAll();
}
public User getUserById(Integer id) {
return userMapper.selectById(id);
}
public int addUser(User user) {
return userMapper.insert(user);
}
public int updateUser(User user) {
return userMapper.update(user);
}
public int deleteUser(Integer id) {
return userMapper.delete(id);
}
}
- Controller 层:
@RestController
@RequestMapping("/users")
public class UserController {
private final UserService userService;
public UserController(UserService userService) {
this.userService = userService;
}
@GetMapping
public List<User> getAllUsers() {
return userService.getAllUsers();
}
@GetMapping("/{id}")
public User getUserById(@PathVariable Integer id) {
return userService.getUserById(id);
}
@PostMapping
public int addUser(@RequestBody User user) {
return userService.addUser(user);
}
@PutMapping("/{id}")
public int updateUser(@PathVariable Integer id, @RequestBody User user) {
user.setId(id);
return userService.updateUser(user);
}
@DeleteMapping("/{id}")
public int deleteUser(@PathVariable Integer id) {
return userService.deleteUser(id);
}
}
总结
MyBatis 是一个功能强大、灵活的持久层框架,它可以帮助开发者高效地完成数据库操作。通过本文的介绍,相信你已经对 MyBatis 有了一定的了解。在实际项目中,你可以根据需求灵活运用 MyBatis,提高开发效率。
