在 Java 后端开发中,数据持久层始终是关键模块。如何既保证 SQL 调优的灵活性,又能提高开发效率,是众多开发者关注的焦点。本文将从基础介绍开始,全面解析 Mybatis 与 Mybatis-Plus 的各个方面,包括工作原理、常见使用场景、详细实例、进阶特性、插件支持以及最佳实践,帮助你在项目中做出更明智的选择。让我们一起开始这段干货满满的技术之旅吧!
Mybatis 是一款轻量级的 ORM 框架,它主要通过 XML 或注解方式将 SQL 语句与 Java 对象进行映射,具备以下特点:
高度灵活
开发者可以自定义 SQL,实现复杂查询及数据库操作。
精细控制
通过 XML 映射文件管理 SQL 与实体类之间的关系,充分掌控底层细节。
低侵入性
只关注数据库交互部分,业务逻辑完全由开发者掌控。
工作原理
映射配置:在 XML 文件或注解中定义 SQL 语句与参数映射。
SqlSession 管理:通过 SqlSession
获取 Mapper 接口,完成数据库 CRUD 操作。
动态 SQL:支持动态 SQL 构建,便于处理复杂查询条件。
示例:Mybatis XML 配置
<mapper namespace="com.example.mapper.UserMapper">
<select id="getUserById" resultType="com.example.entity.User">
SELECT id, name, age FROM user WHERE id = #{id}
select>
mapper>
虽然这种方式灵活、透明,但当项目中涉及大量 SQL 时,XML 文件的编写和维护会变得相对繁琐。
Mybatis-Plus 是在 Mybatis 基础上的增强工具包,旨在极大地简化开发流程,提高生产力。其主要特点包括:
自动 CRUD
内置 BaseMapper 接口,封装常用增删改查操作,省去重复编写 SQL。
代码生成器
通过代码生成快速构建实体类、Mapper 接口和 XML 映射文件。
条件构造器
提供链式调用方式构建查询条件(包括 Lambda 表达式方式),书写清晰直观。
内置插件
包括分页插件、性能分析插件、乐观锁、逻辑删除等常用功能。
自动填充字段
支持创建时间、修改时间等字段的自动填充,简化开发流程。
工作原理
自动封装:根据实体类和注解生成常用 SQL 语句,无需重复编写。
插件机制:通过插件扩展查询、更新、分页等功能,适应不同场景需求。
灵活扩展:支持自定义 SQL 和扩展方法,既满足快速开发又不失定制化能力。
示例:Mybatis-Plus 实体类与 Mapper 接口
// User.java
@Data
@TableName("user")
public class User {
private Long id;
private String name;
private Integer age;
}
// UserMapper.java
public interface UserMapper extends BaseMapper<User> {
// 自定义方法示例:通过名字模糊查询用户
List<User> selectByName(@Param("name") String name);
}
在 Spring Boot 项目中,只需简单配置数据源和包扫描即可快速启动应用。
Mybatis
配置方式:依赖 XML 或注解完成映射,代码与 SQL 分离,灵活但冗长。
维护难度:每个实体或查询都需要单独配置,项目规模扩大时维护成本较高。
Mybatis-Plus
约定优于配置:自动生成常用 SQL,极大减少了 XML 文件数量。
自动化支持:内置自动 CRUD、分页和插件机制,使得配置更简洁、开发更高效。
Mybatis
功能聚焦于 SQL 映射与执行,灵活定制性强,适合对 SQL 有极高要求的场景。
支持动态 SQL,复杂业务逻辑处理能力突出。
Mybatis-Plus
自动 CRUD:BaseMapper 内置方法(如 selectById
、insert
等)极大降低代码重复率。
条件构造器:提供 QueryWrapper
和 LambdaQueryWrapper
,使用链式调用构建查询条件更加直观。
插件体系:分页插件、乐观锁插件、性能分析插件等一应俱全,支持日志打印 SQL 执行时间,便于性能调优。
示例:使用 Lambda 查询构造器
// 查询名字中包含 "张" 的用户,年龄大于 20
List<User> users = userMapper.selectList(
new LambdaQueryWrapper<User>()
.like(User::getName, "张")
.gt(User::getAge, 20)
);
Mybatis-Plus 自动填充
支持在插入或更新数据时自动填充常用字段(如 createTime
、updateTime
)。
通过自定义 MetaObjectHandler 实现字段自动更新,降低出错概率。
示例:自动填充配置
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
this.strictInsertFill(metaObject, "createTime", Timestamp.class, new Timestamp(System.currentTimeMillis()));
this.strictInsertFill(metaObject, "updateTime", Timestamp.class, new Timestamp(System.currentTimeMillis()));
}
@Override
public void updateFill(MetaObject metaObject) {
this.strictUpdateFill(metaObject, "updateTime", Timestamp.class, new Timestamp(System.currentTimeMillis()));
// 强行更新updateTime
// this.setFieldValByName("updateTime", new Timestamp(System.currentTimeMillis()), metaObject);
}
}
逻辑删除
Mybatis-Plus 支持通过配置实现逻辑删除,数据不会真正从数据库删除,只是状态标记为已删除,更便于数据恢复和审计。
只需在实体类上使用 @TableLogic
注解即可。
示例:逻辑删除字段配置
@Data
@TableName("user")
public class User {
private Long id;
private String name;
private Integer age;
@TableLogic
private Integer deleted;
}
性能分析插件
Mybatis-Plus 内置性能分析插件可帮助开发者在开发环境下检测 SQL 执行效率,提前发现慢查询问题。
插件能够打印 SQL 语句及其执行时间,便于调优。
SQL 注入防护
下面将通过两个案例,分别展示使用 Mybatis 与 Mybatis-Plus 实现用户管理系统的基本功能和进阶特性。
环境配置与依赖
依赖引入:在 Maven 中添加 Mybatis、Spring Boot、数据库驱动等依赖。
配置文件:在 application.yml 中配置数据源和 Mybatis 映射文件路径。
spring:
datasource:
url: jdbc:mysql://localhost:3306/mydb?useUnicode=true&characterEncoding=utf8
username: root
password: 123456
mybatis:
mapper-locations: classpath*:mapper/*.xml
Mapper XML 文件
<mapper namespace="com.example.mapper.UserMapper">
<select id="getUserById" resultType="com.example.entity.User">
SELECT id, name, age FROM user WHERE id = #{id}
select>
<insert id="insertUser" parameterType="com.example.entity.User">
INSERT INTO user(name, age) VALUES(#{name}, #{age})
insert>
<update id="updateUser" parameterType="com.example.entity.User">
UPDATE user SET name = #{name}, age = #{age} WHERE id = #{id}
update>
<delete id="deleteUser" parameterType="Long">
DELETE FROM user WHERE id = #{id}
delete>
mapper>
Service 与 Controller 层代码
@Service
public class UserService {
@Autowired
private UserMapper userMapper;
public User getUserById(Long id) {
return userMapper.getUserById(id);
}
public void createUser(User user) {
userMapper.insertUser(user);
}
public void updateUser(User user) {
userMapper.updateUser(user);
}
public void deleteUser(Long id) {
userMapper.deleteUser(id);
}
}
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/{id}")
public User getUser(@PathVariable Long id) {
return userService.getUserById(id);
}
@PostMapping("/")
public String createUser(@RequestBody User user) {
userService.createUser(user);
return "创建成功!";
}
}
该案例展示了 Mybatis 灵活的映射机制,但随着业务复杂度增加,XML 文件和手动配置也会逐步增多。
环境配置与依赖
依赖引入:在 Maven 中添加 Mybatis-Plus Starter 及 Spring Boot 依赖。
配置文件:基本与 Mybatis 类似,但无需编写大量 XML 文件。
spring:
datasource:
url: jdbc:mysql://localhost:3306/mydb?useUnicode=true&characterEncoding=utf8
username: root
password: 123456
mybatis-plus:
mapper-locations: classpath*:mapper/*.xml
实体类、Mapper 与自动填充
// User.java
@Data
@TableName("user")
public class User {
private Long id;
private String name;
private Integer age;
@TableLogic
private Integer deleted;
@TableField(fill = FieldFill.INSERT)
private LocalDateTime createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private LocalDateTime updateTime;
}
// MyMetaObjectHandler.java
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
this.strictInsertFill(metaObject, "createTime", Timestamp.class, new Timestamp(System.currentTimeMillis()));
this.strictInsertFill(metaObject, "updateTime", Timestamp.class, new Timestamp(System.currentTimeMillis()));
}
@Override
public void updateFill(MetaObject metaObject) {
this.strictUpdateFill(metaObject, "updateTime", Timestamp.class, new Timestamp(System.currentTimeMillis()));
// 强行更新updateTime
// this.setFieldValByName("updateTime", new Timestamp(System.currentTimeMillis()), metaObject);
}
Service 层与高级查询示例
@Service
public class UserService {
@Autowired
private UserMapper userMapper;
public User getUserById(Long id) {
return userMapper.selectById(id);
}
public void createUser(User user) {
userMapper.insert(user);
}
public void updateUser(User user) {
userMapper.updateById(user);
}
public void deleteUser(Long id) {
userMapper.deleteById(id);
}
// 进阶示例:使用 LambdaQueryWrapper 进行条件查询
public List<User> getUsersByNameAndAge(String name, int age) {
return userMapper.selectList(
new LambdaQueryWrapper<User>()
.like(User::getName, name)
.ge(User::getAge, age)
);
}
}
Controller 层代码
@RestController
@RequestMapping("/user")
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/{id}")
public User getUser(@PathVariable Long id) {
return userService.getUserById(id);
}
@PostMapping("/")
public String createUser(@RequestBody User user) {
userService.createUser(user);
return "创建成功!";
}
@GetMapping("/search")
public List<User> searchUsers(@RequestParam String name, @RequestParam int age) {
return userService.getUsersByNameAndAge(name, age);
}
}
Mybatis-Plus 的优势在于减少重复代码、支持自动填充、逻辑删除以及内置的高级查询功能,既满足简单 CRUD,又能应对复杂查询场景。
项目规模与复杂度:
对于简单或中小型项目,Mybatis-Plus 以其简洁高效的开发体验无疑更适合。
大型或对 SQL 细节要求极高的系统,则可考虑 Mybatis,或结合使用二者,发挥各自优势。
团队技术水平:
初学者更容易上手 Mybatis-Plus;
资深开发者可根据实际需求灵活选择并扩展自定义功能。
文档与社区:
阅读 Mybatis 和 Mybatis-Plus 的官方文档,关注最新插件和最佳实践;
利用开源社区、博客(如 CSDN、掘金)中的经验分享,获取实际问题的解决方案。
性能调优:
利用 Mybatis-Plus 的性能分析插件及时发现慢查询;
在 Mybatis 中,合理使用动态 SQL 和缓存机制,优化数据库访问效率。
安全性:
注意 SQL 注入问题,优先使用条件构造器和参数化查询;
对于业务敏感数据,配置合理的事务管理和日志审计。
通过本文的详细解析与丰富实例,了解到:
Mybatis 以其极高的灵活性和定制能力适合复杂业务场景,但配置与维护成本较高。
Mybatis-Plus 则在 Mybatis 基础上进行了功能扩展和自动化封装,极大提高了开发效率,适合快速开发中小型项目,同时也支持高级查询、自动填充和逻辑删除等特性。
未来,随着业务场景的不断丰富和技术的持续演进,选择合适的持久层框架将更注重团队开发效率和系统可维护性。
无论是坚持 Mybatis 的精细调优,还是选择 Mybatis-Plus 的自动化便利,深入理解底层原理和不断优化实践都是取得成功的关键!