MyBatis工具：基础CRUD封装

最新推荐文章于 2024-07-24 14:08:06 发布
置顶 最新推荐文章于 2024-07-24 14:08:06 发布
阅读量5k 收藏 6
点赞数 2
分类专栏： java mybatis 文章标签： 数据库 mybatis 框架 jpa
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u010528826/article/details/77146002
版权

MyBatis工具：基础CRUD封装

将基础的 增、删、改、查进行了封装。省掉大部分简单Mapper的编写，节省开发时间。采用标准JPA规范，在此处配置好的POJO，
放到其他任何实现了JPA的框架（如：Hibernate）都能使用。当然目前只使用到了JPA的一小部分注解，可以把这些封装看作一个超超超低配版的Hibernate。
目前支持的注解：

@Table              数据库表名映射。
@Id                 主键映射。
@Column             字段名映射。其中name、updatable、insertable属性均支持
@Transient          表示不需要跟数据库作映射。在我的封装中只有加了@Column才会同数据库映射，但在Hibernate中必须得使用。
@MappedSuperclass   实体之间继承关系

都是一些常用配置。做这个东西的初衷仅仅是为了简化单表的操作，什么@ManyToMany、@JoinTable直接忽略。子查询、关联查询、以及比较复杂的查询请写Mapper比较好。

配置

很简单的几步配置。主要是在SqlSessionFactoryBean中加入结果集处理插件和分页插件，以及MapperScannerConfigurer中增加BaseMappper

省略部分代码......

<!--配置插件-->
<bean id="myBatisResultIntercept" class="me.ly.tools.mybatis.mybatis.MybatisResultInterceptor"/>
<bean id="mybatisPaginationInterceptor" class="me.ly.tools.mybatis.mybatis.MybatisPaginationInterceptor"/>

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
    <property name="plugins">
        <list>
            <ref bean="mybatisPaginationInterceptor"/>
            <ref bean="myBatisResultIntercept"/>
        </list>
    </property>
</bean>
<!-- MapperScanner 中加上 BaseMapper -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="......,me.ly.tools.mybatis.dao"/>
    <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
</bean>

省略部分代码......

使用

1、POJO添加注解

这里以区域表作为例子。下面贴出area表及其对应实体类。

area_idnameparent_idprovince_idcity_idlevelcreate_bycreate_date
23四川-1231system2016-08-24
286成都23232862system2016-08-24
287自贡23232872system2016-08-24
288攀枝花23232882system2016-08-24
289泸州23232892system2016-08-24
@Entity
@Table(name = "area")
public class AreaDO extends BaseDO {

    省略部分代码......

    @Id
    @Column(name = "area_id")
    private Integer areaId;

    @Column
    private String name;

    @Column(name = "parent_id")
    private Integer parentId;

    @Column(name = "city_id")
    private Integer cityId;

    @Column(name = "province_id")
    private Integer provinceId;

    省略getter/setter部分代码......
}

如果有继承关系，则需要在父类加上@MappedSuperclass。如上代码段中AreaDO extends BaseDO 

@MappedSuperclass
public class BaseDO implements Serializable {

    /** 创建人 */
    @Column(name = "create_by", updatable = false)
    private String createBy;

    /** 创建时间 */
    @Column(name = "create_date", updatable = false)
    private Date createDate;

    省略部分代码......
}

2、实现类继承BaseServiceImpl类

@Service
public class AreaServiceImpl extends BaseServiceImpl implements AreaService{
    省略部分代码......

    public void method(){
        AreaDO areaDo1 = this.selectOne(AreaDO.class,"name = ?","四川");
        System.out.println(JSON.toJSONString(areaDO1));
        //输出：{"areaId":23,"cityId":0,"createBy":"system","createDate":1471968000000,"name":"四川","parentId":-1,"provinceId":23}

        AreaDO areaDO2 = this.selectById(AreaDO.class, 23);
        System.out.println(JSON.toJSONString(areaDO2));
        //输出：{"areaId":23,"cityId":0,"createBy":"system","createDate":1471968000000,"name":"四川","parentId":-1,"provinceId":23}

        List<AreaDO> areaList = this.selectAll(AreaDO.class, "parent_id = ? LIMIT 2", 23);
        System.out.println(JSON.toJSONString(areaList));
        //输出：
        //  [
        //    {"areaId":286,"cityId":286,"createBy":"system","createDate":1471968000000,"name":"成都","parentId":23,"provinceId":23},
        //    {"areaId":287,"cityId":287,"createBy":"system","createDate":1471968000000,"name":"自贡","parentId":23,"provinceId":23}
        //  ]
    }    
}

3、注入BaseService

因为可能被其它类继承，所以这里注入时要限定名字。

@Service
public class AreaServiceImpl implements AreaService{
    @Autowired
    @Qualifier(value = "baseServiceImpl")
    private BaseService baseService;

    public void method(){
        AreaDO areaDo1 = this.baseService.selectOne(AreaDO.class,"name = ?","四川");
        System.out.println(JSON.toJSONString(areaDO1));
        //输出：{"areaId":23,"cityId":0,"createBy":"system","createDate":1471968000000,"name":"四川","parentId":-1,"provinceId":23}

        AreaDO areaDO2 = this.baseService.selectById(AreaDO.class, 23);
        System.out.println(JSON.toJSONString(areaDO2));
        //输出：{"areaId":23,"cityId":0,"createBy":"system","createDate":1471968000000,"name":"四川","parentId":-1,"provinceId":23}

        List<AreaDO> areaList = this.baseService.selectAll(AreaDO.class, "parent_id = ? LIMIT 2", 23);
        System.out.println(JSON.toJSONString(areaList));
        //输出：
        //  [
        //    {"areaId":286,"cityId":286,"createBy":"system","createDate":1471968000000,"name":"成都","parentId":23,"provinceId":23},
        //    {"areaId":287,"cityId":287,"createBy":"system","createDate":1471968000000,"name":"自贡","parentId":23,"provinceId":23}
        //  ]
    }

}

代码片段

1、BaseService

BaseService 提供了基础增、删、改、查方法，供其它地方使用

省略部分代码......
<T> T selectOne(Class<T> clazz, String where, Object... params);

<T> List<T> selectAll(Class<T> clazz, String where, Object... params);

<T> T selectById(Class<T> clazz, Object id);

<T> List<T> selectByPage(Class<T> clazz, Pagination pagination, String where, Object... params);

<T> int insert(T obj);

<T> int insertList(List<T> list);

<T> int delete(T obj);

<T> int update(T obj);

<T> int update(T obj, boolean ignoreNull, boolean ignoreEmpty);

<T> int updateList(List<T> objs);

<T> int updateList(List<T> objs, boolean ignoreNull, boolean ignoreEmpty);

int executeCUD(String sql, Object... param);

省略部分代码......

2、CRUDTemplate

用于构造SQL，配合BaseMapper使用。

省略部分代码......

public String selectById(Map<?, ?> map) {
    SQL sql = new SQL();
    Class<?> clazz = (Class<?>) map.get("clazz");
    sql.SELECT("*").FROM(ReflectUtil.tableName(clazz));
    Object id = map.get("id");
    if (null == id || "".equals(id)) {
        return sql.toString();
    }
    Map<String, String> columnMap = ReflectUtil.id(clazz);
    sql.WHERE(columnMap.get(MyBatisUtil.KEY_ID_COLUMN) + " = #{id}");
    return sql.toString();
}
省略部分代码......

3、BaseMapper

通过@SelectProvider/@InsertProvider/@DeleteProvider/@UpdateProvider 将CRUDTemplate构建的SQL交由Mybatis做后续处理

省略部分代码......

@SelectProvider(type = CRUDTemplate.class, method = "selectById")
<T> List<T> selectById(@Param("clazz") Class<T> clazz, @Param("id") Object id);

省略部分代码......

4、MybatisResultInterceptor

用于处理查询结果集的拦截器。通过JPA注解将POJO字段同数据库中字段对应，再交由该拦截器处理。可以省掉很多ResultMap的编写。
注意事项：
1. 如某方法已经设置了ResultMap，则该方法会被拦截但是拦截后会直接交给MyBatis，拦截器本身不会再做处理。
2. 仅支持单表单实体，对于一些复杂的对象请使用ResultMap。
3. SQL查询字段需要和@Column设置的名字对应，使用别名的时候注意一下。
4. 返回对象必须设置@Entity注解，字段必须设置@Column注解。
5. 该拦截器中提供了interceptAllMethod字段，在声明插件时通过Spring注入（true/false），用于设置是否对所有方法拦截。默认true。同时提供了@ResultIntercept注解，来更加灵活的配置对方法的连接。该注解可以在方法或者接口类上使用。

  1. 如果在方法上配置了@ResultIntercept，则该方法一定会或不会被拦截。优先级最高
  2. 如果在接口类上配置了@ResultIntercept(intercept = false)，则该接口类的方法不会被拦截。优先级第二
  3. 如果设置了interceptAllMethod = true，则所有方法都会被拦截。优先级第三
  4. 如果设置了interceptAllMethod = false，则判断接口类上的@ResultIntercept。优先级最低
......
private boolean isIntercept(String fullMethodName) throws Exception {
    // 方法名为空，不拦截
    if (StringUtils.isBlank(fullMethodName)) {
        return false;
    }

    int lastPointIndex = fullMethodName.lastIndexOf(".");
    String fullClazz = fullMethodName.substring(0, lastPointIndex);
    String methodName = fullMethodName.substring(lastPointIndex + 1, fullMethodName.length());
    Class<?> clazz = Class.forName(fullClazz);

    Method method = ReflectUtil.getMethod(clazz, methodName);
    ResultIntercept methodAnnotation = method.getAnnotation(ResultIntercept.class);
    if (methodAnnotation != null) {
        return methodAnnotation.intercept();
    }
    ResultIntercept classAnnotation = clazz.getAnnotation(ResultIntercept.class);
    if (interceptAllMethod) {
        // 设置了拦截所有方法的时候要判断接口类是不是配置不拦截。
        return !(classAnnotation != null && !classAnnotation.intercept());
    }
    //未设置拦截所有方法，则判断接口类是不是配置了拦截
    return !(classAnnotation == null || !classAnnotation.intercept());
}
......

5、MybatisPaginationInterceptor

分页拦截器。SELECT语句且参数带Pagination的方法都会被拦截，拦截后会对SQL做一些包装，比如加上Limit

省略部分代码......

int fromIndex = originalSql.toUpperCase().indexOf("FROM");
String countSql = "SELECT COUNT(*) AS TOTAL " + originalSql.substring(fromIndex);
preparedStatement = connection.prepareStatement(countSql);

if (countSql.contains("?") && paramObj instanceof Map<?, ?>) {
    Map<?, ?> paramMap = (Map<?, ?>) paramObj;
    Object[] params = (Object[]) paramMap.get("params");
    if (params != null) {
        for (int i = 0; i < params.length; i++) {
            preparedStatement.setObject(i + 1, params[i]);
        }
    }

}
rs = preparedStatement.executeQuery();
if (rs.next()) {
    int totalRecord = rs.getInt("TOTAL");
    page.setTotalCount(totalRecord);
}
省略部分代码......

private String mysqlLimitPageSql(Pagination page, String sql) {
    StringBuilder sqlBuilder = new StringBuilder(sql);
    int offset = (page.getPageIndex() - 1) * page.getPageSize();
    sqlBuilder.append(" LIMIT ").append(offset).append(",").append(page.getPageSize());
    return sqlBuilder.toString();
}

省略部分代码......

不足之处

1、insertList生成的SQL（insert into table(c1,c2) values(1,2),(3,4)）无法通用。
2、分页插件仅支持Mysql和Oracle
3、会在代码中植入SQL语句，需要对组员进行规范。复杂SQL使用Mapper文件

数据库兼容性

使用mysql数据库进行的开发，所以都是根据mysql进行的开发。但是所有封装中除insertList外，其他都是用的标准SQL。所以理论上可以不用考虑数据库兼容性的问题，在批量插入时注意下就好。

结语

源码已经放到了GitHub，没啥难度，需要使用拷下来直接使用即可，就不写Demo了 。东西虽然不大，如果有什么问题、建议欢迎大家留言谈论，可以直接PR哦。

https://github.com/Mr-Yao/mybatis-base-CURD

Mr-Yao
关注
专栏目录
PHP---对crud进行封装
huyishero的博客
12-07 337
在php中，对数据库的crud操作，一般是封装成一个类进行。代码如下 class SqlTool{ private $conn; private $host="localhost";//连接的数据库地址 private $user="root"; //用户名 private $password="root"; //密码 private $db="worddb"; //操作的
mybatis的CRUD
du664754270的博客
06-21 210
《MyBatis的CRUD》 带着目标去学习，效果很不一样 学习目标 掌握sqlMapConfig.xml中常用标签 掌握mybatis框架在DAO层的开发 能够完成单表的CRUD操作 掌握mybatis框架的输入输出映射 回顾动态代理 代理模式的组成 作用：对真实角色功能的增强，真实角色和代理角色都是抽象角色的子类 抽象角色：定义了要实现的功能，通常使用接口。这个案例中就是UserMapper接口 真实角色：可以不存在的，这里没有 代理角色：也实现了接口中方法，使用动态代理来实现UserMapper
MyBatis封装简单的CRUD
weixin_33796205的博客
01-07 174
为什么80%的码农都做不了架构师？>>> ...
mybatis批量插入、mybatis-plus批量插入、mybatis实现insertList、mybatis自定义实现批量插入
最新发布
weixin_49114503的博客
07-24 2528
mybatis批量插入、mybatis-plus批量插入、mybatis实现insertList、mybatis自定义实现批量插入
基于SpringBoot框架的Mybatis的CRUD的简单封装
鱼儿@IT
02-24 659
众所周知，Mybatis的横空出世，打破了持久层暗箱操作的时代(Hibernate)，相对于Hibernate而言， 1. Mybatis对SQL是透明的； 2. 程序员不仅可以手动写特定的SQL(舒服呀！)，还能通过SQL优化性能，一箭双雕； 3. 具有高性能，映射，存储的特点，是一个比较不错的半自动化持久层的架构。 然而随着需求的剧增，Mapper文件中需要写的基本CRUD很多，想一想...
MyBatis小白入门CRUD与Mybatis工具类封装；
m0_45442261的博客
12-25 373
什么是框架？ 框架就是一个提供了可重用的公共结构的半成品。为构建新的应用程序提供便利，是可以拿来就用的工具，还提供了可重用的设计。 框架的优点 1）不用再考虑公共问题，框架已经做好了 2）可以专心于业务逻辑，保证核心业务逻辑的开发 3）结构统一，便于学习和维护 4）框架中集成了前人的经验，可以帮助新手写出稳定，性能优良而且结构优美的高质量程序。 当前主流框架 1.Struts 2.hibernate框架 3.spring 框架 什么是数据持有化 就是将内存中的数据模型转换成存储模型，以及将存储模型转换为内.
SpringBoot入门学习笔记-16-MyBatis-Plus通用CRUD方法封装
Java自学笔记-springBoot微服务
07-13 662
springboot封装mybatisPlus的通用CURD方法，实现在基础类对公用字段像创建者、创建时间等字段的处理。
MyBatis实现CRUD
C_r_ush的博客
11-16 98
MyBatis实现CRUD
mybatis:使用mybatis封装一些数据库操作
06-01
在实际开发中，MyBatis常被用来封装数据库操作，以实现更灵活、高效的数据库访问。本文将深入探讨如何使用MyBatis进行SQLite和MySQL数据库的封装。 一、MyBatis简介 MyBatis是由Google Code维护的开源项目，后迁移...
mybatis-universal-crud:基于mybatis的通用crud操作框架
05-14
该项目基于mybatis封装, 目前只支持mysql, 旨在提供一个对dao层通用的操作，支持普通java程序和spring程序. 1 特性： 关键字转义，防止sql注入； 注解支持； 查询, 普通条件查询, 连表查询, 懒加载; 更新, 替换更新...
mybatis基于Dao的crud操作源码
11-02
Mybatis 是一个轻量级的Java持久层框架，它提供了SQL映射框架，使得开发者能够直接编写SQL语句，而不必依赖于ORM（对象关系映射）工具。本项目是基于Mybatis进行DAO（Data Access Object）层的CRUD（Create、Read、...
MyBatis实现简单的CRUD，适合初学者
08-10
MyBatis实现简单的CRUD，适合初学者，包含了项目完整源码。
Springboot+Mybatis实现分页+CRUD
10-01
本篇文章将详细讲解如何利用Spring Boot和MyBatis实现分页查询以及基本的CRUD（创建、读取、更新、删除）操作。 首先，Spring Boot是Spring框架的简化版，它提供了自动配置、起步依赖和内嵌Web服务器等功能，大大...
Mybatis-Plus通用CRUD
LXZ_1024的博客
04-02 799
文章目录前言一、BaseMapper方法二、代码实现1.User对象类2.UserMapper接口3.配置文件4.方法调用1. 插入数据2. 根据id查询数据3. 根据id修改数据4. 修改数据5. 修改数据使用wrapper.set方法6. 根据map多条件删除数据7. 根据数据信息删除数据8.删除多条数据9.查询多条数据10.根据条件查询，只能一条条件11.根据条件查询数据条数12.根据条件查询数据信息13.测试分页查询 前言 我们了解到通过继承BaseMapper就可以获取到各种各样的单表操作，接下
02-MyBatis-CRUD-配置文件、参数封装、mybatisX插件、动态sql, 简单的用注解开发
树叶子的博客
02-28 515
SQL语句正常编写。
MyBatis框架实现CRUD操作
qq_66228897的博客
07-10 825
在持久层mybatis框架中，已经对JDBC进行深层次的封装，也就是底层原理已经是jdbc访问数据库的原理，但是只给用户暴露了必须要用户参与的部分，即SQL撰写部分！其他的操作，mybatis框架都已经做了基础封装！6. 处理结果集 while(resultset.next()){...}3. 获取执行计划 Statement、PrepareStatement。4. 执行SQL executeQuery、executeUpdate。5. 获取结果集 ResultSet。2. 创建SQL String。
Mybatis基础-CRUD
litengbin的博客
02-06 205
配置文件Category.xml 首先一次性修改配置文件Category.xml，提供CRUD对应的sql语句。 每个SQL如何使用在后续对应操作里一一讲解。 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"
mybatis-plus 2 —— CRUD 封装的使用
小水牛的博客
09-08 2421
mybatis-plus 2 —— CRUD 封装的使用前言CRUD 封装WrapperQueryWrapperUpdateWrapperIServicesavegetlistupdatesaveOrUpdateremovepage 前言 上一章节介绍了 MP 和 Springboot 的整合，以及 代码生成 的特性。本章节介绍 MP 对 CRUD 的封装，并结合大量 使用示例 帮助理解 CRUD 封装 MP 帮我们封装了 IService 和 BaseMapper，封装了全面完善的 CRUD 方法，因为我
MyBatis_MyBatis映射文件之实现基本的CURD
u013185175的博客
07-29 154
1.引入
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值