コツコツエンジニアノート

TomcatサーブレットとSQLite3との連携、JDBCの導入

#Web

投稿日:2024-04-13

更新日:2026-08-17

TomcatとSQLiteとの連携の準備

SQLite3をTomcatに配置

今回データベースの作成とテーブルの作成だけは事前にSQLite3で直接作っておきます。
sqlite3の実行ファイルにアクセスし、book.dbを作成、その中にmangaテーブルを作成します。
カラムはname, explainの2つのみです。

Copy Code


.open book.db
create table manga(name, explain);

sqlite3.exeと同一階層に、book.dbが作成されていることを確認します。

Tomcat側、webappsの下にbookというフォルダを作り、ここを今回のテストページのルートディレクトリとします。
後ほどサーブレットのアノテーションを使ってroot.jspにアクセスさせるので、index.htmlもindex.jspも作っていないです。
作成したbook.dbもここにコピペします。

JDBCライブラリのダウンロード

JavaからSQLクライアントにアクセスするには、JDBCというライブラリが必要になります。
ただSQLite3の場合、昔はJDBCライブラリ1個で十分でしたが、最近2つに分かれたようです。(2024年4月現在)

こちらのサイトにアクセスし、「sqlite-jdbc-」と「slf4j-api-」の最新verをダウンロードします。
落としたJDBCとAPIのライブラリはbook/WEB-INF/libの下に置きます。

テーブルに対応したbeanを作成

Javaプロジェクトでデータベースとの連携する際には、BeanとDAOを使った設計パターンが推奨されています。
ここで言うBeanは、テーブルのデータ構造をJava側で表したクラスのことです。
Beanはシンプルで最小の構成が望ましいです。

ここではmangaテーブルに対応するMangaクラスを作成し、ファイルの階層はbook/WEB-INF/src/beanの下とします。

Mangaクラス全文

Mangaクラスのコード全文は下の通り。

Copy Code


package bean;

public class Manga implements java.io.Serializable
{
    private String name;
    private String explain;

    public Mange(
        String name, 
        String explain)
    {
        this.name = name;
        this.explain = explain;
    }

    public String getName()
    {
        return name;
    }
    public String getExplain()
    {
        return explain;
    }

    public void setName(String id)
    {
        this.name = id;
    }
    public void setExplain(String title)
    {
        this.explain = title;
    }
}

見ての通り、メンバ変数にはMangaテーブルのカラム要素であるname, explainしか存在しません。
関数もコンストラクタと、各メンバ変数に対応したgetterとsetterしかないです。

余談ですがサーバサイドのコーディング文化では、変数だけでなく関数も最初の文字を小文字で表します。
個人的にはすごい違和感あるけど今回はその文化に倣います。

DAOでデータベースと連携

DAOはData Access Objectの略で、データベースとJavaの橋渡しをこのクラスに担当させます。
それ以外の機能は極力持たせません。
汎用性のためJDBCにアクセスするDAOクラスと、それを継承してSQL文を発行するMangaDAOクラスを別々に実装します。

DAOクラスのファイルの階層はbook/WEB-INF/src/daoの下とします。

DAOクラス全文

コード全文は次の通り。

Copy Code


package dao;

import javax.servlet.ServletContext;
import java.sql.Connection;
import java.sql.DriverManager;

public class DAO
{
    protected ServletContext context;
    
    public DAO(ServletContext context)
    {
        this.context = context;
    }

    public Connection getConnection() throws Exception 
    {
        Class.forName("org.sqlite.JDBC");
        var conn = DriverManager.getConnection("jdbc:sqlite:" + context.getRealPath("book.db"));
        return conn;
    }
}

関数ごとに詳しく解説します。

Copy Code


    public DAO(ServletContext context)
    {
        this.context = context;
    }

後ほどサーブレットから呼ばれるコンストラクタ部分。メンバ変数にServletContextを代入してるだけになります。
下のgetConnection()関数ですぐ使用します。

Copy Code


    public Connection getConnection() throws Exception 
    {
        Class.forName("org.sqlite.JDBC");
        var conn = DriverManager.getConnection("jdbc:sqlite:" + context.getRealPath("book.db"));
        return conn;
    }

こちらは後ほど継承クラス先から呼ばれます。JDBCにアクセスし、そのインスタンスをConnectionとして返します。
データベース接続は例外エラーが出やすい部分ではあるので、関数にthrows Exceptionを付けて後ほどサーブレット側で例外処理も書きます。

Class.forName("org.sqlite.JDBC");

この部分はSQLite3のJDBC内のクラスにアクセスする際の決まり文句になります。
これがMySQLだと文字列が"com.mysql.jdbc.Driver"になったりします。

DriverManager.getConnection("jdbc:sqlite:" + context.getRealPath("book.db"));

ここでパスを指定しデータベースに接続しています。
今回はローカル環境にあるbook.dbにアクセスしてますが、代わってサーバURLを打ち込みサーバにアクセスすることも可能です。

context.getRealPath

、contextはコンストラクタで代入したServletContextになります。
ServletContext.getRealPathで、このホームページのルートディレクトリから続く絶対パスを取得できます。
つまりbookのルートディレクトリにあるbook.dbというファイルにアクセスしています。

DAOでSQL文の発行

DAOクラスを継承し、SQL文を発行するMangaDAOクラスを作成します。
ファイルの階層はDAOクラスと一緒のbook/WEB-INF/src/daoの下とします。

MangaDAOクラス全文

コード全文は次の通り。

Copy Code


package dao;

import bean.Manga;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.ArrayList;
import java.util.List;

import javax.servlet.ServletContext;

public class MangaDAO extends DAO 
{
    private Connection con;
    public void createConnection() throws Exception
    {
        if(con == null)
        {
            con = getConnection();
        }
    }
    public void closeConnection() throws Exception
    {
        if(con != null)
        {
            con.close();
            con = null;
        }
    }

    public MangaDAO(ServletContext context) {
        super(context);
    }

    public List<Manga> getAllList() throws Exception
    {
        PreparedStatement st;
        st = con.prepareStatement
        ("select * from manga");

        ResultSet rs = st.executeQuery();
        List<Manga> list = new ArrayList<Manga>();
        while(rs.next())
        {
            Manga a = new Manga(
                rs.getString("name"),
                rs.getString("explain")
            ); 
            list.add(a);
        }
        st.close();
        return list;
    }

    public void add(String name, String explain) throws Exception
    {
        PreparedStatement st = con.prepareStatement
        ("insert into manga(name, explain) values(?, ?)");
        st.setString(1, name);
        st.setString(2, explain);
        st.executeUpdate();
        st.close();
    }

    public void delete(String name) throws Exception
    {
        PreparedStatement st = con.prepareStatement
        ("delete from manga where name = ?");
        st.setString(1, name);
        st.executeUpdate();
        st.close();
    }
}

用意したSQLとしての機能は次の通り。

getAllList

: mangaテーブルの全てのレコードを取得

add

: mangaテーブルに新しいレコードを追加

delete

: mangaテーブルの指定の名前のレコードを削除

関数ごとに詳しく解説します。

Copy Code


    private Connection con;
    public void createConnection() throws Exception
    {
        if(con == null)
        {
            con = getConnection();
        }
    }

まだデータベースと接続していない場合は継承元のgetConnectionを呼びConnectionを生成、それを保存します。
すでにデータベースと接続している場合は何もしないです。

Copy Code


    public void closeConnection() throws Exception
    {
        if(con != null)
        {
            con.close();
            con = null;
        }
    }

Conneciton.closeで必要なくなったデータベースとの接続を切ります。
ページを全て読み込み終わったら必ずこの処理を実行する必要があります。

Copy Code


    public MangaDAO(ServletContext context) {
        super(context);
    }

MangaDAOのコンストラクタ。親クラスのコンストラクタを呼んでいるだけです。

Copy Code


    public List<Manga> getAllList() throws Exception
    {
        PreparedStatement st;
        st = con.prepareStatement
        ("select * from manga");

        ResultSet rs = st.executeQuery();
        List<Manga> list = new ArrayList<Manga>();
        while(rs.next())
        {
            Manga a = new Manga(
                rs.getString("name"),
                rs.getString("explain")
            ); 
            list.add(a);
        }
        st.close();
        return list;
    }

全レコード取得の関数、throws Exceptionを付けて例外対応をしてあります。

まず

con.prepareStatement("select * from manga");

で発行したいSQL文をプリコンパイルし、PreparedStatementに保存します。
実際のSQL文発行のコードは

st.executeQuery();

の部分で、結果をResultSetに保存しています。

"select * from manga"

のSQL文を発行しているので、結果はbook.dbの全てのレコードになります。

while(rs.next())

、ここで取得した全レコードを一行ずつ抽出して回しています。
それぞれの抽出したレコードは、BeanのMangaクラスに変換しArrayListに追加します。

rs.getString("name")

と

rs.getString("explain")

で分かる通り、レコードに対してgetStringを打つことで、そのカラムの情報を取得できます。

st.close();

ここで必要なくなったプリコンパイルObjectを破棄します。
SQLでやりたい事が終わったら、すみやかにこのcloseでリソースを開放することが推奨されています。
この際紐づいたResultSetのインスタンスも同時に開放されます。
ドキュメント読むと、一応ガベージコレクションを待つだけでも普通に開放されるようではある。

最後に

return list;

で、Mangaクラスに変換した全レコードを返しています。

Copy Code


    public void add(String name, String explain) throws Exception
    {
        PreparedStatement st = con.prepareStatement
        ("insert into manga(name, explain) values(?, ?)");
        st.setString(1, name);
        st.setString(2, explain);
        st.executeUpdate();
        st.close();
    }

レコード追加の関数、こちらもthrows Exceptionを付けてあります。
引数はレコードに必要なnameとexplainのカラムの情報が指定してあります。

con.prepareStatement("insert into manga(name, explain) values(?, ?)");

でレコード追加のSQL文をプリコンパイルし保存します。

values(?, ?)

部分が特徴的で、JavaからSQLに可変の数値や文字列を与えたい場合、まずこの?という文字列でプリコンパイルします。

st.setString(1, name);

と

st.setString(2, explain);

、この部分がSQLのパラメーターの代入コードです。
第一引数に1を指定した場合、プリコンパイルされたSQL文内の最初の?の位置に第二引数が代入されます。
C言語文化圏と違い、最初のインデックスは0ではなく1なので注意。

st.executeUpdate();

でSQL文を発行し、最後に

st.close();

で必要なくなったPrepareStatementを閉じて終了させます。

Copy Code


    public void delete(String name) throws Exception
    {
        PreparedStatement st = con.prepareStatement
        ("delete from manga where name = ?");
        st.setString(1, name);
        st.executeUpdate();
        st.close();
    }

レコード削除の関数、こちらもthrows Exceptionを付けてあります。
やってることは概ねレコード追加と変わらないです。SQL文が違うくらい。
引数に渡されたnameと一致したレコードを、データベースから削除しています。

サーブレットの実装

要点だけ簡潔に解説していきます。
実装するのはレコード全表示、レコード追加、レコード削除のサーブレットの3つ。

Rootクラス(アノテーション"/")

: レコード全表示

AddMangaクラス(アノテーション"/add_manga")

: レコード追加

DeleteMangaクラス(アノテーション"/delete_manga")

: レコード削除

AddMangaとDelteMangaに関しては、処理を終えた後即時Rootにアクセスし直します。

ファイルの階層は全てbook/WEB-INF/src/rootの下とする。

Rootクラス全文

RootクラスではdoGetとdoPostの2つを用意しています。
これの理由は、AddMangaとDeleteMangaからrequest.getRequestDispatcherでRootクラスにアクセスしてくるためです。
response.sendRedirect("/")ではRootにアクセスできなかったので、その代替え処理になります。

処理は全く一緒なためcommonRequestという関数を用意しそこを通しています。

Copy Code


package root;

import bean.Manga;
import dao.MangaDAO;
import java.io.IOException;
import java.util.List;
import javax.servlet.ServletException;
import javax.servlet.http.*;

import javax.servlet.annotation.WebServlet;

@WebServlet(urlPatterns = {"/"})
public class Root extends HttpServlet 
{
    private void commonRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
    {
        try {
            MangaDAO dao = new MangaDAO(getServletContext());
            dao.createConnection();

            List<Manga> allList = dao.getAllList();
            String resultHtml = "";
            for (Manga manga : allList) {
                resultHtml += manga.getName() + ", " + manga.getExplain();
                resultHtml += "<br>";
            }
            request.setAttribute("allList", resultHtml);

            dao.closeConnection();
            request.getRequestDispatcher("/root.jsp").include(request, response);

        } catch(Exception e) {
            System.err.println(e.getMessage());
        }
    }

    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
    {
        commonRequest(request, response);
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
    {
        commonRequest(request, response);
    }
}

データベースは通信状態などから例外エラーが出やすいので、一応try catchで例外処理をしています。
ここではコンソールにエラー文を出してるだけですが、真面目に作るならエラーページに飛ばすべきだと思います。

MangaDAO dao = new MangaDAO(getServletContext());

で初期化を実行、

dao.createConnection();

でbook.dbと接続。

List allList = dao.getAllList();

で全てのレコードをJavaクラスとして取得、

for (Manga manga : allList)

で一つずつ回します。

resultHtml += manga.getName() + ", " + manga.getExplain();

で漫画の名前と説明をテンプレに代入しresultHtmlに追加。

request.setAttribute("allList", resultHtml);

で、jsp側の${allList}に結果を代入します。

用事が終わったら

dao.closeConnection();

で忘れずにデータベースとの接続を切ります。
最後に

request.getRequestDispatcher("/root.jsp")

でroo.jspにアクセスして終了させます。

AddMangaクラス全文

Copy Code


package root;

import dao.MangaDAO;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.*;

import javax.servlet.annotation.WebServlet;

@WebServlet(urlPatterns = {"/add_manga"})
public class AddManga extends HttpServlet 
{
    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
    {
        try {
            MangaDAO dao = new MangaDAO(getServletContext());
            dao.createConnection();

            dao.add(request.getParameter("name"), request.getParameter("explain"));

            dao.closeConnection();
            request.getRequestDispatcher("/").forward(request, response);

        } catch(Exception e) {
            System.err.println(e.getMessage());
        }
    }
}

dao.createConnection();

まではRootと一緒です。

dao.add(request.getParameter("name"), request.getParameter("explain"));

で名前と説明を指定し新しくレコードを追加しています。

dao.closeConnection();

で忘れずにデータベースとの接続を切ります。

request.getRequestDispatcher("/").forward(request, response);

で"/"のアノテーションに接続、つまりRootクラスにアクセスしています。

DeleteMangaクラス全文

Copy Code


package root;

import dao.MangaDAO;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.*;

import javax.servlet.annotation.WebServlet;

@WebServlet(urlPatterns = {"/delete_manga"})
public class DeleteManga extends HttpServlet 
{
    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
    {
        try {
            MangaDAO dao = new MangaDAO(getServletContext());
            dao.createConnection();

            dao.delete(request.getParameter("name"));

            dao.closeConnection();
            request.getRequestDispatcher("/").forward(request, response);

        } catch(Exception e) {
            System.err.println(e.getMessage());
        }
    }
}

あんまりやってる事がAddMangaと変わらないです。

dao.delete(request.getParameter("name"));

ここが唯一違う部分で、名前が一致したレコードを削除しています。

Javaソースをコンパイル

方法は何でもいいので、src以下の全てのソースファイルをコンパイルしてclassesフォルダに配置します。
自分はいちいちコマンドを打ち込むのが面倒なので、src直下にbatファイルを作り対応しました。
下はそのコード全文です。

Copy Code


set CLASSPATH=C:\SQLite\tomcat\lib\servlet-api.jar

javac -encoding utf-8 -d ..\classes -sourcepath . bean\*.java
javac -encoding utf-8 -d ..\classes -sourcepath . dao\*.java
javac -encoding utf-8 -d ..\classes -sourcepath . root\*.java

CLASSPATHに必要なのはTomcatのservlet-api.jarだけで、jsp-api.jarもJDBCへのパスもいらないです。
batをダブルクリックし、実行した結果は次の通り。

jspの実装

root.jspのソースの中身は次の通り。

Copy Code


<!DOCTYPE html>
<html>

  <head>
      <meta charset="UTF-8">
      <title>Test Database</title>
      <style type="text/css">
        body {
          background-color:blanchedalmond;
        }
      </style>
  </head>

  <body>
    <h2>Mangaテーブルだよ！</h2>
    <h3>全レコード</h3>
    ${allList}

    <h3>レコードの追加</h3>
    <form action="add_manga" method="post">
      [名前]<input type="text" name="name">
      [説明]<input type="text" name="explain">
      <button type="submit">レコードを追加</button>
    </form>

    <h3>レコードの削除</h3>
    <form action="delete_manga" method="post">
      [名前]<input type="text" name="name">
      <button type="submit">レコードを削除</button>
    </form>
  </body>

</html>

${allList}

の部分でサーブレットから受け取った全レコードを表示します。
その下にレコードを追加とレコード削除のボタンを置いています。
それぞれ

form action="add_manga"

と

form action="delete_manga"

で対応するアノテーションのサーブレットにジャンプします。

見た目は下の感じで、自由にレコードの追加と削除がホームページ上で出来ます。