當(dāng)前位置：首頁(yè) > 前端技术 > javascript >内容正文

javascript

将jOOQ与Spring结合使用：配置

發(fā)布時(shí)間：2023/12/3 javascript 23 豆豆

生活随笔收集整理的這篇文章主要介紹了将jOOQ与Spring结合使用：配置小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.

我遇到了由ORM引起的性能問(wèn)題。盡管我不得不承認(rèn)大多數(shù)這些問(wèn)題確實(shí)是由您造成的，但是我開(kāi)始認(rèn)為在只讀操作中使用ORM是不值得的。

我開(kāi)始尋找實(shí)現(xiàn)這些操作的替代方法。

這就是我遇到j(luò)OOQ的方式，它指出：

jOOQ從您的數(shù)據(jù)庫(kù)生成Java代碼，并允許您通過(guò)其流暢的API構(gòu)建類(lèi)型安全的SQL查詢(xún)。

這看起來(lái)非常有趣，因此我決定給jOOQ一炮而紅，并與您分享我的發(fā)現(xiàn)。

這篇博客文章是我的“將jOOQ與Spring結(jié)合使用”系列的第一部分，它描述了如何獲取所需的依賴(lài)關(guān)系并配置應(yīng)用程序的應(yīng)用程序上下文。

讓我們開(kāi)始吧。

使用Maven獲取所需的依賴(lài)關(guān)系

我們的應(yīng)用程序的依賴(lài)項(xiàng)是：

Spring Framework 3.2.6。此時(shí)，我們的示例使用aop ， bean ， core ， context ， context-support ， jdbc和tx模塊。
cglib 3.1。
BoneCP 0.8.0。我們使用BoneCP作為示例應(yīng)用程序的連接池。
jOOQ 3.2.2。
H2 1.3.174。我們使用H2作為示例應(yīng)用程序的數(shù)據(jù)庫(kù)。

如果您想獲得有關(guān)Spring Framework模塊的更多信息，請(qǐng)閱讀Spring Framework Reference Documentation的1.2節(jié) 。

該示例應(yīng)用程序使用Spring Framework 3.2.6而不是4.0的原因是，目前spring-test-dbunit與Spring Framework 4.0不兼容。

pom.xml文件的相關(guān)部分如下所示：

<dependency><groupId>org.springframework</groupId><artifactId>spring-aop</artifactId><version>3.2.6.RELEASE</version> </dependency> <dependency><groupId>org.springframework</groupId><artifactId>spring-beans</artifactId><version>3.2.6.RELEASE</version> </dependency> <dependency><groupId>org.springframework</groupId><artifactId>spring-core</artifactId><version>3.2.6.RELEASE</version> </Dependency> <dependency><groupId>org.springframework</groupId><artifactId>spring-context</artifactId><version>3.2.6.RELEASE</version> </dependency> <dependency><groupId>org.springframework</groupId><artifactId>spring-context-support</artifactId><version>3.2.6.RELEASE</version> </dependency> <dependency><groupId>org.springframework</groupId><artifactId>spring-expression</artifactId><version>3.2.6.RELEASE</version> </dependency> <dependency><groupId>org.springframework</groupId><artifactId>spring-jdbc</artifactId><version>3.2.6.RELEASE</version> </dependency> <dependency><groupId>org.springframework</groupId><artifactId>spring-tx</artifactId><version>3.2.6.RELEASE</version> </dependency><dependency><groupId>cglib</groupId><artifactId>cglib</artifactId><version>3.1</version> </dependency><dependency><groupId>com.jolbox</groupId><artifactId>bonecp</artifactId><version>0.8.0.RELEASE</version> </dependency><dependency><groupId>org.jooq</groupId><artifactId>jooq</artifactId><version>3.2.2</version> </dependency><dependency><groupId>com.h2database</groupId><artifactId>h2</artifactId><version>1.3.174</version> </dependency>

此博客文章的示例應(yīng)用程序還具有其他依賴(lài)性。通過(guò)查看pom.xml文件，可以看到完整的依賴(lài)項(xiàng)列表。

讓我們繼續(xù)研究如何將jOOQ拋出的異常轉(zhuǎn)換為Spring DataAccessExceptions 。

將jOOQ異常轉(zhuǎn)換為Spring DataAccessExceptions

為什么我們要將jOOQ拋出的異常轉(zhuǎn)換為Spring DataAccessExceptions ？

這樣做的一個(gè)原因是，我們希望我們的集成工作與Spring Framework的DAO支持相同。這種支持的重要組成部分是一致的異常層次結(jié)構(gòu) ：

Spring提供了從技術(shù)特定的異常（如SQLException）到其自己的異常類(lèi)層次結(jié)構(gòu)（以DataAccessException作為根異常）的便捷轉(zhuǎn)換。這些異常包裝了原始異常，因此永遠(yuǎn)不會(huì)冒任何可能丟失任何錯(cuò)誤信息的風(fēng)險(xiǎn)。

換句話說(shuō)，如果我們希望我們的應(yīng)用程序是“好公民”，那么確保我們的配置將jOOQ拋出的異常轉(zhuǎn)換為Spring DataAccessExceptions是有意義的。

我們可以按照以下步驟創(chuàng)建提供此功能的組件：

創(chuàng)建一個(gè)JOOQToSpringExceptionTransformer類(lèi)，該類(lèi)擴(kuò)展了DefaultExecuteListener類(lèi)。 DefaultExecuteListener類(lèi)是ExecuteListener接口的公共默認(rèn)實(shí)現(xiàn)，該接口為單個(gè)查詢(xún)執(zhí)行的不同生命周期事件提供偵聽(tīng)器方法。

重寫(xiě)DefaultExecuteListener類(lèi)的exception（ExecuteContext ctx）方法。如果在執(zhí)行生命周期的任何時(shí)刻引發(fā)異常，則調(diào)用此方法。通過(guò)執(zhí)行以下步驟來(lái)實(shí)現(xiàn)該方法：

從jOOQ配置中獲取一個(gè)SQLDialect對(duì)象。

通過(guò)遵循以下規(guī)則，創(chuàng)建一個(gè)實(shí)現(xiàn)SQLExceptionTranslator接口的對(duì)象：

如果找到已配置的SQL方言，請(qǐng)創(chuàng)建一個(gè)新的SQLErrorCodeSQLExceptionTranslator對(duì)象，并將SQL方言的名稱(chēng)作為構(gòu)造函數(shù)參數(shù)傳遞。此類(lèi)通過(guò)分析供應(yīng)商特定的錯(cuò)誤代碼來(lái)“選擇”正確的DataAccessException 。

如果找不到SQL方言，請(qǐng)創(chuàng)建一個(gè)新的SQLStateSQLExceptionTranslator對(duì)象。此類(lèi)通過(guò)分析存儲(chǔ)到SQLException的SQL狀態(tài)來(lái)“選擇”正確的DataAccessException 。

通過(guò)使用創(chuàng)建的SQLExceptionTranslator對(duì)象創(chuàng)建DataAccessException 對(duì)象。

將拋出的DataAccessException轉(zhuǎn)發(fā)給作為方法參數(shù)給出的ExecuteContext對(duì)象。

JOOQToSpringExceptionTransformer類(lèi)的源代碼如下所示：

import org.jooq.ExecuteContext; import org.jooq.SQLDialect; import org.jooq.impl.DefaultExecuteListener; import org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslator; import org.springframework.jdbc.support.SQLExceptionTranslator; import org.springframework.jdbc.support.SQLStateSQLExceptionTranslator;public class JOOQToSpringExceptionTransformer extends DefaultExecuteListener {@Overridepublic void exception(ExecuteContext ctx) {SQLDialect dialect = ctx.configuration().dialect();SQLExceptionTranslator translator = (dialect != null)? new SQLErrorCodeSQLExceptionTranslator(dialect.name()): new SQLStateSQLExceptionTranslator();ctx.exception(translator.translate("jOOQ", ctx.sql(), ctx.sqlException()));} }

這不是我的主意 。我從亞當(dāng)·澤爾（Adam Zell）的要旨（Gist）中得到了這個(gè)想法。

補(bǔ)充閱讀：

jOOQ用戶手冊(cè)的第4.2.5節(jié)“自定義ExecuteListeners”
Spring框架參考文檔的第14.2.3節(jié)“ SQLExceptionTranslator”

我們的工作還沒(méi)有完成。讓我們放在一起，通過(guò)配置示例應(yīng)用程序的應(yīng)用程序上下文來(lái)完成我們的工作。

配置應(yīng)用程序上下文

本節(jié)說(shuō)明如何使用Java配置來(lái)配置應(yīng)用程序的應(yīng)用程序上下文。

讓我們開(kāi)始創(chuàng)建一個(gè)屬性文件，其中包含示例應(yīng)用程序的配置。

實(shí)際應(yīng)用程序的構(gòu)建過(guò)程基于Maven配置文件。這確保了我們可以在不同的環(huán)境中使用不同的配置。您可以閱讀我的博客文章“ 使用Maven創(chuàng)建配置文件特定的配置文件”，以獲取有關(guān)此內(nèi)容的更多信息。

創(chuàng)建屬性文件

我們可以按照以下步驟創(chuàng)建屬性文件：

配置數(shù)據(jù)庫(kù)連接。我們需要配置JDBC驅(qū)動(dòng)程序類(lèi)，JDBC URL，數(shù)據(jù)庫(kù)用戶的用戶名和數(shù)據(jù)庫(kù)用戶的密碼。

配置使用的SQL方言的名稱(chēng)。

配置創(chuàng)建示例應(yīng)用程序數(shù)據(jù)庫(kù)的SQL腳本的名稱(chēng)（這是一個(gè)可選步驟，如果您的應(yīng)用程序不使用嵌入式數(shù)據(jù)庫(kù)，則不需要此步驟）。

application.properties文件如下所示：

#Database Configuration db.driver=org.h2.Driver db.url=jdbc:h2:target/jooq-example db.username=sa db.password=#jOOQ Configuration jooq.sql.dialect=H2#DB Schema db.schema.script=schema.sql

SQLDialect枚舉的Javadoc指定jOOQ支持的數(shù)據(jù)庫(kù)方言列表。

讓我們繼續(xù)研究如何使用Java配置來(lái)配置應(yīng)用程序的應(yīng)用程序上下文。

創(chuàng)建配置類(lèi)

我們可以按照以下步驟配置應(yīng)用程序的應(yīng)用程序上下文：

創(chuàng)建一個(gè)PersistenceContext類(lèi)。

通過(guò)使用@Configuration批注注釋該類(lèi)，確保將創(chuàng)建的類(lèi)識(shí)別為配置類(lèi)。

確保在組件掃描期間找到了我們應(yīng)用程序的jOOQ存儲(chǔ)庫(kù)。我們可以通過(guò)使用@ComponentScan注釋對(duì)配置類(lèi)進(jìn)行注釋來(lái)實(shí)現(xiàn)。

通過(guò)使用@EnableTransactionManagement注釋對(duì)配置類(lèi)進(jìn)行注釋，以啟用注釋驅(qū)動(dòng)的事務(wù)管理。

確保從類(lèi)路徑中找到的application.properties文件中加載了我們應(yīng)用程序的配置。我們可以通過(guò)使用@PropertySource注釋對(duì)配置類(lèi)進(jìn)行注釋來(lái)執(zhí)行此操作。

將環(huán)境字段添加到配置類(lèi)中，并使用@Autowired批注對(duì)該字段進(jìn)行批注。我們使用Environment對(duì)象獲取從application.properties文件加載的配置屬性的屬性值。

配置數(shù)據(jù)源 bean。因?yàn)槲覀兊膽?yīng)用程序使用BoneCP，所以我們創(chuàng)建了一個(gè)BoneCPDataSource對(duì)象作為我們的數(shù)據(jù)源。

配置LazyConnectionDataSourceProxy bean。該bean確保延遲獲取數(shù)據(jù)庫(kù)連接（即，在創(chuàng)建第一條語(yǔ)句時(shí)）。

配置TransactionAwareDataSourceProxy bean。該bean確保所有JDBC連接都知道Spring管理的事務(wù)。換句話說(shuō)，JDBC連接參與線程綁定的事務(wù)。

配置DataSourceTransactionManager bean。 創(chuàng)建新的DataSourceTransactionManager對(duì)象時(shí)，必須將LazyConnectionDataSourceProxy Bean作為構(gòu)造函數(shù)參數(shù)傳遞 。

配置DataSourceConnectionProvider bean。 jOOQ將從作為構(gòu)造函數(shù)參數(shù)給出的數(shù)據(jù)源中獲取使用的連接。 創(chuàng)建新的DataSourceConnectionProvider對(duì)象時(shí)，必須將TransactionAwareDataSourceProxy bean作為構(gòu)造函數(shù)參數(shù)傳遞 。這樣可以確保創(chuàng)建的jOOQ查詢(xún)參與Spring管理的事務(wù)。

配置JOOQToSpringExceptionTransformer bean。

配置DefaultConfiguration bean。此類(lèi)是Configuration接口的默認(rèn)實(shí)現(xiàn)，我們可以使用它來(lái)配置jOOQ。我們必須配置三件事：

我們必須設(shè)置的ConnectionProvider，這是用來(lái)獲取和釋放數(shù)據(jù)庫(kù)連接。

我們必須配置自定義執(zhí)行偵聽(tīng)器。換句話說(shuō)，我們必須將JOOQToSpringExceptionTransformer bean添加到創(chuàng)建的DefaultConfiguration對(duì)象中。這確保了jOOQ拋出的異常被轉(zhuǎn)換為Spring DataAccessExceptions 。

我們必須配置使用的SQL方言。

配置DefaultDSLContext bean。在使用jOOQ創(chuàng)建數(shù)據(jù)庫(kù)查詢(xún)時(shí)，將使用此bean。

配置DataSourceInitializer bean。啟動(dòng)應(yīng)用程序時(shí)，我們使用此bean創(chuàng)建H2數(shù)據(jù)庫(kù)的數(shù)據(jù)庫(kù)架構(gòu)（如果您不使用嵌入式數(shù)據(jù)庫(kù)，則不必配置此bean）。

PersistenceContext類(lèi)的源代碼如下所示：

import com.jolbox.bonecp.BoneCPDataSource; import org.jooq.SQLDialect; import org.jooq.impl.DataSourceConnectionProvider; import org.jooq.impl.DefaultConfiguration; import org.jooq.impl.DefaultDSLContext; import org.jooq.impl.DefaultExecuteListenerProvider; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.PropertySource; import org.springframework.core.env.Environment; import org.springframework.core.io.ClassPathResource; import org.springframework.jdbc.datasource.DataSourceTransactionManager; import org.springframework.jdbc.datasource.LazyConnectionDataSourceProxy; import org.springframework.jdbc.datasource.TransactionAwareDataSourceProxy; import org.springframework.jdbc.datasource.init.DataSourceInitializer; import org.springframework.jdbc.datasource.init.ResourceDatabasePopulator; import org.springframework.transaction.annotation.EnableTransactionManagement;import javax.sql.DataSource;@Configuration @ComponentScan({"net.petrikainulainen.spring.jooq.todo"}) @EnableTransactionManagement @PropertySource("classpath:application.properties") public class PersistenceContext {@Autowiredprivate Environment env;@Bean(destroyMethod = "close")public DataSource dataSource() {BoneCPDataSource dataSource = new BoneCPDataSource();dataSource.setDriverClass(env.getRequiredProperty("db.driver"));dataSource.setJdbcUrl(env.getRequiredProperty("db.url"));dataSource.setUsername(env.getRequiredProperty("db.username"));dataSource.setPassword(env.getRequiredProperty("db.password"));return dataSource;}@Beanpublic LazyConnectionDataSourceProxy lazyConnectionDataSource() {return new LazyConnectionDataSourceProxy(dataSource());}@Beanpublic TransactionAwareDataSourceProxy transactionAwareDataSource() {return new TransactionAwareDataSourceProxy(lazyConnectionDataSource());}@Beanpublic DataSourceTransactionManager transactionManager() {return new DataSourceTransactionManager(lazyConnectionDataSource());}@Beanpublic DataSourceConnectionProvider connectionProvider() {return new DataSourceConnectionProvider(transactionAwareDataSource());}@Beanpublic JOOQToSpringExceptionTransformer jooqToSpringExceptionTransformer() {return new JOOQToSpringExceptionTransformer();}@Beanpublic DefaultConfiguration configuration() {DefaultConfiguration jooqConfiguration = new DefaultConfiguration();jooqConfiguration.set(connectionProvider());jooqConfiguration.set(new DefaultExecuteListenerProvider(jooqToSpringExceptionTransformer()));String sqlDialectName = env.getRequiredProperty("jooq.sql.dialect");SQLDialect dialect = SQLDialect.valueOf(sqlDialectName);jooqConfiguration.set(dialect);return jooqConfiguration;}@Beanpublic DefaultDSLContext dsl() {return new DefaultDSLContext(configuration());}@Beanpublic DataSourceInitializer dataSourceInitializer() {DataSourceInitializer initializer = new DataSourceInitializer();initializer.setDataSource(dataSource());ResourceDatabasePopulator populator = new ResourceDatabasePopulator();populator.addScript(new ClassPathResource(env.getRequiredProperty("db.schema.script")));initializer.setDatabasePopulator(populator);return initializer;} }

如果要使用XML配置文件配置應(yīng)用程序上下文，則示例應(yīng)用程序也具有有效的XML配置文件。

學(xué)分：

此配置基于jOOQ用戶手冊(cè)的3.4.3節(jié) 。
Sergey Epik發(fā)布的消息幫助我弄清楚了如何向jOOQ配置添加自定義ExecuteListeners。
Peter Ertl給了我一個(gè)使用LazyConnectionDataSourceProxy的想法。

我們?nèi)绾沃来伺渲糜行?#xff1f; 這是一個(gè)好問(wèn)題。我們將在下一節(jié)中討論。

這真的有效嗎？

當(dāng)我開(kāi)始研究如何確保用jOOQ創(chuàng)建的數(shù)據(jù)庫(kù)查詢(xún)參與Spring管理的事務(wù)時(shí)，我注意到這不是一個(gè)容易解決的問(wèn)題。

這篇博客文章的示例應(yīng)用程序具有一些集成測(cè)試，這些測(cè)試可以確保事務(wù)（提交和回滾）在非常簡(jiǎn)單的場(chǎng)景中正常工作。但是，使用此博客文章中描述的解決方案時(shí)，必須考慮兩件事：

1.使用jOOQ創(chuàng)建的所有數(shù)據(jù)庫(kù)查詢(xún)必須在事務(wù)內(nèi)執(zhí)行。

TransactionAwareDataSourceProxy類(lèi)的Javadoc指出：

委托DataSourceUtils自動(dòng)參與線程綁定的事務(wù)，例如由DataSourceTransactionManager管理。返回的Connection上的getConnection調(diào)用和close調(diào)用將在事務(wù)中正常運(yùn)行，即始終在事務(wù)Connection上運(yùn)行。如果不在事務(wù)內(nèi)，則將應(yīng)用正常的DataSource行為。

換句話說(shuō)，如果您執(zhí)行多個(gè)復(fù)雜的操作而沒(méi)有事務(wù)，則jOOQ將為每個(gè)操作使用不同的連接。這可能會(huì)導(dǎo)致競(jìng)賽條件錯(cuò)誤。

在閱讀Ben Manes撰寫(xiě)的這篇評(píng)論時(shí)，我注意到了這個(gè)問(wèn)題。

2. Javadoc不建議使用TransactionAwareDataSourceProxy 。

TransactionAwareDataSourceProxy類(lèi)的Javadoc具有如下部分：

該代理允許數(shù)據(jù)訪問(wèn)代碼與普通JDBC API一起使用，并且仍然參與Spring管理的事務(wù)，這與J2EE / JTA環(huán)境中的JDBC代碼類(lèi)似。但是，如果可能，即使沒(méi)有目標(biāo)DataSource的代理，也可以使用Spring的DataSourceUtils ， JdbcTemplate或JDBC操作對(duì)象來(lái)獲取事務(wù)參與，從而避免了首先定義此類(lèi)代理的麻煩。

這是一個(gè)模糊的評(píng)論，因?yàn)樗鼪](méi)有解釋為什么我們不應(yīng)該使用它。 Adam Zell建議，由于該類(lèi)使用反射，因此使用反射可能會(huì)導(dǎo)致性能問(wèn)題。

如果您遇到性能問(wèn)題，則可能要使用
亞當(dāng)·澤爾的要點(diǎn) 。