ひとり開発日記。

2024年8月 Javaプログラミングで "Hello World" を出したいだけだった

2 min read java

前回、2021年6月 Javaプログラミングで “Hello World” を出したいだけだった の続き。 と言うか、自分で何かしらの結果を出したいですしね。

開発環境は、 VSCode と Rancher Desktop だけでやってみます。

自分で作ってみた

で、自分で作ってみました。結構面倒くさい！

これに関しては、幾つかの縛りがあります。 例えば「“Hello World"を出せるくらいの小さいアプリを…」と言われた時、大抵下記のような前提が言外にあると思っても良いでしょう。

  • コンパイル＆ビルドに迷いたくないよね
  • 立ち上げるのには、それなりの速さが欲しいよね
  • 当然、仮想化が前提にあるよね
  • それなりにDI出来るコンテナ欲しいよね
  • 設定値をDI出来る仕組み欲しいよね
  • HTMLテンプレートも欲しいよね
  • APIとして使うことを考えてJSONも出力して欲しいよね
  • ログを統一的に出す機構が欲しいよね

(所謂) The Twelve-Factor App ですよね。 そこら辺を踏まえた上での、自分が考えるアーキテクチャは以下です。

  • コンパイル＆ビルドは Maven
  • サーバーは Jetty Embedded
  • DIは Guice/Guice-Servletに従う
  • 設定値の取得は Apache Geronimo/MicroProfile Config
  • HTMLテンプレートは(多分)一番シンプルな FreeMarker
  • JSON出力は、一番軽量で早い Gson
  • ログは Slf4j/Log4j2

JavaでWebアプリケーションで避けて通れないのが、Java EE -> Jakarta EE への移行でしょう。 あれ、単にパッケージを変えただけでも大概OKなんですが、それでもソース書き換えて再ビルドは、相当きついかもですよ。

だから、ちょっとしたWebアプリケーションは、小さく作って、いつでも交換できるように疎結合にしておく、が、大切ですかね。

結構面倒くさいポイントその1 Guice-Servlet初期化

上記を読むと、よくあるコンテナ(Tomcat)とかにデプロイすることを前提として、 GuiceFilter の設置を書いているのですが、そもそも、アプリコンテナ全体をGuiceのDI対象に含めて、そこに設定を書いてしまえば、わざわざ web.xml 設定も不要ということです。 ConfigModule.java

contextHandler.addFilter(GuiceFilter.class, "/*", EnumSet.allOf(DispatcherType.class));

ここら辺を分からないと「…？」と悩むことになります。

結構面倒くさいポイントその2 FreemarkerServlet のパッケージ

昔のFreeMarkerには、freemarker.ext.servlet.FreemarkerServlet ってクラスがあったんですが、今ではそれが依存するServletのパッケージが違うので、Jakarta EE対象のコンテナを使おうとしても、コンパイルが通りません。 freemarker.ext.jakarta.servlet.FreemarkerServlet に変える必要があるのです

結構面倒くさいポイントその3 FreemarkerServlet の設定値

FreemarkerServlet に関しては、Tomcatとかに書く web.xml 用の記述あるんですが、コレ、スタンドアローンの時にどうやって設定したら良いの？みたいなのがあります。

わたくしの個人解としては、まずプロパティファイルに、こう書く。microprofile-config.properties

# FreeMarker Parameters
freemarker.TemplatePath = classpath:views
freemarker.NoCache = true
freemarker.ResponseCharacterEncoding = fromTemplate
freemarker.ExceptionOnMissingTemplate = true
freemarker.incompatible_improvements = 2.3.28
freemarker.template_exception_handler = rethrow
freemarker.template_update_delay = 0
freemarker.default_encoding = UTF-8
freemarker.output_encoding = UTF-8
freemarker.locale = ja_JP
freemarker.number_format = 0.##########
freemarker.time_zone = JST
freemarker.date_format = yyyy-MM-dd HH:mm:ssZ

そして、DI設定の時に、こう書く ConfigModule.java

  /** FreeMarker設定値を作成する */
  @Provides
  @Singleton
  @Named("freemarker.init.parameters")
  public Map<String, String> prividesFreeMarker(Config config) {
    Map<String, String> params = StreamSupport.stream(config.getPropertyNames().spliterator(), false)
        .filter(key -> key.startsWith("freemarker."))
        .map(key -> new AbstractMap.SimpleImmutableEntry<String, String>(
            key.replaceFirst("^freemarker\\.", ""),
            config.getValue(key, String.class)))
        .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (e1, e2) -> e1));
    LOG.debug("freemarker init params: {}", params);
    return params;
  }

単に、プロパティファイルからキーの先頭に freemarker. が入っている要素を抜き出し、キーの先頭から freemarker. を削除した連想配列を作る、これが本当に面倒くさい！

で、DIで取ってこれた値を、 FreemarkerServlet に渡せば良い、と言う寸法です。 AppContextListener.java

結構面倒くさいポイントその4 java.util.logging(jul)

これ、Javaプログラムやってる人には、永遠の課題なんですが、ログ問題はとにかく面倒くさいです。 自分は、もう割り切って、メインはlog4j2、ファサードはSlf4j、にしています。

だから、まず依存ライブラリに jul-to-slf4jを含め、更にアプリ立ち上げ最初の方で、それなりの記述が必要です。 App.java

    SLF4JBridgeHandler.removeHandlersForRootLogger();
    SLF4JBridgeHandler.install();

〆の感想

いやはや、“Hello World"だけでも、こんなに難しい2024年でしたね。

DBとか使うんだったら、トランザクション境界のことを考えると、素直に Spring-Boot とか Quarkus とか使ったほうが良いのですが、ちょっとした 「入力に対して、別のAPIを叩いて、その結果をJSONで返す」ような BFF(Backend For Frontend) 機能だったら、これくらいで良いのでしょうか？

実際、手元のPCで java -jar target/app-1.0.0.jar コマンド打つと、立ち上がりまで2秒ちょっとなので、やはり Simple is the Best. ですね。