Глава 6. Имена

Объявление вводит сущность в программу и включает идентификатор (§3.8), который может быть использован в имени для ссылки на эту сущность. Идентификатор ограничен, чтобы избежать определенных ключевых слов контекста, когда вводимая сущность является классом, интерфейсом или параметром типа.

Объявляемая сущность может быть следующей:

Конструкторы (§8.8, §8.10.4) также вводятся объявлениями, но используют имя класса, в котором они объявлены, а не вводят новое имя.

Объявление обобщенного класса или интерфейса (class C<T> ... или interface C<T> ...) вводит как класс с именем C, так и семейство типов: необобщенный тип C, параметризованный тип C<Foo>, параметризованный тип C<Bar> и т. д.

Когда ссылка на C встречается в контексте, где обобщенность не важна, идентифицируемом ниже как один из необобщенных контекстов, эта ссылка на C обозначает класс или интерфейс C. В других контекстах ссылка на C обозначает тип или часть типа, введенного с помощью C.

15 необобщенных контекстов приведены ниже:

Первые двенадцать не-генерических контекстов соответствуют первым двенадцати синтаксическим контекстам для TypeName в §6.5.1. Тринадцатый не-генерический контекст — это место, где квалифицированное ExpressionName, такое как C.x, может включать TypeName C для обозначения доступа к статическому члену. Общее использование TypeName в этих тринадцати контекстах важно: оно указывает, что эти контексты включают использование типа с менее чем первоклассным статусом. В отличие от этого, четырнадцатый и пятнадцатый не-генерические контексты используют ClassType, указывая, что в разделах throws и catch типы используются в первоклассном формате, подобно, например, объявлениям полей. Характеристика этих двух контекстов как не-генерических обусловлена тем, что тип исключения не может быть параметризован (§8.1.2).

Обратите внимание, что производство ClassType допускает аннотации, поэтому можно аннотировать использование типа в разделе throws или catch, тогда как производство TypeName запрещает аннотации, поэтому нельзя аннотировать имя типа, например, в объявлении импорта одного типа.

Правила именования

Библиотеки классов Java SE Platform стараются использовать, когда это возможно, имена, выбранные в соответствии с правилами, представленными ниже. Эти правила помогают сделать код более читаемым и избежать определенных типов конфликтов имён.

Мы рекомендуем использовать эти правила во всех программах, написанных на языке программирования Java. Однако следовать этим правилам следует не догматично, если длительное обычное использование диктует иное. Например, методы sin и cos класса java.lang.Math имеют математически общепринятые названия, даже несмотря на то, что эти имена методов нарушают предлагаемую здесь конвенцию, поскольку они короткие и не являются глаголами.

Имена пакетов и модулей

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

Если не использовать уникальные имена пакетов, могут возникнуть конфликты имён пакетов далеко от точки создания любого из конфликтующих пакетов. Это может создать ситуацию, которую трудно или невозможно разрешить пользователю или программисту. Классы ClassLoader и ModuleLayer могут использоваться для изоляции пакетов с одинаковыми именами друг от друга в тех случаях, когда пакеты будут иметь ограниченные взаимодействия, но не таким образом, чтобы это было прозрачно для обычной программы.

Вы формируете уникальное имя пакета, сначала имея (или принадлежа, организации, которая имеет) доменное имя в интернете, например oracle.com. Затем вы инвертируете это имя, компонент за компонентом, чтобы в данном примере получить com.oracle, и используйте это в качестве префикса для ваших имён пакетов, используя соглашение, разработанное внутри вашей организации для дальнейшего администрирования имён пакетов. Такое соглашение может предписывать, чтобы определённые компоненты имени пакета были подразделениями, отделами, проектами, машинами или именами входа.

com.nighthacks.scrabble.dictionary
org.openjdk.compiler.source.tree
net.jcip.annotations
edu.cmu.cs.bovik.cheese
gov.whitehouse.socks.mousefinder

Первый компонент уникального имени пакета всегда записывается строчными латинскими буквами ASCII и должен быть одним из доменных имён верхнего уровня, таких как com, edu, gov, mil, net или org, или одним из английских двухбуквенных кодов, определяющих страны, как указано в ISO Standard 3166.

В некоторых случаях доменное имя может не быть допустимым именем пакета. Вот некоторые рекомендуемые соглашения для решения этих ситуаций:

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

com.nighthacks.scrabble
org.openjdk.compiler
net.jcip.annotations

Первый компонент имени пакета или модуля не должен быть идентификатором java. Имена пакетов и модулей, начинающиеся с идентификатора java, зарезервированы для пакетов и модулей Java SE Platform.

Имя пакета или модуля не должно подразумевать местоположение пакета или модуля в интернете. Например, пакет с именем edu.cmu.cs.bovik.cheese необязательно доступен с хоста cmu.edu или cs.cmu.edu или bovik.cs.cmu.edu. Предлагаемая конвенция для генерации уникальных имён пакетов и модулей просто способ наложения соглашения об именах пакетов и модулей на существующий широко известный реестр уникальных имён вместо создания отдельного реестра для имён пакетов и модулей.

Имена классов и интерфейсов

Имена классов должны быть описательными существительными или существительными словосочетаниями, не слишком длинными, с использованием смешанного регистра, причём первая буква каждого слова должна быть заглавной.

ClassLoader
SecurityManager
Thread
Dictionary
BufferedInputStream

Аналогично, имена интерфейсов должны быть короткими и описательными, не чрезмерно длинными, с использованием смешанного регистра, где первая буква каждого слова прописная. Имя может быть описательным существительным или словосочетанием, что подходит, когда интерфейс используется как абстрактный суперкласс, например, интерфейсы java.io.DataInput и java.io.DataOutput; или это может быть прилагательное, описывающее поведение, как для интерфейсов Runnable и Cloneable.

Имена переменных типа

Имена переменных типа должны быть лаконичными (если возможно, одним символом) и выразительными, и не должны содержать строчных букв. Это упрощает различение параметров типа от обычных классов и интерфейсов.

Классы и интерфейсы контейнеров должны использовать имя E для типа их элементов. Карты должны использовать K для типа своих ключей и V для типа своих значений. Имя X следует использовать для произвольных типов исключений. Мы используем T для типа, когда нет ничего более специфичного, чтобы отличить его. (Это часто случается в методах с параметрами типа.)

Если есть несколько параметров типа, обозначающих произвольные типы, следует использовать буквы, расположенные рядом с T в алфавите, например, S. В качестве альтернативы, допустимо использовать числовые индексы (например, T1, T2) для различения различных переменных типа. В таких случаях все переменные с одинаковым префиксом должны иметь индексы.

Если метод с параметрами типа встречается внутри класса с параметрами типа, рекомендуется избегать использования одинаковых имён для параметров типа метода и класса, чтобы избежать путаницы. То же самое относится к вложенным классам с параметрами типа.

public class HashSet<E> extends AbstractSet<E> { ... }
public class HashMap<K,V> extends AbstractMap<K,V> { ... }
public class ThreadLocal<T> { ... }
public interface Functor<T, X extends Throwable> {
    T eval() throws X;
}

Когда параметры типа не попадают удобно ни в одну из упомянутых категорий, имена должны выбираться максимально осмысленными в пределах одного символа. Упомянутые выше имена (E, K, V, X, T) не должны использоваться для параметров типа, которые не попадают в назначенные категории.

Имена методов

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

Всякий раз, когда это возможно и уместно, наименование методов в новом классе по аналогии с именами в похожем существующем классе, особенно классе из API Java SE Platform, сделает его использование проще.

Имена полей

Имена полей, которые не являются final, должны быть в смешанном регистре, с первой буквой строчной, а первые буквы последующих слов прописные. Обратите внимание, что в хорошо спроектированных классах очень мало public или protected полей, за исключением полей, которые являются константами (static final поля).

Поля должны иметь имена, которые являются существительными, словосочетаниями или аббревиатурами существительных.

Имена констант

Имена констант в интерфейсах должны быть, а final переменные классов могут быть, последовательностью одного или более слов, аббревиатур или сокращений, все заглавные буквы, компоненты разделены символами подчеркивания "_". Имена констант должны быть описательными и не излишне сокращёнными. Традиционно они могут быть любыми подходящими частями речи.

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

interface ProcessStates {
    int PS_RUNNING   = 0;
    int PS_SUSPENDED = 1;
}

Имена локальных переменных и параметров

Имена локальных переменных и параметров должны быть короткими, но осмысленными. Они часто представляют собой короткие последовательности строчных букв, которые не являются словами, такие как:

Односимвольные локальные переменные или имена параметров следует избегать, за исключением временных и циклических переменных или случаев, когда переменная содержит неопределённое значение типа. Традиционные односимвольные имена:

Локальные переменные или имена параметров, состоящие только из двух или трёх строчных букв, не должны совпадать с начальными кодами стран и доменными именами, которые являются первым компонентом уникальных имён пакетов.

Область видимости объявления — это область программы, в пределах которой к сущности, объявленной этим объявлением, можно обратиться, используя простое имя, при условии, что она не скрыта (§6.4.1).

Считается, что объявление находится в области видимости в определённой точке программы тогда и только тогда, когда область видимости объявления включает эту точку.

Область видимости объявления наблюдаемого верхнего уровня пакета (§7.4.3) — все наблюдаемые единицы компиляции, связанные с модулями, для которых пакет имеет уникальную видимость (§7.4.3).

Объявление пакета, который не наблюдаем, никогда не находится в области видимости.

Объявление подпакета никогда не находится в области видимости.

Пакет java всегда находится в области видимости.

Область видимости класса или интерфейса, импортированного с помощью объявления импорта одного типа (§7.5.1) или объявления импорта по требованию типа (§7.5.2) — это объявление модуля (§7.7) и все объявления классов и интерфейсов (§8.1, §9.1) в единице компиляции, в которой появляется объявление import, а также любые аннотации на объявление модуля или объявление пакета этой единицы компиляции.

Область видимости члена, импортированного с помощью объявления импорта одного статического члена (§7.5.3) или объявления статического импорта по требованию (§7.5.4), — это объявление модуля и все объявления классов и интерфейсов единицы компиляции, в которой появляется объявление import, а также любые аннотации на объявление модуля или объявление пакета этой единицы компиляции.

Область видимости верхнего уровня класса или интерфейса (§7.6) — все объявления классов и интерфейсов в пакете, в котором объявлен верхнего уровня класс или интерфейс.

Область видимости объявления члена m, объявленного или унаследованного классом или интерфейсом C (§8.2, §9.2) — всё тело C, включая любые вложенные классы или интерфейсы. Если C — это класс-запись, то область видимости m дополнительно включает заголовок объявления записи C.

Область видимости формального параметра метода (§8.4.1), конструктора (§8.8.1) или лямбда-выражения (§15.27) — всё тело метода, конструктора или лямбда-выражения.

Область видимости параметра типа класса (§8.1.2) — раздел параметров типа объявления класса, и раздел параметров типа любого суперкласса или суперинтерфейса объявления класса, и тело класса. Если класс — это класс-запись (§8.10), то область видимости параметра типа дополнительно включает заголовок объявления записи (§8.10.1).

Область видимости параметра типа интерфейса (§9.1.2) — это раздел параметров типа объявления интерфейса, и раздел параметров типа любого суперинтерфейса объявления интерфейса, и тело интерфейса.

Область видимости параметра типа метода (§8.4.4) — всё объявление метода, включая раздел параметров типа, но не включая модификаторы метода.

Область видимости параметра типа конструктора (§8.8.4) — всё объявление конструктора, включая раздел параметров типа, но не включая модификаторы конструктора.

Область видимости вложенного класса или интерфейса, немедленно заключённого в блок (§14.2) — остальная часть непосредственно окружающего блока, включая объявление самого вложенного класса или интерфейса.

Область видимости объявления вложенного класса или интерфейса, немедленно заключённого в группу операторов блока switch (§14.11) — остальная часть непосредственно окружающего группы операторов блока switch, включая объявление самого вложенного класса или интерфейса.

Область видимости локальной переменной, объявленной в блоке с помощью оператора объявления локальной переменной (§14.4.2), — остальная часть блока, начиная с собственного инициализатора объявления и включая любые другие объявления справа в операторе объявления локальной переменной.

Область видимости локальной переменной, объявленной в части ForInit базового оператора цикла for (§14.14.1) включает всё следующее:

Область видимости локальной переменной, объявленной в заголовке оператора цикла for-each (§14.14.2) — вложенный оператор Statement.

Область видимости локальной переменной, объявленной в спецификации ресурса оператора try-with-resources (§14.20.3) — от объявления вправо по оставшейся части спецификации ресурса и всему блоку try, связанному с оператором try-with-resources.

Перевод оператора try-with-resources подразумевает вышеприведённое правило.

Область видимости параметра обработчика исключения, объявленного в блоке catch оператора цикла try (§14.20) — весь блок, связанный с catch.

package points;
class Point {
    int x, y;
    PointList list;
    Point next;
}

class PointList {
    Point first;
}

class Test1 {
    static int x;
    public static void main(String[] args) {
        int x = x;
    }
}

class Test2 {
    static int x;
    public static void main(String[] args) {
        int x = (x=2)*2;
        System.out.println(x);
    }
}

4

class Test3 {
    public static void main(String[] args) {
        System.out.print("2+1=");
        int two = 2, three = two + 1;
        System.out.println(three);
    }
}

2+1=3

Область видимости объявления переменной шаблона (то есть локальной переменной, объявленной шаблоном) — часть программы, которая может быть выполнена после успешного сопоставления значения с шаблоном (§14.30.2). Она определяется путём рассмотрения точек программы, где переменная шаблона определённо сопоставлена в области, начинающейся с шаблона, который объявляет переменную шаблона.

Остальная часть этого раздела посвящена точному объяснению слов "определенно совпало". Анализ учитывает структуру операторов и выражений, с особым учетом операторов булевых выражений и определенных форм операторов.

Будет видно, что область действия переменной шаблона — это понятие, зависящее от потока, аналогичное определённому присваиванию (§16 (Определённое присваивание)). Правила, определённые в остальной части этого раздела, преднамеренно имеют схожую форму с правилами определённого присваивания.

Анализ опирается на технический термин "введённый", который имеет следующий вид:

Самый простой пример — переменная шаблона s вводится выражением a instanceof String s при истинном значении. Другими словами, если значение выражения равно true, то сопоставление шаблонов должно было быть успешным, и, следовательно, переменной шаблона должно было быть присвоено значение.

В отличие от этого, переменная шаблона t вводится выражением !(b instanceof Integer t) при ложном значении. Это происходит потому, что сопоставление шаблонов могло быть успешным только в том случае, если значение выражения равно false.

Значение имени зависит от контекста, в котором оно используется. Определение значения имени требует трёх шагов:

Использование контекста помогает свести к минимуму конфликты имён между сущностями разных типов. Такие конфликты будут редкими, если будут соблюдены правила именования, описанные в §6.1. Тем не менее, конфликты могут возникать непреднамеренно, по мере развития типов, разработанных разными программистами или организациями. Например, типы, методы и поля могут иметь одинаковые имена. Всегда возможно отличить метод от поля с тем же именем, так как контекст использования всегда указывает, предполагается ли метод.

Язык программирования Java предоставляет механизмы управления доступом для предотвращения зависимости пользователей от пакета или класса от ненужных деталей реализации этого пакета или класса. Если доступ разрешен, то доступная сущность считается доступной.

Обратите внимание, что доступность является статическим свойством, которое можно определить во время компиляции; она зависит только от типов и модификаторов объявления.

Квалифицированные имена являются средством доступа к членам пакетов, классов, интерфейсов, параметров типа и ссылочных типов. Когда имя такого члена классифицируется из его контекста (§6.5.1) как квалифицированное имя типа (обозначающее член пакета, класса, интерфейса или параметра типа) или квалифицированное имя выражения (обозначающее член ссылочного типа), применяется управление доступом.

Например, объявление импорта одного типа использует квалифицированное имя типа (§7.5.1), поэтому именованный класс или интерфейс должен быть доступен из модуля компиляции, содержащего объявление import. В качестве другого примера, объявление класса может использовать квалифицированное имя типа для типа суперкласса (§8.1.5), поэтому именованный класс должен быть доступен.

Некоторые очевидные выражения «отсутствуют» из классификации контекста в §6.5.1: доступ к полю к Первичному (§15.11.1), вызов метода к Первичному (§15.12), ссылка на метод через Первичный (§15.13) и созданный класс в квалифицированном выражении создания экземпляра класса (§15.9). Каждое из этих выражений использует идентификаторы, а не имена, по причине, указанной в §6.2. Следовательно, управление доступом к членам (поля, методы, классы или интерфейсы) применяется явно с помощью выражений доступа к полям, выражений вызова методов, выражений ссылки на методы и выражений квалифицированного создания экземпляра класса. (Обратите внимание, что доступ к полю также может обозначаться квалифицированным именем, встречающимся как постфиксное выражение.)

Кроме того, многие операторы и выражения допускают использование типов, которые не выражаются исключительно именами типов. Например, объявление класса может использовать параметризованный тип (§4.5) для обозначения типа суперкласса. Поскольку параметризованный тип не является квалифицированным именем типа, для объявления класса необходимо явно выполнить управление доступом для обозначенного суперкласса. Следовательно, из операторов и выражений, которые предоставляют контексты в §6.5.1 для классификации ИмениТипа, большинство выполняют свои проверки управления доступом.

Помимо доступа к членам пакета, класса, интерфейса или параметра типа, существует вопрос доступа к конструкторам класса. Управление доступом должно проверяться при явном или неявном вызове конструктора. Следовательно, управление доступом проверяется с помощью оператора явного вызова конструктора (§8.8.7.1) и выражения создания экземпляра класса (§15.9.3). Такие проверки необходимы, потому что §6.5.1 не упоминает операторы явного вызова конструктора (поскольку они ссылаются на конструкторы косвенно, а не через имена) и не знает различия между классом, обозначенным выражением создания неквалифицированного экземпляра класса, и конструктором этого класса. Кроме того, у конструкторов нет квалифицированных имён, поэтому мы не можем полагаться на проверку управления доступом во время классификации квалифицированных имён типов.

Доступность влияет на наследование членов класса (§8.2), включая скрытие и переопределение методов (§8.4.8.1).