展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > MyBatis-Plus增删改查的通用化封装过程

MyBatis-Plus增删改查的通用化封装过程

如果想给 MyBatis-Plus 的增删改查做一套通用的封装,思路其实很直接:利用泛型加继承,把 Mapper、Service、Controller 三层的通用逻辑一次性写好,后续的业务模块直接继承这些通用类,再也不用一遍遍地写那些雷同的 CRUD 代码了。 下面给出完整的实现方案,环境基于 Sp

本文目录

    如果想给 MyBatis-Plus 的增删改查做一套通用的封装,思路其实很直接:利用泛型加继承,把 Mapper、Service、Controller 三层的通用逻辑一次性写好,后续的业务模块直接继承这些通用类,再也不用一遍遍地写那些雷同的 CRUD 代码了。

    MyBatis-Plus增删改查的通用化封装过程

    下面给出完整的实现方案,环境基于 Spring Boot,上手即用。

    一、基础准备:统一响应结果

    先把通用响应类准备好,保证所有接口返回的格式一致,后边写 CRUD 时能省不少事。

    package com.example.mpdemo.common;
    
    import lombok.Data;
    
    /**
     * 通用响应结果类
     * @param  响应数据类型
     */
    @Data
    public class Result {
        // 响应码(200成功,500失败)
        private Integer code;
        // 响应消息
        private String msg;
        // 响应数据
        private T data;
    
        // 成功响应(无数据)
        public static  Result success() {
            return new Result<>(200, "操作成功", null);
        }
    
        // 成功响应(有数据)
        public static  Result success(T data) {
            return new Result<>(200, "操作成功", data);
        }
    
        // 失败响应
        public static  Result 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  实体类类型
     */
    @Mapper
    public interface BaseGenericMapper extends BaseMapper {
        // 无需额外方法,继承 BaseMapper 的 17 个基础 CRUD 方法即可
    }
    

    2. 通用 Service 层

    Service 层也走同样的路子——先定义通用接口,再写一个通用的实现类,把 IService 的高级能力复用起来。

    (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 ja va.io.Serializable;
    import ja va.util.List;
    
    /**
     * 通用 Service 接口
     * @param  实体类类型
     */
    public interface BaseGenericService extends IService {
        // 可扩展通用方法,比如自定义分页、批量操作等
        List list(Wrapper queryWrapper);  // 条件查询列表
        IPage page(IPage page, Wrapper queryWrapper);  // 条件分页查询
        T getById(Serializable id);  // 根据 ID 查询
        boolean sa veEntity(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 ja va.io.Serializable;
    import ja va.util.List;
    
    /**
     * 通用 Service 实现类
     * @param  Mapper 类型
     * @param  实体类类型
     */
    public class BaseGenericServiceImpl, T> 
            extends ServiceImpl implements BaseGenericService {
    
        @Override
        public List list(Wrapper queryWrapper) {
            return baseMapper.selectList(queryWrapper);
        }
    
        @Override
        public IPage page(IPage page, Wrapper queryWrapper) {
            return baseMapper.selectPage(page, queryWrapper);
        }
    
        @Override
        public T getById(Serializable id) {
            return baseMapper.selectById(id);
        }
    
        @Override
        public boolean sa veEntity(T entity) {
            return sa ve(entity);  // 复用 IService 的 sa ve 方法
        }
    
        @Override
        public boolean updateEntity(T entity) {
            return updateById(entity);  // 复用 IService 的 updateById 方法
        }
    
        @Override
        public boolean removeById(Serializable id) {
            return baseMapper.deleteById(id);
        }
    }
    

    3. 通用 Controller 层(核心)

    这一层是重头戏——封装好了通用的增删改查接口,业务 Controller 直接继承,连 HTTP 映射都不用自己写。

    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 ja va.io.Serializable;
    import ja va.util.List;
    
    /**
     * 通用 CRUD Controller
     * @param  实体类类型
     * @param  主键类型(如 Long、String)
     */
    public class BaseGenericController {
    
        // 注入通用 Service(由子类指定具体实现)
        @Autowired
        protected BaseGenericService baseService;
    
        /**
         * 1. 新增
         */
        @PostMapping
        public Result add(@RequestBody T entity) {
            boolean success = baseService.sa veEntity(entity);
            return success ? Result.success(entity) : Result.fail("新增失败");
        }
    
        /**
         * 2. 根据 ID 删除
         */
        @DeleteMapping("/{id}")
        public Result delete(@PathVariable K id) {
            boolean success = baseService.removeById(id);
            return success ? Result.success() : Result.fail("删除失败");
        }
    
        /**
         * 3. 修改
         */
        @PutMapping
        public Result update(@RequestBody T entity) {
            boolean success = baseService.updateEntity(entity);
            return success ? Result.success(entity) : Result.fail("修改失败");
        }
    
        /**
         * 4. 根据 ID 查询
         */
        @GetMapping("/{id}")
        public Result getById(@PathVariable K id) {
            T entity = baseService.getById(id);
            return entity != null ? Result.success(entity) : Result.fail("数据不存在");
        }
    
        /**
         * 5. 查询所有(无条件)
         */
        @GetMapping("/list")
        public Result> list() {
            List list = baseService.list(Wrappers.emptyWrapper());
            return Result.success(list);
        }
    
        /**
         * 6. 分页查询(默认第1页,每页10条,可传参数自定义)
         */
        @GetMapping("/page")
        public Result> page(
                @RequestParam(defaultValue = "1") Long current,
                @RequestParam(defaultValue = "10") Long size) {
            IPage page = baseService.page(new Page<>(current, size), Wrappers.emptyWrapper());
            return Result.success(page);
        }
    }
    

    三、业务模块使用示例(以 User 为例)

    有了上面的通用层,写一个 User 的 CRUD 有多轻松?看下面几步就知道。

    1. 实体类(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 ja va.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 {
        // 无需编写任何代码,自动拥有所有基础 CRUD 能力
    }
    

    3. 业务 Service

    (1)Service 接口

    package com.example.mpdemo.service;
    
    import com.example.mpdemo.entity.User;
    
    public interface UserService extends BaseGenericService {
        // 可扩展自定义业务方法
    }
    

    (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 implements UserService {
        // 无需编写任何代码,自动继承通用 Service 的所有方法
    }
    

    4. 业务 Controller

    继承通用 Controller,指定实体和主键类型,所有接口自动生效:

    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 {
        // 无需编写任何接口代码,自动拥有:
        // POST /user → 新增
        // DELETE /user/{id} → 删除
        // PUT /user → 修改
        // GET /user/{id} → 根据ID查询
        // GET /user/list → 查询所有
        // GET /user/page → 分页查询
    }
    

    四、接口测试(Postman/Curl)

    接口请求方式说明示例请求参数
    /userPOST新增用户{"username":"张三","age":20,"email":"zhangsan@example.com","createTime":"2026-03-13 10:00:00"}
    /user/1DELETE删除用户路径参数 id=1
    /userPUT修改用户{"id":1,"username":"张三","age":21}
    /user/1GET查询单个用户路径参数 id=1
    /user/listGET查询所有用户无参数
    /user/page?current=1&size=2GET分页查询参数 current=1(页码)、size=2(每页条数)

    五、扩展说明

    • 自定义条件查询:如果需要在通用接口基础上增加条件查询,直接在业务 Controller 里加新方法即可。比如:
    // UserController 中新增条件查询接口
    @GetMapping("/listByAge")
    public Result> listByAge(@RequestParam Integer age) {
        LambdaQueryWrapper wrapper = Wrappers.lambdaQuery(User.class)
                .gt(User::getAge, age);
        List list = baseService.list(wrapper);
        return Result.success(list);
    }
    
    • 异常处理:可以配合 @RestControllerAdvice 写一个全局异常处理器,统一捕获 CRUD 过程中可能出现的异常(比如主键不存在、参数不合法等);
    • 权限控制:如果需要做接口权限,在通用 Controller 或业务 Controller 的方法上加上 @PreAuthorize 等注解即可;
    • 参数校验:实体类上可以加 @NotNull、@NotBlank 之类的校验注解,然后在 Controller 参数前加 @Valid,让校验自动生效。

    总结

    • 核心思路:通过泛型 + 继承封装通用的 Mapper、Service、Controller,业务模块只需继承通用类,无需重复编写增删改查代码;
    • 复用性:通用层封装了 6 个核心 CRUD 接口(新增、删除、修改、单查、列表、分页),覆盖 90% 以上的单表业务场景;
    • 扩展性:通用类预留了扩展接口,业务模块可按需新增自定义方法,不破坏通用逻辑。

    这种封装方式能极大减少重复劳动,符合开闭原则,在企业级项目里算是 MyBatis-Plus 的常用最佳实践。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Aperty macOS版
    Aperty macOS版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw macOS版
    AionClaw macOS版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy macOS版
    Loomy macOS版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirBuddy 3 macOS版
    AirBuddy 3 macOS版

    AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

    AirServer macOS版
    AirServer macOS版

    AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

    AnyDesk macOS版
    AnyDesk macOS版

    AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

    WINDOWS 更多
    讯飞绘文 网页版
    讯飞绘文 网页版

    讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

    Maya(Autodesk Maya) Windows版
    Maya(Autodesk Maya) Windows版

    Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

    Aperty Windows版
    Aperty Windows版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw Windows版
    AionClaw Windows版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy Windows版
    Loomy Windows版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirServer Windows版
    AirServer Windows版

    AirServer Windows版可把电脑变成AirPlay、Google Cast和Miracast无线投屏接收端,适合会议演示、课堂教学及家庭大屏分享。发送设备通常无需另装客户端,并可同时接收和智能排列多个镜像会话。