Какие требования к классам которые инициализируем в ресурсах

Требования к классам для инициализации в try-with-resources

Java конструкция try-with-resources (введена в Java 7) — это удобный способ работы с ресурсами, которые должны быть закрыты. Рассмотрим требования к таким классам.

Основное требование: реализация AutoCloseable

Класс, который инициализируется в try-with-resources, должен реализовать интерфейс AutoCloseable:

public interface AutoCloseable {
    void close() throws Exception;
}

Этот интерфейс требует только одного метода — close(), который будет вызван автоматически.

Пример корректного использования

1. Класс, реализующий AutoCloseable

public class Database implements AutoCloseable {
    private Connection connection;
    
    public Database(String url) throws SQLException {
        this.connection = DriverManager.getConnection(url);
    }
    
    public void query(String sql) {
        // Выполнить запрос
    }
    
    @Override
    public void close() throws Exception {
        // Будет вызвана автоматически
        if (connection != null && !connection.isClosed()) {
            connection.close();
        }
    }
}

// Использование
try (Database db = new Database("jdbc:mysql://localhost/mydb")) {
    db.query("SELECT * FROM users");
} catch (Exception e) {
    e.printStackTrace();
}
// close() вызовется автоматически, даже если будет исключение

2. Класс, реализующий Closeable

Alternative — Closeable (подинтерфейс AutoCloseable, для I/O операций):

public interface Closeable extends AutoCloseable {
    void close() throws IOException;  // Более специфичный тип исключения
}

// Пример
public class FileReader implements Closeable {
    private FileInputStream stream;
    
    public FileReader(String path) throws IOException {
        this.stream = new FileInputStream(path);
    }
    
    @Override
    public void close() throws IOException {
        stream.close();
    }
}

// Использование
try (FileReader reader = new FileReader("file.txt")) {
    // Работаем с файлом
} catch (IOException e) {
    e.printStackTrace();
}

3. Встроенные примеры в Java

// FileInputStream уже реализует Closeable
try (FileInputStream fis = new FileInputStream("file.txt")) {
    byte[] data = fis.readAllBytes();
} catch (IOException e) {
    e.printStackTrace();
}

// BufferedReader реализует Closeable
try (BufferedReader br = new BufferedReader(new FileReader("file.txt"))) {
    String line;
    while ((line = br.readLine()) != null) {
        System.out.println(line);
    }
} catch (IOException e) {
    e.printStackTrace();
}

// ResultSet из базы данных
try (Statement stmt = connection.createStatement();
     ResultSet rs = stmt.executeQuery("SELECT * FROM users")) {
    while (rs.next()) {
        System.out.println(rs.getString("name"));
    }
} catch (SQLException e) {
    e.printStackTrace();
}

Требования к методу close()

1. Должен быть идемпотентным

Метод должен безопасно вызваться несколько раз:

public class MyResource implements AutoCloseable {
    private BufferedReader reader;
    private boolean closed = false;
    
    public MyResource(String path) throws IOException {
        this.reader = new BufferedReader(new FileReader(path));
    }
    
    @Override
    public void close() throws IOException {
        // Проверка флага — метод безопасен при повторном вызове
        if (!closed) {
            if (reader != null) {
                reader.close();
            }
            closed = true;
        }
    }
}

2. Не должен выбросить исключение (обычно)

Если close() выбросит исключение, оно может скрыть исключение из try блока:

public class SafeResource implements AutoCloseable {
    @Override
    public void close() throws Exception {
        try {
            // Закрыть ресурс
            doCloseResource();
        } catch (Exception e) {
            // Логировать, но не выбросить (или выбросить вторичное исключение)
            System.err.println("Error closing resource: " + e.getMessage());
            // throw e;  // Может скрыть исключение из try
        }
    }
    
    private void doCloseResource() throws Exception {
        // ...
    }
}

3. Должен быть thread-safe (если используется из разных потоков)

public class ThreadSafeResource implements AutoCloseable {
    private volatile boolean closed = false;
    private final Object lock = new Object();
    
    @Override
    public void close() throws Exception {
        synchronized (lock) {
            if (!closed) {
                // Безопасное закрытие
                closed = true;
            }
        }
    }
}

Множественные ресурсы

Можно инициализировать несколько ресурсов в одном try-with-resources:

try (FileInputStream fis = new FileInputStream("input.txt");
     FileOutputStream fos = new FileOutputStream("output.txt");
     BufferedReader br = new BufferedReader(new InputStreamReader(fis))) {
    
    String line;
    while ((line = br.readLine()) != null) {
        fos.write((line + "\n").getBytes());
    }
} catch (IOException e) {
    e.printStackTrace();
}
// Все три ресурса будут закрыты в обратном порядке (fis, fos, br)

Порядок закрытия ресурсов

Ресурсы закрываются в обратном порядке инициализации (LIFO):

try (Resource1 r1 = new Resource1();
     Resource2 r2 = new Resource2();
     Resource3 r3 = new Resource3()) {
    // ...
}
// Порядок закрытия: r3.close(), r2.close(), r1.close()

Подавление исключений (Suppressed Exceptions)

Если в try выбросится исключение, а в close() тоже, Java автоматически подавляет исключение из close():

try (MyResource res = new MyResource()) {
    throw new IOException("Error in try block");  // Основное исключение
    // Если res.close() выбросит исключение, оно будет подавлено
    // и доступно через exception.getSuppressed()
} catch (IOException e) {
    System.out.println("Main exception: " + e.getMessage());
    
    // Получить подавленные исключения
    for (Throwable suppressed : e.getSuppressed()) {
        System.out.println("Suppressed: " + suppressed.getMessage());
    }
}

Практический пример: кастомный ресурс

public class DatabaseConnection implements AutoCloseable {
    private Connection connection;
    private Statement statement;
    private boolean closed = false;
    
    public DatabaseConnection(String url, String user, String password) throws SQLException {
        this.connection = DriverManager.getConnection(url, user, password);
    }
    
    public ResultSet executeQuery(String sql) throws SQLException {
        statement = connection.createStatement();
        return statement.executeQuery(sql);
    }
    
    public int executeUpdate(String sql) throws SQLException {
        statement = connection.createStatement();
        return statement.executeUpdate(sql);
    }
    
    @Override
    public void close() throws SQLException {
        // Закрытие ресурсов в правильном порядке
        if (!closed) {
            try {
                if (statement != null && !statement.isClosed()) {
                    statement.close();
                }
            } finally {
                try {
                    if (connection != null && !connection.isClosed()) {
                        connection.close();
                    }
                } finally {
                    closed = true;
                }
            }
        }
    }
}

// Использование
public class Application {
    public static void main(String[] args) {
        try (DatabaseConnection db = new DatabaseConnection(
            "jdbc:mysql://localhost/mydb",
            "root",
            "password")) {
            
            ResultSet rs = db.executeQuery("SELECT * FROM users");
            while (rs.next()) {
                System.out.println(rs.getString("name"));
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
        // connection и statement автоматически закрыты
    }
}

Резюме требований

1. Реализация интерфейса AutoCloseable или Closeable

   • AutoCloseable для всех ресурсов
   • Closeable для I/O операций

2. Метод close() должен быть:

   • Идемпотентным (безопасным при повторных вызовах)
   • По возможности не выбрасывать исключения
   • Thread-safe если нужно
   • Закрывать ресурсы в правильном порядке (вложенные в finally)

3. Преимущества try-with-resources:

   • Автоматическое закрытие ресурсов
   • Правильная обработка исключений
   • Поддержка множественных ресурсов
   • Читаемость кода

4. Лучшие практики:

   • Всегда используй try-with-resources для ресурсов
   • Не полагайся на finalize() для закрытия
   • Логируй ошибки закрытия, но не выбрасывай их
   • Проверяй что ресурс не закрыт перед использованием