Spec-Zone .ru спецификации, руководства, описания, API

ГЛАВА 7

Пакеты

Программы организуются как наборы пакетов. У каждого пакета есть свой собственный набор имен для типов, который помогает предотвратить конфликты имен. Высокоуровневый тип доступен (§6.6) вне пакета, который объявляет это, только если тип объявляется public.

Структура именования для пакетов является иерархической (§7.1). Элементы пакета являются классом и интерфейсными типами (§7.6), которые объявляются в единицах компиляции пакета, и подпакетов, которые могут содержать единицы компиляции и собственные подпакеты.

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

Пакет состоит из многих единиц компиляции (§7.3). Единица компиляции автоматически имеет доступ ко всем типам, объявленным в его пакете, и также автоматически импортирует все открытые типы, объявленные в предопределенном пакете java.lang.

Для маленьких программ и случайной разработки, пакет может быть неназванным (§7.4.2) или иметь простое имя, но если код должен быть широко распределен, уникальные имена пакета должны быть выбраны (§7.7). Это может предотвратить конфликты, которые иначе произошли бы, если бы две группы разработки, оказалось, выбрали то же самое имя пакета, и эти пакеты должны были позже использоваться в единственной программе.

7.1 Элементы пакета

Например, в Прикладном программном интерфейсе Java:

• Пакет java имеет подпакеты awt, applet, io, lang, net, и util, но никакие единицы компиляции.
• Пакет java.awt назвали подпакет image, так же как много единиц компиляции, содержащих объявления класса и интерфейсных типов.

Пакет, возможно, не содержит два элемента того же самого имени, или ошибка времени компиляции заканчивается.

Вот некоторые примеры:

• Поскольку пакет java.awt имеет подпакет image, это не может (и не делать), содержат объявление класса или интерфейсного названного типа image.
• Если есть названный пакет mouse и тип элемента Button в том пакете (который тогда мог бы упоминаться как mouse.Button), тогда не может быть никакого пакета с полностью определенным именем mouse.Button или mouse.Button.Click.
• Если com.sun.java.jag полностью определенное имя типа, тогда не может быть никакого пакета, полностью определенное имя которого также com.sun.java.jag или com.sun.java.jag.scrabble.

Иерархическая структура именования для пакетов предназначается, чтобы быть удобной для того, чтобы организовать связанные пакеты стандартным способом, но не имеет никакого значения сам по себе кроме запрета на пакет, имеющий подпакет с тем же самым простым именем как высокоуровневый тип (§7.6) объявленный в том пакете. Между названным пакетом нет никакого специального отношения доступа oliver и другой пакет называют oliver.twist, или между пакетами называется evelyn.wood и evelyn.waugh. Например, код в пакете называют oliver.twist не имеет никакого лучшего доступа к типам, объявленным в пределах пакета oliver чем код в любом другом пакете.

7.2 Поддержка узла Пакетов

Наблюдательность единиц компиляции поочередно определяет, какие пакеты заметны, и какие пакеты находятся в контексте.

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

7.2.1 Хранение Пакетов в Файловой системе

com
gls
jag
java
wnj

Продолжая пример, каталог java содержал бы, среди других, следующих подкаталогов:

applet 
awt
io
lang
net
util

Все еще продолжая пример, если мы должны были смотреть в каталоге util, мы могли бы видеть следующие файлы:

BitSet.java                             Observable.java
BitSet.class                            Observable.class
Date.java                               Observer.java
Date.class                              Observer.class
...

Под этой простой организацией пакетов реализация платформы Java преобразовала бы имя пакета в путь, связывая компоненты имени пакета, помещая разделитель имени файла (индикатор каталога) между смежными компонентами.

Например, если эта простая организация использовалась на системе UNIX, где разделитель имени файла /, имя пакета:

jag.scrabble.board

jag/scrabble/board

com.sun.sunsoft.DOE

com/sun/sunsoft/DOE

Имя компонента имени пакета или имя класса могли бы содержать символ, который не может правильно появиться в обычном имени каталога файловой системы узла, таком как символ Unicode на системе, которая позволяет только символы ASCII в именах файлов. Как соглашение, при использовании символа можно оставить, скажем, @ символ, сопровождаемый четырьмя шестнадцатеричными цифрами, дающими числовое значение символа, как в \uescape xxxx (§3.3), так, чтобы имя пакета:

children.activities.crafts.papierM\u00e2ch\u00e9

children.activities.crafts.papierMâché

children/activities/crafts/papierM@00e2ch@00e9

7.2.2 Хранение Пакетов в Базе данных

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

7.3 Единицы компиляции

CompilationUnit:
        PackageDeclarationopt ImportDeclarationsopt TypeDeclarationsopt
ImportDeclarations:
        ImportDeclaration
        ImportDeclarations ImportDeclaration

TypeDeclarations:
        TypeDeclaration
        TypeDeclarations TypeDeclaration
        

Единица компиляции состоит из трех частей, каждая из которых является дополнительной:

• A package объявление (§7.4), давая полностью определенное имя (§6.7) пакета, которому принадлежит единица компиляции. Единица компиляции, у которой нет никакого объявления пакета, является частью неназванного пакета (§7.4.2).
• import объявления (§7.5), которые позволяют типам от других пакетов и статических элементов типов быть отнесенными в использование их простых имен
• Высокоуровневые описания типа (§7.6) класса и интерфейсных типов

Каждая единица компиляции автоматически и неявно импортирует каждый public имя типа объявляется предопределенным пакетом java.lang, так, чтобы имена всех тех типов были доступны как простые имена, как описано в §7.5.5.

7.4 Объявления пакета

7.4.1 Названный Пакетами

PackageDeclaration:
        Annotationsopt package PackageName ;

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

7.4.1.1 Аннотации пакета

Обсуждение

Этому рекомендуют это package-info.java, если это присутствует, возьмите место package.html для javadoc и других подобных систем генерации документации. Если этот файл присутствует, инструмент генерации документации должен искать комментарий для документации пакета, сразу предшествующий (возможно аннотируемый) объявление пакета в package-info.java. Таким образом пакет-info.java становится единственным репозитарием для аннотаций уровня пакета и документации. Если в будущем это становится требуемым, чтобы добавить информацию на уровне пакета, этот файл должен доказать удобный дом для этой информации.

7.4.2 Неназванные Пакеты

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

class FirstCall {
        public static void main(String[] args) {
                System.out.println("Mr. Watson, come here. "
                                        + "I want you.");
        }
}

Реализация платформы Java должна поддерживать по крайней мере один неназванный пакет; это может поддерживать больше чем один неназванный пакет, но не обязано делать так. То, какие единицы компиляции находятся в каждом неназванном пакете, определяется хост-системой.

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

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

7.4.3 Наблюдательность Пакета

• Единица компиляции, содержащая объявление пакета, заметна.
• Подпакет пакета заметен.

Можно завершить из правила выше и от требований к заметным единицам компиляции, что пакеты java, java.lang, и java.io всегда заметны.

7.4.4 Контекст Объявления Пакета

Из этого следует, что пакет java всегда находится в контексте (§6.3).

7.5 Объявления импорта

ImportDeclaration:
        SingleTypeImportDeclaration
        TypeImportOnDemandDeclaration   
        SingleStaticImportDeclaration   
        StaticImportOnDemandDeclaration
        

Объявление "импорт типа по требованию" (§7.5.2) импортирует все доступные (§6.6) типы именованного типа или пакета как необходимый. Это - ошибка времени компиляции, чтобы импортировать тип из неназванного пакета.

Единственное статическое объявление импорта (§7.5.3) импортирует все доступные статические элементы с именем от типа, давая его каноническое имя.

Объявление "статический импорт по требованию" (§7.5.4) импортирует все доступные статические элементы именованного типа как необходимый.

Контекст типа, импортированного объявлением единственного импорта типа (§7.5.1) или объявлением "импорт типа по требованию" (§7.5.2), является всем классом и интерфейсными описаниями типа (§7.6) в единице компиляции, в которой появляется объявление импорта.

Контекст элемента, импортированного объявлением единственного статического импорта (§7.5.3) или объявлением "статический импорт по требованию" (§7.5.4), является всем классом и интерфейсными описаниями типа (§7.6) в единице компиляции, в которой появляется объявление импорта.

import объявление делает типы доступными их простыми именами только в пределах единицы компиляции, которая фактически содержит import объявление. Контекст объектов (ов), которые это представляет определенно, не включает package оператор, другой import объявления в текущей единице компиляции, или других единицах компиляции в том же самом пакете. См. §7.5.6 для иллюстративного примера.

7.5.1 Объявление единственного импорта типа

SingleTypeImportDeclaration:
   import TypeName ;

Объявление d единственного импорта типа в единице компиляции c пакета p, который импортирует тип, названный n тенями объявления:

• любой высокоуровневый тип, названный n, объявляется в другой единице компиляции p.
• любой тип, названный n, импортированным объявлением ", вводит импорт по требованию" в c.
• любой тип, названный n, импортированным объявлением "статический импорт по требованию" в c.

Пример:

import java.util.Vector;

Обсуждение

Это выделяет ограничение import объявление. Тип, вложенный в универсальном описании типа, может быть импортирован, но его внешний тип всегда стирается.

Если два объявления единственного импорта типа в той же самой единице компиляции пытаются импортировать типы с тем же самым простым именем, то ошибка времени компиляции происходит, если два типа не являются тем же самым типом, когда двойное объявление игнорируется. Если тип, импортированный, объявление единственного импорта типа объявляется в единице компиляции, которая содержит объявление импорта, объявление импорта игнорируется. Если единица компиляции содержит и единственный статический импорт (§7.5.3) объявление, которое импортирует тип, простое имя которого является n, и объявлением единственного импорта типа (§7.5.1), который импортирует тип, простое имя которого является n, ошибка времени компиляции происходит.

Если другой высокоуровневый тип с тем же самым простым именем иначе объявляется в текущей единице компиляции кроме объявлением "импорт типа по требованию" (§7.5.2) или объявлением "статический импорт по требованию" (§7.5.4), то ошибка времени компиляции происходит.

Так пример программы:

import java.util.Vector;
class Vector { Object[] vec; }

import java.util.Vector;
import myVector.Vector;

package myVector;
public class Vector { Object[] vec; }

Отметьте, что оператор импорта не может импортировать подпакет, только тип. Например, это не работает, чтобы попытаться импортировать java.util и затем используйте имя util.Random обратиться к типу java.util.Random:

import java.util;              // incorrect: compile-time error
class Test { util.Random generator; }

7.5.2 Объявление "Импорт типа по требованию"

TypeImportOnDemandDeclaration:
        import PackageOrTypeName . * ;

Если единица компиляции содержит и объявление "статический импорт по требованию" и "импорт типа по требованию" (§7.5.2) объявление, которые называют тот же самый тип, эффект состоит в том, как будто статические типы элемента того типа были импортированы только однажды.

Это не ошибка времени компиляции, чтобы назвать текущий пакет или java.lang в объявлении "вводят импорт по требованию". Объявление "импорт типа по требованию" игнорируется в таких случаях.

Объявление "импорт типа по требованию" никогда не заставляет никакое другое объявление быть затененным.

Пример:

import java.util.*;

7.5.3 Единственное Статическое Объявление Импорта

SingleStaticImportDeclaration:
        import static TypeName . Identifier;

Объявление d единственного статического импорта в единице компиляции c пакета p, который импортирует поле, названное n тенями объявление любого статического поля, названного n, импортированным объявлением "статический импорт по требованию" в c, всюду по c.

Объявление d единственного статического импорта в единице компиляции c пакета p, который импортирует метод, названный n с тенями подписи s объявление любого статического метода, названного n с подписью s, импортированной объявлением "статический импорт по требованию" в c, всюду по c.

Объявление d единственного статического импорта в единице компиляции c пакета p, который импортирует тип, названный n тенями объявления:

• любой статический тип, названный n, импортированным объявлением "статический импорт по требованию" в c.
• любой высокоуровневый тип (§7.6) названный n, объявленным в другой единице компиляции (§7.3) p.
• любой тип, названный n, импортированным объявлением ", вводит импорт по требованию" (§7.5.2) в c.

Отметьте, что это - permissable для одного объявления единственного статического импорта, чтобы импортировать несколько полей или типов с тем же самым именем, или несколько методов с тем же самым именем и подписью.

Если единица компиляции содержит и единственный статический импорт (§7.5.3) объявление, которое импортирует тип, простое имя которого является n, и объявлением единственного импорта типа (§7.5.1), который импортирует тип, простое имя которого является n, ошибка времени компиляции происходит.

Если объявление единственного статического импорта импортирует тип, простое имя которого является n, и единица компиляции также объявляет высокоуровневый тип (§7.6), чье простое имя является n, ошибка времени компиляции происходит.

7.5.4 Объявление "статический Импорт по требованию"

StaticImportOnDemandDeclaration:
         import static TypeName . * ;

Отметьте, что это - permissable для одного объявления "статический импорт по требованию", чтобы импортировать несколько полей или типов с тем же самым именем, или несколько методов с тем же самым именем и подписью.

Если единица компиляции содержит и объявление "статический импорт по требованию" и "импорт типа по требованию" (§7.5.2) объявление, которые называют тот же самый тип, эффект состоит в том, как будто статические типы элемента того типа были импортированы только однажды.

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

7.5.5 Автоматический Импорт

import java.lang.*;

7.5.6 Странный Пример

имя Mosquito:

package Vector;
public class Mosquito { int capacity; }

package strange.example;
import java.util.Vector;
import Vector.Mosquito;
class Test {
        public static void main(String[] args) {
                System.out.println(new Vector().getClass());
                System.out.println(new Mosquito().getClass());
        }
}

class java.util.Vector
class Vector.Mosquito

7.6 Высокоуровневые Описания типа

TypeDeclaration:
        ClassDeclaration
        InterfaceDeclaration
        ;

Контекст высокоуровневого типа является всеми описаниями типа в пакете, в котором объявляется высокоуровневый тип.

Если высокоуровневый тип по имени T объявляется в единице компиляции пакета, полностью определенное имя которого является P, то полностью определенное имя типа является P.T. Если тип объявляется в неназванном пакете (§7.4.2), то у типа есть полностью определенное имя T.

Таким образом в примере:

package wnj.points;
class Point { int x, y; }

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

Например, если единица компиляции содержит объявление единственного импорта типа (§7.5.1):

import java.util.Vector;

тогда в пределах той единицы компиляции простое имя Vector и полностью определенное имя java.util.Vector обратитесь к тому же самому типу.

Когда пакеты сохранены в файловой системе (§7.2.1), хост-система может хотеть осуществлять ограничение, что это - ошибка времени компиляции, если тип не находится в файле под именем, составленным из имени типа плюс расширение (такой как .java или .jav) если любое из следующего является истиной:

• Тип упоминается кодом в других единицах компиляции пакета, в котором объявляется тип.
• Тип объявляется public (и поэтому потенциально доступно от кода в других пакетах).

Это ограничение подразумевает, что должен быть самое большее один такой тип на единицу компиляции. Это ограничение облегчает для компилятора для языка программирования Java или реализации виртуальной машины Java находить именованный класс в пределах пакета; например, исходный код для a public ввести wet.sprocket.Toad был бы найден в файле Toad.java в каталоге wet/sprocket, и соответствующий объектный код был бы найден в файле Toad.class в том же самом каталоге.

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

Ошибка времени компиляции происходит, если имя высокоуровневого типа также объявляется как тип объявлением единственного импорта типа (§7.5.1) в единице компиляции (§7.3) содержащий описание типа.

В примере:

class Point { int x, y; }

package vista;
class Point { int x, y; }

В примере:

package test;
import java.util.Vector;
class Point {

   int x, y;

}
interface Point {                                                                                       // compile-time error #1
        int getR();
        int getTheta();
}
class Vector { Point[] pts; }                                                                                   // compile-time error #2

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

Отметьте, однако, что это не ошибка для имени класса также, чтобы назвать тип, который иначе мог бы быть импортирован объявлением "импорт типа по требованию" (§7.5.2) в единице компиляции (§7.3) содержащий объявление класса. В примере:

package test;
import java.util.*;
class Vector { Point[] pts; }                                                                                   // not a compile-time error

Как другой пример, единица компиляции:

package points;
class Point {
        int x, y;               // coordinates
        PointColor color;       // color of this point
        Point next;             // next point with this color
        static int nPoints;
}
class PointColor {
        Point first;            // first point with this color
        PointColor(int color) {
                this.color = color;
        }
        private int color;      // color components
}

Это - ошибка времени компиляции, если высокоуровневое описание типа содержит кого-либо из следующих модификаторов доступа: protected, private или static.

7.7 Уникальные Имена Пакета

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

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

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

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

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

com.sun.sunsoft.DOE
com.sun.java.jag.scrabble
com.apple.quicktime.v2
edu.cmu.cs.bovik.cheese
gov.whitehouse.socks.mousefinder

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

Содержание | Предыдущий | Следующий | Индекс

Спецификация языка Java Третий Выпуск

Авторское право © 1996-2005 Sun Microsystems, Inc. Все права защищены
Пожалуйста, отправьте любые комментарии или исправления через нашу форму обратной связи