Javaサーブレット開発環境をdocker環境で立ち上げてみる。

はじめに

naritomoと申します。

本職はインフラエンジニアを行っています。
通常ならEclipseで立ち上げるJavaサーブレット開発環境をDockerで構築してみました。

いろいろアドバイスいただけると嬉しいです。

立ち上げ概要

mac環境にて、
docker-composeを使用してjava関連コンテナを立ち上げるものになります。

完成しているソースは以下にあります。

なぜ、あえてDockerなのか？

インフラエンジニアとしてDockerから触れたほうが扱いやすく、
以下の利点を感じられたため、開発環境構築ではDockerを使用することを
推しています。

• OS問わず同じ開発環境での開発が可能　

事前準備

mac+DockerCompose+vscode+gitでの環境を構築してること。

コンテナ構成

apache(httpd)
tomcat(Ver.9)
mysql(5.7.33)
adminer
maven開発(openjdk11)

コンテナ展開方法

git clone https://github.com/naritomo08/tomcat-docker-public.git
cd tomcat-docker-public
docker-compose up -d

tomcatプロジェクトURL

http://localhost:8080/warファイル名/

apache(httpd)プロジェクトURL

http://localhost/warファイル名/

adminer(DB管理ツール)

• ログイン情報
  • サーバ: mysql_db
  • ユーザ名: tomcat
  • パスワード: password
  • データベース: tomcatdb

maven(java)開発環境

コンテナログイン

docker-compose exec maven /bin/bash

tomcatプロジェクト作成

mvn archetype:generate -DgroupId=com.example -DartifactId=my-tomcat-app -Dversion=1.0-SNAPSHOT -DarchetypeArtifactId=maven-archetype-webapp

* "my-tomcat-app"がプロジェクト名(warファイル名)となる。

作成された"my-tomcat-app"内でサーブレットを作成する。

javaフォルダ内でjavaソースファイル/webapp内にJSPファイルを置く。

プロジェクト作成後以下の設定を実施して、mavenビルドできるようにすること。

cd {プロジェクト名}
vi pom.xml

以下の内容を<dependencies>~</dependencies>内に追記する。

    <dependency>
      <groupId>jakarta.servlet</groupId>
      <artifactId>jakarta.servlet-api</artifactId>
      <version>5.0.0</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>jakarta.servlet.jsp</groupId>
      <artifactId>jakarta.servlet.jsp-api</artifactId>
      <version>3.0.0</version>
      <scope>provided</scope>
    </dependency>

以下の内容を<build>~</build>内に追記する。

    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.8.1</version>
        <configuration>
          <source>17</source>
          <target>17</target>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-war-plugin</artifactId>
        <version>3.3.2</version>
      </plugin>
    </plugins>

tomcatサーブレットサンプル

以下のファイルを作成する。

mkdir src/main/java
vi src/main/java/HelloServlet.java

package com.example;

import java.io.IOException;
import jakarta.servlet.ServletException;
import jakarta.servlet.annotation.WebServlet;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

public class HelloServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        response.setContentType("text/html");
        response.getWriter().println("<h1>Hello, World!</h1>");
    }
}

vi src/main/webapp/WEB-INF/web.xml

以下の内容を<web-app>~</web-app>内に追記する。

  <servlet>
    <servlet-name>HelloServlet</servlet-name>
    <servlet-class>com.example.HelloServlet</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>HelloServlet</servlet-name>
    <url-pattern>/helloservlet</url-pattern>
  </servlet-mapping>

mavenビルド

mvn clean package

* targetフォルダ内でwarファイルが作成されること。
コンテナから抜ける。

tomcatビルド

tomcat-docker-public/webapps内にmavenビルドで作成したwarファイルを置く。

以下のURLでサーブレット参照できること。

http://localhost:8080/{プロジェクト名}/{サーブレット名}

apache(httpd)

apacheからのtomcatサイト参照

以下の操作を実施する。

vi tomcat-docker-public/httpd.conf

最後の行に以下の記載を実施。
ProxyPass /my-tomcat-app http://tomcat:8080/my-tomcat-app
ProxyPassReverse /my-tomcat-app http://tomcat:8080/my-tomcat-app

* "my-tomcat-app"(プロジェクト名)について、必要に応じて変更すること。

コンテナ再起動を実施する。

docker-compose stop
docker-compose up -d

以下のURLでサーブレット参照できること。

http://localhost/{プロジェクト名}/{サーブレット名}

おわりに

java開発環境/tomcat稼働dockerを構築してみました。

この記事がjavaを扱う方の助けになればと思います。