java – ページ 2 – サイゼントの技術ブログ

2021年6月9日

Java：任意の順番でのソート

JavaのCollection型（サブクラスにList型等がある）は、Collections.sortメソッドでソートすることが可能です。
Collections.sortメソッドは、第一引数にソートしたいCollection型のオブジェクト、第二引数にComparator型のオブジェクトを渡します。
第二引数のComparator型のオブジェクトにより、ソート順が決まります。

Collections.sortメソッドでは、Comparator型のcompareメソッドを利用してソートを行います。
ソート順を定義するためには、Comparator型を実装したクラスを独自に作成し、compareメソッドをオーバーライドして独自のロジックを記述する必要があります。
compareメソッドの説明は以下です。
https://docs.oracle.com/javase/jp/8/docs/api/java/util/Comparator.html#compare-T-T-
簡単に言うと、compareメソッドの第一引数と第二引数について、戻り値がマイナスの値の場合は「第一引数→第二引数」の順番に並び、戻り値がプラスの値の場合は「第二引数→第一引数」の順番に並びます。

これを利用して、任意の順番でソートを行うサンプルが以下になります。

【サンプルコード】

・MySortMain.java

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;

public class MySortMain {

    public static void main(String［］ args) {

        // ソート対象のリストを作成する
        List＜String＞ list = new ArrayList&lt;>();
        list.add("メグリネ　ルカ");
        list.add("ハツネ　ミク");
        list.add("カガミネ　レン");
        list.add("カガミネ　リン");

        // ソート（文字コード順）
        Comparator＜String＞ mySort1 = new MySort1();
        Collections.sort(list, mySort1);
        System.out.println("［文字コード順のソート］");
        for (String str : list) {
            System.out.println(str);
        }

        // ソート（独自ソート順）
        Comparator＜String＞ mySort2 = new MySort2();
        Collections.sort(list, mySort2);
        System.out.println("");
        System.out.println("［独自ソート順のソート］");
        for (String str : list) {
            System.out.println(str);
        }

    }

}

import java.util.ArrayList;

import java.util.Collections;

import java.util.Comparator;

import java.util.List;

public class MySortMain {

public static void main(String［］ args) {

// ソート対象のリストを作成する

List＜String＞ list = new ArrayList<>();

list.add("メグリネ　ルカ");

list.add("ハツネ　ミク");

list.add("カガミネ　レン");

list.add("カガミネ　リン");

// ソート（文字コード順）

Comparator＜String＞ mySort1 = new MySort1();

Collections.sort(list, mySort1);

System.out.println("［文字コード順のソート］");

for (String str : list) {

System.out.println(str);

}

// ソート（独自ソート順）

Comparator＜String＞ mySort2 = new MySort2();

Collections.sort(list, mySort2);

System.out.println("");

System.out.println("［独自ソート順のソート］");

for (String str : list) {

System.out.println(str);

}

・MySort1.java

import java.util.Comparator;

// 今回はString型を対象としているが、独自型にも同じ方法で対応できる
public class MySort1 implements Comparator＜String＞ {

        @Override
        public int compare(String o1, String o2) {
            // o1の文字コードからo2の文字コードを減算した値を返すメソッド
            return o1.compareTo(o2);
        }

}

import java.util.Comparator;

// 今回はString型を対象としているが、独自型にも同じ方法で対応できる

public class MySort1 implements Comparator＜String＞ {

@Override

public int compare(String o1, String o2) {

// o1の文字コードからo2の文字コードを減算した値を返すメソッド

return o1.compareTo(o2);

}

・MySort2.java

import java.util.Comparator;

// 今回はString型を対象としているが、独自型にも同じ方法で対応できる
public class MySort2 implements Comparator＜String＞ {

    @Override
    public int compare(String o1, String o2) {
        return mySortOrder(o1) - mySortOrder(o2);
    }

    // 独自のソート順の定義
    public int mySortOrder(String str) {
        if (str.equals("ハツネ　ミク")) { return 1; }
        else if (str.equals("カガミネ　リン")) { return 2; }
        else if (str.equals("カガミネ　レン")) { return 3; }
        else if (str.equals("メグリネ　ルカ")) { return 4; }
        else {return 5;}
    }

}

import java.util.Comparator;

// 今回はString型を対象としているが、独自型にも同じ方法で対応できる

public class MySort2 implements Comparator＜String＞ {

@Override

public int compare(String o1, String o2) {

return mySortOrder(o1) - mySortOrder(o2);

}

// 独自のソート順の定義

public int mySortOrder(String str) {

if (str.equals("ハツネ　ミク")) { return 1; }

else if (str.equals("カガミネ　リン")) { return 2; }

else if (str.equals("カガミネ　レン")) { return 3; }

else if (str.equals("メグリネ　ルカ")) { return 4; }

else {return 5;}

}

【実行結果】

［文字コード順のソート］
カガミネ　リン
カガミネ　レン
ハツネ　ミク
メグリネ　ルカ

［独自ソート順のソート］
ハツネ　ミク
カガミネ　リン
カガミネ　レン
メグリネ　ルカ

［文字コード順のソート］

カガミネ　リン

カガミネ　レン

ハツネ　ミク

メグリネ　ルカ

［独自ソート順のソート］

ハツネ　ミク

カガミネ　リン

カガミネ　レン

メグリネ　ルカ

いかがでしたでしょうか。

javaで独自順のソート処理をする機会があったので、実装方法を簡単に書いてみました。
Comparatorインターフェースのcompareメソッドを実装すること、compareメソッドの戻り値によりソート順を定義すること、を抑えれば、何をしているか理解できると思います。

2021年6月1日

Base64の説明とjavaでのエンコード・デコードの例

Base64とは、テキストデータやバイナリデータ（画像ファイル、PDFファイル等）を表現する方式の一つです。
以下の64種類の文字と末尾のパディング文字（=）を用いて表現するのが特徴です。
・アルファベット（a～z, A～Z）
・数字（0～9）
・一部の記号（+, /）

この表現方式は、一部の文字しか使用できないプロトコルでデータの送受信を行いたい場合に有用であり、ASCII文字しか送受信できないプロトコルでもデータの送受信が可能になります。
有名な所で言うと、電子メール（SMTP）でBase64が使われています。
また、APIでのデータ送受信でも良く使われます。

ここで、Base64のエンコード・デコードをイメージしやすくするため、２バイト文字（日本語）をJava8 の java.util.Base64を用いてエンコード・デコードしてみます。

【サンプルコード】

・Base64Test.java

import java.util.Base64;

public class Base64Test {

    public static void main(String［］ args) {

        // 元の文字列（２バイト文字）
        final String orgStr = "こんにちは！";

        // Base64へのエンコード
        String encodedStr =
            Base64.getEncoder().encodeToString(orgStr.getBytes());

        // Base64からのデコード
        String decodedStr =
            new String(Base64.getDecoder().decode(encodedStr));

        System.out.println("元の文字列　　　　　 : " + orgStr);
        System.out.println("Base64へのエンコード : " + encodedStr);
        System.out.println("Base64からのデコード : " + decodedStr);

    }

}

import java.util.Base64;

public class Base64Test {

public static void main(String［］ args) {

// 元の文字列（２バイト文字）

final String orgStr = "こんにちは！";

// Base64へのエンコード

String encodedStr =

Base64.getEncoder().encodeToString(orgStr.getBytes());

// Base64からのデコード

String decodedStr =

new String(Base64.getDecoder().decode(encodedStr));

System.out.println("元の文字列　　　　　 : " + orgStr);

System.out.println("Base64へのエンコード : " + encodedStr);

System.out.println("Base64からのデコード : " + decodedStr);

}

【実行結果】

元の文字列　　　　　 : こんにちは！
Base64へのエンコード : 44GT44KT44Gr44Gh44Gv77yB
Base64からのデコード : こんにちは！

元の文字列　　　　　 : こんにちは！

Base64へのエンコード : 44GT44KT44Gr44Gh44Gv77yB

Base64からのデコード : こんにちは！

なお、今回の記事では触れませんが、バイナリファイルを1バイトずつエンコード・デコードすることで、バイナリデータにも対応できます。
また、Base64のエンコード・デコードの方式は公開されており、人気の言語ではライブラリも存在しているので、他の言語でも実装可能です。

いかがでしたでしょうか。

Base64については入門書で触れられることが少なく、情報処理技術者試験でも午前問題で稀に出題される程度なので、実務で初めて耳にする方は少なくないと思います。
「Base64を使えば画像や動画もASCII文字（1バイト文字）で表現できる」というざっくりな知識だけでも覚えておけば、実務でもスムーズにコミュニケーションできるかと思います。

2021年5月24日

java：通常のクラスと匿名クラス（無名クラス）の書き方の比較

以前の記事で「通常のクラスと匿名クラスの書き方の比較を見たい」という意見があったので、少し補足を行います。

サンプルコードの通り、匿名クラスの場合、クラスに名前を付ける必要が無く、またオブジェクト生成と同時に処理を定義することができます。
これにより、以下のようなメリットがあります。

記述を簡潔にできる
使い捨てのクラスを定義でき、使い捨てであるという意図も明確にできる
（ソースファイル名とクラス名を同じにする場合）管理が容易になる

【サンプルコード】

・AnonymousClass.java

public class AnonymousClass {
    private String str = "Hello Class!";
    public String getStr() {
        return str;
    }
    public void print() {
        System.out.println(getStr());
    }
}

public class AnonymousClass {

private String str = "Hello Class!";

public String getStr() {

return str;

}

public void print() {

System.out.println(getStr());

}

・AnonymousSubClass.java

// 通常のクラスの定義（クラスの継承）
public class AnonymousSubClass extends AnonymousClass {
    public void print() {
        System.out.println("NonAnonymous:" + getStr());
    }
}

// 通常のクラスの定義（クラスの継承）

public class AnonymousSubClass extends AnonymousClass {

public void print() {

System.out.println("NonAnonymous:" + getStr());

}

・AnonymousInterface.java

public interface AnonymousInterface {
    public void print();
}

public interface AnonymousInterface {

public void print();

}

・AnonymousImplementsClass.java

// 通常のクラスの定義（インターフェースの実装）
public class AnonymousImplementsClass implements AnonymousInterface {
    public void print() {
        System.out.println("NonAnonymous:Hello Interface!");
    }
}

// 通常のクラスの定義（インターフェースの実装）

public class AnonymousImplementsClass implements AnonymousInterface {

public void print() {

System.out.println("NonAnonymous:Hello Interface!");

}

・AnonymousMain.java

public class AnonymousMain {
    public static void main(String［］ args) {

        // 通常のクラスのオブジェクトの生成（クラスの継承）
        AnonymousClass nac = new AnonymousSubClass();
        nac.print();

        // 匿名クラスの定義とオブジェクト生成（クラスの継承）
        AnonymousClass ac = new AnonymousClass() {
            public void print() {
                System.out.println("Anonymous:" + getStr());
            }
        };
        ac.print();

        // 通常のクラスのオブジェクトの生成（インターフェースの実装）
        AnonymousInterface nai = new AnonymousImplementsClass();
        nai.print();

        // 匿名クラスの定義とオブジェクト生成（インターフェースの実装）
        AnonymousInterface ai = new AnonymousInterface() {
            public void print() {
                System.out.println("Anonymous:Hello Interface!");
            }
        };
        ai.print();
    }
}

public class AnonymousMain {

public static void main(String［］ args) {

// 通常のクラスのオブジェクトの生成（クラスの継承）

AnonymousClass nac = new AnonymousSubClass();

nac.print();

// 匿名クラスの定義とオブジェクト生成（クラスの継承）

AnonymousClass ac = new AnonymousClass() {

public void print() {

System.out.println("Anonymous:" + getStr());

}

};

ac.print();

// 通常のクラスのオブジェクトの生成（インターフェースの実装）

AnonymousInterface nai = new AnonymousImplementsClass();

nai.print();

// 匿名クラスの定義とオブジェクト生成（インターフェースの実装）

AnonymousInterface ai = new AnonymousInterface() {

public void print() {

System.out.println("Anonymous:Hello Interface!");

}

};

ai.print();

}

【実行結果】

NonAnonymous:Hello Class!
Anonymous:Hello Class!
NonAnonymous:Hello Interface!
Anonymous:Hello Interface!

NonAnonymous:Hello Class!

Anonymous:Hello Class!

NonAnonymous:Hello Interface!

Anonymous:Hello Interface!

良い意見やコメントを頂いた時は、今回のような形で答えていきたいと思います！

2021年5月19日

java：引数で渡した参照型変数をメソッド内で変更する書き方について

参照型変数を引数としてメソッドに渡し、呼び出し先のメソッドの中でその参照型変数に変更を入れた場合、呼び出し元でもその変更内容を参照することができます。
ソースコードで言うと、以下のような形で呼び出し元に影響を与えることができます。
（isDisplay[0]の変更は呼び出し元にも反映されます。実行すると、”Hello World!”が出力され、”Error!”は出力されません。）

public class HelloWorld {
    public static void main(String［］ args){

        boolean［］ isDisplay = {false,false};

        getIsDisplay(isDisplay);

        if (isDisplay［0］) {
            System.out.println("Hello World!");
        }
        if (isDisplay［1］) {
            System.out.println("Error!");
        }

    }

    public static void getIsDisplay(boolean［］ isDisplay) {
        isDisplay［0］ = true;
    }
}

public class HelloWorld {

public static void main(String［］ args){

boolean［］ isDisplay = {false,false};

getIsDisplay(isDisplay);

if (isDisplay［0］) {

System.out.println("Hello World!");

}

if (isDisplay［1］) {

System.out.println("Error!");

}

public static void getIsDisplay(boolean［］ isDisplay) {

isDisplay［0］ = true;

}

このような書き方は、C言語のレガシーなコードではよく見かけますが、javaではあまり見かけることがないと思います。
レガシーな現場に入ったことが無い方は、見慣れていない、違和感がある、と感じる方が多いと思います。

javaでは、以下のように戻り値により呼び出し元に影響を与える書き方の方が主流です。

public class HelloWorld {
    public static void main(String［］ args){

        boolean［］ isDisplay = {false,false};

        isDisplay［0］ = getIsDisplay();

        if (isDisplay［0］) {
            System.out.println("Hello World!");
        }
        if (isDisplay［1］) {
            System.out.println("Error!");
        }

    }

    public static boolean getIsDisplay() {
        return true;
    }
}

public class HelloWorld {

public static void main(String［］ args){

boolean［］ isDisplay = {false,false};

isDisplay［0］ = getIsDisplay();

if (isDisplay［0］) {

System.out.println("Hello World!");

}

if (isDisplay［1］) {

System.out.println("Error!");

}

public static boolean getIsDisplay() {

return true;

}

ビジネスロジックを知り尽くしている場合は、前者のようにメソッドに参照型変数を渡してメソッドの中で好きに変更させる形にした方が楽にコーディングできます。
しかし、ビジネスロジックをよく知らない担当者がソースコードを調査したり改修したりする場合、後者のように戻り値を通して呼び出し元に影響を与える形にしないと、読む必要があるソースコードの範囲が広がり、調査・改修が困難になります。
今回の例で言うと、”isDisplay[1]”に変更が入っていないことを知るために、前者のコードではメソッドの中まで見る必要がありますが、後者のコードではメソッドの中まで見る必要はありません。

現在の開発現場では、複数の担当者が入れ替わり立ち替わりでソースコードを改修し続けるのが主流ですので、後者の書き方の方が望まれます。
現行のソースコードが既に前者の形で書かれているのであれば、それに合わせた方が良い場合もありますが、そうではないなら後者の書き方で書くべきでしょう。

いかがでしたでしょうか。

新しい技術に触れることが多い技術者が前者のようなソースコードを見て戸惑っていたので、今回の記事を書きました。
今からソースコードを書くなら後者の書き方を推奨するのですが、前者のような書き方もあるというのは覚えておいて損は無いかもしれません。

2021年5月12日

java：例外発生後に例外のメッセージを書き変える

例外オブジェクトにはメッセージが格納されており、getMessage()メソッドでそのメッセージを取得することができます。
しかし、このメッセージはコンストラクタでのみ設定可能であり、メッセージを後で変更するメソッドは用意されていないため、例外クラスに用意されている手段では例外発生後にメッセージを書き変えることはできません。

しかし、リフレクションを使用することで、メッセージを後で書き変えることが可能です。
メッセージはThrowableクラスのprivateのクラス変数”detailMessage”に保持されるため、これをリフレクションで書き変えます。

サンプルコードは以下の通りです。

【サンプルコード】

・ExceptionTest.java

import java.io.IOException;
import java.lang.reflect.Field;

public class ExceptionTest {

    public static void main(String［］ args) {

        try {
            method();
        } catch (IOException e) {
            System.out.println(e.getMessage());
        } catch (Exception e) {
            e.printStackTrace();
        }

    }

    static void method() throws Exception {

        try {

            // メッセージ付きで例外を発生させる
            throw new IOException("hoge");

        } catch (Exception e) {

            // detailMessageフィールドの定義を取得
            Field fieldDefinition =
                Throwable.class.getDeclaredField("detailMessage");

            // フィールドをアクセス可能に設定
            fieldDefinition.setAccessible(true);

            // 例外オブジェクトのメッセージを変更する
            fieldDefinition.set(e, e.getMessage() + "fuga");

            // 例外を再スロー
            throw e;

        }

    }

}

import java.io.IOException;

import java.lang.reflect.Field;

public class ExceptionTest {

public static void main(String［］ args) {

try {

method();

} catch (IOException e) {

System.out.println(e.getMessage());

} catch (Exception e) {

e.printStackTrace();

}

static void method() throws Exception {

try {

// メッセージ付きで例外を発生させる

throw new IOException("hoge");

} catch (Exception e) {

// detailMessageフィールドの定義を取得

Field fieldDefinition =

Throwable.class.getDeclaredField("detailMessage");

// フィールドをアクセス可能に設定

fieldDefinition.setAccessible(true);

// 例外オブジェクトのメッセージを変更する

fieldDefinition.set(e, e.getMessage() + "fuga");

// 例外を再スロー

throw e;

}

【実行結果】

・コンソール（標準出力）

hogefuga

hogefuga

・コンソール（標準エラー出力）

WARNING: An illegal reflective access operation has occurred
WARNING: Illegal reflective access by ExceptionTest (file:/C:/pleiades/workspace/Hello/build/classes/) to field java.lang.Throwable.detailMessage
WARNING: Please consider reporting this to the maintainers of ExceptionTest
WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
WARNING: All illegal access operations will be denied in a future release

WARNING: An illegal reflective access operation has occurred

WARNING: Illegal reflective access by ExceptionTest (file:/C:/pleiades/workspace/Hello/build/classes/) to field java.lang.Throwable.detailMessage

WARNING: Please consider reporting this to the maintainers of ExceptionTest

WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations

WARNING: All illegal access operations will be denied in a future release

ちなみに、リフレクション時に発生してしまう標準エラー出力ですが、（試していませんが）Java8では出ないようです。
筆者の環境（Java10）だと出てしまいます。

そこで以下の２つの手段を試しましたが、何れもエラー抑止はできませんでした。

１．JVM引数で抑止

“–illegal-access=deny”を指定したら逆に異常終了するようになってしまいました。

２．標準エラー出力の出力ストリームを変更

通常、”System.setErr(自作PrintStreamオブジェクト);”を記述することで標準エラー出力の出力先を変更し、コンソールに出力されないようにすることができるのですが、今回のケースではそれができませんでした。
“System.err.close();”を記述した場合はコンソールへの出力を抑止することができたので、リフレクション時のWARNINGメッセージでは”System.err”を直接使用しているのではないかと思います。
なお、”System.err”はクローズしたらリオープンすることができないので、”System.err.close();”を実行してしまうと、以降は予期せぬ例外等が発生しても標準エラー出力として出力できなくなってしまいます。
（”System.err.close();”を実行した後に”System.setErr(System.out);”を実行して、予期せぬ例外等も全て標準出力として出力することならできますが…）

いかがでしたでしょうか。

今回の記事では、例外発生時のメッセージを後から書き変えられることを確認しましたが、標準エラー出力が出力されることを考えると、このようなソースコードはできる限り書くべきではないと思います。
どうしても書き変え可能な変数を伝播させたいのであれば、独自例外クラスに独自のクラス変数を定義してそれを伝播させる等の工夫をするべきだと思います。