Класс FileHandler

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

При использовании набора файлов, когда размер каждого файла достигает заданного предела, он закрывается, заменяется следующим в последовательности, и открывается новый файл. Имена более старых файлов формируются добавлением к базовому имени файла «0», «1», «2» и т. д.

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

По умолчанию для форматирования используется класс XMLFormatter.

Конфигурация: По умолчанию каждый FileHandler инициализируется с использованием следующих свойств конфигурации LogManager, где <handler-name> обозначает полное имя класса обработчика. Если свойства не заданы (или имеют недопустимые значения), используются указанные значения по умолчанию.

• <handler-name>.level задает уровень по умолчанию для Handler (по умолчанию — Level.ALL).
• <handler-name>.filter задает имя класса Filter, который следует использовать (по умолчанию Filter отсутствует).
• <handler-name>.formatter задает имя класса Formatter, который следует использовать (по умолчанию — java.util.logging.XMLFormatter)
• <handler-name>.encoding задает имя кодировки набора символов, которую следует использовать (по умолчанию используется кодировка платформы).
• <handler-name>.limit задает приблизительный максимальный объем данных в байтах, записываемых в один файл. Если значение равно нулю, ограничение отсутствует. (По умолчанию ограничение отсутствует).
• <handler-name>.count задает количество выходных файлов в цикле (по умолчанию — 1).
• <handler-name>.pattern задает шаблон для формирования имени выходного файла. Подробнее см. ниже. (По умолчанию — "%h/java%u.log").
• <handler-name>.append задает, следует ли FileHandler добавлять данные в существующие файлы (по умолчанию — false).
• <handler-name>.maxLocks задает максимальное количество блокировок, которые FileHandler может удерживать одновременно (по умолчанию — 100).

Например, свойства для FileHandler будут следующими:

• java.util.logging.FileHandler.level=INFO
• java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

Для пользовательского обработчика, например com.foo.MyHandler, свойства будут следующими:

• com.foo.MyHandler.level=INFO
• com.foo.MyHandler.formatter=java.util.logging.SimpleFormatter

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

• "/" — разделитель локальных путей
• "%t" — временный каталог системы
• "%h" — значение системного свойства "user.home"
• "%g" — номер поколения для различения чередующихся журналов
• "%u" — уникальный номер для устранения конфликтов
• "%%" — преобразуется в один знак процента "%"

Например, шаблон "%t/java%g.log" с количеством файлов 2 обычно приводит к тому, что файлы журналов в Solaris будут записываться в /var/tmp/java0.log и /var/tmp/java1.log, а в Windows 95 — в C:\TEMP\java0.log и C:\TEMP\java1.log

Номера поколений следуют в последовательности 0, 1, 2 и т. д.

Обычно уникальному полю "%u" присваивается значение 0. Однако если FileHandler пытается открыть файл и обнаруживает, что он уже используется другим процессом, он увеличивает значение уникального поля и повторяет попытку. Это будет повторяться, пока FileHandler не найдет имя файла, которое в данный момент не используется. Если возник конфликт, а поле "%u" не было указано, оно будет добавлено в конец имени файла после точки. (После номера поколения, добавленного автоматически, если он есть.)

Например, если три процесса пытаются записывать данные в fred%u.%g.txt, они могут использовать fred0.0.txt, fred1.0.txt и fred2.0.txt в качестве первых файлов в своих последовательностях чередования.

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