HOWTO · Java

Java でコンソールをクリアする

Java でコンソール画面をクリーンアップする 2つの方法を示しています。

このページの内容

Javaには、コンソールを消去する組み込みメソッドはありません。プログラムの実行中にANSIエスケープシーケンスを出力するか、OSが提供するコマンドを起動できます。どちらが使えるかは、プログラムを表示する端末やIDEによって異なります。どちらの方法も表示中の領域を消去するよう要求するもので、スクロールバックに残った過去の出力や、IDEに保存された実行履歴まで確実に削除できるわけではありません。
コンソールの操作は、Java チュートリアル が集めている日常のユーティリティの一つです。

ANSIエスケープシーケンスでコンソールをクリアする

ANSIシーケンスは、端末が解釈する制御文字です。\033[H はカーソルをホーム位置に移動し、\033[2J は表示中の画面全体を消去します。次のプロンプトや状態メッセージを出す前に、両方を出力してください。\033[2J はカーソル位置にかかわらず表示全体を消去します。カーソル位置からの消去には別の消去パラメーターを使います。たとえば \033[0J はカーソル位置から表示の末尾までを消去します。

次の例を実行します。

このセクションのコードと表示されるラベルや出力は英語のままです。

public class ClearConsole {
    public static void main(String[] args) {
        System.out.print("\033[H\033[2J");
        System.out.flush();
        System.out.println("Console cleared!");
    }
}
Console cleared!

Java文字列内のエスケープ \033 は、ESC文字を挿入します。System.out.flush() を呼び出すとシーケンスがすぐに送信されます。呼び出さない場合、後続の出力が行われるまでバッファー内の出力が端末に届かないことがあります。このコードは消去要求を送りますが、未対応の端末にそれを解釈させることはできません。ANSIは端末エミュレーターで広くサポートされていますが、端末の設定、IDEの構成、プログラムの起動方法によって利用できないことがあります。表示画面を消去しても、端末のスクロールバック履歴は残る場合があります。エスケープ文字がそのまま表示されたり、画面が変化しなかったりする場合は、IDEのコンソール消去コマンドを使うか、ANSIサポートの設定を確認してください。コード例と出力に含まれる表示用の文字列は、元のバイト列を保つため英語のままです。

ProcessBuilderでOSのコマンドを実行する

端末に画面消去コマンドが用意されていれば、Javaから ProcessBuilder で起動できます。Windowsのコマンドプロンプトでは cmd /c を通して cls を実行します。macOSやその他のUnix系システムでは、一般に clear が用意されています。この例ではOS名を Locale.ROOT で小文字にし、windows で始まるかを確認します。そのため、macOS(Darwin)はUnix系の分岐に進みます。Windows以外のすべてのシステムで同じコマンドが使えると想定せず、実際のOSに合ったコマンドを選んでください。この例ではまず対話型コンソールの有無を確認します。端末を消去するコマンドでは、ファイルや端末に接続されていないIDEのペインは消去できないためです。

このセクションのコードと表示されるラベルや出力は英語のままです。

import java.io.IOException;
import java.util.Locale;

public class ClearConsoleWithCommand {
    public static void main(String[] args) {
        if (System.console() == null) {
            System.out.println("No interactive console is attached.");
            return;
        }
        try {
            String os = System.getProperty("os.name").toLowerCase(Locale.ROOT);
            ProcessBuilder builder = os.startsWith("windows")
                    ? new ProcessBuilder("cmd", "/c", "cls")
                    : new ProcessBuilder("clear");
            builder.inheritIO();
            Process process = builder.start();
            int exitCode = process.waitFor();
            if (exitCode != 0) {
                System.out.println("The clear command returned " + exitCode + ".");
            }
        } catch (IOException e) {
            System.out.println("The clear command could not be started.");
        } catch (InterruptedException e) {
            Thread.currentThread().interrupt();
            System.out.println("Waiting for the clear command was interrupted.");
        }
    }
}

ProcessBuilder は別プロセスを起動しますが、コマンドが存在しない場合やプロセスの検索パスに含まれていない場合に、そのコマンドを利用可能にするものではありません。inheritIO() は子プロセスをJavaプロセスと同じ標準入力・標準出力・標準エラーに接続し、端末コマンドが接続先の表示に作用できるようにします。この例はコマンドの終了を待ち、終了コードが0以外の場合にその値を報告します。また、待機が中断された場合は割り込み状態を復元します。コマンドが見つからない、環境に端末情報がない、または利用可能な対話型端末なしでプロセスを起動した場合など、コマンドが失敗することもあります。OSの確認で選ばれるのは可能性の高いコマンドにすぎず、そのコマンドの存在や端末が消去要求に従うことまでは保証されません。

端末とOSの対応状況を確認する

端末がANSI制御シーケンスを解釈すると確認できている場合は、ANSI方式を使ってください。外部コマンドへの依存がなく、端末の動作をアプリケーション環境で制御できる場合に適しています。プロセス方式は、選んだコマンドが存在し、同じ対話型端末にアクセスできる場合に限って使ってください。IDEの実行ペイン、リダイレクトされた出力、バックグラウンドジョブは、端末と同じようには動作しないことがあります。IDEにコンソールのようなパネルが表示されていても、IDE内や入力・出力がリダイレクトされた環境では System.console() が null になる場合があります。どちらの方法でも、スクロールバックを確実に削除したり、すべてのIDEのコンソール表示を消去したりすることはできません。表示が変わらない場合は、端末のANSI設定とプログラムが対話型端末に接続されているかを確認してください。IDEの表示を消去する必要がある場合は、IDE独自のコンソール消去機能を使ってください。