配置
适用于 ✅ 开源版 ✅ 专业版 ✅ 企业版
可嵌入类型可以在代码生成器配置中如下指定
XML（独立和 Maven）
编程方式
Gradle (Kotlin)
Gradle (Groovy)
Gradle（第三方）
<configuration>
<generator>
<database>
<!-- For each type, one embeddable entry is required -->
<embeddables>
<embeddable>
<!-- The optional catalog of the embeddable type (the catalog of the first matched table if left empty) -->
<catalog/>
<!-- The optional schema of the embeddable type (the schema of the first matched table if left empty) -->
<schema>PUBLIC</schema>
<!-- The name of the embeddable type -->
<name>AUDIT</name>
<!-- An optional, defining comment of an embeddable -->
<comment>An audit record containing common audit fields.</comment>
<!-- The name of the reference to the embeddable type. Defaults to <name/> if left blank -->
<referencingName>AUDIT_REFERENCE</referencingName>
<!-- An optional, referencing comment of an embeddable. Defaults to <comment/> if left blank -->
<referencingComment>An audit record containing common audit fields.</referencingComment>
<!-- A regular expression matching qualified or unqualified table names to which to apply this embeddable specification
If left blank, this will apply to all tables -->
<tables>.*</tables>
<!-- A list of fields to match to an embeddable's attributes. Each field must match exactly one column in each matched table.
A mandatory regular expression matches field names, whereas an optional name can be provided to define the embeddable
attribute name. If no name is provided, then the first matched field's name will be taken -->
<fields>
<field><expression>CREATED_AT</expression></field>
<field><expression>CREATED_BY</expression></field>
<field><name>MODIFIED_AT</name><expression>MODIFIED_AT|CHANGED_AT</expression></field>
<field><name>MODIFIED_BY</name><expression>MODIFIED_BY|CHANGED_BY</expression></field>
</fields>
</embeddable>
<!-- A more minimal configuration might look like this -->
<embeddable>
<name>MONETARY_AMOUNT</name>
<fields>
<field><expression>AMOUNT</expression></field>
<field><expression>CURRENCY</expression></field>
</fields>
</embeddable>
</embeddables>
</database>
</generator>
</configuration>
有关更多详细信息，请参阅配置 XSD、独立代码生成和maven 代码生成。
new org.jooq.meta.jaxb.Configuration()
.withGenerator(new Generator()
.withDatabase(new Database()
// For each type, one embeddable entry is required
.withEmbeddables(
new EmbeddableDefinitionType()
// The optional catalog of the embeddable type (the catalog of the first matched table if left empty)
.withCatalog("")
// The optional schema of the embeddable type (the schema of the first matched table if left empty)
.withSchema("PUBLIC")
// The name of the embeddable type
.withName("AUDIT")
// An optional, defining comment of an embeddable
.withComment("An audit record containing common audit fields.")
// The name of the reference to the embeddable type. Defaults to <name/> if left blank
.withReferencingName("AUDIT_REFERENCE")
// An optional, referencing comment of an embeddable. Defaults to <comment/> if left blank
.withReferencingComment("An audit record containing common audit fields.")
// A regular expression matching qualified or unqualified table names to which to apply this embeddable specification
// If left blank, this will apply to all tables
.withTables(".*")
// A list of fields to match to an embeddable's attributes. Each field must match exactly one column in each matched table.
// A mandatory regular expression matches field names, whereas an optional name can be provided to define the embeddable
// attribute name. If no name is provided, then the first matched field's name will be taken
.withFields(
new EmbeddableField()
.withExpression("CREATED_AT"),
new EmbeddableField()
.withExpression("CREATED_BY"),
new EmbeddableField()
.withName("MODIFIED_AT")
.withExpression("MODIFIED_AT|CHANGED_AT"),
new EmbeddableField()
.withName("MODIFIED_BY")
.withExpression("MODIFIED_BY|CHANGED_BY")
),
// A more minimal configuration might look like this
new EmbeddableDefinitionType()
.withName("MONETARY_AMOUNT")
.withFields(
new EmbeddableField()
.withExpression("AMOUNT"),
new EmbeddableField()
.withExpression("CURRENCY")
)
)
)
)
import org.jooq.meta.jaxb.*
configuration {
generator {
database {
// For each type, one embeddable entry is required
embeddables {
embeddable {
// The optional catalog of the embeddable type (the catalog of the first matched table if left empty)
catalog = ""
// The optional schema of the embeddable type (the schema of the first matched table if left empty)
schema = "PUBLIC"
// The name of the embeddable type
name = "AUDIT"
// An optional, defining comment of an embeddable
comment = "An audit record containing common audit fields."
// The name of the reference to the embeddable type. Defaults to <name/> if left blank
referencingName = "AUDIT_REFERENCE"
// An optional, referencing comment of an embeddable. Defaults to <comment/> if left blank
referencingComment = "An audit record containing common audit fields."
// A regular expression matching qualified or unqualified table names to which to apply this embeddable specification
// If left blank, this will apply to all tables
tables = ".*"
// A list of fields to match to an embeddable's attributes. Each field must match exactly one column in each matched table.
// A mandatory regular expression matches field names, whereas an optional name can be provided to define the embeddable
// attribute name. If no name is provided, then the first matched field's name will be taken
fields {
field {
expression = "CREATED_AT"
}
field {
expression = "CREATED_BY"
}
field {
name = "MODIFIED_AT"
expression = "MODIFIED_AT|CHANGED_AT"
}
field {
name = "MODIFIED_BY"
expression = "MODIFIED_BY|CHANGED_BY"
}
}
}
// A more minimal configuration might look like this
embeddable {
name = "MONETARY_AMOUNT"
fields {
field {
expression = "AMOUNT"
}
field {
expression = "CURRENCY"
}
}
}
}
}
}
}
有关更多详细信息，请参阅配置 XSD和gradle 代码生成。
configuration {
generator {
database {
// For each type, one embeddable entry is required
embeddables {
embeddable {
// The optional catalog of the embeddable type (the catalog of the first matched table if left empty)
catalog {}
// The optional schema of the embeddable type (the schema of the first matched table if left empty)
schema = "PUBLIC"
// The name of the embeddable type
name = "AUDIT"
// An optional, defining comment of an embeddable
comment = "An audit record containing common audit fields."
// The name of the reference to the embeddable type. Defaults to <name/> if left blank
referencingName = "AUDIT_REFERENCE"
// An optional, referencing comment of an embeddable. Defaults to <comment/> if left blank
referencingComment = "An audit record containing common audit fields."
// A regular expression matching qualified or unqualified table names to which to apply this embeddable specification
// If left blank, this will apply to all tables
tables = ".*"
// A list of fields to match to an embeddable's attributes. Each field must match exactly one column in each matched table.
// A mandatory regular expression matches field names, whereas an optional name can be provided to define the embeddable
// attribute name. If no name is provided, then the first matched field's name will be taken
fields {
field {
expression = "CREATED_AT"
}
field {
expression = "CREATED_BY"
}
field {
name = "MODIFIED_AT"
expression = "MODIFIED_AT|CHANGED_AT"
}
field {
name = "MODIFIED_BY"
expression = "MODIFIED_BY|CHANGED_BY"
}
}
}
// A more minimal configuration might look like this
embeddable {
name = "MONETARY_AMOUNT"
fields {
field {
expression = "AMOUNT"
}
field {
expression = "CURRENCY"
}
}
}
}
}
}
}
有关更多详细信息，请参阅配置 XSD和gradle 代码生成。
// The jOOQ-codegen-gradle plugin has been introduced in version 3.19. // Please use the official plugin instead of the third party plugin that was recommended before.
一如既往，当使用正则表达式时，它们是具有默认标志的正则表达式。
如果之前的配置与相关的表正确匹配，则会生成以下 org.jooq.EmbeddableRecord 实现（已缩写）
public class AuditRecord extends EmbeddableRecordImpl<AuditRecord> {
public AuditRecord(Timestamp createdAt, Timestamp modifiedAt, String createdBy, String modifiedBy) { /* ... */ }
// Getters, setters
}
public class MonetaryAmountRecord extends EmbeddableRecordImpl<MonetaryAmountRecord> {
public MonetaryAmountRecord(BigDecimal amount, String currency) { /* ... */ }
// Getters, setters
}
假设我们有一个像这样的 TRANSACTIONS 表
CREATE TABLE transactions ( id BIGINT NOT NULL PRIMARY KEY, created_at TIMESTAMP NOT NULL, modified_at TIMESTAMP, created_by VARCHAR(100) NOT NULL, modified_by VARCHAR(100) NOT NULL, -- Other columns here amount DECIMAL(18, 2) NOT NULL, currency VARCHAR(10) NOT NULL );
使用之前的可嵌入类型定义，我们将得到一个如下所示的表
public class Transactions extends TableImpl<TransactionsRecord> {
// Field initialisations omitted for simplicity
// The AUDIT embeddable and its physical fields that it represents
public TableField<TransactionsRecord, Integer> ID;
public TableField<TransactionsRecord, Timestamp> CREATED_AT;
public TableField<TransactionsRecord, Timestamp> MODIFIED_AT;
public TableField<TransactionsRecord, String> CREATED_BY;
public TableField<TransactionsRecord, String> MODIFIED_BY;
public TableField<TransactionsRecord, AuditRecord> AUDIT_REFERENCE;
// The MONETARY_AMOUNT embeddable and its physical fields that it represents
public TableField<TransactionsRecord, BigDecimal> AMOUNT;
public TableField<DRecord, String> CURRENCY;
public TableField<DRecord, MonetaryAmountRecord> MONETARY_AMOUNT;
请注意，可嵌入类型只是一个辅助列，默认情况下，它不会替换其底层列。为了替换底层列，请使用<replaceFields/> 标志
您现在可以像往常一样使用底层列，或者改用可嵌入类型
create.insertInto(TRANSACTIONS)
.columns(TRANSACTIONS.ID, TRANSACTIONS.AUDIT_REFERENCE, TRANSACTIONS.MONETARY_AMOUNT)
.values(
1,
new AuditRecord(Timestamp.valueOf("2000-01-01 00:00:00"), null, "user", null),
new MonetaryAmountRecord(new BigDecimal("20.00"), "EUR"))
.execute();
这些列可以在所有类型的语句中使用，包括例如 SELECT、INSERT、UPDATE、DELETE
反馈
您对此页面有任何反馈吗？ 我们很乐意听到！