Mybatis通用Mapper

最新推荐文章于 2023-09-13 16:29:24 发布
最新推荐文章于 2023-09-13 16:29:24 发布
阅读量207 收藏
点赞数
分类专栏： mybatis

极其方便的使用Mybatis单表的增删改查

优点?

不客气的说,使用这个通用Mapper甚至能改变你对Mybatis单表基础操作不方便的想法,使用它你能简单的使用单表的增删改查,包含动态的增删改查.

程序使用拦截器实现具体的执行Sql,完全使用原生的Mybatis进行操作.

你还在因为数据库表变动重新生成xml吗?还是要手动修改自动生成的insert|update|delete的xml呢?赶紧使用通用Mapper,表的变动只需要实体类保持一致,不用管基础的xml,你不止会拥有更多的时间陪老婆|孩子|女朋友|打DOTA,你也不用做哪些繁琐无聊的事情,感兴趣了吗?继续看如何使用吧!!相信这个通用的Mapper会让你更方便的使用Mybatis,这是一个强大的Mapper!!!

不管你信不信,这个项目的测试代码中没有一个Mapper的xml配置文件,但是却可以做到每个Mapper对应上百行xml才能完成的许多功能.没有了这些基础xml信息的干扰,你将会拥有清晰干净的Mapper.xml.

发现BUG可以提Issue,可以给我发邮件,可以加我QQ,可以进Mybatis群讨论.

作者QQ： 120807756

作者邮箱： abel533@gmail.com

Mybatis工具群： 211286137 (Mybatis相关工具插件等等)

推荐使用Mybatis分页插件:PageHelper分页插件


如何使用?

下面是通用Mapper的配置方法,还会提到Spring中的配置方法.还有和PageHelper分页插件集成的配置方式.

1. 引入通用Mapper的代码

将本项目中的4个代码文件(EntityHelper,Mapper,MapperHelper,MapperInterceptor)复制到你自己的项目中.

项目依赖于JPA的注解,需要引入persistence-api-1.0.jar或者添加Maven依赖:

<dependency>
  <groupId>javax.persistence</groupId>
  <artifactId>persistence-api</artifactId>
  <version>1.0</version>
</dependency>

2. 配置Mapper拦截器

在mybatis-config.xml中添加如下配置:

<plugins>
  <plugin interceptor="com.github.abel533.mapper.MapperInterceptor">
    <!--================================================-->
    <!--可配置参数说明(一般无需修改)-->
    <!--================================================-->
    <!--UUID生成策略-->
    <!--配置UUID生成策略需要使用OGNL表达式-->
    <!--默认值32位长度:@java.util.UUID@randomUUID().toString().replace("-", "")-->
    <!--<property name="UUID" value="@java.util.UUID@randomUUID().toString()"/>-->
    <!--主键自增回写方法,默认值CALL IDENTITY(),适应于大多数数据库-->
    <!--<property name="IDENTITY" value="CALL IDENTITY()"/>-->
    <!--主键自增回写方法执行顺序,默认AFTER,可选值为(BEFORE|AFTER)-->
    <!--<property name="ORDER" value="AFTER"/>-->
  </plugin>
</plugins>

可配置参数一般情况下不需要修改,直接像下面这样一行即可:

<plugin interceptor="com.github.abel533.mapper.MapperInterceptor"></plugin>

附:Spring配置相关

如果你使用Spring的方式来配置该拦截器,你可以像下面这样:

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <property name="dataSource" ref="dataSource"/>
  <property name="mapperLocations">
    <array>
      <value>classpath:mapper/*.xml</value>
    </array>
  </property>
  <property name="typeAliasesPackage" value="com.isea533.mybatis.model"/>
  <property name="plugins">
    <array>
      <-- 主要看这里 -->
      <bean class="com.isea533.mybatis.mapperhelper.MapperInterceptor"/>
    </array>
  </property>
</bean>

只需要像上面这样配置一个bean即可.

如果你同时使用了PageHelper分页插件,可以像下面这样配置:

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <property name="dataSource" ref="dataSource"/>
  <property name="mapperLocations">
    <array>
      <value>classpath:mapper/*.xml</value>
    </array>
  </property>
  <property name="typeAliasesPackage" value="com.isea533.mybatis.model"/>
  <property name="plugins">
    <array>
      <bean class="com.isea533.mybatis.pagehelper.PageHelper">
        <property name="properties">
          <value>
            dialect=hsqldb
            reasonable=true
          </value>
        </property>
      </bean>
      <bean class="com.isea533.mybatis.mapperhelper.MapperInterceptor"/>
    </array>
  </property>
</bean>

一定要注意PageHelper和MapperInterceptor这两者的顺序不能颠倒.

如果你想配置MapperInterceptor的参数,可以像PageHelper中的properties参数这样配置

3. 继承通用的Mapper<T>,必须指定泛型<T>

例如下面的例子:

public interface UserInfoMapper extends Mapper<UserInfo> {
  //其他必须手写的接口...

}

一旦继承了Mapper<T>,继承的Mapper就拥有了以下通用的方法:

//根据实体类不为null的字段进行查询,条件全部使用=号and条件
List<T> select(T record);

//根据实体类不为null的字段查询总数,条件全部使用=号and条件
int selectCount(T record);

//根据主键进行查询,必须保证结果唯一
//单个字段做主键时,可以直接写主键的值
//联合主键时,key可以是实体类,也可以是Map
T selectByPrimaryKey(Object key);

//插入一条数据
//支持Oracle序列,UUID,类似Mysql的INDENTITY自动增长(自动回写)
//优先使用传入的参数值,参数值空时,才会使用序列、UUID,自动增长
int insert(T record);

//插入一条数据,只插入不为null的字段,不会影响有默认值的字段
//支持Oracle序列,UUID,类似Mysql的INDENTITY自动增长(自动回写)
//优先使用传入的参数值,参数值空时,才会使用序列、UUID,自动增长
int insertSelective(T record);

//根据实体类中字段不为null的条件进行删除,条件全部使用=号and条件
int delete(T key);

//通过主键进行删除,这里最多只会删除一条数据
//单个字段做主键时,可以直接写主键的值
//联合主键时,key可以是实体类,也可以是Map
int deleteByPrimaryKey(Object key);

//根据主键进行更新,这里最多只会更新一条数据
//参数为实体类
int updateByPrimaryKey(T record);

//根据主键进行更新
//只会更新不是null的数据
int updateByPrimaryKeySelective(T record);

4. 泛型(实体类)<T>的类型必须符合要求

实体类按照如下规则和数据库表进行转换,注解全部是JPA中的注解:

  1. 表名默认使用类名,驼峰转下划线,如UserInfo默认对应的表名为user_info.

  2. 表名可以使用@Table(name = "tableName")进行指定,对不符合第一条默认规则的可以通过这种方式指定表名.

  3. 字段默认和@Column一样,都会作为表字段,表字段默认为Java对象的Field名字驼峰转下划线形式.

  4. 可以使用@Column(name = "fieldName")指定不符合第3条规则的字段名

  5. 使用@Transient注解可以忽略字段,添加该注解的字段不会作为表字段使用.

  6. 建议一定是有一个@Id注解作为主键的字段,可以有多个@Id注解的字段作为联合主键.

  7. 默认情况下,实体类中如果不存在包含@Id注解的字段,所有的字段都会作为主键字段进行使用(这种效率极低).

  8. 实体类可以继承使用,可以参考测试代码中的com.github.abel533.model.UserLogin2类.

  9. 由于基本类型,如int作为实体类字段时会有默认值0,而且无法消除,所以实体类中建议不要使用基本类型.

除了上面提到的这些,Mapper还提供了序列(支持Oracle)、UUID(任意数据库,字段长度32)、主键自增(类似Mysql,Hsqldb)三种方式，其中序列和UUID可以配置多个，主键自增只能配置一个。

这三种方式不能同时使用,同时存在时按照 序列>UUID>主键自增的优先级进行选择.下面是具体配置方法:

  1. 使用序列可以添加如下的注解:

    //可以用于数字类型,字符串类型(需数据库支持自动转型)的字段
@SequenceGenerator(name="Any",sequenceName="seq_userid")
@Id
private Integer id;

  2. 使用UUID时:

    //可以用于任意字符串类型长度超过32位的字段
@GeneratedValue(generator = "UUID")
private String countryname;

  3. 使用主键自增:

    //不限于@Id注解的字段,但是一个实体类中只能存在一个(继承关系中也只能存在一个)
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Integer id;

5. 将继承的Mapper接口添加到Mybatis配置中

例如本项目测试中的配置:

<mappers>
  <mapper class="com.github.abel533.mapper.CountryMapper" />
  <mapper class="com.github.abel533.mapper.Country2Mapper" />
  <mapper class="com.github.abel533.mapper.CountryTMapper" />
  <mapper class="com.github.abel533.mapper.CountryUMapper" />
  <mapper class="com.github.abel533.mapper.CountryIMapper" />
  <mapper class="com.github.abel533.mapper.UserInfoMapper" />
  <mapper class="com.github.abel533.mapper.UserLoginMapper" />
  <mapper class="com.github.abel533.mapper.UserLogin2Mapper" />
</mappers>

附:Spring配置相关

如果你在Spring中配置Mapper接口,不需要像上面这样一个个配置,只需要有下面的这个扫描Mapper接口的这个配置即可:

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
  <property name="basePackage" value="com.isea533.mybatis.mapper"/>
</bean>

6. 代码中使用

例如下面这个简单的例子:

SqlSession sqlSession = MybatisHelper.getSqlSession();
try {
    //获取Mapper
    UserInfoMapper mapper = sqlSession.getMapper(UserInfoMapper.class);
    UserInfo userInfo = new UserInfo();
    userInfo.setUsername("abel533");
    userInfo.setPassword("123456");
    userInfo.setUsertype("2");
    userInfo.setEmail("abel533@gmail.com");
    //新增一条数据
    Assert.assertEquals(1, mapper.insert(userInfo));
    //ID回写,不为空
    Assert.assertNotNull(userInfo.getId());
    //6是当前的ID
    Assert.assertEquals(6, (int)userInfo.getId());
    //通过主键删除新增的数据
    Assert.assertEquals(1,mapper.deleteByPrimaryKey(userInfo));
} finally {
    sqlSession.close();
}

另一个例子:

SqlSession sqlSession = MybatisHelper.getSqlSession();
try {
    //获取Mapper
    CountryMapper mapper = sqlSession.getMapper(CountryMapper.class);
    //查询总数
    Assert.assertEquals(183, mapper.selectCount(new Country()));
    //查询100
    Country country = mapper.selectByPrimaryKey(100);
    //根据主键删除
    Assert.assertEquals(1, mapper.deleteByPrimaryKey(100));
    //查询总数
    Assert.assertEquals(182, mapper.selectCount(new Country()));
    //插入
    Assert.assertEquals(1, mapper.insert(country));
} finally {
    sqlSession.close();
}

附:Spring使用相关

直接在需要的地方注入Mapper继承的接口即可,和一般情况下的使用没有区别.


关于和Spring结合的例子,可以看下面的地址:



当前版本v0.1.0



这是一个新生的开源项目

首先感谢您能看到这里!

这是一个新生的项目,一切都刚刚开始,虽然项目中包含大量的测试,但是仍然会有很多未知的bug存在,希望各位能够在使用过程中发现问题时及时反馈,欢迎各位fork本项目进行参与!

chen58683632
关注
专栏目录
mybatis通用mapper笔记
10-10
### MyBatis通用Mapper知识点详解 #### 一、MyBatis通用Mapper简介 MyBatis通用Mapper是一种基于MyBatis框架的扩展插件，它能够为开发者提供一系列方便的CRUD（创建、读取、更新、删除）操作方法，极大地简化了...
通用mapper（mapper-mybatis）
m0_62520968的博客
07-19 1万+
通用Mapper是一个可以实现任意MyBatis通用方法的框架，项目提供了常规的增删改查操作以及Example相关的单表操作，与mybatisplus相似，对mybatis制作增强不做修改。为什么要用通用mapper？我们这里列举一下原生Mybatis的痛点1、mapper.xml文件里有大量的sql，当数据库表字段变动，配置文件就要修改2、需要自己实现sql分页，select*fromtablewhere...limit1,3。...
MyBatis之通用mapper
qq_45578181的博客
08-27 1847
文章目录对比依赖yml配置扫描BaseMapper的方法通用mapper的example类examplecriteria 对比 以单表person，生成对应的Person实体类为例： 原生mybatis生成： PersonMapper.xml、Person.java、PersonMapper.java、PersonExample.java 通用mapper生成： PersonMapper.xml、Person.java、PersonMapper.java 原生mybatis生成的POJO中，纯代码，不包含
SpringCloud第03讲：（番外篇）整合MyBatis通用Mapper
分享日常工作技术
01-17 1332
参考： https://github.com/abel533/Mapper https://github.com/abel533/Mapper/wiki/1.3-spring-boot 一、整合通用Mapper 1、在项目pom.xml中添加依赖（文章最后面提供完整pom.xml） <dependency> <groupId>tk.mybatis</groupId> <artifactId&
基于mybatis的通用mapper实现
terry2870的专栏
03-12 7424
基于mybatis的通用mapper实现     目前市面上开源的通用mapper有很多，比如mybatis-plus，tkmybatis等等。 可以能有人会认为这是在重复造轮子，但是经过自己的摸索探索出来的一套框架还是让自己有所收益。这套框架已经在项目中运行多年，当然功能也在不断改进中。 ...
Mybatis之通用Mappper
China_TomCat的博客
08-31 411
Mybatis之通用Mappper 通用 Mapper 介绍 通用 Mapper 是一个辅助 MyBatis 单表开发的组件，它使我们能极其方便的使用 MyBatis 单表的增删改查。 快速入门 2.1 搭建环境 创建数据库 mapper，和 table_user 表 DROP TABLE IF EXISTS table_user; CREATE TABLE table_user ( user_id int(11) NOT NULL AUTO_INCREMENT, user_name varch
浅谈MyBatis通用Mapper实现原理
08-26
浅谈MyBatis通用Mapper实现原理 MyBatis通用Mapper是MyBatis框架中的一种通用Mapper实现方式，主要提供了一些通用的方法，这些方法是以接口的形式提供的。通用Mapper的实现原理主要是通过Java反射机制和MyBatis框架...
spring-boot+tk.mybatis通用mapper
08-25
本教程将深入探讨如何在Spring Boot项目中集成tk.mybatis通用Mapper，实现高效的数据访问。 首先，我们需要理解Spring Boot的核心特性：自动配置。Spring Boot通过扫描类路径并根据存在的依赖来自动配置相应的Bean...
mybatis 通用mapper
11-25
MyBatis通用Mapper是一个基于MyBatis框架的扩展工具，它极大地简化了针对单一表的操作，使得开发人员无需编写繁琐的XML映射文件和接口定义就能实现数据层的增删改查等基本功能。其优势在于简化了开发流程，降低了...
mybatis通用mapper
04-18
MyBatis通用Mapper是一款在MyBatis框架基础上封装的工具，旨在简化开发过程中对数据库 CRUD（创建、读取、更新、删除）操作的繁琐过程。它通过提供预定义的SQL映射方法，使得开发者可以无需编写大量的XML配置文件，...
MyBatis 通用 Mapper
横竖撇折点
09-22 911
前言 上一篇，我们完成了 Spring Boot + MyBatis 项目的搭建，本篇将对 MyBatis 做深度的解析，构建自己的 MyBatis 工具类，为快捷高效的代码开发做准备。 现状分析 从这一篇开始正式写代码，按照既定的接口文档和数据库设计文档实现相应的业务逻辑。那么是不是接到开发任务就要赶紧写业务代码呢？ 在实际开发项目时切忌闷头苦干，要思考如何快速高效地完成任务，一个资深程序员往往...
MyBatis-Plus【通用Mapper篇】
热门推荐
mmklo的博客
05-26 1万+
MP-通用Mapper 一、通用Mapper二、使用方式1、源码分析:one:Insert 插入方法:two:Delete 删除方法:three:Update 修改方法:four: Select 查询方法 一、通用Mapper 在MyBatis-Plus里面，可以实现对数据库的CRUD操作，官方对通用Mapper的解释如下说明: 通用 CRUD 封装BaseMapper (opens new window)接口，为 Mybatis-Plus 启动时自动解析实体表关系映射转换为 Mybatis 内部对象注
Mybatis-通用Mapper
weixin_45822542的博客
09-28 500
Mybatis-通用Mapper 概念：通用Mapper对MyBatis进行简化的第三方工具包 通用Mapper提供了一个名为Mapper的接口，用于自动完成单表的增删改查操作 public interface UserMapper extends Mapper<User> { } 1.搭建环境 2.修改工具类-Mybatis工具类 public class MyBatisUtils { // 会话工厂 private static SqlSessionFactory fa
Mybatis中的通用mapper的使用
想作会飞的鱼的博客
04-21 4870
Mybatis中的通用mapper的使用 1、在maven中添加依赖 com.github.abel533 mapper 2.3.4 2、集成通用mapper 对com.github.abel533.mapper.Mapper的集成，实际上是配置MapperHelper。一共有三种方式：针对Java编码、和Spring集成和使用拦截器配置。 (1)Java编码
学习MybatisPlus，看这一篇文章就够了！（详细教程）
最新发布
weixin_46608377的博客
09-13 1700
为什么要使用MybatisPlus？MybatisPlus的好处是什么？因为Mybatis-Plus框架封装了大量CURD的方法，包括我们常用的一些增删改查的SQL命令，Mybatis-Plus都帮我们完成好了，只需要调用相关方法，即可完成对数据库的操作，减少了程序员重复写基本SQL命令的操作，大大提升项目的开发效率。官网介绍：MyBatis-Plus是一个MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。无侵入。
ORM框架之Mybatis（六）mybatis通用mapper
小蜜蜂1010的博客
10-13 695
一、简介通用mapper 1.1 官方介绍：（官网：https://mapperhelper.github.io/docs/） 通用Mapper都可以极大的方便开发人员。可以随意的按照自己的需要选择通用方法，还可以很方便的开发自己的通用方法。 极其方便的使用MyBatis单表的增删改查。 支持单表操作，不支持通用的多表联合查询。 不是表中字段的属性必须加@Transient注解 通...
BaseMapper的各种方法
weixin_42602241的博客
01-02 1693
BaseMapper是MyBatis中用于执行数据库操作的接口。它继承了org.apache.ibatis.mapping.Mapper接口，并提供了一些常用的数据库操作方法。 常用的BaseMapper方法包括： insert：向数据库中插入一条记录 delete：从数据库中删除一条记录 update：更新数据库中的一条记录 selectOne：从数据库中查询一条记录 selectList：从...
MyBatis-Plus之BaseMapper
沉淀、分享、成长，让自己和他人都能有所收获！
10-04 6228
【代码】MyBatis-Plus之BaseMapper。
Mybatis通用Mapper集成与使用教程
"这篇文档是关于MyBatis通用Mapper的使用教程，主要针对Java Maven项目。通用Mapper是一个方便快捷的工具，它可以帮助开发者减少大量重复的CRUD操作，提高开发效率。文档中提供了通用Mapper的码云地址以及必要的依赖...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值