More than 5 years have passed since last update.

WebSphereからMySQLへDataSource接続（DataSourceプロパティ変？）

Last updated at 2018-01-29Posted at 2018-01-29

WebSphere Application Server（WAS）からMySQLへのDataSource定義を作成してみたところ、DataSourceのカスタムプロパティで興味深いことを発見したので調査してみました。

DataSourceの作成と接続テスト

WASではJDBC4ドライバに準拠したJDBC接続をサポートしています¹。というわけで、早速やってみましょう。

JDBCプロバイダの作成

JDBC接続（DataSource）は、以下の３つの要素によって構成します。

J2C認証データ
JDBCプロバイダ
JDBCデータソース

順番に設定していきます。

J2C認証データの作成

WASではデータベース接続ユーザをJ2C認証データとしてセキュアに（？）²保存することができます。明文化されている範囲では、J2C認証データとしてユーザ名とパスワードを保持することで、interoperabilityが高まるとのことです。DBアクセスユーザのパスワード変更時の影響を、J2C認証データで吸収できて、アプリケーションには影響しないということでしょうか（いまどきサーバサイドのアプリケーションでパスワードをソースやプロパティに埋込みなんてありえるんでしょうか。。。）。

JDBCドライバは、公式サイトからダウンロードしてきます。本稿記載時点で最新である"Connector/J 5.1.45"前提で話を進めます。

WASの管理コンソールにログインし、「セキュリティー」ー「グローバル・セキュリティー」ー「Java 認証・承認サービス」ー「J2C認証データ」を開きます。「新規作成」を押します。任意の別名、DB接続ユーザのIDおよびパスワードを入力し、「OK」を押します。サーバーレベルで認証データが作成されます。

JDBCプロバイダの作成

JDBCプロバイダはJDBCドライバをロードしてくれる機能です。設定内容もドライバのパスを指定するだけです。
「リソース」ー「JDBC」ー「JDBCプロバイダー」を開き、「有効範囲」をサーバーに設定して「新規作成」します。「データベース・タイプ」を「ユーザー定義」にし、「実装クラス名」に"com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource"³、任意の名称と説明を入力し、「次へ」いきます。「クラスパス」に"${MYSQL_JDBC_DRIVER_PATH}/mysql.jar"を入力し、「次へ」いきます。ドライバパスは移植性の点から、WebSphere変数として定義しておくのがグッドプラクティスですかね。
ドライバのJarファイルを配置するときに注意するべき点は、間違ってもWASディレクトリの"/lib"や"/lib/ext"下に置かないことです。ここに配置してしまうと、サーバー起動時にクラスローダーからドライバがロードされてしまい、DataSource作成時とで重複動作してしまいます。また、ここに"jar"ファイルを置きっ放しにしておいて、あるときに気が変わって別のディレクトリにドライバを置き直したとします。ドライバのアップデートに伴い、後者のファイルだけ置き換えても、ブートストラップ時のクラスローダーが置きっ放しの"jar"をロードしてしまい、結局古いままのドライバを使っていた、なんてオチがつきかねません。こういったトラブルを避けるためにも、またフィックスパックなどによって上書きされたり消されたりしないようにするためにも、製品ディレクトリ下には配置しない方が賢明かと思われます。今回は"/home/piro/mysql.jar"として配置しておきます。

「環境」ー「WebSphere変数」を開き、「有効範囲」をサーバーにしつつ、「新規作成」します。変数名と値を入力して「OK」からの「保存」です。

DataSource作成

同様に、データソースを作成します。任意のデータソース名およびJNDI名を入力して「次へ」いきます。JNDI名アプリケーションからlookupする際にはもう一段かましてENC名でlookup("java:comp/env/jdbc/mysqlmaster")するのが一般的でしょうか（参考文献）。JDBCプロバイダに先ほど設定した"MySQLConnectionPoolDataSource"を指定して「次へ」いきます。「データ・ストアのヘルパー・クラス名」、という聞きなれない用語が出てきましたが、そのまま（初期設定値）で「次へ」いきます。DataSourceのヘルパー・クラスはWASの拡張機能らしく、有名どころのRDBMS用のものは、WASが提供してくれています。が、MySQLはありません。なければ自分で作ればいいじゃん、ということらしいです。これを見る限り、RDBMSエンジン独自のエラーハンドリングなんかを定義するもののようです。あとはこれも先ほど設定したDB接続ユーザーをJ2C認証エイリアスから指定して「次へ」いきます（いつか実験でつかうかもしれないのでコンテナ管理パーシスタンス用も有効にしておきました）。「終了」して構成を「保存」します。

接続テスト

DataSourceができあがりましたので、早速~~装備してみるかい？~~接続してみます。チェックして「テスト接続」をポチッとな。
まあ、繋がるわけありませんよね。これで繋がったら一体お前は何をもってどこのデータベースに接続したんだ！？となりますから。ウィザードにはMySQLのURLを指定する箇所が一切ありませんでしたね。これがOracleとかDb2とかだとウィザード内で指定できます。今回は「ユーザー定義」すなわち、その他諸々なのでURLは聞かれません。自分でDataSourceのカスタムプロパティーとして定義する必要があります。

で、おもむろにDataSourceのプロパティを開くと。。。

なんだかえげつない数のプロパティが存在します。マニュアルにもそんなにないんですけど。。。

カスタムプロパティの元を探る

と、ここまでが前置きです。あれ？と思ったのは、この239個のプロパティの中に、"URL"もあれば"url"もあるという点です。なんで二つあるの？どっち使えばいいの？となりますね。

答えばどちらでもよい、です。どっちでもいいので、正しいURL（例："jdbc:mysql://hostname:3306/dbname"）を入力しておけば、テスト接続は成功します（例のヘルパークラスがデフォルトのジェネリッククラスのままだよ、という警告を伴いますがスルーしましょう）。

気になったのはこのマニュアルにも書かれていないプロパティをどこから取ってきているのかという点です。ドライバ自身から取ってきているに違いないですが、一体どうやって？とJava初心者は不思議に思ったわけです。MySQL Driver/Jの"jar"ファイルごとEclipseにインポートしたら、exposeAsXML()なるメソッドを提供していて⁴、それでプロパティを取ってこられるようになっていましたが、残念ながら"URL"も"url"も出てきませんし、そもそも全てのJDBC準拠ドライバがこんなメソッドを提供しているとも思えません。

GetJDBCProperty.java

package net.mognet.devel;
import java.beans.BeanInfo;
import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.lang.reflect.Method;

class JDBCProperty {
	public static String exposeAsHTML(Object obj) {
		StringBuilder sb = new StringBuilder();
		BeanInfo bi = null;
		PropertyDescriptor[] pd = null;
		
		sb.append("<html>\n");
		sb.append("<head>\n");
		sb.append("<title>" + obj.getClass().getName() + "</title>\n");
		sb.append("<style> table { border-style: solid; border-collapse: collapse; border-width: 1px; padding: 1px 1px 1px 1px ; } </style>\n");
		sb.append("</head>\n");
		sb.append("<body>\n");
		sb.append("<h1>Properties of " + obj.getClass().getName() + "</h1>\n");
		sb.append("<table border>\n");
		try {
			bi = Introspector.getBeanInfo(obj.getClass());
			pd = bi.getPropertyDescriptors();
			sb.append("<tr><th>name</th><th>displayName</th><th>type</th><th>shortDescription</th><th>value</th><th>getter</th><th>setter</th><th>toString</th></tr>\n");
			for(int i = 0; i < pd.length; i++) {
				sb.append("<tr>");
				sb.append("<td>" + pd[i].getName() + "</td>");
				sb.append("<td>" + pd[i].getDisplayName() + "</td>");
				sb.append("<td>" + pd[i].getPropertyType().getName() + "</td>");
				sb.append("<td>" + pd[i].getShortDescription() + "</td>");
				sb.append("<td>" + (String) pd[i].getValue(pd[i].getName()) + "</td>");
				Method m = pd[i].getReadMethod();
				if(m != null) sb.append("<td>" + m.toGenericString() + "</td>");
				else sb.append("<td>n/a</td>");
				m = pd[i].getWriteMethod();
				if(m != null) sb.append("<td>" + m.toGenericString() + "</td>");
				else sb.append("<td>n/a</td>");
				sb.append("<td>" + pd[i].toString() + "</td>");
				sb.append("</tr>\n");
			}
		} catch(IntrospectionException e) {
			e.printStackTrace();
		}
		sb.append("</table></body></html>");
		return sb.toString();
	}
}
public class GetJDBCProperty {
	public static void main(String[] args) throws TransformerException, ClassNotFoundException, InstantiationException, IllegalAccessException {
		Class<?> cls = Class.forName(args[0]);
		Object obj = (Object) cls.newInstance();
		System.out.print(JDBCProperty.exposeAsHTML(obj));
	}
}

XML版とCSV版も実装しましたが、特にXML版は見辛いのでHTML版のみ掲載します。main()は力尽きた感がありますが、第一引数に適当なクラス名を指定するだけです（相手のクラスパスも通します）。一応、GetJDBCPropertyという名前ですが、指定する相手はBean系であればなんでもいいです。
で、これを使ってみたら、結果としてほとんどのプロパティがgetできましたというお話でした（"URL"も"url"も出てきました）。

実行例

$ java -jar -cp <path_to_driver.jar>:. hoge.jar com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource > mysqlConnectionPool.html

付録

JDBC実装クラス名とURL

ついでですが、各種RDBMSでのJDBC実装クラス名とURLシンタックスをまとめてみました。こうやって並べるとOracleの独自性（パッケージングルールやURLの書き方）が際立っていますね。

RDBMS	java.sql.Driver	javax.sql.ConnectionPoolDataSource	javax.sql.XADataSource	URL syntax
MySQL	com.mysql.jdbc.Driver	com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource	com.mysql.jdbc.jdbc2.optional.MysqlXADataSource	jdbc:mysql://[hostname]:[port]/[schema][?attribute=value]*
Db2	com.ibm.db2.jcc.DB2Driver	com.ibm.db2.jcc.DB2ConnectionPoolDataSource	com.ibm.db2.jcc.DB2XADataSource	jdbc:db2://[hostname]:[port]/[database]
Oracle	oralce.jdbc.driver.OracleDriver	oracle.jdbc.pool.OracleConnectionPoolDataSource	oracle.jdbc.xa.client.OracleXADataSource	jdbc:oracle:thin:@[hostname]:[port]:[SID]
SQL Server	com.microsoft.sqlserver.jdbc.SQLServerDriver	com.microsoft.sqlserver.jdbc.SQLServerConnectionPoolDataSource	com.microsoft.sqlserver.jdbc.SQLServerXADataSource	jdbc:sqlserver://[hostname]:1433;DatabaseName=[database]
Derby	org.apache.derby.jdbc.EmbeddedDriver	org.apache.derby.jdbc.EmbeddedConnectionPoolDataSource40	org.apache.derby.jdbc.EmbeddedXADataSource40	jdbc:derby:[subsubprotocol:][databaseName][;attribute=value]*

各JDBCドライバ（ConnectionPoolDataSource実装クラス）に対して実行した結果もご参考までに（DataSourceのプロパティとして必ず使えるというわけではありません）。

com.mysql.jdbc.jdbc2.optional.MysqlConnectionPoolDataSource

com.ibm.db2.jcc.DB2ConnectionPoolDataSource

com.microsoft.sqlserver.jdbc.SQLServerConnectionPoolDataSource

oracle.jdbc.pool.OracleConnectionPoolDataSource

サポートされるコンポーネント一覧※ブラウザの相性なのかうまく表示できないことがあります ↩
特段明記はされていないというか、言及されているところを見ないんですが、きっと暗号化くらいはしてくれているんでしょうね。Liberty Profileですら暗号化可能なので（xorまたはAES128）。 ↩
付録にもまとめましたが、XADataSourceの場合の実装クラス名は"com.mysql.jdbc.jdbc2.optional.MysqlXADataSource "です。 ↩
MysqlConnectionPoolDataSourceのソースをひたすら追いかけてどこかのクラスに実装されていたんですが、どういう継承関係だったかメモを紛失してわからなくなってしまいました。。。
というわけで、JavaのAPIドキュメントからそれっぽいものを探すという不毛な努力を続けた結果、BeanInfoなる素敵そうな名前のクラスを発見して、以下のコードを書いてみました。 ↩

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up