5.1. データベースアクセス(共通編)¶
Caution
本バージョンの内容は既に古くなっています。最新のガイドラインはこちらからご参照ください。
Todo
TBD
本章では以下の内容について、現在精査中である。
- 複数データソースについて具体的な内容は、Overviewの複数データソースについておよびHow to extendsの複数データソースについてを参照されたい。
- JPA利用時の一意制約エラー及び悲観排他エラーのハンドリング方法について具体的な内容は、Overviewの例外ハンドリングについてを参照されたい。
5.1.1. Overview¶
5.1.1.1. JDBC DataSourceについて¶
5.1.1.1.1. アプリケーションサーバ提供のJDBCデータソース¶
¶ 項番 アプリケーションサーバ 参照ページ
Apache Tomcat 7 Apache Tomcat 7 User Guide(JNDI Datasource HOW-TO)(Apache Commons DBCP)を参照されたい。
Oracle WebLogic Server 12c Oracle WebLogic Server Product Documentationを参照されたい。
IBM WebSphere Application Server Version 8.5 WebSphere Application Server Online information centerを参照されたい。
Resin 4.0 Resin Documentationを参照されたい。
5.1.1.1.2. OSS/Third-Partyライブラリ提供のJDBCデータソース¶
¶ 項番 ライブラリ名 説明
Apache Commons DBCP Apache Commons DBCPを参照されたい。
5.1.1.1.3. Spring Framework提供のJDBCデータソース¶
5.1.1.2. トランザクションの管理方法について¶
5.1.1.3. トランザクション境界/属性の宣言について¶
@Transactional
アノテーションを指定することで実現する。5.1.1.4. データの排他制御について¶
5.1.1.5. 例外ハンドリングについて¶
java.sql.SQLException
)や、O/R Mapper固有の例外を、Spring Frameworkから提供しているデータアクセス例外(org.springframework.dao.DataAccessException
のサブクラス)に変換する機能がある。DataAccessException
をcatchするのではなく、エラー内容を通知するサブクラスの例外をcatchすること。
¶ 項番 クラス名 説明
org.springframework.dao.DuplicateKeyException 一意制約違反が発生した場合に発生する例外。
org.springframework.dao.OptimisticLockingFailureException 楽観ロックに成功しなかった場合に発生する例外。他の処理によって同一データが更新されていた場合に発生する。本例外は、O/R MapperとしてJPAを使用する場合に発生する例外である。Mybatisには楽観ロックを行う機能がないため、O/R Mapper本体から本例外が発生することはない。
org.springframework.dao.PessimisticLockingFailureException 悲観ロックに成功しなかった場合に発生する例外。他の処理で同一データがロックされており、ロック解放待ちのタイムアウト時間を超えてもロックが解放されない場合に発生する。Note
O/R MapperにMybatisを使用して楽観ロックを実現する場合は、ServiceやRepositoryの処理として楽観ロック処理を実装する必要がある。
本ガイドラインでは、楽観ロックに失敗したことを、Controllerに通知する方法として、
OptimisticLockingFailureException
およびその子クラスの例外を発生させることを推奨する。理由は、アプリケーション層の実装(Controllerの実装)を、使用するO/R Mapperに依存させないためである。
Todo
JPA(Hibernate)を使用すると、現状意図しないエラーとなることが発覚している。
- 一意制約違反が発生した場合、
DuplicateKeyException
ではなく、org.springframework.dao.DataIntegrityViolationException
が発生する。- 悲観ロックに失敗した場合、
PessimisticLockingFailureException
ではなく、org.springframework.dao.UncategorizedDataAccessException
の子クラスが発生する。悲観エラー時に発生する
UncategorizedDataAccessException
は、システムエラーに分類される例外なので、アプリケーションでハンドリングすることは推奨されないが、最悪ハンドリングを行う必要があるかもしれない。 原因例外には、悲観ロックエラーが発生したことを通知する例外が格納されているので、ハンドリングできる。⇒継続調査。
現状以下の動作となる。
- PostgreSQL + for update nowait
- org.springframework.orm.hibernate3.HibernateJdbcException
- Caused by: org.hibernate.PessimisticLockException
- Oracle + for update
- org.springframework.orm.hibernate3.HibernateSystemException
- Caused by: Caused by: org.hibernate.dialect.lock.PessimisticEntityLockException
- Caused by: org.hibernate.exception.LockTimeoutException
- Oracle / PostgreSQL + 一意制約
- org.springframework.dao.DataIntegrityViolationException
- Caused by: org.hibernate.exception.ConstraintViolationException
下記は、一意制約違反を、ビジネス例外として扱う実装例である。
try { accountRepository.saveAndFlash(account); } catch(DuplicateKeyException e) { // (1) throw new BusinessException(ResultMessages.error().add("e.xx.xx.0002"), e); // (2) }
項番 説明 (1) 一意制約違反が発生した場合に発生する例外(DuplicateKeyException)をcatchする。 (2) データが重複している旨を伝えるビジネス例外を発生させている。例外をcatchした場合は、必ず原因例外(e
) をビジネス例外に指定すること。
5.1.1.6. 複数データソースについて¶
¶ 項番 ケース 例 特徴
データ(テーブル)の分類毎にデータベースやスキーマがわかれている場合。 顧客情報を保持するテーブル群と請求情報を保持するテーブル群が別々のデータベースやスキーマに格納されている場合など。 処理で扱うデータは決まっているので、静的に使用するデータソースを決定することができる。
利用者(ログインユーザ)によって使用するデータベースやスキーマが分かれている場合。 利用者の分類毎にデータベースやスキーマがわかれている場合など(マルチテナント等)。 利用者によって使用するデータソースが異なるため、動的に使用するデータソースを決定する必要がある。 Todo
TBD
今後、以下の内容を追加する予定である。
- 概念レベルのイメージ図
- 上記2ケースについての詳細。 特に、(1)のケースは、処理パターン(複数のデータソースに対して更新あり、更新は1つのデータソース、参照のみ、同時アクセスはなしなど)によってトランザクション管理の方法がかわると思うので、その辺りを中心にブレークダウンする予定である。
5.1.2. How to use¶
5.1.2.1. データソースの設定¶
5.1.2.1.1. アプリケーションサーバで定義したDataSourceを使用する場合の設定¶
xxx-context.xml
(Tomcatの設定ファイル)<!-- (1) --> <Resource type="javax.sql.DataSource" name="jdbc/SampleDataSource" driverClassName="org.postgresql.Driver" url="jdbc:postgresql://localhost:5432/terasoluna" username="postgres" password="postgres" defaultAutoCommit="false" /> <!-- (2) -->
xxx-env.xml
<jee:jndi-lookup id="dataSource" jndi-name="jdbc/SampleDataSource" /> <!-- (3) -->
項番 属性名 説明 (1)- データソースを定義する。 type リソースの種類を指定する。 javax.sql.DataSource
を指定する。name リソース名を指定する。ここで指定した名前がJNDI名となる。 driverClassName JDBCドライバクラスを指定する。例では、PostgreSQLから提供されているJDBCドライバクラスを指定する。 url 接続URLを指定する。 【環境に合わせて変更が必要】 username 接続ユーザ名を指定する。【環境に合わせて変更が必要】 password 接続ユーザのパスワードを指定する。【環境に合わせて変更が必要】 defaultAutoCommit 自動コミットフラグのデフォルト値を指定する。falseを指定する。トランザクション管理下であれば強制的にfalseになる。 (2)- Tomcat7の場合、factory属性を省略するとtomcat-jdbc-poolが使用される。設定項目の詳細については、Attributes of The Tomcat JDBC Connection Poolを参照されたい。 (3)- データソースのJNDI名を指定する。Tomcatの場合は、データソース定義時のリソース名「(1)-name」に指定した値を指定する。
5.1.2.1.2. Bean定義したDataSouceを使用する場合の設定¶
xxx-env.xml
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close"> <!-- (1) (8) --> <property name="driverClassName" value="org.postgresql.Driver" /> <!-- (2) --> <property name="url" value="jdbc:postgresql://localhost:5432/terasoluna" /> <!-- (3) --> <property name="username" value="postgres" /> <!-- (4) --> <property name="password" value="postgres" /> <!-- (5) --> <property name="defaultAutoCommit" value="false"/> <!-- (6) --> <!-- (7) --> </bean>
項番 説明 (1)データソースの実装クラスを指定する。例では、Apache Commons DBCPから提供されているデータソースクラス( org.apache.commons.dbcp.BasicDataSource
)を指定する。 (2)JDBCドライバクラスを指定する。例では、PostgreSQLから提供されているJDBCドライバクラスを指定する。 (3)接続URLを指定する。 【環境に合わせて変更が必要】 (4)接続ユーザ名を指定する。【環境に合わせて変更が必要】 (5)接続ユーザのパスワードを指定する。【環境に合わせて変更が必要】 (6)自動コミットフラグのデフォルト値を指定する。falseを指定する。トランザクション管理下であれば、強制的にfalseになる。 (7) BasicDataSourceには上記以外に、JDBC共通の設定値の指定、JDBCドライバー固有のプロパティ値の指定、コネクションプーリング機能の設定値の指定を行うことができる。設定項目の詳細については、DBCP Configurationを参照されたい。 (8) 設定例では値を直接指定しているが、環境によって設定値がかわる項目については、Placeholder(${…})を使用して、実際の設定値はプロパティファイルに指定すること。Placeholderについては、Spring Reference DocumentのPropertyPlaceholderConfigurer
を参照されたい。
5.1.2.2. トランザクション管理を有効化するための設定¶
5.1.2.3. JDBCのDebug用ログの設定¶
Warning
本設定はDebug用の設定なので、性能試験および商用環境にリリースする資材には、設定しないようにすること。
5.1.2.3.1. log4jdbc提供のデータソースの設定¶
xxx-env.xml
<jee:jndi-lookup id="dataSourceSpied" jndi-name="jdbc/SampleDataSource" /> <!-- (1) --> <bean id="dataSource" class="net.sf.log4jdbc.Log4jdbcProxyDataSource"> <!-- (2) --> <constructor-arg ref="dataSourceSpied" /> <!-- (3) --> </bean>
項番 説明 (1)データソースの実体を定義する。例では、アプリケーションサーバからJNDI経由で取得したデータソースを使用している。 (2)log4jdbcより提供されている net.sf.log4jdbc.Log4jdbcProxyDataSource
を指定する。 (3)データソースの実体となるbeanを、コンストラクタに指定する。 Warning
性能試験及び商用環境にリリースする場合、データソースとしてLog4jdbcProxyDataSourceは使用しないこと。
具体的には、(2)と(3)の設定を外し、
"dataSourceSpied"
のbean名を"dataSource"
に変更する。
5.1.2.3.2. log4jdbc用ロガーの設定¶
logback.xml
<!-- (1) --> <logger name="jdbc.sqltiming"> <level value="debug" /> </logger> <!-- (2) --> <logger name="jdbc.sqlonly"> <level value="warn" /> </logger> <!-- (3) --> <logger name="jdbc.audit"> <level value="warn" /> </logger> <!-- (4) --> <logger name="jdbc.connection"> <level value="warn" /> </logger> <!-- (5) --> <logger name="jdbc.resultset"> <level value="warn" /> </logger> <!-- (6) --> <logger name="jdbc.resultsettable"> <level value="debug" /> </logger>
項番 説明 (1) バインド変数に値が設定された状態のSQL文と、SQLの実行時間を出力するためのロガー。値がバインドされた形式のSQLが出力されるので、DBアクセスツールに貼りつけて実行する事ができる。 (2) バインド変数に値が設定された状態のSQL文を、出力するためのロガー。(1)との違いは、実行時間が出力されない。 (3) ResultSetインタフェースを除く、JDBCインタフェースのメソッド呼び出し(引数と、返り値)を出力するためのロガー。JDBC関連で問題が発生した時の解析に有効なログであるが、出力されるログの量が多い。 (4) Connectionの接続/切断イベントと使用中の接続数を出力するためのロガー。接続リークが発生時の解析に有効なログであるが、接続リークの問題がなければ、出力する必要はない。 (5) ResultSetインタフェースに対するメソッド呼び出し(引数と、返り値)を出力するためのロガー。取得結果が、想定と異なった時の解析に有効なログであるが、出力されるログの量が多い。 (6) ResultSetの中身を確認しやすい形式にフォーマットして出力するためのロガー。取得結果が、想定と異なった時の解析に有効なログであるが、出力されるログの量が多い。Warning
ロガーによっては大量にログが出力されるので、必要なロガーのみ定義、または出力対象にすること。
上記サンプルでは、開発中の非常に有効なログを出力するロガーについて、ログレベルを
"debug"
に設定している。 その他のロガーについては、必要に応じて"debug"
に設定する必要がある。性能試験及び商用環境にリリースする場合、正常終了時にlog4jdbc用のロガーによってログが出力されないようにすること。
具体的には、ログレベルを
"warn"
に設定する。
5.1.2.3.3. log4jdbcのオプションの設定¶
クラスパス直下に、log4jdbc.properties
というプロパティファイルを配置することで、log4jdbcのデフォルトの動作をカスタマイズすることができる。
log4jdbc.properties
# (1) log4jdbc.dump.sql.maxlinelength=0 # (2)
項番 説明 (1)SQL分の折り返し文字数を指定する。0を指定すると、折り返しはされない。 (2)オプションの詳細については、log4jdbc project pageを参照されたい。
5.1.3. How to extend¶
5.1.3.1. 複数データソースを使用するための設定¶
Todo
TBD
今後、以下の内容を追加する予定である。
- 複数データソースを使う際の注意点などを踏まえた設定例。
- 実装にも影響がある場合は、実装例。
5.1.4. how to solve the problem¶
5.1.4.1. N+1問題の対策方法¶
N+1問題とは、データベースから取得するレコード数に比例して実行されるSQLの数が増えることにより、データベースへの負荷およびレスポンスタイムの劣化を引き起こす問題のことである。
以下に、具体的をあげる。
項番 説明 (1) 検索条件に一致するレコードを、メインとなるテーブルから検索する。上記例では、 MainTableテーブルのcol1カラムが、'Foo'
のレコードを取得しており、20件のレコードが取得されている。 (2) (1)で検索した各レコードに対して、関連レコードを関連テーブルから取得する。上記例では、SubTableテーブルのidカラムが、(1)で取得したレコードのidカラムと同じレコードを取得している。このSQLは、(1)で取得されたレコード件数分、実行される。上記例では、合計で21回のSQLが発行されることになる。仮に関連テーブルが3テーブルあると、合計で61回のSQLが発行されることになるため、対策が必要となる。
N+1問題の解決方法の代表例を、以下に示す。
5.1.4.1.1. JOIN(Join Fetch)を使用して解決する¶
項番 説明 (1) 検索条件に一致するレコードを検索する際に、関連テーブルをJOINすることで、メインとなるテーブルと関連テーブルから、レコードを一括で取得する。上記例では、 MainTableテーブルのcol1カラムが'Foo'
のレコードと、検索条件に一致したレコードのidが一致するSubTableのレコードを一括で取得している。カラム名が重複する場合は、別名を付与してどちらのテーブルのカラムなのか識別する必要がある。JOIN(Join Fetch)を使用すると、1回のSQLの発行で必要なデータを全て取得することができる。Warning
関連テーブルとの関連が、1:Nの場合は、JOIN(Join Fetch)による解決も可能だが、以下の点に注意すること。
- 1:Nの関連をもつレコードをJOINする場合、関連テーブルのレコード数に比例して、無駄なデータを取得することになる。 詳細については、一括取得時の注意事項を参照されたい。
- JPA(Hibernate)使用する際に、1:NのNの部分が、複数ある場合は、Nの部分を格納するコレクション型は、
java.util.List
ではなく、java.util.Set
を使用する必要がある。
5.1.4.1.2. 関連レコードを一括で取得する事で解決する¶
項番 説明 (1) 検索条件に一致するレコードを、メインとなるテーブルから検索する。上記例では、 MainTableテーブルのcol1カラムが、'Foo'
のレコードを取得しており、20件のレコードが取得されている。 (2) (1)で検索した各レコードに対して、関連レコードを関連テーブルから取得する。1レコード毎に取得するのではなく、(1)で取得した各レコードの外部キーに一致するレコードを、一括で取得する。上記例では、SubTableテーブルのidカラムが、(1)で取得したレコードのidカラムと同じレコードを、IN句を使用して一括取得している。 (3) (2)で取得したSubTableのレコードを、(1)で取得したレコードに振り分けマージする。上記例では、合計で2回のSQLの発行で、必要なデータを取得することができる。仮に、関連テーブルが、3テーブルあっても、合計で4回のSQLの発行で済むことになる。Note
この方法は、SQLの発行を最小限におさえつつ、必要なデータのみ取得することができるという特徴をもつ。 関連テーブルのレコードをプログラミングによって振り分ける必要があるが、関連テーブルの数が多い場合や、1:NのNのレコード数が多い場合は、この方法で解決する方がよいケースがある。
5.1.5. Appendix¶
5.1.5.1. LIKE検索時のエスケープについて¶
org.terasoluna.gfw.common.query.QueryEscapeUtils
クラスのメソッドを使用することで、実現することができる。5.1.5.1.1. 共通ライブラリのエスケープ仕様について¶
共通ライブラリから提供しているエスケープ処理の仕様は、以下の通りである。
- エスケープ文字は「
"~"
」。 - エスケープ対象文字は「
"%"
,"_"
,"%"
,"_"
」 の4文字。
具体的なエスケープ例を以下に示す。
項番 対象文字列 エスケープ後文字列 エスケープ有無 解説
"a"
"a"
無 エスケープ対象文字が含まれていないため、エスケープされない。
"a~"
"a~~"
有 エスケープ文字が含まれているため、エスケープされる。
"a%"
"a~%"
有 エスケープ対象文字が含まれているため、エスケープされる。
"a_"
"a~_"
有 No.3と同様。
"_a%"
"~_a~%"
有 エスケープ対象文字が含まれているため、エスケープされる。エスケープ対象文字が複数存在する場合はすべてエスケープされる。
"a%"
"a~%"
有 No.3と同様。
"a_"
"a~_"
有 No.3と同様。
" "
" "
無 No.1と同様。
""
""
無 No.1と同様。
null
null
無 No.1と同様。
5.1.5.1.2. 共通ライブラリから提供しているエスケープ用のメソッドについて¶
QueryEscapeUtils
クラスのエスケープ用メソッドの一覧を、以下に示す。
項番 メソッド名 説明
toLikeCondition(String) 引数で渡された文字列をLIKE検索用にエスケープする。SQLやJPQL側で一致方法(前方一致、後方一致、部分一致)を指定する場合は、本メソッドを使用してエスケープのみ行う。
toStartingWithCondition(String) 引数で渡された文字列をLIKE検索用にエスケープした上で、エスケープ後の文字列の最後尾に"%"
を付与する。前方一致検索用の値に変換する場合に使用するメソッドである。
toEndingWithCondition(String) 引数で渡された文字列をLIKE検索用にエスケープした上で、エスケープ後の文字列の先頭に"%"
を付与する。後方一致検索用の値に変換する場合に使用するメソッドである。
toContainingCondition(String) 引数で渡された文字列をLIKE検索用にエスケープした上で、エスケープ後の文字列の先頭と最後尾に"%"
を付与する。部分一致検索用の値に変換する場合に使用するメソッドである。Note
No.2, 3, 4 については、SQLやJPQL側で一致方法(前方一致、後方一致、部分一致)を指定するのではなく、プログラム側で指定する時に使用するメソッドである。
5.1.5.1.3. 共通ライブラリの使用方法¶
LIKE検索時のエスケープ実装例については、使用するO/R Mapper向けのドキュメントを参照されたい。
- JPA(Spring Data JPA)を使用する場合は、データベースアクセス(JPA編)のLIKE検索時のエスケープについてを参照されたい。
- Mybatis2(TERASOLUNA DAO)を使用する場合は、データベースアクセス(Mybatis2編)のLIKE検索時のエスケープについてを参照されたい。
5.1.5.2. Sequencerについて¶
Note
共通ライブラリとしてSequencerを用意した理由
Sequencerを用意した理由は、JPAの機能として提供されているID採番機能において、シーケンス値を文字列としてフォーマットする仕組みがないためである。 実際のアプリケーション開発では、フォーマットされた文字列をプライマリキーに設定するケースもあるため、共通ライブラリとしてSequencerを提供している。
プライマリキーに設定する値が数値の場合は、JPAの機能として提供されているID採番機能を使用することを推奨する。JPAのID採番機能については、データベースアクセス(JPA編)のEntityの追加を参照されたい。
Sequencerを用意した主な目的は、JPAでサポートされていない機能の補完であるが、JPAと関係ない処理で、シーケンス値が必要な場合に、使用することもできる。
5.1.5.2.1. 共通ライブラリから提供しているクラスについて¶
項番 クラス名 説明
org.terasoluna.gfw.common.sequencer.Sequencer 次のシーケンス値を取得するメソッド(getNext)とシーケンスの現在値を返却するメソッド(getCurrent)を定義しているインタフェース。
org.terasoluna.gfw.common.sequencer.JdbcSequencerSequencer
インタフェースのJDBC用の実装クラス。データベースにSQLを発行してシーケンス値を取得するためのクラスである。データベースのシーケンスオブジェクトから値を取得することを想定したクラスではあるが、データベースにストアードされているファンクションを呼び出すことで、シーケンスオブジェクト以外から値を取得することもできる。
5.1.5.2.2. 共通ライブラリの利用方法¶
Sequencerをbean定義する。
xxx-infra.xml
<!-- (1) --> <bean id="articleIdSequencer" class="org.terasoluna.gfw.common.sequencer.JdbcSequencer"> <!-- (2) --> <property name="dataSource" ref="dataSource" /> <!-- (3) --> <property name="sequenceClass" value="java.lang.String" /> <!-- (4) --> <property name="nextValueQuery" value="SELECT TO_CHAR(NEXTVAL('seq_article'),'AFM0000000000')" /> <!-- (5) --> <property name="currentValueQuery" value="SELECT TO_CHAR(CURRVAL('seq_article'),'AFM0000000000')" /> </bean>
項番 説明 (1)org.terasoluna.gfw.common.sequencer.Sequencer
インタフェースを実装したクラスを、bean定義する。上記例では、SQLを発行してシーケンス値を取得するためのクラス(JdbcSequencer
)を指定している。 (2) シーケンス値を取得するSQLを、実行するデータソースを指定する。 (3) 取得するシーケンス値の型を指定する。上記例では、SQLで文字列へ変換しているので、java.lang.String
型を指定している。 (4) 次のシーケンス値を取得するためのSQLを指定する。上記例では、データベース(PostgreSQL)のシーケンスオブジェクトから取得したシーケンス値を、文字列としてフォーマットしている。データベースのから取得したシーケンス値が、1
の場合、"A0000000001"
がSequencer#getNext()
メソッドの返り値として返却される。 (5) 現在のシーケンス値を取得するためのSQLを指定する。データベースのから取得したシーケンス値が、2
の場合、"A0000000002"
がSequencer#getCurrent()
メソッドの返り値として返却される。
bean定義したSequencerからシーケンス値を取得する。
- Service
// omitted // (1) @Inject @Named("articleIdSequencer") // (2) private Sequencer<String> articleIdSequencer; // omitted @Transactional public Article createArticle(Article inputtedArticle) { String articleId = articleIdSequencer.getNext(); // (3) inputtedArticle.setArticleId(articleId); Article savedArticle = articleRepository.save(inputtedArticle); return savedArticle; }
項番 説明 (1) bean定義したSequencer
オブジェクトをInjectする。上記例では、シーケンス値は、フォーマットされた文字列として取得するため、Sequencer
のジェネリックス型には、java.lang.String
型を指定している。 (2) Injectするbeanのbean名を@javax.inject.Named
アノテーションのvalue属性に指定する。上記例では、xxx-infra.xml
に定義したbean名("articleIdSequencer"
)を指定している。 (3)Sequencer#getNext()
メソッドを呼び出し、次のシーケンス値を取得する。上記例では、取得したシーケンス値を、EntityのIDとして使用している。現在のシーケンス値を取得する場合は、Sequencer#getCurrent()
メソッドを呼び出す。Tip
bean定義する
Sequencer
が一つの場合は、@Named
アノテーションが省略できる。複数指定する場合は、@Named
アノテーションを使用して、bean名の指定が必要となる。
5.1.5.3. Spring Frameworkから提供されているデータアクセス例外へ変換するクラス¶
Spring Frameworkのデータアクセス例外へ変換する役割を持つクラスを、以下に示す。
¶ 項番 クラス名 説明
org.springframework.orm.hibernate3.SessionFactoryUtilsJPA(Hibernateの実装)を使った場合、本クラスによって、O/R Mapper例外がSpring Frameworkのデータアクセス例外に変換される。
org.hibernate.dialect.DialectのサブクラスJPA(Hibernateの実装)を使った場合、本クラスによって、JDBC例外とO/R Mapper例外に変換される。
org.springframework.jdbc.support.SQLErrorCodeSQLExceptionTranslatorMybatisや、JdbcTemplateを使った場合、本クラスによって、JDBC例外が、Spring Frameworkのデータアクセス例外に変換される。変換ルールは、XMLファイルに記載されており、デフォルトで使用されるXMLファイルは、spring-jdbc.jar内のorg/springframework/jdbc/support/sql-error-codes.xmlとなる。 クラスパス直下に、XMLファイル(sql-error-codes.xml)を配置することで、デフォルトの動作を変更することもできる。
5.1.5.4. Spring Frameworkから提供されているJDBCデータソースクラス¶
¶ 項番 クラス名 説明
org.springframework.jdbc.datasource.DriverManagerDataSourceアプリケーションからコネクションの取得依頼があったタイミングで、 java.sql.DriverManager#getConnection
を呼び出し、新しいコネクションを生成するデータソースクラス。 コネクションのプーリングが必要な場合は、アプリケーションサーバのデータソース、または、OSS/Third-Partyライブラリから提供されているデータソースを使用すること。
org.springframework.jdbc.datasource.SingleConnectionDataSourceDriverManagerDataSource
の子クラスで、一つのコネクションを使いまわす実装になっており、シングルスレッドで動くユニットテスト向けのデータソースクラスである。 ユニットテストでも、マルチスレッドでデータソースにアクセスする場合は、本クラスを使用すると、期待した動作にならないことがあるので、注意が必要である。
org.springframework.jdbc.datasource.SimpleDriverDataSourceアプリケーションからコネクションの取得依頼があったタイミングで、 java.sql.Driver#getConnection
を呼び出し、新しいコネクションを生成するデータソースクラス。 コネクションのプーリングが必要な場合は、アプリケーションサーバのデータソース、または、OSS/Third-Partyライブラリから提供されているデータソースを使用すること。
¶ 項番 クラス名 説明
org.springframework.jdbc.datasource.TransactionAwareDataSourceProxyトランザクション管理されていないデータソースを、Spring Frameworkのトランザクション管理対象にするためのアダプタークラス。
org.springframework.jdbc.datasource.lookup.IsolationLevelDataSourceRoute実行中のトランザクションの独立性レベルによって、使用するデータソースを切り替えるためのアダプタークラス。