MyBatis 常用工具類

来源:https://www.cnblogs.com/Yee-Q/archive/2023/07/23/17574986.html
-Advertisement-
Play Games

## SQL 類 MyBatis 提供了一個 SQL 工具類，使用這個工具類，我們可以很方便在 Java 代碼動態構建 SQL 語句 ```java String newSql = new SQL() ({ SELECT("P.ID, P.USERNAME, P.PASSWORD, P.FULL N ...


SQL 類

MyBatis 提供了一個 SQL 工具類，使用這個工具類，我們可以很方便在 Java 代碼動態構建 SQL 語句

String newSql = new SQL() ({
  SELECT("P.ID, P.USERNAME, P.PASSWORD, P.FULL NAME");
  SELECT("P.LAST NAME, P.CREATED ON, P.UPDATED ON");
  FROM("PERSON P");
  FROM("ACCOUNT A");
  INNER JOIN("DEPARTMENT D ON DID=P.DEPARTMENT ID");
  INNER JOIN("COMPANY C On D.COMPANY ID=C.ID");
  WHERE("P.ID = A.ID");
  WHERE("P.FIRST NAME like ?");
  OR();
  WHERE("P.LAST NAME like ?");
  GROUP BY("P.ID");
  HAVING("P.LAST_NAME like ?");
  OR();
  HAVING("P.FIRST NAME like ?");
  ORDER BY("P.ID");
  ORDER BY("P.FULL NAME");
}}.tostring();

如上面的代碼所示，創建了一個匿名的 SQL 類的子類，在匿名子類的初始化代碼塊中，調用 SELECT()、FROM() 等方法構建 SQL 語句，這種方式能夠很好地避免字元串拼接過程中缺少空格或者偶然間重覆出現的 AND 關鍵字導致的 SOL 語句不正確

除了 SELECT 語句外，SQL 工具類也可以用作構建 UPDATE、INSERT 等語句

@Test
public void testInsertSql() {
  String insertSql = new SQL().
    INSERT INTO("PERSON").
    VALUES("ID, FIRST NAME","#{id}, #{firstName}").
    VALUES("LAST NAME","#(lastName}").toString();
  System.out.println(insertSal);
}

@Test
public void testDeleteSql() {
  String deleteSql= new SQL() {{
    DELETE FROM("PERSON");
    WHERE("ID = #{id)");
  }}.toString();
  System.out.println(deleteql);
}

@Test
public void testUpdateSql() {
  String updateSql= new SQL() {{
    UPDATE("PERSON");
    SET("FIRST NAME = #{firstName}");
    WHERE("ID = #{id}");
  }}.toString();
  System.out.println(updateSql);
}

使用 SQL 工具類的另一個好處是可以很方便地在 Java 代碼中根據條件動態地拼接 SQL 語句

public String selectPerson(final String id, final String firstName, final String lastName) {
  return new SQL() {{
    SELECT("P.ID, P.USERNAME, P.PASSWORD");
    SELECT("P.FIRST_NAME, P.LAST NAME");
    FROM("PERSON P");
    if (id != null) {
      WHERE("P.ID=#{id}");
    }
    if (firstName != null) {
      WHERE("P.FIRST_NAME=#{firstName}");
    }
    if (lastName != null) {
      WHERE("P.LAST_NAME=#{lastName}");
    }
  }}.toString();
}

ScriptRunner

該工具類用於讀取腳本文件中的 SQL 語句並執行

public void testscriptRunner() {
  try  {
    Connection connection=DriverManager.getConnection("jdbc:hsqldb:mem:mybatis","sa","");
    Scriptrunner scriptRunnermnew ScriptRunner(connection):
    scriptrunner.runScript(Resources.getResourceAsReader("create-table.sql"))
  } catch (Exception e) {
    e.printstackTrace();
  }
}

如上面的代碼所示，ScriptRunner 工具類的構造方法需要一個 java.sql.Connection 對象作為參數。創建 ScriptRunner 對象後，調用該對象的 runScript 方法即可，該方法接收一個讀取 SQL 腳本文件的 Reader 對象作為參數

ScriptRunner 工具類中提供了一些屬性，用於控制執行 SQL 腳本的一些行為，代碼如下;

public class ScriptRunner{
  // SQL異常是否中斷程式執行
  private boolean stopOnError;
  // 是否拋出 SQLWarning 警告
  private boolean throwWarning;
  //是否自動提交
  private boolean autoCommit;
  // 屬性為 true 時，批量執行文件中的 SQL 語句
  //為false時逐條執行 sQL 語句，預設情況下，SQL語句以分號分割
  private boolean sendfullScript;
  //是否去除Windows系統換行符中的\r
  private boolean removecrs;
  //設置statement屬性是否支持轉義處理
  private boolean escapeProcessing=true;
  // 日誌輸出位置，預設標準輸入輸出，即控制台
  private PrintWriter logWriter=new PrintWriter(System.out);
  // 錯誤日誌輸出位置，預設控制台
  private PrintWriter errorLoqWriter =new PrintWriter(System.err);
  // 腳本文件中 SOL 語句的分隔符，預設為分號
  private String delimiter= DEFAULT_DELIMITER;
  // 是否支持 SOL 語句分割符，單獨占一行
  private boolean fullLineDelimiter;
  ...
}

我們可以直接調用這些屬性對應的 Setter 方法來控制 ScriptRunner 工具類執行 SQL 腳本的行為


SqlRunner

MyBatis 提供了一個非常實用的、用於操作資料庫的 SqlRunner 工具類，該類對 JDBC 做了很好的封裝，結合 SQL 工具類，能夠很方便地通過 Java 代碼執行 SQL 語句並檢索 SQL 執行結果

SglRunner 類提供了幾個操作資料庫的方法，分別說明如下：

  • SqlRunner#closeConnection: 用於關閉 Connection 對象
  • SqlRunner#selectOne(String sql, Object… args)：執行 SELECT 語句，SQL 語句中可以使用占位符，如果 SOL 中包含占位符，則可變參數用於為參數占位符賦值，該方法只返回一條記錄，若查詢結果行數不等於一，則會拋出 SQLException 異常
  • SqlRunner#selectAll(String sql,Object… args)：該方法和 selectOne 方法的作用相同，只不過該方法可以返回多條記錄，方法返回值是一個 List 對象，List 中包含多個 Map 對象，每個 Map 對象對應資料庫中的一行記錄
  • SqlRunner#insert(String sql,Object… args)：執行一條 INSERT 語句，插入一條記錄
  • SqlRunner#update(String sql,Object… args)：更新若幹條記錄
  • SqlRunner#delete(String sql,Object… args)：刪除若幹條記錄
  • SqlRunner#run(String sql)：執行任意一條 SQL 語句，最好為 DDL 語句

接下來我們來看一下 SqlRunner 工具類的使用案例，代碼如下:

@Test
public void testselectOne() throws SQLException {
  SqlRunner sqlRunner=new SqlRunner(connection)
  String gryUserSql = new SQL() {{
    SELECT("*");
    FROM("user");
    WHERE("id=?");
  }}.toString();
  Map<String, Object> resultMap = sqlRunner.selectOne(qryUserSql, Integer.valueOf(1));
  System.out.println(JSON.toJSONString(resultMap));
}

@Test
public void testDelete() throws SQLException {
  SqlRunner sqlRunner=new SqlRunner(connection);
  String deleteUserSql = new SQL() {{
    DELETE FROM("user");
    WHERE("id = ?");
  }}.toString();
  sqlRunner.delete(deleteUserSql,Integer.valueOf(1));
}

@Test
public void testUpdate() throws SQLException {
  SqlRunner sqlRunner=new SqlRunner(connection);
  String updateUserSql = new SQL() {{
    UPDATE("user");
    SET("nick_name = ?");
    WHERE("id = ?");
  }}.toString();
  sqlRunner.update(updateUserSql,"Jane",Integer.valueOf(1));
}

@Test
public void testInsert() throws SQLException {
  SqlRunner sqlRunner=new SqlRunner(connection);
  String insertUserSql = new SQL() {{
    INSERT INTO("user");
    INTO COLUMNS("create_time, name, password, phone, nick_name");
    INTO VALUES("?,?,?,?,?");
  }}.toString();
  sqlRunner.insert(insertUserSql,createTime,"Jane","test","18700000000" "J");
}

MetaObject

MetaObject 是 MyBatis 中的反射工具類，該工具類在 MyBati s源碼中出現的頻率非常高。使用 MetaObject 工具類，我們可以很優雅地獲取和設置對象的屬性值

使用 MetaObject 工具類獲取 User 對象的屬性信息，案例代碼如下：

@Test
public void testMetaObject() {
  List<order> orders= new ArrayList()(
    add(new Order("order20171024010246","《MyBatis源碼深度解析》圖書"));
    add(new Order("order20171024010248"，"《AngularJs入門與進階》圖書"));
  };
  User user = new User(orders，"江榮波"，3);
  MetaObject metaObject = SystemMetaObject.forObject(user);
  // 獲取第一筆訂單的商品名稱
  System.out.println(metaObject.getValue("orders[0].goodsName"));
  // 獲取第二筆訂單的商品名稱
  System.out.println(metaObject.getvalue("orders[1].goodsName"));
  // 為屬性設置值
  metaObject.setValue("orders[1].orderNo","order20181113010139");
  // 判斷 User 對象是否有 orderNo 屬性
  System.out.println("是否有orderNo屬性且orderNo屬性有對應的Getter方法:" + metaObject.hasGetter("orderNo"));
  // 判斷 User 對象是否有 name 屬性
  System.out.println("是否有name屬性且name 屬性有對應的Getter方法:" + metaObject.hasGetter("name"));
}

MetaClass

MetaClass 是 MyBatis 中的反射工具類，與 MetaOjbect 不同的是，MetaObject 用於獲取和設置對象的屬性值，而 MetaClass 則用於獲取類相關的信息

@Test
public void testMetaClass() {
  MetaClass metaClass =MetaClass.forClass(Orderclass,newDefaultReflectorFactory());
  // 獲取所有有 Getter 方法的屬性名
  String[] getterNames = metaClass.getGetterNames();
  System.out.println(JSON.toJSONString(getterNames));
  // 是否有預設構造方法
  System.out.println("是否有預設構造方法:" + metaClass.hasDefaultConstructor());
  // 某屬性是否有對應的Getter/Setter方法
  System.out.printIn("orderNo屬性是否有對應的Getter 方法:" + metaClass.hasGetter("orderNo"));
  System.out.println("orderNo屬性是否有對應的Setter方法:" + metaClass.hasSetter("orderNo"));
  System.out.println("orderNo屬性類型:" + metaClass.getGetterType("orderNo"));
}

ObjectFactory

ObjectFactory 是 MyBatis 中的對象工廠，MyBatis 每次創建 Mapper 映射結果對象的新實例時，都會使用一個對象工廠實例來完成。ObjectFactory 介面只有一個預設的實現，即 DefaultObjectFactory，預設的對象工廠需要做的僅僅是實例化目標類，要麼通過預設構造方法，要麼在參數映射存在的時候通過參數構造方法來實例化

public class ObjectFactoryExample {
  @Test
  public void testObjectFactory() {
    ObjectFactory objectFactory = new DefaultObjectFactory();
    List<Integer> list = objectFactory.create(List.class);
    Map<String, String> map = objectFactory.create(Map.class);
    list.addAll(Arrays.asList(1. 23));
    map.put("test","test");
    System.out.printin(list);
    System.out.println(map);
  }
}

MyBatis 中使用 ObjectFactory 實例創建 Mapper 映射結果對象的目的是什麼呢？實際上，這是 MyBatis 提供的一種擴展機制。有些情況下，在得到映射結果之前我們需要處理一些邏輯，或者在執行該類的有參構造方法時，在傳入參數之前，要對參數進行一些處理，這時我們可以通過自定義 ObjectFactory 來實現。下麵是一個自定義 ObjectFactory 的案例，代碼如下:

public class CustomObjectfactory extends Defaultobjectfactory{
  
  @Override
  public object create(Class type){
    if(type.equals(User.class)) {
      //實例化User類
      User user=(User)super.create(type);
      user.setUuid(UUID.randomUUID().toString());
      return user;
    }
    return super.create(type);
  }
}

如上面的代碼所示，自定義一個 ObjectFactory 非常簡單，我們可以繼承 DefaultObjectFactory，然後重寫 create 方法即可。自定義 ObjectFactory 後，還需要在MyBatis 主配置文件中通過 標簽配置自定義的 ObjectFactory，具體如下:

<objectfactory type="com.blog4java.mybatis.objectfactory.CustomobjectFactory">
  <property name="someProperty" value="10"/>
</objectfactory>

ProxyFactory

ProxyFactory 是 MyBatis 的代理工廠，主要用於創建動態代理對象，ProxyFactory介面有兩個不同的實現，分別為 CglibProxyFactory 和 JavassistProxyFactory。從實現類的名稱可以看出，MyBatis 支持兩種動態代理策略，分別為 Cglib 和 Javassist 動態代理。ProxyFactory主要用於實現 MyBatis 的懶載入功能。當開啟懶載入後，MyBatis 創建 Mapper 映射結果對象後，會通過 ProxyFactory 創建映射結果對象的代理對象。當我們調用代理對象的 Getter 方法獲取數據時，會執行 CglibProxyFactory 或 JavassistProxyFactory 中定義的攔截邏輯，然後執行一次額外的查詢

下麵是使用 JavassistProxyFactory 創建動態代理對象的案例，代碼如下:

public class ProxyFactoryExample {

  @Data
  @AllArgsConstructor
  private static class Order {
    private String orderNo;
    private String goodsName;
  }

  @Test
  public void testProxyFactory() {
    // 創建 ProxyFactory對象
    ProxyFactory proxyFactory =new JavassistProxyFactory();
    Order order = new Order("gn20170123","《MyBatis源碼深度解析》圖書");
    ObjectFactory objectFactory=new DefaultObjectFactory();
    //調用ProxyFactory對象的createProxy()方法創建代理對象
    Object proxyOrder=proxyFactory.createProxy(order,
      mock(ResultLoaderMap.class),
      mock(Configuration.class),
      objectfactory,
      Arrays.asList(String.class,String.class),
      Arrays.asList(order.getorderNo(),order.getGoodsName()));
    System.out.println(proxyOrder.getClass());
    System.out.println(((Order)proxyOrder).getGoodsName());
  }
}

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

-Advertisement-
Play Games
更多相關文章
  • 手把手教你落地DDD
    一、前言 常見的DDD實現架構有很多種，如經典四層架構、六邊形（適配器埠）架構、整潔架構（Clean Architecture）、CQRS架構等。架構無優劣高下之分，只要熟練掌握就都是合適的架構。本文不會逐個去講解這些架構，感興趣的讀者可以自行去瞭解。 本文將帶領大家從日常的三層架構出發，精煉推導 ...
  • Java Maven Settings配置參考
    ## 介紹 ### 快速概覽 `settings.xml`文件中的 `settings` 元素包含用於定義以各種方式配置Maven執行的值的元素，如`pom.xml`，但不應綁定到任何特定項目或分發給受眾。這些值包括本地倉庫位置、備用遠程倉庫伺服器和身份驗證信息。 `settings.xml`文件可 ...
  • [爬蟲]3.4.1 Scrapy框架的基本使用
    搭建多Master多Slave模式（同步）集群時的java.lang.NullPointerException異常 一、運行環境等基本描述（問題產生原因是許可權問題，即許可權不夠導致無法啟動broker，甚至broker線程無法通過jps命令查出。下麵闡述分析思路） 1.1）操作系統：Linux 虛擬機 ...
  • C++記憶體分區模型
    當涉及C++記憶體分區模型時，我們必須理解棧、堆和全局/靜態存儲區的概念。棧用於存儲函數調用和局部變數，堆用於動態記憶體分配，而全局/靜態存儲區用於全局變數和靜態變數。同時，我們還探討了棧幀重用現象，它可能在函數調用時導致局部變數地址重疊。瞭解這些記憶體分區的特點和優化行為，可以幫助我們編寫高效、可靠的C... ...
  • Java服務剛啟動時，一小波介面超時排查全過程
    > 原創：扣釘日記（微信公眾號ID：codelogs），歡迎分享，非公眾號轉載保留此聲明。 ### 簡介 我們組有一個流量較大的Java服務，每次發代碼時，服務都會有一小波介面超時，之前簡單分析過，發現這些超時的case僅發生在服務剛啟動時，少量請求會耗時好幾秒，但之後又馬上恢復正常。 ### 問題 ...
  • 小程式軟鍵盤&SM2解密方式
    ## 小程式軟鍵盤&SM2解密方式 轉載請著名出處:[https://www.cnblogs.com/funnyzpc/p/17572445.html](https://www.cnblogs.com/funnyzpc/p/17572445.html) ### SM2基本信息 + 私鑰(primar ...
  • Java 調用gdal API(二)——柵格裁剪
    ## 1.等待多線程完成的 CountDownLatch CountDownLatch 允許一個或多個線程等待其他線程完成操作。 假如有這樣一個需求：我們需要解析一個 Excel 里多個 sheet 的數據，此時可以考慮使用多線程，每個線程解析一個 sheet 里的數據，等到所有的 sheet 都解 ...
  • java 攔截、過濾器2
    python的環境以及IDE都準備好之後，我們就可以開始Python之旅了。Python的第一個程式通常是列印輸出"Hello, World!"，非常簡單。以下是一個示例： ```python print("Hello, World!") ``` # 運行python代碼 首先必須明白python是 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 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 ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類