Hibernate hbm2ddl.auto: Полное руководство и лучшие практики

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

Содержание

• Возможные значения и их поведение
• Лучшие значения конфигурации для конкретных изменений схемы
• Плюсы и минусы опций экспорта
• Альтернативы hbm2ddl.auto
• Лучшие практики и рекомендации
• Заключение

Возможные значения и их поведение

Параметр hbm2ddl.auto Hibernate поддерживает несколько значений конфигурации, каждое из которых имеет отличное поведение:

validate

Проверяет, что схема базы данных соответствует вашим сопоставлениям сущностей, не внося никаких изменений. Если обнаружены расхождения, Hibernate генерирует исключение.

update

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

• Добавляет новые таблицы и столбцы
• Изменяет существующие атрибуты столбцов (например, возможность NULL, длину)
• Не удаляет существующие столбцы или таблицы
• Не изменяет существующие типы данных в большинстве случаев

create

Удаляет все существующие таблицы и создает полную схему с нуля. Это приводит к потере данных и должно использоваться с осторожностью.

create-drop

Аналогично create, но дополнительно удаляет все таблицы при закрытии SessionFactory. Это полезно для тестовых сценариев, где требуется чистая настройка базы данных для каждого теста.

none (или опущение свойства)

Автоматическое управление схемой не происходит. Hibernate ни проверяет, ни обновляет, ни создает, ни удаляет какие-либо объекты схемы.

drop (доступно с Hibernate 5.1)

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

Согласно официальной документации Hibernate, эти операторы выполняются только если схема создается, то есть hibernate.hbm2ddl.auto установлено в create, create-drop или update.

Лучшие значения конфигурации для конкретных изменений схемы

Добавление новых таблиц

• Лучший вариант: update
• Альтернатива: create или create-drop (если вас не беспокоит потеря данных)
• Поведение: update создаст новые таблицы, сохраняя существующие данные и таблицы

Добавление новых столбцов в существующие таблицы

• Лучший вариант: update
• Поведение: update специально разработан для этого сценария и добавит отсутствующие столбцы в существующие таблицы
• Примечание: При добавлении столбца NOT NULL в существующую таблицу с данными необходимо предоставить значение по умолчанию или обработать миграцию данных отдельно

Удаление столбцов

• Лучший вариант: Ни одно из значений hbm2ddl.auto не безопасно обрабатывает это
• Поведение: update не удаляет столбцы, в то время как create, create-drop или drop удалили бы столбцы, но также удалили бы все данные
• Рекомендация: Используйте ручной SQL или инструменты миграции для удаления столбцов

Изменение типов данных столбцов

• Лучший вариант: Ограниченная поддержка с update
• Поведение: update может обрабатывать некоторые изменения типов данных, но часто зависит от диалекта базы данных и конкретных изменений
• Ограничение: Сложные изменения типов данных или те, которые требуют преобразования данных, могут не сработать или быть проигнорированы
• Альтернатива: Ручное выполнение SQL или использование инструментов миграции

Изменение атрибутов столбцов

• Лучший вариант: update
• Поведение: update обычно обрабатывает такие изменения, как:
  • Изменение возможности NULL
  • Корректировка длины столбца
  • Добавление ограничений
• Примечание: Некоторые изменения атрибутов могут не поддерживаться всеми диалектами баз данных

Удаление таблиц

• Лучший вариант: create-drop (для тестирования) или ручной SQL
• Поведение: create-drop удалит все таблицы при завершении работы приложения
• Предупреждение: Используйте с крайней осторожностью в производственных средах

Изменение значений столбцов

• Лучший вариант: Не обрабатывается hbm2ddl.auto
• Поведение: Инструменты управления схемой не обрабатывают изменения значений данных
• Решение: Используйте скрипты миграции данных или логику приложения для изменения данных

Плюсы и минусы опций экспорта

Хотя “экспорт” не является прямым значением для hbm2ddl.auto, существуют связанные возможности экспорта схемы:

Инструменты экспорта схемы

Hibernate предоставляет инструменты для экспорта DDL-скриптов без их выполнения:

Плюсы:

• Позволяет просматривать сгенерированный SQL перед выполнением
• Включает версионирование схемы базы данных
• Полезно для командной работы и миграций базы данных
• Предоставляет аудит изменений схемы

Минусы:

• Требует ручного выполнения сгенерированных скриптов
• Усложняет процесс развертывания
• Не обеспечивает автоматическую синхронизацию
• Может требовать настройки скриптов для производственных сред

Пример использования:
Вы можете использовать инструмент SchemaExport Hibernate для генерации DDL-скриптов:

new SchemaExport().setFormat(true).setDelimiter(";").createOnly(outputFile, config);

Альтернативы hbm2ddl.auto

Flyway

Наиболее популярный инструмент миграции базы данных для приложений Hibernate.

Плюсы:

• Версионированные миграции базы данных
• Поддержка сложных изменений схемы
• Возможности отката
• Дружелюбность к командной работе
• Безопасность для производства

Минусы:

• Кривая обучения
• Дополнительная зависимость
• Требует управления скриптами миграции

Liquibase

Еще один надежный инструмент миграции с расширенными возможностями.

Плюсы:

• Журналы изменений на основе XML, JSON, YAML или SQL
• Поддержка предусловий и условных изменений
• Отличные возможности отката
• Независимый от базы данных синтаксис

Минусы:

• Более сложная конфигурация
• Большой объем
• Более крутая кривая обучения

Лучшие практики и рекомендации

Среда разработки

• Используйте update для быстрой итерации разработки
• Рассмотрите create-drop для интеграционных тестов
• Используйте инструменты экспорта схемы для версионирования

Тестовая среда

• Используйте create-drop для модульных тестов для обеспечения чистого состояния
• Используйте validate для интеграционных тестов для проверки согласованности схемы
• Рассмотрите использование баз данных в памяти для более быстрого выполнения тестов

Производственная среда

• Избегайте автоматических изменений схемы в производстве
• Используйте validate для обеспечения согласованности схемы
• Реализуйте правильные процессы миграции базы данных
• Рассмотрите стратегии развертывания без простоя

Стратегия миграции

1. Разработка: update для удобства
2. Тестирование: create-drop или ручное управление схемой
3. Производство: Ручные миграции с Flyway/Liquibase

Как объясняет Vlad Mihalcea, “Это эквивалентно стратегии create hibernate.hbm2ddl.auto. Как вы можете видеть, у JPA нет эквивалента для стратегий create-drop, validate и update hibernate.hbm2ddl.auto.”

Заключение

Понимание конфигурации hbm2ddl.auto Hibernate важно для эффективного управления схемой базы данных. Ключевые выводы:

1. update - наиболее универсальный вариант для разработки, который обрабатывает добавление таблиц/столбцов и изменение атрибутов
2. В производственных средах следует избегать автоматических изменений схемы и вместо этого использовать ручные инструменты миграции
3. Ни одно значение hbm2ddl.auto не безопасно обрабатывает удаление столбцов или сложные изменения типов данных
4. Flyway и Liquibase обеспечивают превосходные возможности миграции базы данных для производственных сред
5. Инструменты экспорта схемы предлагают промежуточное решение для контролируемого управления схемой

Для большинства современных приложений рекомендуется подход: использование update во время разработки, validate в тестировании и правильного инструмента миграции, такого как Flyway, для развертывания в производстве. Эта комбинация обеспечивает как удобство разработки, так и безопасность в производстве.

Источники

1. What are the possible values of the Hibernate hbm2ddl.auto configuration and what do they do - Stack Overflow
2. Hibernate hbm2ddl.auto schema generation - Vlad Mihalcea
3. Hibernate hbm2ddl auto possible values and their uses - Edureka Community
4. Hibernate Configuration Documentation - JBoss
5. hbm2ddl Configuration and Name Annotations in Hibernate - Dinesh on Java