MyBatis模板化

最新推荐文章于 2024-06-26 15:51:32 发布
最新推荐文章于 2024-06-26 15:51:32 发布
阅读量4.4k 收藏 1
点赞数
分类专栏： 技术讨论
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/joycean/article/details/50358997
版权

MyBatis，这个优秀的持久层引擎让开发者在追求性能的同时可以集中维护SQL。虽然它已经提供了一些模板化的支持，然而在面对表结构变动以及复杂联合查询时，所产生的Mapper文件将会过度增长，让维护变得困难。我是一个懒惰的码猿，现在我们有了MyBatis Scripting for Freemarker/Velocity插件，是时候进一步简化我们的Mapper文件咯。在MyBatis引擎加载Mapper文件的时候，会调用脚本引擎解释特定标签，动态生成满足MyBatis XML语义的文本，然后交由MyBatis继续执行。在MyBatis官网给出的例子过于简单，经过摸索，我采用xml的include以及freemarker宏调用相结合，大幅简化了mapper文件。有了真正模板的支持，维护工作可能简单到只需维护字段定义了。代码骨架已发布到Github，宏代码经过测试，项目地址： https://github.com/Joycean/skeleton-mybatis-persistence

使用Freemarker模板之后，我们的Mapper文件看起来是这样子的：

<?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="<span style="font-family: Arial, Helvetica, sans-serif;">skeleton.persistence</span><span style="font-family: Arial, Helvetica, sans-serif;">.persistence.mapper.UserMapper"></span>
    
    <sql id="def">
    <![CDATA[
        <#assign tableName = 'Users'>
        <#include 'common.ftl'>
    ]]>
    </sql>
    
    <insert id="insert" parameterType="User">
        <include refid="def"/><![CDATA[<@insert />]]>
    </insert>
    
    <update id="update" parameterType="User">
        <include refid="def"/><![CDATA[<@update />]]>
    </update>
    
    <update id="delete" parameterType="User">
        <include refid="def"/><![CDATA[<@delete />]]>
    </update>
    
    <select id="get" parameterType="long" resultType="User">
        <include refid="def"/><![CDATA[<@get />]]>
    </select>
    
    <select id="count" parameterType="map" resultType="int">
        <include refid="def"/><![CDATA[<@count />]]>
    </select>
    
    <select id="select" parameterType="map" resultType="User">
        <include refid="def"/><![CDATA[<@select />]]>
    </select>
    
</mapper>
/*=======分割线========*/
而在使用Freemarker之前，我们的Mapper看起来可能是这样子的： 

<?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.seefond.server.persistence.mapper.UserMapper">
    
    <sql id="tableName">t_user</sql>
    
    <sql id="insertColumns">
        company_id,login_name,real_name,employee_no,password,mobile,email,title,introduction,
        last_login,role,last_device_id,enabled
    </sql>
    
    <sql id="insertValues">
        #{companyId,javaType=long,jdbcType=BIGINT},
        #{loginName,javaType=String,jdbcType=VARCHAR},
        #{realName,javaType=String,jdbcType=VARCHAR},
        #{employeeNo,javaType=String,jdbcType=VARCHAR},
        #{password,javaType=String,jdbcType=VARCHAR},
        #{mobile,javaType=String,jdbcType=VARCHAR},
        #{email,javaType=String,jdbcType=VARCHAR},
        #{title,javaType=String,jdbcType=VARCHAR},
        #{introduction,javaType=String,jdbcType=VARCHAR},
        #{lastLogin,javaType=Date,jdbcType=TIMESTAMP},
        #{role,javaType=int,jdbcType=TINYINT},
        #{lastDeviceId,javaType=long,jdbcType=BIGINT},
        #{enabled,javaType=boolean,jdbcType=TINYINT}
    </sql>
    
    <sql id="updateColumnValues">
        company_id=#{companyId,javaType=long,jdbcType=BIGINT},
        login_name=#{loginName,javaType=String,jdbcType=VARCHAR},
        real_name=#{realName,javaType=String,jdbcType=VARCHAR},
        employee_no=#{employeeNo,javaType=String,jdbcType=VARCHAR},
        password=#{password,javaType=String,jdbcType=VARCHAR},
        mobile=#{mobile,javaType=String,jdbcType=VARCHAR},
        email=#{email,javaType=String,jdbcType=VARCHAR},
        title=#{title,javaType=String,jdbcType=VARCHAR},
        introduction=#{introduction,javaType=String,jdbcType=VARCHAR},
        last_login=#{lastLogin,javaType=Date,jdbcType=TIMESTAMP},
        role=#{role,javaType=int,jdbcType=TINYINT},
        last_device_id=#{lastDeviceId,javaType=long,jdbcType=BIGINT},
        enabled=#{enabled,javaType=boolean,jdbcType=TINYINT}
    </sql>
    
    <sql id="selectAliases">
        company_id companyId,
        login_name loginName,
        real_name realName,
        employee_no employeeNo,
        password password,
        mobile mobile,
        email email,
        title title,
        introduction introduction,
        last_login lastLogin,
        role role,
        last_device_id lastDeviceId,
        enabled enabled
    </sql>
    
    <sql id="selectCriteria">
        <if test="criteria.companyId != null">
            AND company_id=#{criteria.companyId,javaType=long,jdbcType=BIGINT}
        </if>
        <if test="criteria.loginName != null">
            AND login_name=#{criteria.loginName,javaType=String,jdbcType=VARCHAR}
        </if>
        <if test="criteria.realName != null">
            AND real_name LIKE #{criteria.realName,javaType=String,jdbcType=VARCHAR}
        </if>
        <if test="criteria.employeeNo != null">
            AND employee_no=#{criteria.employeeNo,javaType=String,jdbcType=VARCHAR}
        </if>
        <if test="criteria.mobile != null">
            AND mobile=#{criteria.mobile,javaType=String,jdbcType=VARCHAR}
        </if>
        <if test="criteria.email != null">
            AND email LIKE #{criteria.email,javaType=String,jdbcType=VARCHAR}
        </if>
        <if test="criteria.title != null">
            AND title LIKE #{criteria.title,javaType=String,jdbcType=VARCHAR}
        </if>
        <if test="criteria.role != null">
            AND role=#{criteria.role,javaType=int,jdbcType=TINYINT}
        </if>
        <if test="criteria.lastDeviceId != null">
            AND last_device_id=#{criteria.lastDeviceId,javaType=long,jdbcType=BIGINT}
        </if>
        <if test="criteria.enabled != null">
            AND enabled=#{criteria.enabled,javaType=boolean,jdbcType=TINYINT}
        </if>
    </sql>
    
    <select id="getByLoginName" parameterType="map" resultType="User">
        SELECT 
            <include refid="com.seefond.server.persistence.mapper.BaseMapper.commonSelectAliases"/>
            <include refid="selectAliases"/>
        FROM t_user WHERE deleted=0 AND login_name=#{loginName} AND company_id=#{companyId} 
    </select>
    
    <select id="getSubordinateUsersInManagedStores" parameterType="long" resultType="User">
        SELECT 
            <include refid="com.seefond.server.persistence.mapper.BaseMapper.commonSelectAliases"/>
            <include refid="selectAliases"/>
        FROM  (
        <![CDATA[
          SELECT u2.* FROM 
          t_user u1,
          t_store_user su1,
          t_store_user su2,
          t_user u2
          WHERE u1.id=#{id}
          AND u1.id=su1.user_id
          AND su1.store_id=su2.store_id
          AND su2.user_id=u2.id
          AND u2.role < u1.role
          AND u1.deleted=0
          AND u2.deleted=0
          AND su1.deleted=0
          AND su2.deleted=0
        ]]>
          ) _T ORDER BY role DESC, employeeNo
    </select>
    
    <select id="getSubordinateUsersInManagedStore" parameterType="map" resultType="User">
        SELECT 
            <include refid="com.seefond.server.persistence.mapper.BaseMapper.commonSelectAliases"/>
            <include refid="selectAliases"/>
        FROM  (
        <![CDATA[
          SELECT u2.* FROM 
          t_user u1,
          t_store_user su1,
          t_store_user su2,
          t_user u2
          WHERE u1.id=#{userId,javaType=long,jdbcType=BIGINT}
          AND u1.id=su1.user_id
          AND su1.store_id=#{storeId,javaType=long,jdbcType=BIGINT}
          AND su1.store_id=su2.store_id
          AND su2.user_id=u2.id
          AND u2.role < u1.role
          AND u1.deleted=0
          AND u2.deleted=0
          AND su1.deleted=0
          AND su2.deleted=0
        ]]>
          ) _T ORDER BY role DESC, employeeNo
    </select>
    
    <select id="getByStoreId" parameterType="long" resultType="User">
        SELECT 
            <include refid="com.seefond.server.persistence.mapper.BaseMapper.commonSelectAliases"/>
            <include refid="selectAliases"/>
        FROM  (
        <![CDATA[
          SELECT u.* FROM 
          t_user u,
          t_store_user su
          WHERE u.id=su.user_id
          AND su.store_id=#{storeId,javaType=long,jdbcType=BIGINT}
          AND u.deleted=0
          AND su.deleted=0
        ]]>
          ) _T ORDER BY role DESC, employeeNo
    </select>
    
    <insert id="insert" parameterType="User" useGeneratedKeys="true" keyProperty="id">
        <include refid="com.seefond.server.persistence.mapper.BaseMapper.commonInsertWithAutoIdStatement"/>
    </insert>
    
    <update id="update" parameterType="User">
        <include refid="com.seefond.server.persistence.mapper.BaseMapper.commonUpdateStatement"/>
    </update>
    
    <update id="delete" parameterType="User">
        <include refid="com.seefond.server.persistence.mapper.BaseMapper.commonDeleteStatement"/>
    </update>
    
    <delete id="purge" parameterType="User">
        <include refid="com.seefond.server.persistence.mapper.BaseMapper.commonPurgeStatement"/>
    </delete>
    
    <select id="get" parameterType="long" resultType="User">
        <include refid="com.seefond.server.persistence.mapper.BaseMapper.commonGetStatement"/>
    </select>
    
    <select id="count" parameterType="map" resultType="int">
        <include refid="com.seefond.server.persistence.mapper.BaseMapper.commonCountByCriteriaStatement"/>
    </select>
    
    <select id="select" parameterType="map" resultType="User">
        <include refid="com.seefond.server.persistence.mapper.BaseMapper.commonSelectByCriteriaStatement"/>
    </select>

    
    <sql id="isolationFilter">
        id=#{isolationId,javaType=long,jdbcType=BIGINT}
    </sql>
    
    <insert id="syncInsert" parameterType="User">
        <include refid="com.seefond.server.persistence.mapper.SyncableMapper.commonSyncInsertStatement"/>
    </insert>
    
    <update id="syncUpdate" parameterType="User">
        <include refid="com.seefond.server.persistence.mapper.SyncableMapper.commonSyncUpdateStatement"/>
    </update>
    
    <update id="syncDelete" parameterType="User">
        <include refid="com.seefond.server.persistence.mapper.SyncableMapper.commonSyncDeleteStatement"/>
    </update>
    
    <select id="getIdsByStatus" parameterType="map" resultType="long">
        <include refid="com.seefond.server.persistence.mapper.SyncableMapper.commonChangedStoreBasedIdSelectStatement"/>
    </select>
    
    <select id="getItemsByStatus" parameterType="map" resultType="User">
        <include refid="com.seefond.server.persistence.mapper.SyncableMapper.commonChangedStoreBasedItemSelectStatement"/>
    </select>
    
</mapper>

细心的读者可能会说两个Mapper定义的方法不一样，不可比。这两个文件均来自真实项目，而重点是我们可以看到Freemarker已将我们从繁琐的<sql>片段中解脱了。当然，为了迎合mapper xml的语法规约，现在还做不到极简。如果MyBatis在将来弱化xml的schema限制，比如取消<select><update><resultMap>等标签限制，我们可以让事情极简。虽然现在已经可以完全使用原生模板，但插件引擎只支持到方法级，一个方法一个模板文件，不实用。希望这个偷懒方法对你有用。






joycean
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
MyBatisPlus代码生成器自定义模板时的模板文件
04-25
MyBatisPlus代码生成器自定义模板时的模板文件
spring+mybatis模板
12-19
这个模板可以帮助开发者快速搭建基于 Spring 和 MyBatis 的项目，节省初始化时间，提高开发效率。对于初学者来说，这是一个很好的学习资源，可以了解如何整合这两个框架以及它们在实际项目中的应用。对于有经验的...
mybatis sql模板
weixin_30414245的博客
09-20 238
<?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" > <!--与xml对应的dao层类 --> <ma...
10 种超赞的 MyBatis 写法！
最新发布
犬小哈
06-26 53
来源：blog.csdn.net/smile_lg/article/details/71215619???? 欢迎加入小哈的星球，你将获得:专属的项目实战 /1v1 提问/Java 学习路线 /学习打卡/每月赠书/社群讨论新项目:《从零手撸：仿小红书（微服务架构）》正在持续爆肝中，基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17.....
MyBatis使用模板
毕业势必进大厂的博客
11-02 220
我们创建一个新的项目MyBatis-second 创建步骤参考​​​​​​MyBatis框架快速入门（四天学会MyBatis之第二天）_ypxcan的博客-CSDN博客 然后在第六步，我们需要创建一个mapper文件来写sql语句，在这个文件里面，只有你写的sql语句是自己写的，其他都是不变的，这样我们就可以创建一个mapper文件模板 创建步骤： 第一步，我们来准备好模板 <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE
Mybatis常用模板
yangshuai_csdn的博客
03-22 772
log4j.properties 模板文件 # Set root category priority to INFO and its only appender to CONSOLE. #log4j.rootCategory=INFO, CONSOLE debug info warn error fatal log4j.rootCategory=debug, CO...
mybatis generator修改默认生成的sql模板
weixin_33892359的博客
11-14 451
本文转自 小眼儿 博客园博客，原文链接：http://www.cnblogs.com/hujunzheng/p/7110510.html，如需转载请自行联系原作者 ...
mybatis-plus自定义模板.zip
05-28
然而，有时候我们可能需要根据项目需求进行一些定制化，比如修改生成模板，以满足特定格式或业务逻辑。这就是“自定义模板”功能的用武之地。 在标题中提到的"mybatis-plus自定义模板.zip"文件，很可能包含了一套...
mybatis模板生成器
03-27
MyBatis模板生成器是一款强大的工具，用于自动化MyBatis框架中的代码生成过程，从而显著提高开发效率。这款工具能够根据用户配置自动生成基于MyBatis的DAO、Mapper接口、Mapper XML文件以及实体类，极大地减少了手动...
mybatis plus 模板文件
03-02
1. **自动化 CRUD 操作**：MyBatis Plus 提供了基于注解或XML的CRUD操作，通过简单的配置或注解，就可以实现对数据库的基本操作，如插入（insert）、更新（update）、删除（delete）、查询（select）。 2. **条件...
mybatis代码模板
12-26
在IT行业中，ORM(Object-Relational Mapping)是一种重要的技术，它允许程序员以面向对象的方式处理数据库，从而减少了数据库操作的复杂性...通过理解这些概念和实践，开发者可以更好地利用MyBatis进行数据持久化操作。
mybatis自动生成代码模板
09-29
包含mybatis-generator1.3.2的jar包、mysql数据库连接jar包、mybatis3.2.7.jar以及自动生成代码的配置文件模板。
MyBatis的SQL片段与模板
禅与计算机程序设计艺术
01-21 326
1.背景介绍 MyBatis是一款流行的Java持久层框架，它可以简化数据库操作，提高开发效率。在MyBatis中，我们可以使用SQL片段和模板来实现复杂的查询和更新操作。本文将详细介绍MyBatis的SQL片段与模板，并提供实际应用场景和最佳实践。 1.背景介绍 MyBatis是基于Java的持久层框架，它可以简化数据库操作，提高开发效率。MyBatis的核心功能是将SQL语句与Java代...
MyBatis - 04 - 设置mybatis-config.xml、xxxMapper.xml配置文件模版
qq_39413850的博客
02-26 296
设置配置文件模板、MyBatis获取参数值的两种方式、@Param源码分析
mybatis的xml文件模板
qq_44339639的博客
10-07 96
【代码】mybatis的xml文件模板。
一个Mybatis的简单模板（绝对能成功运行）
qq_35146979的博客
10-19 1379
Hello,大家好我是酷酷的奇锋，最近正在研究SSM（Spring+SpringMvc+Mybatis），所以我要研究一下这些技术，并且同步分享给大家，当然了，在研究这些技术的时候会有很多陷阱，想在网上寻找资源，但是很多资源都太片面了，不能实际解决问题，为此我有点小小的愤怒，想做良心的博客，并且呼吁大家一起来做这样的事情，我会根据程序搭建过程中的一些问题进行总结，并且把所有的资源都放在云盘上面方便
Mybatis的案例和接口代理开发和模板配置
黑某人
06-25 939
Mybatis的简单入门案例 一、框架的简介和Mybatis简介 ​ 框架就是一个半成品，在框架的基础上进行开发可以大大的提高开发效率，减少代码量。 ​ 框架就相当于地基，使用框架开发就相当于在地基上添砖加瓦即可。 ​ Dbutils：数据库工具类 ​ 工具类和框架的区别： ​ 工具类：是某种功能的代码封装 ​ 框架：是对开发某层的深度封装。 ​ 例如：Mybatis是对Dao层的深度封装 ​ 三层架构 ​ 为什么要使用分层开发？ ​ 降低开发难度，提高效率，实现模块间的解耦。 ​ 耦
Mybatis中Mapper.xml详解
weixin_42113716的博客
10-14 972
Mybatis中Mapper.xml详解
模板引擎介绍
鹏霄万里展雄飞
01-05 5535
模板引擎，是指利用某种模板语言将页面制成模板，再依据业务逻辑将该模板语言翻译成业务数据，从而生成最终展示页面。其目的就是要把页面与业务数据实现彻底分离。它不属于特定技术领域，而是跨领域跨平台的概念。在Asp、Jsp下有模板引擎，在PHP下也有模板引擎，在C#下也有，甚至JavaScript、WinForm开发都会用到模板引擎技术。 模板引起根据原理可分为：置换型、解释型、编译型。 模板引擎不仅
自定义Mybatis Generator模板及配置详解
"这篇文档介绍了如何使用两种方法配置和运行Mybatis Generator，以自定义生成模板文件，并在项目中集成该工具。" Mybatis Generator 是一个强大的代码生成工具，能够帮助开发者自动生成Mybatis相关的Java实体类、...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值