Hibernate 5の命名戦略の設定

Hibernate 5命名戦略の構成

1. 概要

Hibernate 5は、Hibernateエンティティで使用する2つの異なる命名戦略を提供します。暗黙的な命名戦略と物理的な命名戦略です。

このチュートリアルでは、エンティティをカスタマイズされたテーブル名と列名にマップするようにこれらの命名戦略を構成する方法を説明します。

Hibernateを初めて使用する読者は、introduction article hereを確認してください。

2. 依存関係

このチュートリアルでは、basic Hibernate Core dependencyを使用します。


    org.hibernate
    hibernate-core
    5.3.6.Final

3. 暗黙の命名戦略

Hibernateは「論理名」を使用して、エンティティ名または属性名をテーブル名または列名にマッピングします。この名前can be customized in two ways：ImplicitNamingStrategyを使用して自動的に導出することも、アノテーション.を使用して明示的に定義することもできます

ImplicitNamingStrategyは、HibernateがJavaクラスとプロパティ名から論理名を導出する方法を管理します。 We can select from four built-in strategies, or we can create our own.

この例では、デフォルトの戦略であるImplicitNamingStrategyJpaCompliantImpl.を使用します。この戦略を使用すると、論理名はJavaクラスおよびプロパティ名と同じになります。

If we want to deviate from this strategy for a specific entity, we can use annotations to make those customizations。 @Tableアノテーションを使用して、@Entityの名前をカスタマイズできます。プロパティには、@Columnアノテーションを使用できます。

@Entity
@Table(name = "Customers")
public class Customer {

    @Id
    @GeneratedValue
    private Long id;

    private String firstName;

    private String lastName;

    @Column(name = "email")
    private String emailAddress;

    // getters and setters

}

この構成を使用すると、Customerエンティティとそのプロパティの論理名は次のようになります。

Customer -> Customers
firstName -> firstName
lastName -> lastName
emailAddress -> email

4. 物理的な命名戦略

論理名を構成したので、物理名を見てみましょう。

Hibernateは物理命名戦略を使用して、論理名をSQLテーブルとその列にマッピングします。

前のセクションで指定したBy default, the physical name will be the same as the logical name.物理名をカスタマイズする場合は、カスタムのPhysicalNamingStrategyクラスを作成できます。

たとえば、Javaコードではキャメルケース名を使用したいが、データベース内の実際のテーブル名および列名にはアンダースコアで区切られた名前を使用したい場合があります。

これで、注釈とカスタムImplicitNamingStrategyの組み合わせを使用してこれらの名前を正しくマップできますが、Hibernate 5はこのプロセスを単純化する方法としてPhysicalNamingStrategyを提供します。前のセクションの論理名を使用して、すべてを1か所でカスタマイズできます。

これがどのように行われるかを見てみましょう。

まず、キャメルケース名をより標準的なSQL形式を使用するように変換する戦略を作成します。

public class CustomPhysicalNamingStrategy implements PhysicalNamingStrategy {

    @Override
    public Identifier toPhysicalCatalogName(final Identifier identifier, final JdbcEnvironment jdbcEnv) {
        return convertToSnakeCase(identifier);
    }

    @Override
    public Identifier toPhysicalColumnName(final Identifier identifier, final JdbcEnvironment jdbcEnv) {
        return convertToSnakeCase(identifier);
    }

    @Override
    public Identifier toPhysicalSchemaName(final Identifier identifier, final JdbcEnvironment jdbcEnv) {
        return convertToSnakeCase(identifier);
    }

    @Override
    public Identifier toPhysicalSequenceName(final Identifier identifier, final JdbcEnvironment jdbcEnv) {
        return convertToSnakeCase(identifier);
    }

    @Override
    public Identifier toPhysicalTableName(final Identifier identifier, final JdbcEnvironment jdbcEnv) {
        return convertToSnakeCase(identifier);
    }

    private Identifier convertToSnakeCase(final Identifier identifier) {
        final String regex = "([a-z])([A-Z])";
        final String replacement = "$1_$2";
        final String newName = identifier.getText()
          .replaceAll(regex, replacement)
          .toLowerCase();
        return Identifier.toIdentifier(newName);
    }
}

最後に、新しい戦略を使用するようHibernateに指示できます。

hibernate.physical_naming_strategy=com.example.hibernate.namingstrategy.CustomPhysicalNamingStrategy

Customerエンティティに対する新しい戦略を使用すると、物理名は次のようになります。

Customer -> customers
firstName -> first_name
lastName -> last_name
emailAddress -> email

5. 結論

この簡単な記事では、暗黙的命名戦略と物理的命名戦略の関係を学びました。

また、エンティティとそのプロパティの暗黙的および物理的な名前をカスタマイズする方法も見てきました。

このチュートリアルover on Githubのソースコードを表示できます。

TOC