devkuma – Tomcat

Tomcat概要

kc@example.com (kc kim) — Tue, 08 Nov 2022 00:46:00 +0900

Tomcat概要

Tomcatは、世界中で広く使用されているオープンソースのWebコンテナである。

Tomcatの正式名称は「Apache Tomcat」だが、単に「Tomcat」と言っても多くの人が認識できるほど、現在のWebコンテナの事実上の標準と言っても過言ではない。TomcatはJava言語で書かれており、Javaが動作する多くのプラットフォームで使用でき、安定していて軽量で性能も良いため、多くのエンタープライズシステムでも活用されている。

TomcatはJava ServletおよびJSP（JavaServer Pages）のリファレンス実装としてSun Microsystems社で開発が始まり、1999年にApache Software Foundation（ASF）へ寄贈された後、初期バージョンとして3.0が発表された。

Tomcatという「雄猫」を意味する名前は、単独で行動し戦えるというイメージから来ており、開発者James Duncan Davidsonによって命名された。

現在も積極的にバージョンアップされており、Apache Software Foundationが保有するトップレベルプロジェクトの一つとして進化を続けている。

最新バージョンの10.0.xでは、Servlet 5.0、JSP 3.0、EL 4.0、WebSocket 2.0、HTTP/2などの機能が含まれている。現在開発中の次期バージョン10.1.xでは、Servlet 6.0、JSP 3.1、EL 5.0、WebSocket（バージョン未確定）、Authentication（JASPIC）（バージョン未確定）が実装される。

Tomcatライセンス

Tomcatのライセンスは「Apache License version 2」に基づいて公開されており、営利・非営利を問わず誰でも自由かつ無料で利用、変更、再配布できる。 TomcatはServlet/JSP仕様をサポートするリリースモジュールを使用する。

Tomcatと類似したソフトウェア

商用ソフトウェア製品では、WebLogic ExpressやWebSphere Application Server ExpressがTomcatと類似した機能を提供する。

Tomcatの主な特徴

Tomcatには高性能と高い安定性だけでなく、次のような特徴がある。
機能や性能、実績などは商用製品と比べてもTomcatでほとんど変わらないため、「よりオープンスタンダードである」「よりコストを削減できる」という点がTomcatを選ぶ決め手になっているようである。

JSP/Servlet標準仕様
- TomcatはJava ServletとJSPの公式リファレンス実装として開発および実装された。
- Tomcat単体でもWebサーバー（httpd）として動作するが、通常はApacheやIISと組み合わせて使用する。
軽快な動作、安定性
- Tomcatは動作が安定していて軽量なため、商用製品のように高スペックなハードウェアを必要とせず、インストールも容易である。
マルチプラットフォーム
- TomcatはRed Hat Enterprise Linux、SUSE Linux、Sun Solaris、HP-UX、Microsoft Windows、AIXなど、さまざまなOSプラットフォームをサポートする。
世界中で利用されている
- 世界中で広く使われているWebコンテナの事実上の標準であり、多くの導入事例がある。
高機能、高性能
- TomcatはJSP/Servlet標準仕様として、機能は商用製品と同等であり、性能も商用製品と同等、またはむしろ高速である。
技術者を集めやすい
- Tomcatは世界中で利用されているデファクトスタンダードであるため、大人数で開発するプロジェクトや海外開発などでも技術者を集めやすい。また、環境構築や開発に余分な教育コストがかからず、知的資産を共有しやすいなどの利点もある。
長期間利用可能
- 通常、商用製品のサポートは3～5年だが、Tomcatは動作が安定しているため、サポートなしでも長期間利用できる場合が多い。
コスト効果
- Tomcatは高機能なWebコンテナでありながらライセンス費用がかからないため、気軽に使用でき、商用製品に比べてコストを大幅に削減できる。

TomcatおよびServlet/JSPバージョン対応表

Apache Tomcatバージョン	Servlet Spec	JSP Spec	EL Spec	WebSocket Spec	JDK
10.1.x	6.0	3.1	5.0	2.1	8以上
10.0.x	5.0	3.0	4.0	2.0	8以上
9.0.x	4.0	2.3	3.0	1.1	8以上
8.5.x	3.1	2.3	3.0	1.1	7以上
8.0.x(EOL)	3.1	2.3	3.0	1.1	7以上
7.0.x(EOL)	3	2.2	2.2	1.1	6以上
6.0.x(EOL)	2.5	2.1	2.1	-	5以上
5.5.x(EOL)	2.4	2	-	-	1.4以上

参照元: http://tomcat.apache.org/whichversion.html

TomcatでWebフォルダにアクセスしてファイル一覧を表示する設定

kc@example.com (kc kim) — Sun, 31 Dec 2017 12:04:39 +0900

Web画面からフォルダにアクセスし、ファイル一覧を確認する設定方法について説明する。

デフォルト設定の場合、ブラウザからURLフォルダに直接アクセスすると、次のように404エラーが表示されてアクセスできない。

Tomcatの DefaultServlet は、デフォルトではディレクトリ一覧を表示しないように構成されている。Tomcatの {Tomcatインストールフォルダ}/conf/web.xml ファイルを開き、DefaultServlet の <servlet> 要素を探す。

... 省略 ...
    <servlet>
        <servlet-name>default</servlet-name>
        <servlet-class>org.apache.catalina.servlets.DefaultServlet</servlet-class>
        <init-param>
            <param-name>debug</param-name>
            <param-value>0</param-value>
        </init-param>
        <init-param>
            <param-name>listings</param-name>
            <param-value>false</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
... 省略 ...

ここで、パラメータ listings の値を次のように true に変更する。

変更前：一覧を表示しない

        <init-param>
            <param-name>listings</param-name>
            <param-value>false</param-value>
        </init-param>

変更後：一覧を表示する

        <init-param>
            <param-name>listings</param-name>
            <param-value>true</param-value>
        </init-param>

一覧を表示するように変更すると、次のようにフォルダへ直接アクセスできるようになる。

Tomcat

kc@example.com (kc kim) — Sun, 31 Dec 2017 12:04:39 +0900

Tomcatについての説明。

Tomcatで特定IPのアクセスを制限する

kc@example.com (kc kim) — Sun, 31 Dec 2017 12:04:39 +0900

Tomcatでは、特定IPからのアクセスを許可または制限するオプションが提供されている。

Tomcatの設定ファイル conf/server.xml で、<Host> から </Host> の間に次の内容を追加または変更し、再起動すればよい。

特定IPのアクセス許可 allow

<Valve className="org.apache.catalina.valves.RemoteAddrValve" allow="127.0.0.1, 192.168.0.1"/>

特定IPのアクセス制限 deny

<Valve className="org.apache.catalina.valves.RemoteAddrValve" deny="192.168.0.1"/>

参考

http://tomcat.apache.org/tomcat-9.0-doc/config/valve.html

Tomcatの起動と停止

kc@example.com (kc kim) — Sun, 31 Dec 2017 12:04:39 +0900

Tomcatの起動

プロンプトで次のように入力するとTomcatが起動する。

$ ./tomcat/bin/startup.sh

Tomcat起動確認

Tomcat起動後、Tomcatが正常に起動したか確認するには、次のように入力する。

$ tail tomcat/logs/catalina.out

上記のコマンドを入力すると、catalina.out ファイルの内容が画面に出力される。その内容の最後の行に、次のような文言があることを確認する。

23-Mar-2019 01:17:16.985 정보 [main] org.apache.catalina.startup.Catalina.start Server startup in 8176 ms

Tomcatの停止

プロンプトで次のように入力するとTomcatが停止する。

$ ./tomcat/bin/shutdown.sh

Tomcat URL Encoding設定

kc@example.com (kc kim) — Sun, 31 Dec 2017 12:04:39 +0900

Tomcatのドキュメントによると、URLのデコードは指定しない場合、デフォルトでISO-8859-1に設定される。そのため、設定を行わずに韓国語をGETで渡すと文字化けする。一方、POSTで渡される場合は、HTTP bodyの入力ストリームがデフォルトでUTF-8としてデコードされるため問題はない。

これはTomcat設定でエンコーディングを変更すれば解決できる。{Tomcatインストールフォルダ}/conf/server.xml の次の <Connector> 要素に、URIEncoding をUTF-8として設定する。

<Connector port="8080" protocol="HTTP/1.1"
           connectionTimeout="20000"
           redirectPort="8443" 
           URIEncoding="UTF-8" />

Apacheと連携するために mod_jk を使用する場合は、mod_jk の設定部分にも同様の変更を行う。

<Connector port="8009" protocol="AJP/1.3" redirectPort="8443" URIEncoding="UTF-8"/>

参考

https://tomcat.apache.org/tomcat-9.0-doc/config/http.html

Tomcatの使い方 | HTTPからHTTPSへ自動リダイレクトを設定する

kc@example.com (kc kim) — Sun, 31 Dec 2017 12:04:39 +0900

TomcatでHTTPアクセスされたときにHTTPSへ変更する方法について説明する。

server.xmlにSSLを設定する

Tomcatの tomcat/conf/server.xml ファイルで、HTTPS設定を443ポートに設定し、追加でHTTP設定を80ポートに設定する。

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<server>
<Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />

... 中略 ...

<Connector port="80" protocol="HTTP/1.1"
           connectionTimeout="20000"
           redirectPort="443" />

<Connector port="443" protocol="org.apache.coyote.http11.Http11Protocol"
           maxThreads="150" SSLEnabled="true" scheme="https" secure="true"
           clientAuth="false" sslProtocol="TLS"
           keystoreFile="{keystoreFile}" keystorePass="{keystorePass}" />

<Connector port="8009" protocol="AJP/1.3" redirectPort="443" />

... 中略 ...

</server>

web.xmlにリダイレクト設定を追加する

web.xml ファイルに次の <security-constraint> 設定を追加する。その後Tomcatを再起動し、HTTPでアクセスするとHTTPSへリダイレクトされることを確認できる。

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
                      http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
  version="3.1">

    ... 中略 ...

    <security-constraint>
        <web-resource-collection>
            <web-resource-name>HTTP</web-resource-name>
            <url-pattern>/*</url-pattern>
        </web-resource-collection>
        <user-data-constraint>
            <transport-guarantee>CONFIDENTIAL</transport-guarantee>
        </user-data-constraint>
    </security-constraint>

</web>

web.xml ファイル内の <security-constraint> タグは複数回出現できる。Tomcatでは、セキュリティ目的で特定のHTTP Methodを制限したり、特定URLだけを設定したりする場合にも <security-constraint> を使用する。

Tomcat管理・監視ツール Probe

kc@example.com (kc kim) — Wed, 30 Jun 2021 16:59:39 +0900

Probeについて

ProbeはTomcatの管理および監視機能を提供するツールである。アプリケーション状態、データソース、デプロイ、システム、接続など、さまざまな機能を提供する。

このようなツールがあることを筆者は今回初めて知り、気になったのでさらに調べてみることにした。

Probeに関する資料

Probeの資料はあまり使われていないためか、インターネットで検索してもなかなか出てこなかった。ようやく見つけたサイトがGitHubだった。

GitHub（ソースコード）: https://github.com/psi-probe/psi-probe/
公式サイト: https://psi-probe.github.io/psi-probe/

Probeをインストールしてみる

ここにある内容でProbeのインストールテストを行うことができた。インストール方法は次の通りである。

Probeのソースファイルを次のように git clone コマンドで取得する。

git clone https://github.com/psi-probe/psi-probe.git

コマンドを実行すると次のようになる。

kimkc@kimkcui-MacBookPro probe % git clone https://github.com/psi-probe/psi-probe.git
Cloning into 'psi-probe'...
remote: Enumerating objects: 54626, done.
remote: Counting objects: 100% (1030/1030), done.
remote: Compressing objects: 100% (499/499), done.
remote: Total 54626 (delta 564), reused 927 (delta 498), pack-reused 53596
Receiving objects: 100% (54626/54626), 33.42 MiB | 10.71 MiB/s, done.
Resolving deltas: 100% (38049/38049), done.
kimkc@kimkcui-MacBookPro probe %

Probeプロジェクトで次のようにMavenビルドを実行する。

mvn package

ビルドを進めると次のように表示される。

kimkc@kimkcui-MacBookPro psi-probe % mvn package
[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO] 
[INFO] psi-probe                                                          [pom]
[INFO] psi-probe-core                                                     [jar]
[INFO] psi-probe-rest                                                     [jar]
[INFO] psi-probe-tomcat7                                                  [jar]
[INFO] psi-probe-tomcat85                                                 [jar]
[INFO] psi-probe-tomcat9                                                  [jar]
[INFO] psi-probe-web                                                      [war]
[INFO] 

（中略）

[INFO] Reactor Summary for psi-probe 3.5.5-SNAPSHOT:
[INFO] 
[INFO] psi-probe .......................................... SUCCESS [  1.573 s]
[INFO] psi-probe-core ..................................... SUCCESS [ 20.977 s]
[INFO] psi-probe-rest ..................................... SUCCESS [  1.375 s]
[INFO] psi-probe-tomcat7 .................................. SUCCESS [  4.093 s]
[INFO] psi-probe-tomcat85 ................................. SUCCESS [  3.823 s]
[INFO] psi-probe-tomcat9 .................................. SUCCESS [  3.801 s]
[INFO] psi-probe-web ...................................... SUCCESS [  4.559 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  40.441 s
[INFO] Finished at: 2021-06-30T16:11:58+09:00
[INFO] ------------------------------------------------------------------------
kimkc@kimkcui-MacBookPro psi-probe %

上記のようにすべてのプロジェクトが SUCCESS と表示されれば、正常に完了している。

Tomcatサイトからダウンロードし、適切なディレクトリにファイルを展開する。

ここではtar.gzファイルをダウンロードし、次のコマンドで展開した。

tar -xvf apache-tomcat-8.5.68.tar.gz

kimkc@kimkcui-MacBookPro probe % tar -xvf apache-tomcat-8.5.68.tar.gz
x apache-tomcat-8.5.68/conf/
x apache-tomcat-8.5.68/conf/catalina.policy
x apache-tomcat-8.5.68/conf/catalina.properties
x apache-tomcat-8.5.68/conf/context.xml
x apache-tomcat-8.5.68/conf/jaspic-providers.xml

展開がすべて終わったら、ファイル内容を確認する。

kimkc@kimkcui-MacBookPro apache-tomcat-8.5.68 % cd /Users/kimkc/dev/probe/apache-tomcat-8.5.68 
kimkc@kimkcui-MacBookPro apache-tomcat-8.5.68 % ls
BUILDING.txt    LICENSE         README.md       RUNNING.txt     conf            logs            webapps
CONTRIBUTING.md NOTICE          RELEASE-NOTES   bin             lib             temp            work
kimkc@kimkcui-MacBookPro apache-tomcat-8.5.68 %

次に、{tomcatディレクトリ}/webapps にProbeでビルドしたWARファイルを配置する。

ProbeのWARファイルは次のディレクトリにある。

{probeソースコードディレクトリ}/psi-probe-web/target/probe.war

WARファイルをTomcatの webapps に入れる。

kimkc@kimkcui-MacBookPro psi-probe % cp ./psi-probe-web/target/probe.war ../apache-tomcat-8.5.68/webapps

最後に、Tomcatのユーザー情報ファイル（apache-tomcat-x.x.x/conf/tomcat-users.xml）にrole情報を次のように追加する。

（省略）
<tomcat-users xmlns="http://tomcat.apache.org/xml"
              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              xsi:schemaLocation="http://tomcat.apache.org/xml tomcat-users.xsd"
              version="1.0">
（中略）

  <role rolename="manager-gui"/>
  <role rolename="manager-script"/>
  <role rolename="manager-status"/>
  <user username="devkuma" password="1234" roles="manager-gui,manager-script,manager-status"/>

</tomcat-users>

このTomcatのProbeアカウントは、ユーザー名が devkuma、パスワードが 1234 になる。

上記の情報を入れないと、Probe Webへアクセスできなくなる。

次にTomcatを再起動する。

kimkc@kimkcui-MacBookPro bin % ./startup.sh 
Using CATALINA_BASE:   /Users/kimkc/dev/probe/apache-tomcat-8.5.68
Using CATALINA_HOME:   /Users/kimkc/dev/probe/apache-tomcat-8.5.68
Using CATALINA_TMPDIR: /Users/kimkc/dev/probe/apache-tomcat-8.5.68/temp
Using JRE_HOME:        /Library/Java/JavaVirtualMachines/adoptopenjdk-8.jdk/Contents/Home
Using CLASSPATH:       /Users/kimkc/dev/probe/apache-tomcat-8.5.68/bin/bootstrap.jar:/Users/kimkc/dev/probe/apache-tomcat-8.5.68/bin/tomcat-juli.jar
Using CATALINA_OPTS:
Tomcat started.
kimkc@kimkcui-MacBookPro bin %

次のリンクにアクセスして画面が開けば、正しくインストールされている。

http://localhost:8080/probe/

Probeを通じてWebアプリケーション（.war）ファイルをデプロイする

次の場所へ移動する。

http://10.10.100.158:8080/probe/adm/deploy.htm

Select a .war file to upload * でWebサービスのWARファイルを選択する。
Context name (ex. /dummy) を入力する。
Deploy ボタンをクリックする。
入力した通りにサービスが実行されるか確認する。Context name に /dummy を入れた場合、Webアドレスは次のようになる。

http://10.10.100.158:8080/dummy

注意: Probeを通じてデプロイすると、Tomcat自体は再起動されず、WebアプリケーションのWARファイルだけが置き換えられてWebサービスが再度起動する。この過程でサービスが一時的に停止する可能性があるため、無停止デプロイとは言えない。いずれにしても、簡単なテストとしてデプロイ機能を使うのは問題ないが、これを利用して実際のサービスをデプロイしてはいけない。