ubuntuのTomcatからMySQLに接続するServletを作る。

TomcatからMySQLに接続してテーブルの内容を表示するServletを作ります。TomcatとMySQLは同じサーバー(OSはubuntu)にあります。Servletを動かすためにはJDBCドライバの配置とデータソースの設定をする必要があります。

実行環境
OS: ubuntu 20.04 LTS
Java: OpenJDK 1.8
Tomcat: ver 9.0.65
MySQL: ver 8.0.30

事前の準備としてJDBCドライバを入手します。MySQLのダウンロードページに行きます。

「Connector/J」を選びます。

Select Operating System: に「Ubuntu Linux」を、Select OS Version: には「Ubuntu Linux 20.04」を選びます。ドライバのバージョンは 8.0.30 です。「Download」を押下します。

ログインかサインアップを促す画面となりますが、下部にある「No thanks, just start my download.」をクリックします。

ファイルがダウンロードされます。

ダウンロードしたファイルは mysql-connector-java_8.0.30-1ubuntu20.04_all.deb というdebパッケージです。このパッケージをubuntuにインストールします。

JDBCドライバのインストール
$ sudo apt install ./mysql-connector-java_8.0.30-1ubuntu20.04_all.deb

/usr/share/java 配下に mysql-connector-java-8.0.30.jar が配置されます。

ここからTomcatの設定に入ります。

Tomcatの設定はServletの内容と関連するため、Servletの情報を記載します(実際のソースは後半に書きます)。

ソースファイル名: DsSample.java
クラスファイル名: DsSample.class
コンテキストパス: test
パッケージ: sample1

Tomcatのwebapps配下にファイルを配置していきます。ディレクトリは作成します。薄い青色がデイレクトリ、薄いオレンジ色がファイルです。薄い灰色はソースの配置場所です。

まずは、JDBCドライバを配置します。

/usr/share/java 配下にある mysql-connector-java-8.0.30.jar を WEB-INF/lib 配下にコピーします。シンボリックリンクの作成だとドライバのロードができませんでしたのでコピーをします。

次に、Tomcatのデータソースの設定を行います。データソースはMySQLへの接続情報です。META-INF 配下の context.xml に記載します。context.xml は新規作成します。

MySQLへの接続情報
サーバー: localhost
データベース名: testdb
ユーザ名: test
パスワード: test

コマンドラインでMySQLに接続したときのログです。SHOHINテーブルを検索しました。

この場合の context.xml の記載内容です。

※テキストエディタの画像を貼り付けたのでコードは最後に記載しておきます。

context.xml のResourceタグの各属性の意味です。

name
データソースの名前です。任意の名前をつけます。jdbc/test としました。

auth
Containerを指定するとTomcatが認証の処理を行います。Applicationを指定するとアプリケーションが認証の処理を行います。

type
リソースのクラス名またはインターフェース名です。javax.sql.DataSource を指定します。

driverClassName
JDBCドライバのクラス名です。MySQLのver8.xの場合、com.mysql.cj.jdbc.Driver となります。

url
接続文字列です。MySQLの場合は「jdbc:mysql://サーバー名:ポート/データベース名」という書式です。デフォルトポートの場合はポートの記載を省略できます。

username/password
ユーザ名とパスワードです。

Servletのソースコード( DsSample.java )を見ておきます。文字コードはUTF-8で記載しています。

※テキストエディタの画像を貼り付けたのでソースコードは最後に記載しておきます。

InitialContextクラスのlookupメソッドを使ってデータソースを取得します。取得したデータソースは javax.sql.DataSource インターフェイスのオブジェクトです。lookupメソッドの引数のリソース名は、context.xml のデータソース名の前に java:/comp/env/ を付与して java:/comp/env/jdbc/test とします。

DsSample.javaではWebServletアノテーションを使ってServletのURLを指定しています。コンテキストパスが test、コンテキストルート以降のパスは /sample1/dssample です。

Servletをjavacコマンドでコンパイルします。

コンパイルする際には servlet-api.jar にクラスパスを通しておきます。servlet-api.jar はwebappsと同じ階層のlibディレクトリにあります。コンパイルしたクラスファイルを WEB-INF/classes 配下に持っていきます。

これでServletを動かす準備ができました。Tomcatを起動させます。今回の場合は以下のURLとなります。

http://localhost:8080/test/sample1/dssample

ブラウザにはこんな感じで表示されます。

最後にソースコードを載せておきます。

context.xml


<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration>

<Context reloadable="true">
	<Resource
		name="jdbc/test"
		auth="Container"
		type="javax.sql.DataSource"
		driverClassName="com.mysql.cj.jdbc.Driver"
		url="jdbc:mysql://localhost/testdb"
		username="test"
		password="test"
	/>
</Context>

DsSample.java


package sample1;

import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletException;
import javax.servlet.http.*;
import javax.servlet.annotation.WebServlet;
import javax.naming.InitialContext;
import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;

@WebServlet(urlPatterns={"/sample1/dssample"})
public class DsSample extends HttpServlet
{
	public void doGet (
		HttpServletRequest request, HttpServletResponse response
		) throws ServletException, IOException
		{
			response.setContentType("text/html; charset=UTF-8");
			PrintWriter out = response.getWriter();

			try	{
				out.println("<!DOCTYPE html>");
				out.println("<html>");
				out.println("<head>");
				out.println("<meta charset='UTF-8'>");
				out.println("<title>DsSample.java</title>");
				out.println("</head>");
				out.println("<body>");

				//DBへの接続
				InitialContext ic = new InitialContext();
				DataSource ds = (DataSource)ic.lookup(
					"java:/comp/env/jdbc/test" );
				Connection cn = ds.getConnection();

				//SQLの実行
				PreparedStatement st = cn.prepareStatement(
					"select * from SHOHIN" );
				ResultSet rs = st.executeQuery();

				//結果の出力
				while ( rs.next() )	{
					out.println(rs.getInt("NUMBER"));
					out.println(", ");
					out.println(rs.getString("PRODUCT"));
					out.println(", ");
					out.println(rs.getInt("PRICE"));
					out.println("<br>");
				}

				//オブジェクトのclose
				rs.close();
				st.close();
				cn.close();
			}
			catch ( Exception e ) {
				out.println("エラーが発生しました<br>");
				e.printStackTrace( out );
			}
			finally	{
				out.println("</body>");
				out.println("</html>");
			}
		}
}

ubuntuのJavaからJDBCドライバを使ってMySQLに接続する。

JDBCドライバを使ってMySQLに接続するサンプルプログラムを作りました。ubuntuにJavaをインストールし、MySQLもubuntuのローカルにあります。

OS: ubuntu 20.04 LTS
Java: OpenJDK 1.8
MySQL: ver 8.0.30

まずは、MySQLのJDBCドライバを入手します。MySQLの公式ページに行きます。

「デベロッパーゾーン」をクリックします。

「MySQL Downloads」を選びます。

「Connector/J」を選びます。

Select Operating System: に「Ubuntu Linux」を、Select OS Version: には「Ubuntu Linux 20.04」を選びます。ドライバのバージョンは 8.0.30 です。「Download」を押下します。

ログインかサインアップを促す画面となりますが、下部にある「No thanks, just start my download.」をクリックします。

ファイルがダウンロードされます。

ダウンロードしたファイルですが、ファイル名が mysql-connector-java_8.0.30-1ubuntu20.04_all.deb となっていました。jarファイルがダウンロードされるものと思っていたので、ちょっと想定外です。debパッケージなので、このパッケージをubuntuにインストールします。

JDBCドライバのインストール
$ sudo apt install ./mysql-connector-java_8.0.30-1ubuntu20.04_all.deb

/usr/share/java 配下に mysql-connector-java-8.0.30.jar ができているのを見つけました。どうやらこれがMySQLのJDBCドライバのようです。

ここまでがJDBCドライバであるjarファイルの配置です。

サンプルプログラムを動かす前にMySQLの接続情報を確認しておきます。

サーバー: localhost
データベース名: testdb
ユーザ名: test
パスワード: test

コマンドラインでMySQLに接続したときのログです。SHOHINテーブルを検索しました。

同様のことをJavaでやってみます。JavaからSHOHINテーブルの検索をします。サンプルプログラム( JdbcSample.java )のソースです。文字コードはUTF-8で記載しています。

※テキストエディタの画像を貼り付けたのでソースコードは最後に記載しておきます。

処理としては、

  • DBへの接続
  • SQLの実行
  • 結果の出力
  • オブジェクトのclose

としています。

MySQLの場合の接続文字列の書式です。サンプルプログラムではポートがデフォルトのままなので省略しています。

jdbc:mysql://サーバー名:ポート/データベース名

オブジェクトのcloseですが、ResultSetに関してはPreparedStatementをcloseすれば自動的にcloseされるのですが、省略せずに書いています。エラー処理については、かなり省略しています。

javacコマンドでコンパイルします。

Javaのコンパイル
$ javac ./JdbcSample.java

サンプルプログラムを実行する前にJDBCドライバへのパスを通しておきます。

クラスパスの追加
$ export CLASSPATH=$CLASSPATH:/usr/share/java/mysql-connector-java-8.0.30.jar

サンプルプログラムを実行します。

Javaの実行
$ java JdbcSample

画面上の出力結果
1, Apple, 120
2, Orange, 150
3, Banana, 100

実行してみてわかったことですが、ドライバ名を com.mysql.jdbc.Driver にして実行すると次のメッセージが出ます。

Loading class `com.mysql.jdbc.Driver’. This is deprecated. The new driver class is `com.mysql.cj.jdbc.Driver’. The driver is automatically registered via the SPI and manual loading of the driver class is generally unnecessary.

googleで和訳すると

クラス「com.mysql.jdbc.Driver」をロードしています。これは非推奨です。新しいドライバクラスは「com.mysql.cj.jdbc.Driver」です。ドライバは SPI を介して自動的に登録され、ドライバクラスを手動でロードする必要は通常ありません。

とのことです。ですので、ドライバ名を com.mysql.cj.jdbc.Driver としています。MySQLのver8.xだと、こちらが正しいようです。

最後にソースコードを載せておきます。色が無いのはご容赦ください。


import java.sql.DriverManager;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

public class JdbcSample
{
	public static void main( String[] args )
	{
		//ドライバ名
		String driver = "com.mysql.cj.jdbc.Driver";
		
		//接続文字列
		String url =  "jdbc:mysql://localhost/testdb";
		
		//ユーザー名
		String user = "test";
		
		//パスワード
		String pass = "test";
		
		//SQL文
		String sql = "select * from SHOHIN";
		
		try
		{
			//DBへの接続
			Class.forName( driver );
			Connection cn = DriverManager.getConnection( url, user, pass );
		
			//SQLの実行
			PreparedStatement st = cn.prepareStatement( sql );
			ResultSet rs = st.executeQuery();
		
			//結果の出力
			while( rs.next() )
			{
				String col1 = rs.getString( "NUMBER" );
				String col2 = rs.getString( "PRODUCT" );
				String col3 = rs.getString( "PRICE" );
				System.out.println( col1 + ", " + col2 + ", " + col3 );
			}
		
			//オブジェクトのclose
			rs.close();
			st.close();
			cn.close();
		}
		catch ( ClassNotFoundException e )
		{
			System.out.println( "ドライバのロード失敗" );
			e.printStackTrace();
		}
		catch ( SQLException e )
		{
			System.out.println( "SQLエラーコード: " + e.getErrorCode() );
			e.printStackTrace();
		}
	}
}