MyBatis 是一个优秀的持久层框架,它消除了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的过程。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。
快速上手
1. 环境搭建
首先,确保你的开发环境已经安装了Java和Maven。Maven 是一个项目管理工具,用于构建、依赖管理和文档。
在你的 pom.xml 文件中添加 MyBatis 的依赖:
<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>
2. 配置文件
创建一个 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>
3. 创建映射文件
创建一个 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 users WHERE id = #{id}
</select>
</mapper>
4. 接口定义
创建一个 UserMapper 接口。
package com.example.mapper;
import com.example.entity.User;
import org.apache.ibatis.annotations.Select;
public interface UserMapper {
User selectById(Integer id);
}
5. 使用 MyBatis
在你的业务逻辑层,注入 UserMapper 并使用它。
package com.example.service;
import com.example.entity.User;
import com.example.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class UserService {
@Autowired
private UserMapper userMapper;
public User getUserById(Integer id) {
return userMapper.selectById(id);
}
}
实战案例解析
假设我们需要实现一个简单的用户管理系统,包含用户注册、登录和查询功能。
1. 用户注册
首先,我们需要一个注册接口,它接受用户名和密码,并将它们存储到数据库中。
package com.example.controller;
import com.example.entity.User;
import com.example.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class UserController {
@Autowired
private UserMapper userMapper;
@PostMapping("/register")
public String register(@RequestBody User user) {
userMapper.insert(user);
return "注册成功";
}
}
2. 用户登录
登录接口接受用户名和密码,验证它们是否匹配数据库中的记录。
@PostMapping("/login")
public String login(@RequestBody User user) {
User dbUser = userMapper.selectByUsernameAndPassword(user.getUsername(), user.getPassword());
if (dbUser != null) {
return "登录成功";
} else {
return "用户名或密码错误";
}
}
3. 用户查询
查询接口允许用户通过 ID 查询自己的信息。
@GetMapping("/user/{id}")
public User getUserById(@PathVariable Integer id) {
return userMapper.selectById(id);
}
总结
通过以上步骤,你已经成功地使用 MyBatis 搭建了一个简单的用户管理系统。MyBatis 的强大之处在于它能够让你以最少的配置和代码,实现复杂的数据库操作。在实际项目中,你可以根据需求调整和扩展 MyBatis 的功能。
