Класс LocaleServiceProvider

public abstract class LocaleServiceProvider extends Object

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

Интерфейсы поставщиков услуг, чувствительных к локали, — это интерфейсы, соответствующие классам, чувствительным к локали, в пакетах java.text и java.util, чтобы предоставить данные локали для каждой службы. Интерфейсы позволяют создавать объекты, чувствительные к локали, и извлекать локализованные имена для этих пакетов. Чувствительные к локали фабричные методы и методы для получения имен в пакетах java.text и java.util используют реализации интерфейсов поставщиков, чтобы предоставить поддержку локалей, которые выходят за рамки набора локалей, поддерживаемых собственно средой выполнения Java. Поставщики услуг, чувствительные к локали, развертываются на пути модуля приложения или на пути класса приложения. Для поиска поставщики должны быть видимыми для system class loader. Дополнительные сведения о развертывании поставщика чувствительной к локали службы в качестве модуля или на пути класса см. в разделе Deploying Service Providers.

Упаковки реализаций поставщиков услуг, чувствительных к локали

Для поставщика услуг, чувствительного к локали, развернутого в модуле, в объявлении модуля необходимо указать директиву provides. Директива provides указывает как услугу, так и поставщика услуги.

Например, реализация класса DateFormatProvider, развернутая в модуле, может указать следующую директиву:

     provides java.text.spi.DateFormatProvider with com.example.ExternalDateFormatProvider;
 

Для поставщика услуг локали, развернутого на пути класса, поставщик определяет себя с помощью файла конфигурации поставщика в каталоге ресурсов META-INF/services. Имя файла должно соответствовать полному имени класса интерфейса поставщика. Файл должен содержать список полных имен классов конкретных поставщиков, по одному на строке. Строка завершается любой из символов перевода строки ('\n'), возврата каретки ('\r') или возврата каретки, сразу за которым следует перевод строки. Пробелы и символы табуляции вокруг каждого имени, а также пустые строки игнорируются. Символом комментария является '#' ('#'); все символы на каждой строке после первого символа комментария игнорируются. Файл должен быть закодирован в UTF-8.

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

Например, реализация класса DateFormatProvider должна иметь вид JAR-файла, который содержит файл:

 META-INF/services/java.text.spi.DateFormatProvider
 

А файл java.text.spi.DateFormatProvider должен содержать строку типа:

 com.foo.DateFormatProviderImpl
 

, которая является полным именем класса, реализующего DateFormatProvider.

Вызов услуг, чувствительных к локали

Чувствительные к локали фабричные методы и методы для получения имени в пакетах java.text и java.util вызывают методы поставщиков услуг по мере необходимости для поддержки запрошенной локали. Методы сначала проверяют, поддерживает ли сама среда выполнения Java запрошенную локаль, и используют её поддержку, если она доступна. В противном случае они вызывают методы isSupportedLocale установленных поставщиков для соответствующего интерфейса, чтобы найти поставщика, который поддерживает запрошенную локаль. Если такой поставщик найден, вызываются его другие методы для получения запрошенного объекта или имени. При проверке поддержки локали расширения локали по умолчанию игнорируются. (Если необходимо проверять также расширения локали, метод isSupportedLocale должен быть переопределен). Если ни сама среда выполнения Java, ни установленный поставщик не поддерживают запрошенную локаль, методы перебирают список кандидатных локалей и повторяют проверку доступности для каждой, пока не найдут соответствие. Алгоритм создания списка кандидатных локалей по умолчанию совпадает с алгоритмом, используемым ResourceBundle (подробнее см. getCandidateLocales). Даже если локаль выбрана из списка кандидатов, методы, возвращающие запрошенные объекты или имена, вызываются с исходной запрошенной локалью, включая Locale расширения. Среда выполнения Java должна поддерживать основную локаль для всех услуг, чувствительных к локали, чтобы гарантировать завершение этого процесса.

Поставщикам имен (но не поставщикам других объектов) разрешено возвращать null для некоторых запросов имени даже для локалей, которые они утверждают, что поддерживают, включая их в возвращаемое значение для getAvailableLocales. Аналогично, сама среда выполнения Java может не иметь всех имен для всех поддерживаемых ею локалей. Это связано с тем, что наборы объектов, для которых запрашиваются имена, могут быть большими и изменяться со временем, так что полностью покрыть их не всегда возможно. Если среда выполнения Java или поставщик возвращают null вместо имени, поиск будет продолжен, как описано выше, как если бы локаль не поддерживалась.

Порядок поиска служб, чувствительных к локали, можно настроить, используя системную переменную java.locale.providers. Эта системная переменная определяет предпочтительный порядок поиска служб, чувствительных к локали, разделённых запятой. Поскольку это значение переменной считывается и кэшируется только при инициализации этого класса, пользователи должны указать переменную в командной строке запуска Java. Не рекомендуется устанавливать её во время выполнения с помощью System.setProperty(String, String), и это может не повлиять на порядок. Реализация JDK Reference предоставляет следующие три поставщика данных локали:

• "CLDR": Поставщик данных локали, основанный на общем репозитории данных локали (CLDR) Консорциума Юникода .
• "SPI": представляет собой чувствительные к локали службы, реализующие подклассы этого класса LocaleServiceProvider.
• "HOST": Поставщик данных локали, отражающий пользовательские настройки в основной операционной системе. Этот поставщик может быть недоступен в зависимости от реализации JDK Reference.

Например, если в свойстве указано следующее:

 java.locale.providers=SPI,CLDR
 

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

По умолчанию для поиска предпочтительных поставщиков данных локали используется "CLDR", поэтому указание только "CLDR" идентично поведению по умолчанию. Приложения, которым требуются реализации служб, чувствительных к локали, должны явно указать "SPI", чтобы среда выполнения Java загрузила их из пути класса.