ソフトウェアエンジニアの日常の雑記

日々思ったことをまとめます

JavaのEnumとSwitch式の良い関係

はじめに

今回は、私が好きで多用しているEnumとSwitch式の良い関係を書きます。

enum

Enumは、Java1.5(Tiger)のときに入った機能で、EffectiveJava(第3版)でも、第6章 enumとアノテーションアノテーションとセットですが、1章を割かれるくらいの機能になります。他の言語だとenumにはあまりスポットがあたっているのを見かけませんが、最近だとFlutter3にJavaと同じようなenumの機能が入っていました。

enumのよく使うケース

システム上で固定で判定できるものは、ほとんどenumで対応したりしています。下記はシステム上で使用するステータスを管理するenumになります。

public enum StatusType {
    TODO("作業前")
    , DOING("作業中")
    , CHECK("確認中")
    , DONE("完了")
    , OTHER("その他");

    private static final Map<String, StatusType> STATUS_TYPE_MAP = Arrays.stream(StatusType.values()).collect(Collectors.toMap(e -> e.name(), e -> e));  // 初期化時にMapに入れて取り出しやすくします
    
    private final String displayName;

    StatusType(String displayName) {
        this.displayName = displayName;
    }

    // データベース等に入っている文字列をこのメソッドを通すことで、enum型に変換します
    public StatusType getStatusType(String name) {
        return STATUS_TYPE_MAP.getOrDefault(name.toUpperCase(), StatusType.OTHER);
    }
}

このような感じのenumをシステムの挙動にあわせて、結構作成します。アプリケーション側ではenumの値によって処理を変えるということをやるときには下記のようになります。

class Sample {

    List<String> index(StatusType statusType){
        return switch (statusType) {
            case TODO -> todo();
            case DOING -> doing();
            case CHECK -> check();
            case DONE -> done();
            case OTHER -> other();
        }
    }
    
    // 各メソッドのみ記述(処理は省きます)
    private List<String> todo(){ return List.of();}
    private List<String> doing(){ return List.of();}
    private List<String> check(){ return List.of();}
    private List<String> done(){ return List.of();}
    private List<String> other(){ return List.of();}
}

enumのステータスが追加されることになったとき

上記のようなenumのステータスごとに分岐する処理があちらこちらに書いてあるとします。そのときに、enumの値が追加されると漏れなく全てを書き直さないといけません。enumとswitch式を使用している、enumに定義している定数を追加した際に、switch式の定義が足りないとコンパイルエラーが発生します。

public enum StatusType {
    TODO("作業前")
    , DOING("作業中")
    , CHECK("確認中")
    , CHECKED("確認済")    // <- ステータスの追加を行う
    , DONE("完了")
    , OTHER("その他");

(中略)

}

上記のように、ステータスの追加を行ってコンパイルをしてみましょう。

エラー: switch式がすべての可能な入力値をカバーしていません
        return switch (statusType) {
               ^

switch式がenumの全て要素の処理が書かれていないので、コンパイルエラーになります。これで、ステータスが追加されても処理の抜け漏れがなくて安全にステータスの追加や削除が行なえます。安心安全の型システムの恩恵を享受できています。

まとめ

enumは列挙型であるとともに、switch式と組み合わせると網羅性も担保されており、ドメイン知識が多いシステムのときにぬけもれがなく安心して開発ができるとても手軽で便利な機能だと思います。最近では、recordsealedを組み合わせて、enumでなくても網羅性のあるコードが書けるようになってきています。頑強なシステムを開発するのに重要な機能だと思いますので使いこなしていきたいです。

※この網羅性の機能はswitch式のみで使用できる機能であり、switch文では使用できません。

さいごに

久しぶりに個人ブログを書きました。しばらくは、所属会社の方のテックブログを頑張っていたのですが、これを機に個人ブログも再開しようかと思います。来年も良いJava開発ライフであると良いなと思います。

良いお年を!

MavenプロジェクトをGradleプロジェクトに変換する

MavenのプロジェクトをGradleのプロジェクトに変換したいときがあります。

変換する

下記のディレクトリをGradleプロジェクトに変換したい

$ ls
README.md   cdk.json    pom.xml     src
  • 変換する pom.xmlがあるディレクトリで、 gradle init を実行する。 pom.xmlが存在すると、Maven プロジェクトをみつけて、変換するかを選択できる。
$ gradle init

Welcome to Gradle 6.5!

Here are the highlights of this release:
 - Experimental file-system watching
 - Improved version ordering
 - New samples

For more details see https://docs.gradle.org/6.5/release-notes.html

Starting a Gradle Daemon (subsequent builds will be faster)

Found a Maven build. Generate a Gradle build from this? (default: yes) [yes, no] yes     // <- yes と入力する

Mavenにしかないものとかは動かないと思うので、それは一つずつ対応していくいかないです。

flywayのmultiple databases migration の設定メモ

本家はこちら

flyway でdb migrateしているが、公式ドキュメントではmultiple schemaは記述の仕方でなんとかなるんだけど、DBが分かれた場合は、地道にタスクを書くしかないっぽくて、そんなの嫌なのでちょっとメモ。

全体構成

一旦こんな感じのディレクトリ構成にしてみる。

├── build.gradle
├── conf
│   ├── example-admin.conf
│   └── example.conf
└── src
    └── main
        └── resources
            ├── example
            │   └── migration
            │       ├── V201801060359__create_account_table.sql
            │       └── V201801070137__create_table.sql
            └── example-admin
                └── migration
                    ├── V201801060359__create_account_table.sql
                    └── V201801070137__create_table.sql

resourcesディレクト

SQLはsrc/main/resources配下にexampleとexample-adminの配下にマイグレーション用のSQLファイルがおいてある。

build.gradle

汚いけど、taskを動的生成する

build.gradle

repositories {
    jcenter()
}

plugins {
    id 'org.flywaydb.flyway' version '6.4.1'
        id 'java'
}

["example", "example-admin"].each { name ->
    task  "${name}FlywayMigrate" (type: org.flywaydb.gradle.task.FlywayMigrateTask) {
        configFiles = ["conf/${name}.conf"]
    }

    task "${name}FlywayBaseline"(type: org.flywaydb.gradle.task.FlywayBaselineTask) {
        configFiles = ["conf/${name}.conf"]
    }

    task  "${name}FlywayClean"(type: org.flywaydb.gradle.task.FlywayCleanTask) {
        configFiles = ["conf/${name}.conf"]
    }

    task  "${name}FlywayInfo"(type: org.flywaydb.gradle.task.FlywayInfoTask) {
        configFiles = ["conf/${name}.conf"]
    }
}

こんな感じで、タスクを動的生成するようにする

confディレクト

ここにはDBとスキーマの定義ファイルがおいてある confファイルはこんな感じ

conf/example.conf

flyway.url=jdbc:postgresql://localhost:5432/example
flyway.user=example
flyway.password=example
flyway.schemas=public
flyway.locations=filesystem:src/main/resources/example/migration

conf/example-admin.conf

記事の効率的な読み方を試行錯誤

本家はこちら

最近、追う記事が多くてキャッチしきれなくなってきたので、スタイルを変えてみた。

もともと

TechCrunchとかはてぶとかTwitterとかで流れているものを、いちいち中身を追ってました。しかし、この方法だとどんどん流れるし、読んでて調べないとわからないことを調べているとどんどん流れていってしまいます。見る範囲が狭いときは、この方法でもよかったが、プログラミング、AWS、AI、マーケティング、英語、ビジネス、IR... とか増えていったときに、もう多すぎて流れていってしまって見落としが多いことに気づき、やり方を見直しを行いました。

Pocket

まず、読むだろう記事をPocketにストックしていくようにしました。以前はPocketを使っていたんですが、ここ2,3年全然つかっていなく、アップデートを確認してなかったんですが、音声再生の機能が格段にあがってました。コードが貼ってあるような記事はちょっと辛いのですが、それ以外のビジネス関係の読み物にはかなりあっていて、ほとんどこれで再生して聞いています。聞いている間に別の記事をストックしていくという感じで、短縮もできています。

Evernote or Notion

Pocketで格納した記事で残したいものは、さらにEvernoteとかNotionにシェアします。そうするとEvernote or NotionでWebクリップをしてくれるので残せます。

まとめ

気になったタイトルとかキーワードの記事はさっとPocketにためて、Pocketからまとめて読んだり、音声再生をして聞いたりして、残したいものはEvernoteかNotionにWebクリップすれば、かなりいいスクラップブックになるかなと思いました。他にもいいやり方があれば教えていただけるとー。

MyBatisが色々てんこ盛りになっていい感じになっている件

本家はこちら

久しぶりにSpringBootの環境構築をやろうかと思い、ORMをどうするか選定していたところ、MyBatisが結構進化していたので、メモ。

MyBatis3DynamicSql

こんな感じでかけます。

        List<TableCode> records = mapper.selectByExample()
                .where(id, isEqualTo(3))
                .build()
                .execute();       

        List<TableCode> records = mapper.selectByExample()
                .where(id, isEqualTo(3))
                .or(description, isLike("f%"))
                .build()
                .execute();    

        List<TableCode> records = mapper.selectByExample()
                .where(id, isLessThan(10), and(description, isEqualTo("foo")))
                .or(description, isLike("b%"))
                .orderBy(id.descending())
                .build()
                .execute(); 

JOOQみたいに、タイプセーフでSQLがかけるのはとてもすごい進化だと思います。

FreeMarker Tempalte

前に書いたとおりのFreeMarker Templateは健在。XMLがいやでFreeMarkerにしたけど、複雑なクエリはやはりJavaコードじゃなくて、素のSQLの方がいいイメージなので、継続して使用します。

sample.ftl

select
 *
from
  sample_table
where
  id = <@p name="param.id" />

こんな感じでかける。

from句とかを別のftlファイルにして、includeして使うことも可能です。

Thymeleaf Template

Doma2とかでやっている2WaySQLがThymeleaf Templateで実現している。Doma2より書き方は野暮ったいけど、一応2waySQLはできる。

SELECT * FROM names
  WHERE 1 = 1
  /*[# th:if="${not #lists.isEmpty(ids)}"]*/
    AND id IN (/*[# mb:p="ids"]*/ 1 /*[/]*/)
  /*[/]*/
  ORDER BY id

MyBatis Migrate

これは前からあったみたいなんだが、Flywayの陰に隠れて知らなかった。 機能的には十分っぽいので、試してみる。

詳細 => https://mybatis.org/migrations/

Mybatis Log Plugin (Intellijのみ)

これがあると、条件分岐があって、引数のバインドが全部終わったSQLを出力してくれるので、デバッグに便利です。 必需品かと思います。(Domaは標準でありますが)

https://plugins.jetbrains.com/plugin/10065-mybatis-log-plugin

最後に

タイプセーフでSQLかけるし、2WaySQLあるし、Migrateあるし、なんかMyBatisで全部OKなんじゃないかとおもいました。おそらくThymeleafは

GraalVMのnative-imageを少し試してみる

本家はこちら

GraalVMのnative-imageがそろそろ色々使えそうなので、試してみる。

Javaやってる人は SDK Man は入ってると思うので、それ前提でメモします。 (SDK Man のインストールはこちら -> https://sdkman.io/ )

GraalVM のインストール

まずは、GraalVMのインストールを行う。

$ sdk install java 20.0.0.r11-grl

GraalVMを使ってnative-imageをinstallする

GraalVMのパッケージツールでnative-imageをinstallする。

$  gu install native-image

これでnative-imageのinstallが完了。

かんたんなJavaコードを書く

Sample.java

class Sample {
  public static void main(String[] args) {
   System.out.println("Hello World");
  }
}

Javaコンパイルする。

$ javac Sample.java

コンパイルすると、classファイルができる。

Sample.class

native-imageでコンパイルする


$ native-image Sample sample // 最後のファイル名を指定しないと、デフォルトで小文字になる

下記、ファイルができる。

Sample

このファイルは実行できる。

./sample

比較する

JavaVMでの実行とnative-imageでの実行を比較する

$ time ./sample
real    0m0.007s
user    0m0.003s
sys     0m0.003s

======

$ time javac Sample
real    0m0.179s
user    0m0.110s
sys     0m0.035s

JavaVMの起動速度が入ってしまっていると思うが、結構違う。 JVMの起動後にどのくらい違うのかはまた次回。 あと、こんな1ファイルで使う人もいないと思うので、Jar での作成方法もまた次回。

MyBatisが色々てんこ盛りになっていい感じになっている件

本家はこちら

久しぶりにSpringBootの環境構築をやろうかと思い、ORMをどうするか選定していたところ、MyBatisが結構進化していたので、メモ。

MyBatis3DynamicSql

こんな感じでかけます。

        List<TableCode> records = mapper.selectByExample()
                .where(id, isEqualTo(3))
                .build()
                .execute();       

        List<TableCode> records = mapper.selectByExample()
                .where(id, isEqualTo(3))
                .or(description, isLike("f%"))
                .build()
                .execute();    

        List<TableCode> records = mapper.selectByExample()
                .where(id, isLessThan(10), and(description, isEqualTo("foo")))
                .or(description, isLike("b%"))
                .orderBy(id.descending())
                .build()
                .execute(); 

JOOQみたいに、タイプセーフでSQLがかけるのはとてもすごい進化だと思います。

FreeMarker Tempalte

前に書いたとおりのFreeMarker Templateは健在。XMLがいやでFreeMarkerにしたけど、複雑なクエリはやはりJavaコードじゃなくて、素のSQLの方がいいイメージなので、継続して使用します。

select
 *
from
  sample_table
where
  id = &lt;@p name=&quot;param.id&quot; /&gt;

&lt;pre&gt;&lt;code&gt;こんな感じでかける。

from句とかを別のftlファイルにして、includeして使うことも可能です。


## Thymeleaf Template
Doma2とかでやっている2WaySQLがThymeleaf Templateで実現している。Doma2より書き方は野暮ったいけど、一応2waySQLはできる。

&lt;/code&gt;&lt;/pre&gt;

SELECT * FROM names
  WHERE 1 = 1
  /&lt;em&gt;[# th:if=&quot;${not #lists.isEmpty(ids)}&quot;]&lt;/em&gt;/
    AND id IN (/&lt;em&gt;[# mb:p=&quot;ids&quot;]&lt;/em&gt;/ 1 /&lt;em&gt;[/]&lt;/em&gt;/)
  /&lt;em&gt;[/]&lt;/em&gt;/
  ORDER BY id

MyBatis Migrate

これは前からあったみたいなんだが、Flywayの陰に隠れて知らなかった。 機能的には十分っぽいので、試してみる。

詳細 => https://mybatis.org/migrations/

Mybatis Log Plugin (Intellijのみ)

これがあると、条件分岐があって、引数のバインドが全部終わったSQLを出力してくれるので、デバッグに便利です。 必需品かと思います。(Domaは標準でありますが)

https://plugins.jetbrains.com/plugin/10065-mybatis-log-plugin