MyBatis-Plus增删改查的通用化封装过程
作者:工頁光軍
这段文章详细介绍了MyBatis-Plus的通用化封装方案,通过泛型和继承实现了Mapper、Service、Controller层的通用接口;业务模块仅需继承这些通用类即可实现增删改查功能;此方案极大提升了代码复用性和扩展性;适用于企业级开发实践
要实现 MyBatis-Plus 增删改查的通用化封装,核心思路是利用泛型 + 继承封装通用的 Mapper、Service、Controller 层,让业务模块直接继承这些通用类,无需重复编写增删改查代码。
以下是完整的实现方案(Spring Boot 环境):
一、基础准备:统一响应结果
先封装通用响应类,保证接口返回格式统一,减少重复编码:
package com.example.mpdemo.common;
import lombok.Data;
/**
* 通用响应结果类
* @param <T> 响应数据类型
*/
@Data
public class Result<T> {
// 响应码(200成功,500失败)
private Integer code;
// 响应消息
private String msg;
// 响应数据
private T data;
// 成功响应(无数据)
public static <T> Result<T> success() {
return new Result<>(200, "操作成功", null);
}
// 成功响应(有数据)
public static <T> Result<T> success(T data) {
return new Result<>(200, "操作成功", data);
}
// 失败响应
public static <T> Result<T> fail(String msg) {
return new Result<>(500, msg, null);
}
}
二、通用层封装
1. 通用 Mapper 层(BaseMapper 增强)
MyBatis-Plus 的 BaseMapper 已封装基础 CRUD,我们只需定义通用接口让业务 Mapper 继承:
package com.example.mpdemo.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.apache.ibatis.annotations.Mapper;
/**
* 通用 Mapper 接口
* @param <T> 实体类类型
*/
@Mapper
public interface BaseGenericMapper<T> extends BaseMapper<T> {
// 无需额外方法,继承 BaseMapper 的 17 个基础 CRUD 方法即可
}
2. 通用 Service 层
封装通用 Service 接口和实现类,复用 IService 的高级 CRUD 能力:
(1)通用 Service 接口
package com.example.mpdemo.service;
import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
import java.io.Serializable;
import java.util.List;
/**
* 通用 Service 接口
* @param <T> 实体类类型
*/
public interface BaseGenericService<T> extends IService<T> {
// 可扩展通用方法,比如自定义分页、批量操作等
List<T> list(Wrapper<T> queryWrapper); // 条件查询列表
IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper); // 条件分页查询
T getById(Serializable id); // 根据 ID 查询
boolean saveEntity(T entity); // 新增
boolean updateEntity(T entity); // 修改
boolean removeById(Serializable id); // 根据 ID 删除
}
(2)通用 Service 实现类
package com.example.mpdemo.service.impl;
import com.baomidou.mybatisplus.core.conditions.Wrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.mpdemo.mapper.BaseGenericMapper;
import com.example.mpdemo.service.BaseGenericService;
import java.io.Serializable;
import java.util.List;
/**
* 通用 Service 实现类
* @param <M> Mapper 类型
* @param <T> 实体类类型
*/
public class BaseGenericServiceImpl<M extends BaseGenericMapper<T>, T>
extends ServiceImpl<M, T> implements BaseGenericService<T> {
@Override
public List<T> list(Wrapper<T> queryWrapper) {
return baseMapper.selectList(queryWrapper);
}
@Override
public IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper) {
return baseMapper.selectPage(page, queryWrapper);
}
@Override
public T getById(Serializable id) {
return baseMapper.selectById(id);
}
@Override
public boolean saveEntity(T entity) {
return save(entity); // 复用 IService 的 save 方法
}
@Override
public boolean updateEntity(T entity) {
return updateById(entity); // 复用 IService 的 updateById 方法
}
@Override
public boolean removeById(Serializable id) {
return baseMapper.deleteById(id);
}
}
3. 通用 Controller 层(核心)
封装通用的增删改查接口,业务 Controller 只需继承此类并指定实体和主键类型,无需重复编写接口:
package com.example.mpdemo.controller;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.mpdemo.common.Result;
import com.example.mpdemo.service.BaseGenericService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.io.Serializable;
import java.util.List;
/**
* 通用 CRUD Controller
* @param <T> 实体类类型
* @param <K> 主键类型(如 Long、String)
*/
public class BaseGenericController<T, K extends Serializable> {
// 注入通用 Service(由子类指定具体实现)
@Autowired
protected BaseGenericService<T> baseService;
/**
* 1. 新增
*/
@PostMapping
public Result<T> add(@RequestBody T entity) {
boolean success = baseService.saveEntity(entity);
return success ? Result.success(entity) : Result.fail("新增失败");
}
/**
* 2. 根据 ID 删除
*/
@DeleteMapping("/{id}")
public Result<Void> delete(@PathVariable K id) {
boolean success = baseService.removeById(id);
return success ? Result.success() : Result.fail("删除失败");
}
/**
* 3. 修改
*/
@PutMapping
public Result<T> update(@RequestBody T entity) {
boolean success = baseService.updateEntity(entity);
return success ? Result.success(entity) : Result.fail("修改失败");
}
/**
* 4. 根据 ID 查询
*/
@GetMapping("/{id}")
public Result<T> getById(@PathVariable K id) {
T entity = baseService.getById(id);
return entity != null ? Result.success(entity) : Result.fail("数据不存在");
}
/**
* 5. 查询所有(无条件)
*/
@GetMapping("/list")
public Result<List<T>> list() {
List<T> list = baseService.list(Wrappers.emptyWrapper());
return Result.success(list);
}
/**
* 6. 分页查询(默认第1页,每页10条,可传参数自定义)
*/
@GetMapping("/page")
public Result<IPage<T>> page(
@RequestParam(defaultValue = "1") Long current,
@RequestParam(defaultValue = "10") Long size) {
IPage<T> page = baseService.page(new Page<>(current, size), Wrappers.emptyWrapper());
return Result.success(page);
}
}
三、业务模块使用示例(以 User 为例)
只需编写少量代码,继承通用类即可拥有完整的增删改查接口:
1. 实体类(User)
沿用之前的 User 实体(无需修改):
package com.example.mpdemo.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import java.time.LocalDateTime;
@Data
@TableName("user")
public class User {
@TableId(type = IdType.ASSIGN_ID)
private Long id;
private String username;
private Integer age;
private String email;
private LocalDateTime createTime;
}
2. 业务 Mapper(UserMapper)
继承通用 Mapper:
package com.example.mpdemo.mapper;
import com.example.mpdemo.entity.User;
import org.springframework.stereotype.Repository;
@Repository
public interface UserMapper extends BaseGenericMapper<User> {
// 无需编写任何代码,自动拥有所有基础 CRUD 能力
}
3. 业务 Service
(1)Service 接口
package com.example.mpdemo.service;
import com.example.mpdemo.entity.User;
public interface UserService extends BaseGenericService<User> {
// 可扩展自定义业务方法
}
(2)Service 实现类
package com.example.mpdemo.service.impl;
import com.example.mpdemo.entity.User;
import com.example.mpdemo.mapper.UserMapper;
import com.example.mpdemo.service.UserService;
import org.springframework.stereotype.Service;
@Service
public class UserServiceImpl extends BaseGenericServiceImpl<UserMapper, User> implements UserService {
// 无需编写任何代码,自动继承通用 Service 的所有方法
}
4. 业务 Controller
继承通用 Controller,指定实体(User)和主键类型(Long):
package com.example.mpdemo.controller;
import com.example.mpdemo.entity.User;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* 用户控制器,继承通用 Controller 后自动拥有所有 CRUD 接口
*/
@RestController
@RequestMapping("/user")
public class UserController extends BaseGenericController<User, Long> {
// 无需编写任何接口代码,自动拥有:
// POST /user → 新增
// DELETE /user/{id} → 删除
// PUT /user → 修改
// GET /user/{id} → 根据ID查询
// GET /user/list → 查询所有
// GET /user/page → 分页查询
}
四、接口测试(Postman/Curl)
| 接口 | 请求方式 | 说明 | 示例请求参数 |
|---|---|---|---|
| /user | POST | 新增用户 | {"username":"张三","age":20,"email":"zhangsan@example.com","createTime":"2026-03-13 10:00:00"} |
| /user/1 | DELETE | 删除用户 | 路径参数 id=1 |
| /user | PUT | 修改用户 | {"id":1,"username":"张三","age":21} |
| /user/1 | GET | 查询单个用户 | 路径参数 id=1 |
| /user/list | GET | 查询所有用户 | 无参数 |
| /user/page?current=1&size=2 | GET | 分页查询 | 参数 current=1(页码)、size=2(每页条数) |
五、扩展说明
- 自定义条件查询:若需添加条件查询,可在通用 Controller 中扩展,或在业务 Controller 中新增方法:
// UserController 中新增条件查询接口
@GetMapping("/listByAge")
public Result<List<User>> listByAge(@RequestParam Integer age) {
LambdaQueryWrapper<User> wrapper = Wrappers.lambdaQuery(User.class)
.gt(User::getAge, age);
List<User> list = baseService.list(wrapper);
return Result.success(list);
}
- 异常处理:可添加全局异常处理器(
@RestControllerAdvice),统一捕获增删改查中的异常(如主键不存在、参数非法等); - 权限控制:若需接口权限,可在通用 Controller 或业务 Controller 中添加
@PreAuthorize等注解; - 参数校验:可在实体类中添加
@NotNull、@NotBlank等校验注解,配合@Valid实现参数校验。
总结
- 核心思路:通过泛型 + 继承封装通用的 Mapper、Service、Controller,业务模块只需继承通用类,无需重复编写增删改查代码;
- 复用性:通用层封装了 6 个核心 CRUD 接口(新增、删除、修改、单查、列表、分页),覆盖 90% 以上的单表业务场景;
- 扩展性:通用类预留了扩展接口,业务模块可按需新增自定义方法,不破坏通用逻辑。
这种方式极大减少了重复编码,符合“开闭原则”,是企业开发中常用的 MyBatis-Plus 最佳实践。
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。
