Множественные классы в одном файле Java: нюансы и ограничения

Быстрый ответ

В Java в рамках одного файла можно объявить несколько классов. Однако лишь один класс может быть публичным, а имя файла должно совпадать с именем этого класса. Остальные классы будут доступны на уровне пакета, то есть они не будут видимы за его пределами. Ниже приведен пример структуры файла с классами:

public class MainClass { // Имя файла должно совпадать с моим именем, иначе компилятор выдаст ошибку!
    // Код основного публичного класса.
    public static void main(String[] args) {
        // Точка входа в программу 🎉
    }
}

class AuxiliaryClass { // Я скромный класс, не задуман для просмотра извне.
    // Код вспомогательного класса.
}

// Можно добавить сколько угодно классов с доступом на уровне пакета, но стоит уважать их пространство!

Обратите внимание, что класс AuxiliaryClass и все классы, объявленные после него, не будут видимы вне этого файла.

Лучшие практики организации классов

Несмотря на возможность определения нескольких классов в одном файле, рекомендуется придерживаться правила – один публичный класс на файл, поскольку:

• Процесс сборки: Большое количество классов в одном файле может сбивать с толку во время компиляции. Единичные файлы обеспечивают порядок и удобство управления.
• Отладка: Флаг -Xlint:all после компиляции предоставляет подсказки о всех нюансах взаимосвязей между классами.
• Отслеживание изменений: Важно следить за изменениями в спецификациях последних версий Java, особенно если используются ссылки на классы. В Java 11 некоторые ограничения смягчились, но проверять следует всё равно.

Применение вложенных классов

Не стоит путать ограничение на наличие только одного верхнего класса в файле с запретом на несколько классов вообще. Внутренние или вложенные классы могут быть полезны:

• Близость: Вспомогательные классы, тесно связанные с основным, могут быть расположены внутри него, что облегчает управление схожим кодом.
• Защита данных: Вложенные классы имеют доступ к приватным членам внешнего класса, обеспечивая дополнительный уровень защиты.

Подробнее об этом расскажет наш спикер на видео

Использование возможностей Java 11

С выходом Java 11 появилась возможность запуска файлов .java, содержащих несколько верхних классов, это реализовано в JEP 330:

• Метод main следует поместить в первый класс.
• Только один класс может быть объявлен как public, если планируется его компиляция.
• Вариант удобен для небольших скриптов, но неудобен для разработки крупных приложений.

Визуализация

Представим исходный файл Java как книжную полку:

📚 Книжная полка (исходный файл Java): [📘 Книга (public класс), 📗 Тетрадь (класс), 📙 Дневник (класс)]

Золотое правило: В файле может находиться только один публичный класс, представляющий собой книгу 📘 на полке с определенной маркировкой. Это неизменное правило, не могущее терпеть исключений.

| Предмет        | Разрешено |
| -------------- | --------- |
| 📘 Книга       | 1️⃣      |
| 📗 Тетрадь     | ✅       |
| 📙 Дневник     | ✅       |

Вывод: В одном файле может содержаться несколько классов, но только один из них может быть главной частью книги 📘. Это всё напоминает "Игру престолов" – когда главных героев слишком много, историю становится трудно воспринимать.

Понимание непубличных классов верхнего уровня

При работе с несколькими классами в одном файле не забывайте:

• Их часто называют верхними классами с ограничением видимости до уровня пакета.
• Они похожи на эрмитажи – предпочитают оставаться в своём собственном мире, не захламляя namespace и сохраняя чистоту вашего кода.
• Желательно делать эти классы максимально простыми и ориентированными на служение основному классу.

Преодоление потенциальных проблем

Несколько классов в одном файле могут вызвать проблемы:

• Неоднозначные ссылки: Если два файла включают в себя классы с одинаковыми именами на уровне пакета, то компилятор распознает эти ссылки как неоднозначные, что приведет к ошибкам.
• Трудности рефакторинга: Разделение и переименование классов может стать проблематичным, особенно когда все они находятся в одном файле.
• Навигация по коду: Сложно найти нужный класс в большом файле, особенно в рамках больших проектов.

Рекомендации:

• Используйте инструменты навигации вашей IDE для быстрого доступа к нужным классам.
• Регулярно проводите рефакторинг кода, разделяя большие классы на более маленькие и помещая их в отдельные файлы.
• Оставайтесь внимательными при управлении областью видимости класса, чтобы поддерживать модульность вашего кода.

Полезные материалы

1. Глава 8. Классы – Спецификация языка Java — погружение в спецификацию языка Java на тему объявления классов.
2. Изучение языка Java – Классы и объекты — учебник Oracle, в котором раскрываются основы работы с классами и объектами в Java.
3. Java: Объявление нескольких классов в одном файле – Stack Overflow — обсуждение на Stack Overflow практических аспектов использования нескольких классов в одном файле.
4. Организация пакетов по функционалу, а не по слою – Java Practices — методы организации классов и интерфейсов в пакетах Java.
5. Основы классов: Классы и их экземпляры – DZone — руководство по основным принципам использования классов в Java.
6. Java – Объекты и классы – TutorialsPoint — обзор классов, объектов и методов в Java.