手把手教你如何擴展(破解)mybatisplus的sql生成

来源:https://www.cnblogs.com/Jcloud/archive/2023/11/13/17823637.html
-Advertisement-
Play Games

眾所周知,mybatisplus提供了強大的代碼生成能力,他預設生成的常用的CRUD方法(例如插入、更新、刪除、查詢等)的定義,能夠幫助我們節省很多體力勞動 ...


mybatisplus 的常用CRUD方法

眾所周知,mybatisplus提供了強大的代碼生成能力,他預設生成的常用的CRUD方法(例如插入、更新、刪除、查詢等)的定義,能夠幫助我們節省很多體力勞動。

他的BaseMapper中定義了這些常用的CRUD方法,我們在使用時,繼承這個BaseMapper類就預設擁有了這些能力。

BaseMapper.png

如果我們的業務中,需要類似的通用Sql時,該如何實現呢?

是每個Mapper中都定義一遍類似的Sql嗎?

顯然這是最笨的一種方法。

此時我們可以藉助mybatisplus這個成熟框架,來實現我們想要的通用Sql。

擴展常用CRUD方法

新增一個通用sql

比如有一個這樣的需求,項目中所有表或某一些表,都要執行一個類似的查詢,如`SelectByErp`,那麼可以這樣實現。(這是一個最簡單的sql實現,使用時可以根據業務需求實現更為複雜的sql:比如多租戶系統自動增加租戶id參數、分庫分表系統增加分庫分表欄位條件判斷)

  1. 定義一個SelectByErp類,繼承AbstractMethod類,並實現injectMappedStatement方法

  2. 定義sql方法名、sql模板、實現sql的拼接組裝

/**
 * 新增一個通用sql
 */
public class SelectByErp extends AbstractMethod {
     // 需要查詢的列名
    private final String erpColumn = "erp";
    // sql方法名
    private final String method = "selectByErp";
    // sql模板
    private final String sqlTemplate = "SELECT %s FROM %s WHERE %s=#{%s} %s";

    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
       	// 獲取需要查詢的欄位名及屬性名
        TableFieldInfo erpFiled = getErpProperty(tableInfo);
        // 拼接組裝sql
        SqlSource sqlSource = new RawSqlSource(configuration, String.format(sqlTemplate,
                sqlSelectColumns(tableInfo, false),
                tableInfo.getTableName(), 
                erpFiled.getColumn(), erpFiled.getProperty(),
                tableInfo.getLogicDeleteSql(true, false)), Object.class);
        return this.addSelectMappedStatementForTable(mapperClass, method, sqlSource, tableInfo);
}
	/**
     * 查詢erp列信息
     */
    private TableFieldInfo getErpProperty(TableInfo tableInfo) {
        List<TableFieldInfo> fieldList = tableInfo.getFieldList();
        TableFieldInfo erpField = fieldList.stream().filter(filed -> filed.getColumn().equals(erpColumn)).findFirst().get();
        return erpField;
    }

3.定義一個sql註入器GyhSqlInjector,添加SelectByErp對象

// 需註入到spring容器中
@Component
public class GyhSqlInjector extends DefaultSqlInjector {    
    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
        List<AbstractMethod> methodList = super.getMethodList(mapperClass);
        // 增加 SelectByErp對象,程式啟動後自動載入
        methodList.add(new SelectByErp());
        return methodList;
    }
}

4.定義一個基礎MapperGyhBaseMapper,添加selectByErp方法

/**
 * 自定義的通用Mapper
 */
public interface GyhBaseMapper<T> extends BaseMapper<T> {
    List<T> selectByErp(String erp);
}

5.應用中需要使用該SelectByErp方法的表,都繼承GyhBaseMapper,那麼這些表將都擁有了selectByErp這個查詢方法,程式啟動後會自動為這些表生成該sql。

public interface XXXMapper extends GyhBaseMapper<XXXTable> 

添加一個mybatisplus已有sql

1.mybatisplus 常用CRUD方法如最上圖,這些方法已經預設會自動生成,但mybatisplus其實提供了更多的方法,如下圖,只要我們在啟動時添加進去,就可以使用了。

method.png

2.比如我想使用AlwaysUpdateSomeColumnById方法,該方法可以在更新時只更新我需要的欄位,不進行全欄位更新。添加步驟如下。

3.定義一個sql註入器 ,如GyhSqlInjector,添加AlwaysUpdateSomeColumnById對象

@Component
public class GyhSqlInjector extends DefaultSqlInjector {    
    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
        List<AbstractMethod> methodList = super.getMethodList(mapperClass);
        // 添加 AlwaysUpdateSomeColumnById 對象
        methodList.add(new AlwaysUpdateSomeColumnById());
        return methodList;
    }
}

4.定義一個基礎Mapper 如GyhBaseMapper,添加alwaysUpdateSomeColumnById方法

/**
 * 自定義的通用Mapper
 */
public interface GyhBaseMapper<T> extends BaseMapper<T> {
    int alwaysUpdateSomeColumnById(@Param(Constants.ENTITY) T entity);
}

5.繼承GyhBaseMapper的其他Mapper,將自動擁有alwaysUpdateSomeColumnById方法

/**
 * 自定義的通用Mapper
 */
public interface GyhBaseMapper<T> extends BaseMapper<T> {
    int alwaysUpdateSomeColumnById(@Param(Constants.ENTITY) T entity);
}


6.繼承GyhBaseMapper的其他Mapper,將自動擁有alwaysUpdateSomeColumnById方法

編輯一個mybatisplus已有sql

1.如果想編輯一個mybatisplus已有sql,比如分庫分表系統,執行updateById操作時,雖然主鍵Id已確定,但目標表不確定,此時可能導致該sql在多張表上執行,造成資源浪費,並且分庫分表欄位不可修改,預設的updateById不能用,需要改造。以下以shardingsphere分庫分表為例。

2.定義一個UpdateByIdWithSharding類,繼承UpdateById

public class UpdateByIdWithSharding extends UpdateById {
    private String columnDot = "`";
    private YamlShardingRuleConfiguration yamlShardingRuleConfiguration;
    // 註入shardingsphere的分庫分表配置信息
    public UpdateByIdWithSharding(YamlShardingRuleConfiguration yamlShardingRuleConfiguration) {
        this.yamlShardingRuleConfiguration = yamlShardingRuleConfiguration;
    }

    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
        String tableName = tableInfo.getTableName();
        // shardingsphere 分庫分表配置信息
        Map<String, YamlTableRuleConfiguration> tables = yamlShardingRuleConfiguration.getTables();
        // 判斷當前表是否設置了分表欄位
        if (tables.containsKey(tableName)) {
            YamlTableRuleConfiguration tableRuleConfiguration = tables.get(tableName);
            // 獲取分表欄位
            String shardingColumn = tableRuleConfiguration.getTableStrategy().getStandard().getShardingColumn();
            // 構建sql
            boolean logicDelete = tableInfo.isLogicDelete();
            SqlMethod sqlMethod = SqlMethod.UPDATE_BY_ID;
            // 增加分表欄位判斷
            String shardingAdditional = getShardingColumnWhere(tableInfo, shardingColumn);
            // 是否判斷邏輯刪除欄位
            final String additional = optlockVersion() + tableInfo.getLogicDeleteSql(true, false);
            shardingAdditional = shardingAdditional + additional;
            String sql = String.format(sqlMethod.getSql(), tableInfo.getTableName(),
                    getSqlSet(logicDelete, tableInfo, shardingColumn),
                    tableInfo.getKeyColumn(), ENTITY_DOT + tableInfo.getKeyProperty(),
                    shardingAdditional);
            SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
            return addUpdateMappedStatement(mapperClass, modelClass, sqlMethod.getMethod(), sqlSource);
        } else {
            return super.injectMappedStatement(mapperClass, modelClass, tableInfo);
        }
    }

    /**
     * where條件增加分表欄位
     */
    private String getShardingColumnWhere(TableInfo tableInfo, String shardingColumn) {
        StringBuilder shardingWhere = new StringBuilder();
        shardingWhere.append(" AND ").append(shardingColumn).append("=#{");
        shardingWhere.append(ENTITY_DOT);
        TableFieldInfo fieldInfo = tableInfo.getFieldList().stream()
                .filter(f -> f.getColumn().replaceAll(columnDot, StringUtils.EMPTY).equals(shardingColumn))
                .findFirst().get();
        shardingWhere.append(fieldInfo.getEl());
        shardingWhere.append("}");
        return shardingWhere.toString();
    }

    /**
     * set模塊去掉分表欄位
     */
    public String getSqlSet(boolean ignoreLogicDelFiled, TableInfo tableInfo, String shardingColumn) {
        List<TableFieldInfo> fieldList = tableInfo.getFieldList();
        // 去掉分表欄位的set設置,即不修改分表欄位
        String rmShardingColumnSet = fieldList.stream()
                .filter(i -> ignoreLogicDelFiled ? !(tableInfo.isLogicDelete() && i.isLogicDelete()) : true)
                .filter(i -> !i.getColumn().equals(shardingColumn))
                .map(i -> i.getSqlSet(ENTITY_DOT))
                .filter(Objects::nonNull).collect(joining(NEWLINE));
        return rmShardingColumnSet;
    }
}


3.定義一個sql註入器GyhSqlInjector,添加UpdateByIdWithSharding對象

// 需註入到spring容器中
@Component
public class GyhSqlInjector extends DefaultSqlInjector {    
    /**
     * shardingsphere 配置信息
     */
    @Autowired
    private YamlShardingRuleConfiguration yamlShardingRuleConfiguration;

    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
        List<AbstractMethod> methodList = super.getMethodList(mapperClass);
        // 添加 UpdateByIdWithSharding 對象,並註入分庫分表信息
        methodList.add(new UpdateByIdWithSharding(yamlShardingRuleConfiguration));
        return methodList;
    }
}


4.定義一個基礎MapperGyhBaseMapper,添加新的selectById方法

/**
 * 自定義的通用Mapper
 */
public interface GyhBaseMapper<T> extends BaseMapper<T> {
   int updateById(@Param(Constants.ENTITY) T entity);
}


5.所有參與分表的表,在定義Mapper時繼承GyhBaseMapper,那麼在使用他的updateById方法時,將自動增加分庫分表判斷,準確命中目標表,減少其他分表查詢的資源浪費。


以上是針對mybatisplus的一些簡單改造,希望能為你提供一點點幫助~

作者:京東科技 郭艷紅

來源:京東雲開發者社區 轉載請註明來源


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

-Advertisement-
Play Games
更多相關文章
  • 原文在這裡。 由 Russ Cox, for the Go team 發佈於2023年11月10日 今天,我們慶祝Go開源發佈的第十四個生日!Go在過去一年裡取得了巨大的進展,發佈了兩個功能豐富的版本,並實現了其他重要的里程碑。 我們發佈了Go 1.20 in February和Go 1.21 in ...
  • 本篇以代碼為核心,在實踐中自學吧年輕人~ 非常好迭代作業,愛來自BUAA File對象 要進行文件處理肯定需要File類啦。 File的實例是一個實例(?),但是可以鏈接到本地的文件、文件夾,並對它們進行操作。 從下麵的一些示例中可以看到,同一份本地文件可以擁有多個File對象;同時,構造一個Fil ...
  • 在處理多個 PDF 文檔時,頻繁地打開關閉文件會嚴重影響效率。因此,對於一大堆內容相關的 PDF 文件,我們可以先將這些 PDF 文件合併起來再操作,從而提高工作效率。比如,在傳送大量的 PDF 文檔時,在處理同一項目下的多個 PDF 文檔時,或在列印一系列 PDF 文檔時,將文檔合併起來可以減少工 ...
  • 1、項目簡介 Chatgpt-Java是OpenAI官方Api的Java SDK,可以快速接入項目使用。支持OpenAI官方全部介面。 目前收穫將2500+star🌟。 開源地址:https://github.com/Grt1228/chatgpt-java 官方文檔:https://chatgp ...
  • 1 簡介 SQLFlow 可跟蹤超過 20 種主要資料庫(包括 Snowflake、Hive、SparkSQL、Teradata、Oracle、SQL Server、AWS Redshift、BigQuery 等)的欄位級數據血緣。 從查詢歷史記錄、ETL 腳本、Github/Bitbucket、本 ...
  • 在 Go 語言中,零值(Zero Value)是指在聲明變數但沒有顯式賦值的情況下,變數會被自動賦予一個預設值。這個預設值取決於變數的類型,不同類型的變數會有不同的零值。零值是 Go 語言中的一個重要概念,因為它確保了變數在聲明後具有一個可預測的初始狀態,減少了未初始化變數引發的問題。 以下是一些常 ...
  • 公眾號「架構成長指南」,專註於生產實踐、雲原生、分散式系統、大數據技術分享。 概述 在之前的教程中,我們看到了使用 RestTemplate 的 Spring Boot 微服務通信示例。 從 5.0 開始,RestTemplate處於維護模式,很快就會被棄用。因此 Spring 團隊建議使用org. ...
  • 大家好,我是棧長。 昨天 17 點多,棧長興緻來了,忙裡偷閑正在看了一把 LOL S13 淘汰賽,沒想到比賽還沒看完朋友圈就已經炸鍋了: 朋友圈有人開玩笑說,阿裡 35 歲的人是不是都被優化了?還是雙 11 後都鬆懈了?這大周末的還讓加班?讓不讓人省心點。。 這我看完也有點懵 B ,大家還記得上次的 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...