Чтение текстового файла из classpath в Java

Одной из распространенных задач в Java является чтение текстовых файлов, которые находятся в classpath. Это может быть полезно, например, при работе с конфигурационными файлами или ресурсами, которые включены в приложение.

Проблема

Возьмем для примера простой текстовый файл, который находится в том же каталоге, что и класс, который пытается его прочитать. Пусть этот файл называется myFile.txt, а класс, который пытается прочитать его, называется MyClass.

public class MyClass {
    public void readMyFile() {
        InputStream is = this.getClass().getClassLoader().getResourceAsStream("myFile.txt");
        // Дальнейшая обработка потока...
    }
}

Однако, это не всегда работает, как ожидается. Иногда getResourceAsStream возвращает null, что означает, что файл не был найден.

Решение

Проблема обычно заключается в том, что путь к файлу указан неверно. Метод getResourceAsStream ищет ресурсы относительно classpath, а не относительно файловой системы. Это означает, что если файл находится в корневом каталоге проекта, его можно прочитать, используя getResourceAsStream("/myFile.txt").

public class MyClass {
    public void readMyFile() {
        InputStream is = this.getClass().getClassLoader().getResourceAsStream("/myFile.txt");
        // Дальнейшая обработка потока...
    }
}

Если файл находится в подкаталоге resources, нужно указать полный путь к нему, начиная с /, так: getResourceAsStream("/resources/myFile.txt").

public class MyClass {
    public void readMyFile() {
        InputStream is = this.getClass().getClassLoader().getResourceAsStream("/resources/myFile.txt");
        // Дальнейшая обработка потока...
    }
}

После этого метод getResourceAsStream должен успешно найти и открыть файл. Если это все равно не работает, стоит проверить, находится ли файл в действительности там, где предполагается, и правильно ли он включен в classpath.