MyBatis通用Mapper：简化数据库操作的利器

2024-05-31 13:20
文章标签 通用 操作 数据库 mybatis mapper 利器 简化

本文主要是介绍MyBatis通用Mapper：简化数据库操作的利器，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

引言

在软件开发中，数据库操作是不可或缺的一部分。通常我们会使用mybatis，的MBG插件，自动生成表对应的基本操作语句xml。

当我们的表字段发生变化的时候，我们需要修改实体类和Mapper文件定义的字段和方法。如果是增量维护，那么一个个文件去修改。如果是全量替换，我们还要去对比用MBG生成的文件。字段变动一次就要修改一次，维护起来非常麻烦。

MBG

mybatis 代码生成工具 （https://github.com/mybatis/generator）

MBG（MyBatis Generator）是一个针对MyBatis和iBATIS的代码生成工具。以下是关于MBG的详细简单介绍：

1. 功能概述

  • 代码生成：MBG能够自动生成与数据库表结构相匹配的Java POJO（Plain Old Java Object，简单的Java对象）、Mapper文件（DAO接口）以及XML映射文件。
  • 支持版本：它支持所有版本的MyBatis以及iBATIS 2.2.0及以后的版本。
  • CRUD操作：MBG可以内省数据库表，并生成用于访问这些表的基础对象，从而简化了与数据库表进行交互时的对象和配置文件创建过程。它主要解决了简单的CRUD（创建、检索、更新、删除）操作。

2. 生成的代码类型

  • Java POJO：
    • 匹配表主键的类（如果存在主键）
    • 匹配表非主键字段的类（BLOB字段除外）
    • 包含BLOB字段的类（如果表具有BLOB字段）
    • 允许动态查询、更新和删除的类（如Example查询）
  • Mapper文件（DAO接口）：与MyBatis 3.x或iBATIS 2.x兼容的Mapper接口。
  • XML映射文件：MyBatis/iBATIS兼容的SQL映射XML文件，包含用于简单CRUD操作的SQL语句。

3. 优点

  • 提高开发效率：自动生成代码可以减少重复的编码工作，节省开发时间。
  • 提高代码质量：自动生成的代码基本上是经过测试的，可以减少一些错误，提高代码的质量。
  • 易于维护：自动生成的代码结构清晰，易于阅读和理解，方便维护。
  • 可自定义：可以根据自己的需求定制生成规则，满足项目的特定需求。

4. 缺点

  • 生成的代码可能不符合项目需求：生成的代码可能不完全符合项目的需求，需要手动修改。
  • 学习成本：需要花时间学习生成工具的使用方法，可能需要一定的技术水平。
  • 可能会覆盖已有代码：生成的代码可能会覆盖已有的代码，导致一些问题。
  • 可能会导致代码冗余：生成的代码可能会存在冗余，需要手动清理。

5. 使用方法

  • 配置MBG：在项目的构建配置文件中（如pom.xml）添加MBG的依赖，并创建MBG的配置文件（如generatorConfig.xml），配置数据库连接信息、Java模型生成器等相关设置。
  • 运行MBG：通过构建工具（如Maven）运行MBG，根据配置文件生成代码。

6. 注意事项

  • 在使用MBG时，应确保数据库表结构的准确性和完整性，以避免生成的代码出现问题。
  • 根据项目的实际需求，合理配置MBG的生成规则，以满足项目的特定需求。
  • 在使用生成的代码时，应仔细检查和测试，确保代码的正确性和稳定性。

通用Mapper的实现方案

mapper继承

第一个，因为MyBatis的Mapper是支持继承的（见：Can mybatis support mapper xml extend feature? · Issue #35 · mybatis/mybatis-3 · GitHub）。所以我们可以把我们的Mapper.xml和Mapper接口都分成两个文件。一个是MBG生成的，这部分是固定不变的。然后创建DAO类继承生成的接口，变化的部分就在DAO里面维护。

public interface UserMapperExt extends UserMapper {public List<User> selectUserByName(String userName);
}

对应的映射文件

<?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.boge.vip.mapper.UserMapperExt" ><resultMap id="BaseResultMapExt" type="com.boge.vip.domain.User" ><id column="id" property="id" jdbcType="INTEGER" /><result column="user_name" property="userName" jdbcType="VARCHAR" /><result column="real_name" property="realName" jdbcType="VARCHAR" /><result column="password" property="password" jdbcType="VARCHAR" /><result column="age" property="age" jdbcType="INTEGER" /><result column="d_id" property="dId" jdbcType="INTEGER" /><result column="i_id" property="iId" jdbcType="INTEGER" /></resultMap><select id="selectUserByName" resultMap="BaseResultMapExt" >select * from t_user where user_name = #{userName}</select>
</mapper>

当然在全局配置文件里面我们需要增加这个mapper的扫描

    <mappers><mapper resource="mapper/UserMapper.xml"/><mapper resource="mapper/UserMapperExt.xml"/></mappers>

所以以后只要修改Ext的文件就可以了。这么做有一个缺点，就是文件会增多。

mybatis-plus

推荐使用。官网如下：快速开始 | MyBatis-Plus

这里贴一个例子，非常好用。

添加依赖，引入 MyBatis-Plus Starter 依赖

<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.5.6</version></dependency>

配置

在 application.yml 配置文件中添加 H2 数据库的相关配置：

application.yml

# DataSource Config
spring:datasource:driver-class-name: org.h2.Driverusername: rootpassword: testsql:init:schema-locations: classpath:db/schema-h2.sqldata-locations: classpath:db/data-h2.sql

上面的配置是任何一个 Spring Boot 工程都会配置的数据库链接信息，如果您使用的是其他数据库，如 MySQL，则需要修改相应的配置信息。

在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹：

Application.java

@SpringBootApplication
@MapperScan("com.baomidou.mybatisplus.samples.quickstart.mapper")
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}}

编码

编写实体类 User.java：

User.java

@Data
public class User {private Long id;private String name;private Integer age;private String email;
}

编写 Mapper 接口类 UserMapper.java：

public interface UserMapper extends BaseMapper<User> {}

开始使用

添加测试类，进行功能测试：

@SpringBootTest
public class SampleTest {@Autowiredprivate UserMapper userMapper;@Testpublic void testSelect() {System.out.println(("----- selectAll method test ------"));List<User> userList = userMapper.selectList(null);Assert.isTrue(5 == userList.size(), "");userList.forEach(System.out::println);}}

控制台输出：

User(id=1, name=Jone, age=18, email=test1@baomidou.com)

User(id=2, name=Jack, age=20, email=test2@baomidou.com)

User(id=3, name=Tom, age=28, email=test3@baomidou.com)

User(id=4, name=Sandy, age=21, email=test4@baomidou.com)

User(id=5, name=Billie, age=24, email=test5@baomidou.com)

这篇关于MyBatis通用Mapper：简化数据库操作的利器的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1018042。

相关文章

Python正则表达式匹配和替换的操作指南

Python正则表达式匹配和替换的操作指南

《Python正则表达式匹配和替换的操作指南》正则表达式是处理文本的强大工具,Python通过re模块提供了完整的正则表达式功能,本文将通过代码示例详细介绍Python中的正则匹配和替换操作,需要的朋... 目录基础语法导入re模块基本元字符常用匹配方法1. re.match() - 从字符串开头匹配2.
阅读更多...
MyBatis分页查询实战案例完整流程

MyBatis分页查询实战案例完整流程

《MyBatis分页查询实战案例完整流程》MyBatis是一个强大的Java持久层框架,支持自定义SQL和高级映射,本案例以员工工资信息管理为例,详细讲解如何在IDEA中使用MyBatis结合Page... 目录1. MyBATis框架简介2. 分页查询原理与应用场景2.1 分页查询的基本原理2.1.1 分
阅读更多...
MyBatis Plus实现时间字段自动填充的完整方案

MyBatis Plus实现时间字段自动填充的完整方案

《MyBatisPlus实现时间字段自动填充的完整方案》在日常开发中,我们经常需要记录数据的创建时间和更新时间,传统的做法是在每次插入或更新操作时手动设置这些时间字段,这种方式不仅繁琐,还容易遗漏,... 目录前言解决目标技术栈实现步骤1. 实体类注解配置2. 创建元数据处理器3. 服务层代码优化填充机制详
阅读更多...
mybatis映射器配置小结

mybatis映射器配置小结

《mybatis映射器配置小结》本文详解MyBatis映射器配置,重点讲解字段映射的三种解决方案（别名、自动驼峰映射、resultMap）,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定... 目录select中字段的映射问题使用SQL语句中的别名功能使用mapUnderscoreToCame
阅读更多...
Linux下MySQL数据库定时备份脚本与Crontab配置教学

Linux下MySQL数据库定时备份脚本与Crontab配置教学

《Linux下MySQL数据库定时备份脚本与Crontab配置教学》在生产环境中,数据库是核心资产之一,定期备份数据库可以有效防止意外数据丢失,本文将分享一份MySQL定时备份脚本,并讲解如何通过cr... 目录备份脚本详解脚本功能说明授权与可执行权限使用 Crontab 定时执行编辑 Crontab添加定
阅读更多...
mybatis-plus如何根据任意字段saveOrUpdateBatch

mybatis-plus如何根据任意字段saveOrUpdateBatch

《mybatis-plus如何根据任意字段saveOrUpdateBatch》MyBatisPlussaveOrUpdateBatch默认按主键判断操作类型,若需按其他唯一字段（如agentId、pe... 目录使用场景方法源码方法改造首先在service层定义接口service层接口实现总结使用场景my
阅读更多...
Java实现在Word文档中添加文本水印和图片水印的操作指南

Java实现在Word文档中添加文本水印和图片水印的操作指南

《Java实现在Word文档中添加文本水印和图片水印的操作指南》在当今数字时代,文档的自动化处理与安全防护变得尤为重要,无论是为了保护版权、推广品牌,还是为了在文档中加入特定的标识,为Word文档添加... 目录引言Spire.Doc for Java：高效Word文档处理的利器代码实战：使用Java为Wo
阅读更多...
MyBatis ParameterHandler的具体使用

MyBatis ParameterHandler的具体使用

《MyBatisParameterHandler的具体使用》本文主要介绍了MyBatisParameterHandler的具体使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参... 目录一、概述二、源码1 关键属性2.setParameters3.TypeHandler1.TypeHa
阅读更多...
MyBatis-plus处理存储json数据过程

MyBatis-plus处理存储json数据过程

《MyBatis-plus处理存储json数据过程》文章介绍MyBatis-Plus3.4.21处理对象与集合的差异：对象可用内置Handler配合autoResultMap,集合需自定义处理器继承F... 目录1、如果是对象2、如果需要转换的是List集合总结对象和集合分两种情况处理，目前我用的MP的版本
阅读更多...
如何通过try-catch判断数据库唯一键字段是否重复

如何通过try-catch判断数据库唯一键字段是否重复

《如何通过try-catch判断数据库唯一键字段是否重复》在MyBatis+MySQL中,通过try-catch捕获唯一约束异常可避免重复数据查询,优点是减少数据库交互、提升并发安全,缺点是异常处理开... 目录1、原理2、怎么理解“异常走的是数据库错误路径，开销比普通逻辑分支稍高”？1. 普通逻辑分支 v
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2