Hibernate 自定義表名映射

weij 發(fā)布于2019-08-16 12:30 / 876人閱讀

摘要：所以設(shè)計的表名映射格式為，如果不加注解，則將實(shí)體名按照默認(rèn)的生成規(guī)則進(jìn)行生成，如果加了注解，則填寫的就作為表名映射，不進(jìn)行任何處理。云智命名策略實(shí)體與數(shù)據(jù)表名的關(guān)系配置然后將該項(xiàng)配置修改為我們自己建立的實(shí)現(xiàn)類。

問題描述 Hibernate映射介紹

Hibernate中，默認(rèn)的生成關(guān)系是將我們駝峰命名的實(shí)體進(jìn)行拼接下劃線同時轉(zhuǎn)小寫。

這種情況我們可以接受，默認(rèn)的設(shè)置很規(guī)范。

但是這樣，我們在實(shí)體之上聲明了@Table注解，并說我們的表名是Mandatory_Instrument_Apply，但是Hibernate還是將我們的數(shù)據(jù)表映射為小寫加下劃線的形式。這種情況看起來就有些不合理了。

業(yè)務(wù)需求

因?yàn)樾枰嫒堇享?xiàng)目，老項(xiàng)目的數(shù)據(jù)表命名不很很規(guī)范，所以需要用最小的成本實(shí)現(xiàn)數(shù)據(jù)庫的兼容。

所以設(shè)計的表名映射格式為，如果不加@Table注解，則將實(shí)體名按照Hibernate默認(rèn)的生成規(guī)則進(jìn)行生成，如果加了@Table注解，則填寫的name就作為表名映射，不進(jìn)行任何處理。

功能實(shí)現(xiàn) 入門

拋出來一個問題，無從下手。

打開瀏覽器，看看有沒有前人的經(jīng)驗(yàn)，Google來Google去發(fā)現(xiàn)找不著啥有價值的信息。但是在StackOverflow上找到一篇引人思索的問題。

Spring boot JPA insert in TABLE with uppercase name with Hibernate - StackOverflow

spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl

將這個配置聲明為org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl，就能實(shí)現(xiàn)大寫的轉(zhuǎn)換。

試試再說：

將配置按該問題的回答進(jìn)行修改：

測試一番：

加了@Table注解的，是我們想要的配置，直接映射。那不加注解的呢？

這個又不是我們想要的了，這個注解應(yīng)該是直接將注解中的名或?qū)嶓w名映射到數(shù)據(jù)表，不做任何修改。

發(fā)現(xiàn)新大陸

正當(dāng)一籌莫展之時，再去看一下配置，有了新的領(lǐng)悟。

org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl，這個配置的不就是一個實(shí)現(xiàn)類嗎？我是不是也可以寫一個類然后將我寫的類配置上呢？

點(diǎn)進(jìn)去，發(fā)現(xiàn)不過是一個實(shí)現(xiàn)了PhysicalNamingStrategy與Serializable兩個接口的類。

看實(shí)現(xiàn)的toPhysicalTableName方法，應(yīng)該就是生成數(shù)據(jù)表名的方法。直接將name返回，這就和我們之前猜想的一致，這個配置是直接將@Table或?qū)嶓w名映射到數(shù)據(jù)表。

YunzhiNamingStrategy

建立配置類YunzhiNamingStrategy.java，云智命名策略，分別實(shí)現(xiàn)上述PhysicalNamingStrategyStandardImpl實(shí)現(xiàn)的兩個接口。同時實(shí)現(xiàn)接口中聲明的方法。

package com.mengyunzhi.demo.config;

import org.hibernate.boot.model.naming.Identifier;
import org.hibernate.boot.model.naming.PhysicalNamingStrategy;
import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;

import java.io.Serializable;

/**
 * @author zhangxishuo on 2018/6/15
 * 云智命名策略
 * 實(shí)體與數(shù)據(jù)表名的關(guān)系配置
 */
public class YunzhiNamingStrategy implements PhysicalNamingStrategy, Serializable {
    @Override
    public Identifier toPhysicalCatalogName(Identifier identifier, JdbcEnvironment jdbcEnvironment) {
        return null;
    }

    @Override
    public Identifier toPhysicalSchemaName(Identifier identifier, JdbcEnvironment jdbcEnvironment) {
        return null;
    }

    @Override
    public Identifier toPhysicalTableName(Identifier identifier, JdbcEnvironment jdbcEnvironment) {
        return null;
    }

    @Override
    public Identifier toPhysicalSequenceName(Identifier identifier, JdbcEnvironment jdbcEnvironment) {
        return null;
    }

    @Override
    public Identifier toPhysicalColumnName(Identifier identifier, JdbcEnvironment jdbcEnvironment) {
        return null;
    }
}

然后將該項(xiàng)配置修改為我們自己建立的實(shí)現(xiàn)類。

兼容原配置項(xiàng)

因?yàn)樵摻涌谥杏卸鄠€配置項(xiàng)，如：數(shù)據(jù)庫名、字段名等，我們只想修改實(shí)體到數(shù)據(jù)表的命名策略，所以我們找到了另一個實(shí)現(xiàn)PhysicalNamingStrategy命名策略的實(shí)現(xiàn)類：SpringPhysicalNamingStrategy。

這就是我們第一次演示的策略，無論添不添加@Table注解，都會映射到小寫的加下劃線的表名。

同時這里的字段映射為小寫下劃線我們是需要保留的，為了代碼的復(fù)用，我們用到了面向?qū)ο蟮睦^承大法。

package com.mengyunzhi.demo.config;

import org.springframework.boot.orm.jpa.hibernate.SpringPhysicalNamingStrategy;

/**
 * @author zhangxishuo on 2018/6/15
 * 云智命名策略
 * 實(shí)體與數(shù)據(jù)表名的關(guān)系配置
 */
public class YunzhiNamingStrategy extends SpringPhysicalNamingStrategy {
    
}

我們對父類中的toPhysicalTableName方法不滿意，Command + N，重寫父類方法。

package com.mengyunzhi.demo.config;

import org.hibernate.boot.model.naming.Identifier;
import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;
import org.springframework.boot.orm.jpa.hibernate.SpringPhysicalNamingStrategy;

/**
 * @author zhangxishuo on 2018/6/15
 * 云智命名策略
 * 實(shí)體與數(shù)據(jù)表名的關(guān)系配置
 */
public class YunzhiNamingStrategy extends SpringPhysicalNamingStrategy {
    @Override
    public Identifier toPhysicalTableName(Identifier name, JdbcEnvironment jdbcEnvironment) {
        return super.toPhysicalTableName(name, jdbcEnvironment);
    }
}

注解判斷

我們可以開始我們的邏輯了。

有@Table注解的，就按@Table中的名稱中，否則就按Spring默認(rèn)的父類走。

但是問題出現(xiàn)了，Identifier中給我們的名稱就是已經(jīng)處理好的名稱。

Identifier

假如這么寫：

@Entity
public class MandatoryInstrumentApply {
}

那我們的Identifier中的text值就是MandatoryInstrumentApply。

@Entity
@Table(name = "Mandatory_Instrument_Apply")
public class MandatoryInstrumentApply {
}

那我們的Identifier中的text值就是Mandatory_Instrument_Apply。

Hibernate是把應(yīng)該處理好的名稱告訴我們，但是不會告訴我們這個名稱是實(shí)體的名還是在注解上獲取的。

解決方案

package com.mengyunzhi.demo.config;

import org.hibernate.boot.model.naming.Identifier;
import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;
import org.springframework.boot.orm.jpa.hibernate.SpringPhysicalNamingStrategy;

import javax.persistence.Table;

/**
 * @author zhangxishuo on 2018/6/15
 * 云智命名策略
 * 實(shí)體與數(shù)據(jù)表名的關(guān)系配置
 */
public class YunzhiNamingStrategy extends SpringPhysicalNamingStrategy {

    // 定義包名
    private static final String packageName = "com.mengyunzhi.demo.entity.";

    /**
     * 重寫父類生成表名的方法
     */
    @Override
    public Identifier toPhysicalTableName(Identifier name, JdbcEnvironment jdbcEnvironment) {
        try {
            // 獲取實(shí)體類
            Class entityClass = Class.forName(packageName + name.getText());
            // 判斷類上是否有Table注解
            Boolean hasAnnotation = entityClass.isAnnotationPresent(Table.class);
            // 存在Table注解
            if (hasAnnotation) {
                // 獲取Table注解實(shí)例
                Table table = (Table) entityClass.getAnnotation(Table.class);
                // 如果注解中的name字段不為空
                if (!table.name().equals("")) {
                    // 不對名稱進(jìn)行處理
                    return name;
                }
            }
            // 表示這是一個類名，按父類操作進(jìn)行處理
            return super.toPhysicalTableName(name, jdbcEnvironment);
        } catch (ClassNotFoundException e) {
            // 找不到實(shí)體類，說明肯定是@Table注解中的名稱
            return name;
        }
    }
}

測試