知識庫 / JPA RSS 訂閱

5. 原生查詢

通過原生查詢調用數據庫函數的一種方法是使用原生查詢。 使用原生查詢調用數據庫函數有兩的不同方式。

5.1. 本地調用

從之前的 Hibernate 日誌中，我們可以看到 Hibernate 執行了一個 CALL 命令。同樣，我們可以使用相同的命令來調用我們的數據庫函數：

public interface ProductRepository extends JpaRepository<Product, Integer> {
    @Query(value = "CALL SHA256_HEX(:value)", nativeQuery = true)
    String getSha256HexByNativeCall(@Param("value") String value);
}

執行結果將與我們使用 @NamedStoredProcedureQuery 的示例相同。

5.2. 原生選擇

如前所述，我們無法將其與選擇查詢結合使用。我們將將其轉換為選擇查詢，並將其應用於表中列的值。在我們的示例中，我們定義了一個倉庫方法，它使用原生選擇查詢來調用數據庫函數，該函數應用於 name 列（即 Product 表）的值：

public interface ProductRepository extends JpaRepository<Product, Integer> {
    @Query(value = "SELECT SHA256_HEX(name) FROM product", nativeQuery = true)
    String getProductNameListInSha256HexByNativeSelect();
}

在執行後，我們可以獲得與我們定義的完全相同的查詢，因為我們將其定義為原生查詢。

Hibernate: 
    SELECT
        SHA256_HEX(name) 
    FROM
        product

6. 函數註冊

函數註冊是 Hibernate 中定義和註冊自定義數據庫函數的過程，這些函數可用於 JPA 或 Hibernate 查詢中。這有助於 Hibernate 將自定義函數翻譯成相應的 SQL 語句。

6.1. 自定義方言

通過創建自定義方言，我們可以註冊自定義函數。 以下是擴展默認的 H2Dialect 類並註冊我們自定義函數的自定義方言類：

public class CustomH2Dialect extends H2Dialect {
    @Override
    public void initializeFunctionRegistry(FunctionContributions functionContributions) {
        super.initializeFunctionRegistry(functionContributions);
        SqmFunctionRegistry registry = functionContributions.getFunctionRegistry();
        TypeConfiguration types = functionContributions.getTypeConfiguration();

        new PatternFunctionDescriptorBuilder(registry, "sha256hex", FunctionKind.NORMAL, "SHA256_HEX(?1)")
          .setExactArgumentCount(1)
          .setInvariantType(types.getBasicTypeForJavaType(String.class))
          .register();
    }
}

當 Hibernate 初始化一個方言時，它會通過 initializeFunctionRegistry() 方法將可用的數據庫函數註冊到函數註冊表中。 我們通過覆蓋 initializeFunctionRegistry() 方法來註冊默認方言未包含的額外數據庫函數。

PatternFunctionDescriptorBuilder 創建一個 JPQL 函數映射，將我們的數據庫函數 SHA256_HEX 映射到 JPQL 函數 sha256Hex，並將映射註冊到函數註冊表中。參數 ?1 表示數據庫函數的第一個輸入參數。

6.2. Hibernate 配置

我們需要指示 Spring Boot 採用 CustomH2Dialect 而不是默認的 H2Dialect。這裏使用了 HibernatePropertiesCustomizer，這是一個 Spring Boot 提供的接口，用於自定義 Hibernate 使用的屬性。

我們通過覆蓋 customize() 方法來添加額外的屬性，表明我們將使用 CustomH2Dialect。

@Configuration
public class CustomHibernateConfig implements HibernatePropertiesCustomizer {
    @Override
    public void customize(Map<String, Object> hibernateProperties) {
        hibernateProperties.put("hibernate.dialect", "com.baeldung.customfunc.CustomH2Dialect");
    }
}

Spring Boot 在應用程序啓動時會自動檢測並應用自定義配置。

6.3. 倉庫方法

在我們的倉庫中，現在可以使用將新定義的函數 sha256Hex 替代原生查詢的 JPQL 查詢：

public interface ProductRepository extends JpaRepository<Product, Integer> {
    @Query(value = "SELECT sha256Hex(p.name) FROM Product p")
    List<String> getProductNameListInSha256Hex();
}

當我們執行後檢查Hibernate日誌時，我們看到Hibernate正確地將JPQL的sha256Hex函數翻譯為我們數據庫中的函數SHA256_HEX：

Hibernate: 
    select
        SHA256_HEX(p1_0.name) 
    from
        product p1_07'

7. 結論

在本文中，我們對數據庫函數和存儲過程進行了簡要比較。兩者都提供了一種強大的方式來封裝邏輯並執行在數據庫中。

此外，我們還探討了調用數據庫函數的不同方法，包括利用 <em @NamedStoredProcedureQuery</em> 註解、原生查詢以及通過自定義方言註冊函數。通過將數據庫函數整合到存儲庫方法中，我們可以輕鬆構建數據庫驅動的應用程序。