Spring Data JPA | 禁止生成外键约束

Spring Data JPA

通常看到这篇文章的同学,已经对 JPA 有了较深入的了解,因此我们跳过不必要的介绍,直接进入主题。

禁止生成外键

经过实践,可以得到两个结论:

  • 结论 1 @OneToOne@OneToMany
    使用 @JoinColumn(foreignKey = @ForeignKey(ConstraintMode.NO_CONSTRAINT)) 可以禁止生成外键。
  • 结论 2 @ManyToOne@ManyToMany
    使用 @JoinTable(foreignKey = @ForeignKey(ConstraintMode.NO_CONSTRAINT), inverseForeignKey = @ForeignKey(ConstraintMode.NO_CONSTRAINT)) 可以禁止生成外键,其中 foreignKey 禁止生成当前实体在关联表中的外键,inverseForeignKey 禁止生成集合中的元素实体在关联表中的外键。

结论 2 可能比较抽象,通常来说,有 账号角色 两张表是多对多的关系,即一个账号可以拥有多个角色,一个角色也可以被多个账号拥有。

在这种场景下,账号表中会有 角色集合字段,即 roleList,我们使用 @ManyToMany 注解来标记这个字段为多对多关系,然后通过 @JoinTable 来禁止使用外键。

这个时候,我们需要给 @JoinTable 注解加入 foreignKey = @ForeignKey(ConstraintMode.NO_CONSTRAINT) 参数,表示在 账号角色关联表 中,将禁止生成账号 ID (当前实体)的外键,同时加上 inverseForeignKey = @ForeignKey(ConstraintMode.NO_CONSTRAINT) 参数,表示在 账号角色关联表 中,将禁止生成角色 ID(集合中的元素实体) 的外键。

实践样例

为了更具体一点,我们来个实践样例。

首先我们有账号 Account、用户信息 User、角色 Role 这三个实体,AccountUser 是一对一关系 @OneToOneAccountRole 是多对多关系 @ManyToMany,这是最典型的搭配,基本覆盖大部分场景。

账号实体:


@Data
@Entity
@Table(name = "account")
public class Account {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    /**
     * 用户名,唯一不重复,不能为空。
     */
    @Column(unique = true, nullable = false)
    private String username;
    /**
     * 密码,不能为空,不可逆的加密存储。
     */
    @Column(nullable = false)
    private Password password;

    /**
     * 用户信息,注册时需要填写,用来找回密码,确认身份。
     */
    @OneToOne(cascade = CascadeType.ALL, optional = false)
    @JoinColumn(foreignKey = @ForeignKey(ConstraintMode.NO_CONSTRAINT))
    private User user;

    /**
     * 角色信息,通常是 USER 角色,也可以被添加为 ADMIN 角色。
     */
    @ManyToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER)
    @JoinTable(foreignKey = @ForeignKey(ConstraintMode.NO_CONSTRAINT), 
            inverseForeignKey = @ForeignKey(ConstraintMode.NO_CONSTRAINT))
    private List<Role> authorities;

    // 省略其他代码 ...
}

生成的账号表:

生成的账号角色关联表:

用户信息实体:


@Data
@Entity
@Table(name = "user")
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    /**
     * 真实姓名
     */
    @Column(nullable = false)
    private String realName;
    /**
     * 电话号码
     */
    private String phone;
    /**
     * 手机号码
     */
    private String mobile;
    /**
     * 电子邮箱
     */
    private String email;

    @OneToOne
    @JoinColumn(foreignKey = @ForeignKey(ConstraintMode.NO_CONSTRAINT))
    private Account account;

    // 省略其他代码...
}

生成的用户信息表:

角色实体:


@Data
@Entity
@Table(name = "role")
public class Role implements GrantedAuthority {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    @Enumerated(EnumType.STRING)
    @Column(nullable = false)
    private Authority authority = Authority.ROLE_USER;

    @Override
    public String getAuthority() {
        return authority.toString();
    }

    public enum Authority {
        ROLE_ADMIN("ROLE_ADMIN"),
        ROLE_USER("ROLE_USER"),
        ;

        private final String value;

        Authority(String value) {
            this.value = value;
        }

        @Override
        public String toString() {
            return value;
        }
    }
}

生成的角色表:

可以看到,所有的数据库表中,都没有生成外键,说明禁止成功了。

简单剖析

样例中的 Spring Data JPA 使用的是 hibernate-core:5.4.27.Final 库。

org.hibernate.cfg.AnnotationBinder.java 中,我们可以看到这样的一段代码:

通过 Find Usages,我们在 org.hibernate.mapping.ManyToOne.java 中发现这样的判断:

还有 org.hibernate.mapping.SimpleValue.java 中也有类似的判断:

我们暂不进行更深入的解析,通过上面的判断,我们知道只要外键名称是 none 就不会自动创建外键。

而使用结论 1 和结论 2 的方式,可以在绑定外键时自动设置外键名称为 none,进而禁止自动创建外键。

总结

网上的教程都是表面,有的时候,自己去看源码才能收获更多的知识和乐趣。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,657评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,662评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,143评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,732评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,837评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,036评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,126评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,868评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,315评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,641评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,773评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,859评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,584评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,676评论 2 351

推荐阅读更多精彩内容