JavaのCaseFormatクラスとは?Guavaで文字列のケース形式を変換する方法

CaseFormatは、Googleが提供するJavaライブラリ「Guava」に含まれるユーティリティクラスの一つです。このクラスを使うと、ハイフン区切り、アンダースコア区切り、キャメルケースなど、さまざまなASCIIケース形式の文字列を相互に簡単に変換できます。

命名規則の異なるシステム間でデータを受け渡す際や、定数名・変数名・JSONキーなどを一括して整形したい場合に非常に便利なクラスです。

CaseFormatで利用できるケース形式

CaseFormatクラスには、以下の5つの列挙型定数が用意されています。それぞれの形式と表記例を見てみましょう。

主なメソッド

CaseFormatでは、変換を行うためのto()メソッドが中心となります。

• to(CaseFormat format, String str):呼び出し元の形式から、引数で指定した形式へ文字列を変換して返します。
• converterTo(CaseFormat targetFormat):Converterオブジェクトとして変換処理を再利用できるようにします。

使用例

それでは、実際にCaseFormatクラスを使用したサンプルプログラム(GuavaTester.java)を見てみましょう。

import com.google.common.base.CaseFormat;

public class GuavaTester {
    public static void main(String args[]) {
        GuavaTester tester = new GuavaTester();
        tester.testCaseFormat();
    }

    private void testCaseFormat() {
        // ハイフン区切りからローワーキャメルケースへ変換
        System.out.println(CaseFormat.LOWER_HYPHEN.to(CaseFormat.LOWER_CAMEL, "test-data"));

        // アンダースコア区切りからローワーキャメルケースへ変換
        System.out.println(CaseFormat.LOWER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, "test_data"));

        // 大文字アンダースコアからアッパーキャメルケースへ変換
        System.out.println(CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.UPPER_CAMEL, "TEST_DATA"));
    }
}

コンパイル方法

作成したクラスをjavacコンパイラでコンパイルします。

C:\Guava>javac GuavaTester.java

続いて、プログラムを実行します。

C:\Guava>java GuavaTester

実行結果

上記のプログラムを実行すると、次のような出力が得られます。

testData
testData
TestData

このように、to()メソッドの第一引数に元の形式、第二引数に変換後の形式を指定するだけで、文字列のケース形式を自在に変換できることがわかります。

まとめ

CaseFormatクラスを活用すれば、複雑な文字列操作を自前で実装することなく、簡潔かつ安全にケース形式の変換を行えます。特に、データベースのカラム名(スネークケース)とJavaのフィールド名(キャメルケース)をマッピングする場面などで重宝するので、ぜひ活用してみてください。