HOWTO · Java

Limpar a Consola em Java

Mostra os dois métodos para limpar o ecrã de uma consola em Java

Nesta página

Java não tem um método integrado para limpar o console. Durante a execução de um programa, você pode imprimir sequências de escape ANSI ou iniciar um comando fornecido pelo sistema operacional. A abordagem que funciona depende do terminal ou da IDE que exibe o programa. Ambos os métodos solicitam que a área visível da tela seja limpa; nenhum deles garante que a saída anterior seja removida do histórico de rolagem do terminal ou do histórico de execuções armazenado pela IDE.
O tratamento da consola é um dos utilitários do dia a dia reunidos no Tutorial de Java.

Use sequências de escape ANSI para limpar o console

Sequências ANSI são caracteres de controle interpretados por um terminal. A sequência \033[H move o cursor para a posição inicial, e \033[2J apaga a tela visível. Imprima ambas antes do próximo prompt ou da próxima mensagem de status. \033[2J apaga toda a tela; outros parâmetros de apagamento, como \033[0J, têm comportamento relativo ao cursor e apagam do cursor até o fim da tela.

Execute este exemplo; o rótulo exibido no bloco de saída permanece em inglês:

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!

Os escapes \033 na string Java inserem o caractere ESC. System.out.flush() envia a sequência imediatamente; sem ele, a saída armazenada em buffer talvez não chegue ao terminal antes da saída seguinte. Este código envia a solicitação, mas não faz com que um terminal sem suporte a interprete. O suporte a ANSI é comum em emuladores de terminal, mas pode depender das configurações do terminal, da configuração da IDE e da forma como o programa é iniciado. Limpar a tela visível também pode deixar intacto o histórico de rolagem do terminal. Se os caracteres de escape aparecerem literalmente ou a tela não mudar, use o comando da IDE para limpar o console ou confira a configuração de suporte a ANSI.

Execute um comando do sistema operacional com ProcessBuilder

Se o terminal oferecer um comando para limpar a tela, o Java poderá iniciá-lo com ProcessBuilder. O Prompt de Comando do Windows usa cls por meio de cmd /c; o macOS e outros sistemas semelhantes ao Unix geralmente oferecem clear. O exemplo converte o nome do sistema operacional para minúsculas com Locale.ROOT e verifica se começa com o prefixo windows, portanto o macOS (Darwin) segue o ramo semelhante ao Unix. Escolha o comando apropriado para o sistema operacional em uso, em vez de presumir que todos os sistemas que não são Windows usem o mesmo comando. Este exemplo primeiro verifica se há um console interativo, pois um comando que limpa um terminal não pode limpar um arquivo nem um painel da IDE que não esteja conectado a um terminal:

O código e os rótulos ou saídas exibidos nesta seção permanecem em inglês.

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 inicia um processo separado; ele não disponibiliza um comando que esteja ausente ou fora do caminho de busca do processo. inheritIO() conecta o processo filho aos mesmos fluxos padrão de entrada, saída e erro do processo Java, permitindo que um comando de terminal afete a tela conectada. O exemplo aguarda a conclusão e informa um código de saída diferente de zero. Ele também restaura o estado de interrupção caso a espera seja interrompida. Ainda assim, o comando pode falhar se estiver ausente, se o ambiente não tiver informações sobre o terminal ou se o processo for iniciado sem um terminal interativo utilizável. A verificação do sistema operacional apenas seleciona um comando provável; não confirma que ele existe nem que o terminal o executará.

Verifique o suporte do terminal e do sistema operacional

Use a abordagem ANSI quando souber que o terminal interpreta sequências de controle ANSI. Ela evita uma dependência externa e é adequada quando o comportamento do terminal é controlado pelo ambiente da aplicação. Use a abordagem com processo somente quando o comando escolhido existir e puder acessar o mesmo terminal interativo; painéis de execução de IDEs, saída redirecionada e tarefas em segundo plano podem não se comportar como um terminal. System.console() pode ser null em IDEs e quando a entrada ou a saída é redirecionada, mesmo que a IDE mostre um painel parecido com um console. Nenhuma das abordagens remove o histórico de rolagem de forma confiável nem limpa a visualização do console em todas as IDEs. Se a tela não mudar, confira a configuração ANSI do terminal e se o programa está conectado a um terminal interativo; quando precisar limpar a visualização da IDE, prefira o controle próprio da IDE para limpar o console.