Hibernate 自举

原文: https://javabeginnerstutorial.com/hibernate/hibernate-bootstrapping/

在本文中,我将向您介绍 Hibernate 5 的新本机自举 API。

自举有什么好处?

如果您觉得需要对 Hibernate 的内部配置进行更多控制,则可以利用此新功能来实现此目标。 如果您有一个仅需要使用 Hibernate 而不需要其他 JPA 框架的简单项目,这将非常有用:借助自举 API,您可以在没有太多魔术的情况下启动和运行项目。

自然,每一朵玫瑰都有其刺:新的本机自举 API 的使用使配置更加复杂,但它比 JPA 自举 API 更强大。

为什么这比以前更好?

引入的新功能使您可以通过 Java 代码访问 API。 这意味着您不必依赖单一的 XML 配置,您可以在代码库中添加一些配置,只有当您提供新版本的软件时,该配置才能更改。

在某些情况下,这非常有用,因为您的应用不必依赖通过配置文件配置的属性的正确性,或者您可以在 Hibernate 中调整一些您不想通过外部文件更改的内部配置。 。

如何使用 API​​?

首先,您需要项目中正确的依赖项。 至于本系列文章中的所有示例,我正在使用 Hibernate 版本 5.3.6。 最终版本和 H2 版本 1.4.197。

我们需要创建一个StandardServiceRegistry,一个元数据对象,并使用它来启动SessionFactory

hibernate.cfg.xml

大多数时候,我使用基于 XML 的配置文件hibernate.cfg.xml来设置StandardServiceRegistry

  1. <hibernate-configuration>
  2. <session-factory>
  3. <!-- Database connection settings -->
  4. <property name="connection.driver_class">org.h2.Driver</property>
  5. <property name="connection.url">jdbc:h2:mem:db1;DB_CLOSE_DELAY=-1;MVCC=TRUE</property>
  6. <property name="connection.username">sa</property>
  7. <property name="connection.password"/>
  8. <!-- JDBC connection pool (use the built-in) -->
  9. <property name="connection.pool_size">1</property>
  10. <!-- SQL dialect -->
  11. <property name="dialect">org.hibernate.dialect.H2Dialect</property>
  12. <!-- Echo all executed SQL to stdout -->
  13. <property name="show_sql">true</property>
  14. <!-- Drop and re-create the database schema on startup -->
  15. <property name="hbm2ddl.auto">create</property>
  16. <mapping class="hibernate_example.Book"/>
  17. </session-factory>
  18. </hibernate-configuration>

使用此文件可以使配置独立于源代码,并以结构化的方式概述配置。

  1. final Configuration configuration = new Configuration().configure();
  2. final StandardServiceRegistryBuilder builder = new StandardServiceRegistryBuilder().configure(“hibernate.cfg.xml”);

如示例代码所示,您需要告诉 Hibernate 您正在使用hibernate.cfg.xml文件。 在以前的 Hibernate 版本中,您不需要指定使用此文件来设置服务注册表,因为这是默认行为。

程序配置

使用 Hibernate 5,您可以选择以 Java 代码编程配置 ORM。

让我们看看如何将先前显示的hibernate.cfg.xml文件映射到 Java 代码中。 为此,我创建了一个名为HibernateUtil的类,如下所示:

  1. package hibernate_example;
  2. import java.util.Properties;
  3. import org.hibernate.SessionFactory;
  4. import org.hibernate.boot.MetadataSources;
  5. import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
  6. import org.hibernate.service.ServiceRegistry;
  7. /**
  8. * Utility class for bootstrapping Hibernate through Java code only.
  9. *
  10. * @author GHajba
  11. */
  12. public class HibernateUtil {
  13. protected HibernateUtil() {
  14. }
  15. public static SessionFactory createSessionFactory() {
  16. MetadataSources metadataSources = new MetadataSources(configureServiceRegistry());
  17. addClasses(metadataSources);
  18. return metadataSources.buildMetadata()
  19. .getSessionFactoryBuilder()
  20. .build();
  21. }
  22. private static ServiceRegistry configureServiceRegistry() {
  23. return new StandardServiceRegistryBuilder()
  24. .applySettings(getProperties())
  25. .build();
  26. }
  27. private static Properties getProperties() {
  28. Properties properties = new Properties();
  29. properties.put("hibernate.connection.driver_class", "org.h2.Driver");
  30. properties.put("hibernate.connection.url", "jdbc:h2:mem:db1;DB_CLOSE_DELAY=-1;MVCC=TRUE");
  31. properties.put("hibernate.connection.username", "sa");
  32. properties.put("hibernate.connection.password", "");
  33. properties.put("hibernate.connection.pool_size", 1);
  34. properties.put("hibernate.dialect", "org.hibernate.dialect.H2Dialect");
  35. properties.put("hibernate.show_sql", "true");
  36. properties.put("hibernate.hbm2ddl.auto", "create");
  37. properties.put("", "");
  38. return properties;
  39. }
  40. private static void addClasses(MetadataSources metadataSources) {
  41. metadataSources.addAnnotatedClass(Book.class);
  42. }
  43. }

如您所见,所有内容现在都在 Java 代码中。 这使得仅处理 Java 类变得很方便-但是想想如果您有很多实体,您会得到什么? 我认为,它将像下面的屏幕截图那样混乱您的代码库:

因此,我更喜欢将配置保存在单独的文件中,而不是在 Java 代码中-但这是我个人的看法。

hibernate.properties

让代码喘气的一种方法是将配置提取到属性文件中-在大多数情况下,该文件称为hibernate.properties

使用上面的示例,我们可以将配置提取到以下文件中:

  1. hibernate.connection.driver_class=org.h2.Driver
  2. hibernate.connection.url=jdbc:h2:mem:db1;DB_CLOSE_DELAY=-1;MVCC=TRUE
  3. hibernate.connection.username=sa
  4. hibernate.connection.password=
  5. hibernate.connection.pool_size=1
  6. hibernate.dialect=org.hibernate.dialect.H2Dialect
  7. hibernate.show_sql=true
  8. hibernate.hbm2ddl.auto=create

现在,我们也必须改编HibernateUtil类以使用此新文件:

  1. package hibernate_example;
  2. import java.io.IOException;
  3. import java.util.Properties;
  4. import org.hibernate.SessionFactory;
  5. import org.hibernate.boot.MetadataSources;
  6. import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
  7. import org.hibernate.service.ServiceRegistry;
  8. /**
  9. * Utility class for bootstrapping Hibernate through Java code and hibernate.properties file.
  10. *
  11. * @author GHajba
  12. */
  13. public class HibernateUtil {
  14. protected HibernateUtil() {
  15. }
  16. public static SessionFactory createSessionFactory() {
  17. MetadataSources metadataSources = new MetadataSources(configureServiceRegistry());
  18. addClasses(metadataSources);
  19. return metadataSources.buildMetadata()
  20. .getSessionFactoryBuilder()
  21. .build();
  22. }
  23. private static ServiceRegistry configureServiceRegistry() {
  24. return new StandardServiceRegistryBuilder()
  25. .applySettings(getProperties())
  26. .build();
  27. }
  28. private static Properties getProperties() {
  29. Properties properties = new Properties();
  30. try {
  31. properties.load(HibernateUtil.class
  32. .getResourceAsStream("/hibernate.properties"));
  33. } catch (IOException e) {
  34. throw new RuntimeException(e);
  35. }
  36. return properties;
  37. }
  38. private static void addClasses(MetadataSources metadataSources) {
  39. metadataSources.addAnnotatedClass(Book.class);
  40. }
  41. }

总结

使用自举 API,您可以配置 Hibernate 应用-这使您的项目更加复杂,但是您可以将这些功能隐藏在服务类中。 如果只想在简单项目中使用 Hibernate,这将很方便。

如果您仔细阅读本系列文章随附的示例应用,您会发现我自己使用此 API 来使应用与 Hibernate 一起运行。