mybatis條件判斷及動態sql的簡單拓展

来源:https://www.cnblogs.com/menghl/p/18242539
-Advertisement-
Play Games

在MyBatis中,可以通過使用一些特定的標簽(if、choose...)以及其他動態SQL功能來實現條件判斷。 這使得SQL查詢可以根據不同的條件動態生成,從而提高查詢的靈活性和可維護性。 本文以訂單列表簡單查詢為例, 對mybatis條件判斷及動態sql進行簡單拓展。 建表語句 CREATE T ...


在MyBatis中,可以通過使用一些特定的標簽(if、choose...)以及其他動態SQL功能來實現條件判斷。
這使得SQL查詢可以根據不同的條件動態生成,從而提高查詢的靈活性和可維護性。
本文以訂單列表簡單查詢為例, 對mybatis條件判斷及動態sql進行簡單拓展。

建表語句

CREATE TABLE order_table (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '訂單序號',
  `order_type` varchar(255) NULL COMMENT '訂單類型',
  `status` varchar(255) NULL COMMENT '訂單狀態',
  `customer_id` bigint(20) NULL COMMENT '所屬客戶id',
  `quantity` double NULL COMMENT '數量',
  `address` varchar(500) NULL COMMENT '收貨地',
  PRIMARY KEY (`id`)
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_bin COMMENT = '訂單表';

條件判斷及動態sql

以if標簽為例,if標簽類似於 Java 中的 if 語句, 是mybatis中最常用的判斷標簽。

語法
<if test="判斷條件">
  SQL語句
</if>
簡單使用
判斷數值:
<if test="id != null ">
 and id = #{id,jdbcType=BIGINT}
</if>
判斷字元:
// 判斷是否為空
<if test="orderType != null and orderType.trim().length() > 0">
 sql語句
</if>
// 判斷是否包含某個字元
<if test="orderType != null and orderType eq 'customer'">
 sql語句
</if>
判斷集合:
<if test="idSet != null and idSet.size > 0">
  and id in
  <foreach collection="idSet" item="item" separator="," open="(" close=")">
    #{item}
  </foreach>
</if>

簡單拓展

if標簽與常用Java工具類結合

// 判空
<if test="@java.util.Objects@nonNull(customerId)">
    sql語句
</if>
<if test="@org.apache.commons.lang3.StringUtils@isNotBlank(status)">
  sql語句
</if>
// 判斷是否相等
<if test="@java.util.Objects@equals(1,flag)">
    sql語句
</if>
<if test='@org.apache.commons.lang3.StringUtils@equals("customer",status)' >
  sql語句
</if>
// 判斷集合是否為空
<if test="@org.apache.commons.collections.CollectionUtils@isNotEmpty(idSet)">
    and id in
    <foreach collection="idSet" item="item" open="(" close=")" separator=",">
        #{item}
    </foreach>
</if>
同理
// 判斷兩個欄位同時不為空
<if test="@org.apache.commons.lang3.ObjectUtils@allNotNull(flag1,flag2)">
  sql語句
</if>
// 判斷集合中只要包含某一個欄位
<if test="@org.apache.commons.collections.CollectionUtils@containsAny(flagList, "1")">
  sql語句
</if>
等等...

同理, 別的標簽也適用;

對查詢欄位的特殊處理

列表查詢中,有時需要對某些欄位做特殊的處理查詢, 例: 對數值欄位進行特殊處理查詢(>、<、>=、<=、!=), 對某些文本欄位的查詢做特殊處理..., 我們可以巧用占位符來實現這些處理。
在MyBatis中,# 和 $ 是兩種不同的占位符,用於在SQL語句中插入參數。

占位符:用於安全的參數綁定和轉義,防止SQL註入,適用於大多數情況。
$ 占位符:用於直接文本替換,不進行轉義,適用於動態SQL片段或表名等非用戶輸入的值,但要特別註意SQL註入風險。
通過合理使用這兩種占位符,可以在確保全全的前提下實現靈活的SQL查詢。

數值欄位特殊處理

新建枚舉類(OperationFlagEnum), 事先與前端規定操作符的傳遞;
操作符枚舉

/**
 * 操作標識枚舉
 * 
 * @author alin
 * @date 2024-06-11
 */
@Getter
@AllArgsConstructor
public enum OperationFlagEnum {

    EQUAL("EQUAL", "="),
    NOT_EQUAL("NOT_EQUAL", "!="),
    LARGER("LARGER", ">"),
    LESS("LESS", "<"),
    LARGER_OR_EQUAL("LARGER_OR_EQUAL", ">="),
    LESS_OR_EQUAL("LESS_OR_EQUAL", "<=");

    private String code;
    private String value;

    private static final Map<String, OperationFlagEnum> VALUE_MAP = new HashMap<>(values().length);

    static {
        Arrays.stream(OperationFlagEnum.values()).forEach(c -> VALUE_MAP.put(c.getCode(), c));
    }

    public static OperationFlagEnum getByCode(String code) {
        return StringUtils.isBlank(code) ? null : VALUE_MAP.get(code);
    }

    public static String getValueByCodeDefault(String code) {
        OperationFlagEnum flagEnum = null;
        if(StringUtils.isNotEmpty(code)){
            flagEnum = getByCode(code);
        }
        return flagEnum == null ? EQUAL.getValue(): flagEnum.value;
    }

}

mapper文件中的動態sql

<if test="quantity != null">
    and quantity
    ${@com.vx.tms.common.enums.OperationFlagEnum@getValueByCodeDefault(quantityFlag)}
    ${quantity}
</if>

文本欄位特殊處理

若文本欄位中含有某些特殊字元, 則對這個欄位進行特殊處理, 例: 若某些欄位值中間含有空格(或別的字元), 則對此欄位用空格切割後進行範圍查詢;
新建mapper工具類: MapperUtils, 用於特殊處理;

/**
 * @author alin
 * @date 2024-06-11
 */
public class Mapperutils {
    private static final String SPACE = " ";
    public static final String EQUALS = " = #{${propertyField},jdbcType=VARCHAR}";

    public static final String IN = " in ('${propertyField}')";

    /**
     * 獲取通用字元串查詢模板
     *
     * @param propertyField model欄位屬性
     * @param value         對應值
     * @return
     */
    public static String getQuery(String propertyField, String value) {
        if (StringUtils.contains(value.trim(), SPACE)) {
            // sql註入過濾
            sqlInject(value);
            return replace(IN, StringUtils.join(StringUtils.split(value, SPACE), "','"));
        } else if(...) {
            .....
        }
        //sql註入過濾
        sqlInject(value);
        //等值查詢
        return replace(EQUALS, propertyField);
    }

    /**
     * 替代
     *
     * @param type
     * @param propertyField
     * @return
     */
    public static String replace(String type, String propertyField) {
        Map<String, Object> params = Maps.newHashMap();
        params.put("propertyField", propertyField);
        return new StrSubstitutor(params).replace(type);
    }

    /**
     * SQL註入過濾
     *
     * @param str 待驗證的字元串
     * @throws
     */
    public static void sqlInject(String str) {
        if (StringUtils.isBlank(str)) {
            return;
        }
        //去掉'|"|;|\字元
        str = StringUtils.replace(str, "'", "");
        str = StringUtils.replace(str, "\"", "");
        str = StringUtils.replace(str, ";", "");
        str = StringUtils.replace(str, "\\", "");

        //轉換成小寫
        str = str.toLowerCase();

        //非法字元
        String[] keywords = {"master", "truncate", "insert", "select", "delete", "update", "declare", "alert", "create", "drop"};

        //判斷是否包含非法字元
        for (String keyword : keywords) {
            if (str.contains(keyword)) {
                throw new RuntimeException("查詢輸入條件存在非法字元!");
            }
        }
    }
}

mapper文件中的動態sql

<if test="@org.apache.commons.lang3.StringUtils@isNotBlank(address)">
  and ord.address ${@com.vx.tms.common.utils.MapperHelp@getQuery("ord.address",address)}
</if>

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 這篇文章介紹瞭如何在Vue 3項目中配置ESLint和Prettier以統一代碼風格,實現代碼規範性與可讀性的提升。通過設置規則、解決衝突、以及將配置融入持續集成流程和代碼審查過程,確保團隊協作時代碼風格的一致性,提升開發效率與項目維護性。 ...
  • 基於Vue-Cli創建 現在官方推薦使用 create-vue 來創建基於 Vite 的新項目(⚠️ Vue CLI 現已處於維護模式!) # 查看@vue/cli版本號,確保@vue/cli版本在4.5.0以上 vue --version # 沒有安裝@vue/cil或者版本不在4.5.0以上執行 ...
  • 寫在前面 這是PB案例學習筆記系列文章的第5篇,該系列文章適合具有一定PB基礎的讀者。 通過一個個由淺入深的編程實戰案例學習,提高編程技巧,以保證小伙伴們能應付公司的各種開發需求。 文章中設計到的源碼,小凡都上傳到了gitee代碼倉庫https://gitee.com/xiezhr/pb-proje ...
  • Cursor 是一個基於 Visual Studio Code(VS Code)技術構建的高級代碼編輯器,專為提高編程效率並更深度地整合 AI 功能而設計。它不僅繼承了 VS Code 的強大功能和用戶界面,還增加了專門針對 AI 支持的特色功能。Cursor 是 VS Code 的一個分支,這意味... ...
  • 1 maven介紹 1)為什麼使用maven Maven是一個強大的項目管理和構建工具,它能夠簡化Java項目的構建、依賴管理和發佈過程。以下是Maven的一些主要特點和功能: 項目結構管理:Maven採用約定優於配置的原則,提供了標準的項目結構模板,使得開發人員可以快速創建和維護項目。 依賴管理: ...
  • NumPy 中的簡單算術運算可以通過 `add`, `subtract`, `multiply`, `divide`, `power`, `mod`, `remainder` 等函數實現,這些函數支持條件運算,並接受 `where` 參數。例如,`add()` 實現加法,`subtract()` 表... ...
  • JSON 簡介 JSON(JavaScript Object Notation,JavaScript對象表示法)是一種輕量級的數據交換格式。它基於ECMAScript(歐洲電腦製造商協會制定的js規範)的一個子集,採用完全獨立於編程語言的文本格式來存儲和表示數據。簡潔和清晰的層次結構使得JSON成 ...
  • 關註作者,復旦AI博士,分享AI領域與雲服務領域全維度開發技術。擁有10+年互聯網服務架構、AI產品研發經驗、團隊管理經驗,同濟本復旦碩博,復旦機器人智能實驗室成員,國家級大學生賽事評審專家,發表多篇SCI核心期刊學術論文,阿裡雲認證的資深架構師,項目管理專業人士,上億營收AI產品研發負責人。 精講 ...
一周排行
    -Advertisement-
    Play Games
  • 通過WPF的按鈕、文本輸入框實現了一個簡單的SpinBox數字輸入用戶組件並可以通過數據綁定數值和步長。本文中介紹了通過Xaml代碼實現自定義組件的佈局,依賴屬性的定義和使用等知識點。 ...
  • 以前,我看到一個朋友在對一個系統做初始化的時候,通過一組魔幻般的按鍵,調出來一個隱藏的系統設置界面,這個界面在常規的菜單或者工具欄是看不到的,因為它是一個後臺設置的關鍵界面,不公開,同時避免常規用戶的誤操作,它是作為一個超級管理員的入口功能,這個是很不錯的思路。其實Winform做這樣的處理也是很容... ...
  • 一:背景 1. 講故事 前些天有位朋友找到我,說他的程式每次關閉時就會自動崩潰,一直找不到原因讓我幫忙看一下怎麼回事,這位朋友應該是第二次找我了,分析了下 dump 還是挺經典的,拿出來給大家分享一下吧。 二:WinDbg 分析 1. 為什麼會崩潰 找崩潰原因比較簡單,用 !analyze -v 命 ...
  • 在一些報表模塊中,需要我們根據用戶操作的名稱,來動態根據人員姓名,更新報表的簽名圖片,也就是電子手寫簽名效果,本篇隨筆介紹一下使用FastReport報表動態更新人員簽名圖片。 ...
  • 最新內容優先發佈於個人博客:小虎技術分享站,隨後逐步搬運到博客園。 創作不易,如果覺得有用請在Github上為博主點亮一顆小星星吧! 博主開始學習編程於11年前,年少時還只會使用cin 和cout ,給單片機點點燈。那時候,類似async/await 和future/promise 模型的認知還不是 ...
  • 之前在阿裡雲ECS 99元/年的活動實例上搭建了一個測試用的MINIO服務,以前都是直接當基礎設施來使用的,這次準備自己學一下S3相容API相關的對象存儲開發,因此有了這個小工具。目前僅包含上傳功能,後續計劃開發一個類似圖床的對象存儲應用。 ...
  • 目錄簡介快速入門安裝 NuGet 包實體類User資料庫類DbFactory增刪改查InsertSelectUpdateDelete總結 簡介 NPoco 是 PetaPoco 的一個分支,具有一些額外的功能,截至現在 github 星數 839。NPoco 中文資料沒多少,我是被博客園群友推薦的, ...
  • 前言 前面使用 Admin.Core 的代碼生成器生成了通用代碼生成器的基礎模塊 分組,模板,項目,項目模型,項目欄位的基礎功能,本篇繼續完善,實現最核心的模板生成功能,並提供生成預覽及代碼文件壓縮下載 準備 首先清楚幾個模塊的關係,如何使用,簡單畫一個流程圖 前面完成了基礎的模板組,模板管理,項目 ...
  • 假設需要實現一個圖標和文本結合的按鈕 ,普通做法是 直接重寫該按鈕的模板; 如果想作為通用的呢? 兩種做法: 附加屬性 自定義控制項 推薦使用附加屬性的形式 第一種:附加屬性 創建Button的附加屬性 ButtonExtensions 1 public static class ButtonExte ...
  • 在C#中,委托是一種引用類型的數據類型,允許我們封裝方法的引用。通過使用委托,我們可以將方法作為參數傳遞給其他方法,或者將多個方法組合在一起,從而實現更靈活的編程模式。委托類似於函數指針,但提供了類型安全和垃圾回收等現代語言特性。 基本概念 定義委托 定義委托需要指定它所代表的方法的原型,包括返回類 ...