逆向工程

逆向工程列

一些开发者更喜欢 DB-first 应用程序开发方法。 首先， 他们直接向数据库添加列，然后更新 JPA 模型。 IntelliJ IDEA 可以自动化此过程。

智能引用检测

IntelliJ IDEA 深刻理解您的模型。 在某些情况下，可以正确检测基数： @OneToOne、 @OneToMany、 @ManyToOne、 @ManyToMany。 最酷的是，IntelliJ IDEA 即使在当前表格中没有相应列的情况下也能显示引用。

让我们更仔细地看看这些情况。

@OneToOne

在两种情况下，我们可以自信地假设关系的基数为 @OneToOne：

1. 表中有一列带有唯一约束，引用了另一个表的主键

2. 表的主键是外键

情况 1：

CREATE TABLE profiles ( id BIGINT GENERATED BY DEFAULT AS IDENTITY NOT NULL, join_date date, user_id BIGINT, status VARCHAR(255), bio VARCHAR(255), CONSTRAINT pk_profiles PRIMARY KEY (id) ); CREATE TABLE users ( id BIGINT GENERATED BY DEFAULT AS IDENTITY NOT NULL, last_name VARCHAR(255), first_name VARCHAR(255), CONSTRAINT pk_users PRIMARY KEY (id) ); ALTER TABLE profiles ADD CONSTRAINT uc_profiles_user UNIQUE (user_id); ALTER TABLE profiles ADD CONSTRAINT FK_PROFILES_ON_USER FOREIGN KEY (user_id) REFERENCES users (id);

IntelliJ IDEA将在 User 实体中生成一个 @OneToOne 关联，具有一个 @JoinColumn 注解，并在 Profile 实体中生成一个 @OneToOne 关联，具有一个 mappedBy 参数：

@Entity @Table(name = "users") public class User { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) @Column(name = "id", nullable = false) private Long id; @OneToOne(fetch = FetchType.LAZY) @JoinColumn(name = "profile_id") private Profile profile; } @Entity @Table(name = "profiles") public class Profile { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) @Column(name = "id", nullable = false) private Long id; @OneToOne(fetch = FetchType.LAZY, mappedBy = "profile") private User users; }

案例编号 2：

CREATE TABLE users ( id BIGINT GENERATED BY DEFAULT AS IDENTITY NOT NULL, last_name VARCHAR(255), first_name VARCHAR(255), CONSTRAINT pk_users PRIMARY KEY (id) ); CREATE TABLE profiles ( user_id BIGINT NOT NULL, status VARCHAR(255), bio VARCHAR(255), join_date date, CONSTRAINT pk_profiles PRIMARY KEY (user_id) ); ALTER TABLE profiles ADD CONSTRAINT FK_PROFILES_ON_USER FOREIGN KEY (user_id) REFERENCES users (id);

由于 @Id 不应是持久化实体，IntelliJ IDEA 将生成：

• 基本类型的 id 属性并使用 @Id 注解对其进行标记

• users@OneToOne 关联并使用 @MapsId 注解标记

@Entity @Table(name = "profiles") public class Profile { @Id @Column(name = "user_id", nullable = false) private Long id; @MapsId @OneToOne(fetch = FetchType.LAZY, optional = false) @JoinColumn(name = "user_id", nullable = false) private User users; //... } @Entity @Table(name = "users") public class User { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) @Column(name = "id", nullable = false) private Long id; @OneToOne(fetch = FetchType.LAZY, mappedBy = "user") private Profile profiles; //... }

@OneToMany & @ManyToOne

如果一个表具有指向另一个表的主键的列，则很可能是一个 @ManyToOne 关联。 但是您也可以根据需要将基数更改为 @OneToOne。 因此，取决于您在哪个表上调用反向工程操作，IntelliJ IDEA 将检测映射类型为 @OneToMany 或 @ManyToOne：

CREATE TABLE users ( id BIGINT GENERATED BY DEFAULT AS IDENTITY NOT NULL, last_name VARCHAR(255), first_name VARCHAR(255), CONSTRAINT pk_users PRIMARY KEY (id) ); CREATE TABLE profiles ( id BIGINT GENERATED BY DEFAULT AS IDENTITY NOT NULL, join_date date, status VARCHAR(255), bio VARCHAR(255), user_id BIGINT, CONSTRAINT pk_profiles PRIMARY KEY (id) ); ALTER TABLE profiles ADD CONSTRAINT FK_PROFILES_ON_USER FOREIGN KEY (user_id) REFERENCES users (id);

IntelliJ IDEA 将生成以下代码：

@Entity @Table(name = "users") public class User { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) @Column(name = "id", nullable = false) private Long id; @OneToMany(mappedBy = "user") private Set<Profile> profiles = new LinkedHashSet<>(); //... } @Entity @Table(name = "profiles") public class Profile { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) @Column(name = "id", nullable = false) private Long id; @ManyToOne(fetch = FetchType.LAZY) @JoinColumn(name = "user_id") private User user; //... }

@ManyToMany

要在两张表之间建立多对多关系，您需要使用连接表。 在这种情况下，连接表只包含两列——外键。 IntelliJ IDEA 能够自动检测这样的表，并识别两个表之间的关系基数，这两个表的 ids 在连接表中表示为外键，如 @ManyToMany。

CREATE TABLE users ( id BIGINT GENERATED BY DEFAULT AS IDENTITY NOT NULL, last_name VARCHAR(255), first_name VARCHAR(255), CONSTRAINT pk_users PRIMARY KEY (id) ); CREATE TABLE profiles ( id BIGINT GENERATED BY DEFAULT AS IDENTITY NOT NULL, join_date date, status VARCHAR(255), bio VARCHAR(255), CONSTRAINT pk_profiles PRIMARY KEY (id) ); CREATE TABLE profiles_users ( profile_id BIGINT NOT NULL, users_id BIGINT NOT NULL, CONSTRAINT pk_profiles_users PRIMARY KEY (profile_id, users_id) ); ALTER TABLE profiles_users ADD CONSTRAINT fk_prouse_on_profile FOREIGN KEY (profile_id) REFERENCES profiles (id); ALTER TABLE profiles_users ADD CONSTRAINT fk_prouse_on_user FOREIGN KEY (users_id) REFERENCES users (id);

如果任何实体中不存在此关联，IntelliJ IDEA 将在调用反向工程操作的实体中生成该关联。

@Entity @Table(name = "users") public class User { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) @Column(name = "id", nullable = false) private Long id; @ManyToMany @JoinTable(name = "profiles_users", joinColumns = @JoinColumn(name = "users_id"), inverseJoinColumns = @JoinColumn(name = "profile_id")) private Set<Profile> profiles = new LinkedHashSet<>(); //... }

如果此关联已经存在于其中一个实体中，那么 IntelliJ IDEA 将生成带有 @ManyToMany 属性和 mappedBy 参数的属性。

@Entity @Table(name = "profiles") public class Profile { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) @Column(name = "id", nullable = false) private Long id; @ManyToMany(mappedBy = "profiles") private Set<User> users = new LinkedHashSet<>(); //... }

视频教程

以下视频演示了在映射需要一些额外配置时如何对数据库架构进行逆向工程。

对 JPA 实体进行逆向工程并使其继承自父类

IntelliJ IDEA 提供通过从 @MappedSuperclass 注释的类中选择一个类以定义父实体的功能，这可以在 父项 下拉框中完成。 这允许生成的实体扩展自父类，并自动继承所有具有相同名称和类型的属性。

在 @MappedSuperclass 中的列名与子实体的表不匹配的情况下，我们仍然可以使用 @AttributeOverride 注解继承该属性。 只需选择特性名称并选择要重写的项，IntelliJ IDEA 即可帮助管理继承。

在生成实体期间，IntelliJ IDEA 如果检测到数据库中缺少来自 @MappedSuperclass 的任何继承属性，会发出警报。 要使模型与数据库对齐，请访问 JPA Structure 菜单中的 通过实体生成 DDL 操作并选择 现有数据库更新 选项。

将数据库特定的列类型映射到实体特性

对于某些 SQL 类型，没有与 Java 类完全匹配的对应关系。 在这种情况下，IntelliJ IDEA 不会设置类型，以防生成无法工作的编码。 您需要自己选择属性类型。 也可以在 参考：JPA 逆向工程设置 中为每个 DBMS 配置默认类型映射。

如果项目依赖项列表中包含 HibernateTypes 库 ，IntelliJ IDEA 可以在逆向工程期间自动从该库为不支持的 SQL 类型建议合适的类型：

将数据库视图映射到实体

IntelliJ IDEA 遵循所有最佳做法，在逆向工程时为 DB 视图提供最高效的映射：

1. 由于数据库视图没有主键，IntelliJ IDEA 允许您选择一个字段或一组字段作为目标实体的标识符。

2. 大多数 DB 视图是不可变的。 因此，IntelliJ IDEA 会向实体添加 @Immutable 注解，并且仅生成 getter。 这有助于提高应用程序性能。

3. IntelliJ IDEA 仅为映射到数据库视图的实体生成无参 protected 构造函数，符合 JPA 规范，这可防止开发者在业务逻辑编码中创建此类实体的新实例。

参考：从数据库创建实体对话框

来自数据库的 JPA 实体 对话框可让你将数据库表和视图映射到 JPA 或 Spring Data JPA 实体。

来自数据库的 JDBC 实体 对话框可让你将数据库表映射到 Spring Data JDBC 实体。

实体映射选项

对话框左下方列出所选数据库中的表和视图，并按类型和当前映射状态分组：

• 映射的关系 ：已映射到实体的表和视图。 未完全映射的项带有 未映射的列标签。

• 表 ：未映射到任何实体的表。

• 视图 ：未映射到任何实体的视图。

选择表、视图或关系时，对话框右下方会列出其可映射元素，并同样按状态分组：

• 映射的列 ：已映射到实体特性的列。

• 列 ：未映射到任何实体特性的列。

• 引用: 其他表中指向此表且未映射到此表实体中任何特性的外部密钥。

对于每个可映射项，对话框会显示以下选项：

条目	描述
类名	指定生成的实体类的名称。 IntelliJ IDEA 会根据表名称和 JPA 逆向工程设置自动填充此值。
父项	选择一个 映射超类 ，作为生成的实体类的父类。
ID 生成	选择主密钥的 ID 生成策略: 无 ：无自动化策略；应用程序必须在实体持久化之前分配 ID。 序列 ：ID 由所选数据库序列生成，并在实体持久化时由持久化提供程序分配（在 INSERT 语句之前）。 标识 ：实体持久化时，ID 由数据库使用自动递增列、serial 列或 identity 列生成并分配（在 INSERT 语句期间）。 UUID ：ID 在实体持久化时由持久化提供程序生成并分配（在 INSERT 语句之前）。 从 官方 Hibernate 文档详细了解 ID 生成策略。
ID 列	选择哪些列应被视为主键列。
列/引用名	所选表或视图中的列名称以及其他表中对其的引用，均为只读。 使用复选框选择要进行逆向工程的列和引用。
特性	为生成的实体字段指定名称。 IntelliJ IDEA 会根据列名称以及适用时的 JPA 逆向工程设置自动填充这些值。 如果指定了父类，可以针对每个匹配的列决定是从父类继承其特性，还是生成新的特性。 如果继承的特性不是完全匹配，实体将使用 @AttributeOverride 注解。
映射类型	选择如何将列或引用映射到实体特性。 有关所有可用值的描述，请参阅 可用的映射类型。
特性/转换器/Hibernate 类型	选择用于生成的实体字段的特性类型、JPA 特性转换器或 Hibernate 自定义类型。

对话框左下方列出所选数据库中的表，并按类型和当前映射状态分组：

• 映射的关系 ：已映射到实体的表。 未完全映射的项带有 未映射的列标签。

• 表 ：未映射到任何实体的表。

选择表或关系时，对话框右下方会列出其可映射元素，并同样按状态分组：

• 映射的列 ：已映射到实体特性的列。

• 列 ：未映射到任何实体特性的列。

• 引用: 其他表中指向此表且未映射到此表实体中任何特性的外部密钥。

对于每个可映射项，对话框会显示以下选项：

条目	描述
类名	指定生成的实体类的名称。 IntelliJ IDEA 会根据表名称和 JPA 逆向工程设置自动填充此值。
ID 生成	选择主密钥的 ID 生成策略: 无 ：无自动化策略；保存实体时，ID 由数据库使用自动递增列、serial 列或 identity 列生成并分配（在 INSERT 语句期间）。 序列 ：ID 由所选数据库序列生成，并在保存实体时由 Spring Data JDBC 分配（在 INSERT 语句之前）。
ID 列	选择哪些列应被视为主键列。
列/引用名	所选表中的列名称以及其他表中对其的引用，均为只读。 使用复选框选择要进行逆向工程的列和引用。
特性	为生成的实体字段指定名称。 IntelliJ IDEA 会根据列名称以及适用时的 JPA 逆向工程设置自动填充这些值。
映射类型	选择如何将列或引用映射到实体特性。 有关所有可用值的描述，请参阅 可用的映射类型。
特性类型	选择用于生成的实体字段的特性类型。

参考：JPA 逆向工程设置

JPA 逆向工程 设置允许配置 IntelliJ IDEA 在逆向工程期间如何将数据库表和列映射为实体及实体字段。