您如何以编程方式生成 Hibernate JPA 模式？答案

【问题标题】：How do you programmatically generate a Hibernate JPA schema?您如何以编程方式生成 Hibernate JPA 模式？
【发布时间】：2017-11-27 23:48:04
【问题描述】：

我想使用 Hibernate/HBM2DDL 模式生成作为使用 Liquibase 或 Flyway 等工具管理我的应用程序的 SQL 模式的起点。为了解决这个问题，我需要在我的项目中运行一个小实用程序，我可以运行它来打印自动生成的架构。

对于旧版本或 Hibernate，这相对简单。像下面这样的东西会起作用：

EntityManagerFactory emf = null; // TODO: create your EMF the usual way.
Class<? extends Dialect> hibernateDialectType = null; // TODO: e.g. HSQLDialect.class.

Configuration hibernateConfig = new Configuration();
hibernateConfig.setProperty(Environment.DIALECT, hibernateDialectType.getName());
for (EntityType<?> entityType : emf.getMetamodel().getEntities()) {
        hibernateConfig.addAnnotatedClass(entityType.getJavaType());
}

SchemaExport schemaExporter = new SchemaExport(hibernateConfig);
schemaExporter.setFormat(true);
schemaExporter.setDelimiter(";");
schemaExporter.create(Target.SCRIPT);

但至少从 Hibernate 5.2 开始，SchemaExport 实用程序不能从 Hibernate Configuration 实例构建。

那么现在怎么能做到呢？

【问题讨论】：

标签： java hibernate jpa hbm2ddl

【解决方案1】：

在挖掘了Hibernate Ant task's source on GitHub之后，我想出了以下解决方案：

/**
 * Uses Hibernate's HBM2DDL {@link SchemaExport} utility to generate SQL
 * database schemas.
 */
public final class HibernateSchemaPrinter {
    /**
     * A small application driver that calls
     * {@link #printHibernateSchemaToStdout(String, Class)}.
     * 
     * @param args
     *            (unused)
     */
    public static void main(String[] args) {
        printHibernateSchemaToStdout("gov.hhs.cms.bluebutton.data", PostgreSQL95Dialect.class);
    }

    /**
     * Prints the Hibernate-/HDM2DDL- auto-generated SQL schema to
     * {@link System#out}.
     * 
     * @param persistenceUnitName
     *            the name of the JPA persistence unit to generate the schema
     *            for
     * @param dialectType
     *            the Hibernate {@link Dialect} type to generate the schema for,
     *            e.g. {@link PostgreSQL95Dialect}
     */
    public static void printHibernateSchemaToStdout(String persistenceUnitName, Class<? extends Dialect> dialectType) {
        Map<Object, Object> properties = new HashMap<>();
        properties.put(AvailableSettings.DIALECT, dialectType.getName());

        /*
         * Use a Hibernate EntityManagerFactoryBuilderImpl to create a JPA
         * EntityManagerFactory, then grab the (now populated) Hibernate
         * Metadata instance out of it.
         */
        EntityManagerFactoryBuilderImpl entityManagerFactoryBuilder = new CustomHibernatePersistenceProvider()
                .getEntityManagerFactoryBuilder(persistenceUnitName, properties);
        entityManagerFactoryBuilder.build();
        Metadata metadata = entityManagerFactoryBuilder.getMetadata();

        SchemaExport schemaExport = new SchemaExport();
        schemaExport.setHaltOnError(true);
        schemaExport.setFormat(true);
        schemaExport.setDelimiter(";");
        schemaExport.execute(EnumSet.of(TargetType.STDOUT), Action.CREATE, metadata);
    }

    /**
     * A small hack, needed to extract the
     * {@link EntityManagerFactoryBuilderImpl} from
     * {@link HibernatePersistenceProvider}. Taken from the Hibernate Ant task
     * here: <a href=
     * "https://github.com/hibernate/hibernate-tools/blob/321dba082f0cd11a2295063e0cbcf4f34a5b8bdd/main/src/java/org/hibernate/tool/ant/JPAConfigurationTask.java">
     * JPAConfigurationTask.java</a>.
     */
    private static final class CustomHibernatePersistenceProvider extends HibernatePersistenceProvider {
        /**
         * (See overridden method; we're just making it <code>public</code>.)
         * 
         * @param persistenceUnit
         *            (see overridden method)
         * @param properties
         *            (see overridden method)
         * @return (see overridden method)
         */
        public EntityManagerFactoryBuilderImpl getEntityManagerFactoryBuilder(String persistenceUnit,
                Map<Object, Object> properties) {
            return (EntityManagerFactoryBuilderImpl) getEntityManagerFactoryBuilderOrNull(persistenceUnit, properties);
        }
    }
}

这些天需要更多的代码，但仍然有效，足够好。

【讨论】：

弹簧容器是否需要处于活动状态才能使这段代码工作？
@JITHN 我写这篇文章已经很久了，但我没有在课堂上看到@Component 注释，所以我有理由确定答案是“不”。跨度>

【解决方案2】：

如果您想直接从 Hibernate 元数据生成 Liquibase 更改日志，则可以使用以下代码：

// Create a "connection" to the offline JPA data.
String url = "jpa:persistence:META-INF/persistence.xml";
Database jpaDatabase = CommandLineUtils.createDatabaseObject(RESOURCE_ACCESSOR, url, null, null, null, null,
        null, false, false, null, null, null, null, null, null, null);

DiffResult schemaDiff = DiffGeneratorFactory.getInstance().compare(jpaDatabase, null,
        CompareControl.STANDARD);
DiffToChangeLog diffChangeLogProducer = new DiffToChangeLog(schemaDiff, new DiffOutputControl());
diffChangeLogProducer.print(System.out);

【讨论】：

【解决方案3】：

我认为没有充分的理由不使用标准 JPA，通过

Persistence.generateSchema(String persistenceUnitName, Map properties);

这样您就不会将自己束缚于任何特定的实现，并且仍然可以通过使用 javax.persistence.schema-generation.* 属性来获取 DDL 脚本。

【讨论】：

不知道已添加到 JPA。我去看看！