jOOQ代码生成器对计算列空值约束处理的优化

计算列空值约束的现状

在数据库表设计中，计算列(GENERATED ALWAYS AS)和系统版本控制列(SYSTEM_VERSIONING)是两种常见的自动生成值的列类型。这些列虽然在DDL中被定义为NOT NULL，但实际上它们的值是由数据库系统自动计算或维护的，应用程序在插入数据时不应该也不需要为这些列提供值。

然而，在jOOQ 3.19.18及更早版本中，代码生成器在处理这类列时存在一个设计缺陷：它会为这些列生成非空约束的Kotlin属性，导致开发者必须为这些实际上应该自动生成的列提供值，这与数据库的实际行为不符。

问题具体表现

以一个系统版本控制表为例：

CREATE TABLE [reference].[InstrumentReferenceData]
(
    [InstrumentReferenceDataId] INT IDENTITY(1, 1) NOT NULL,
    [ReferenceValue]            VARCHAR(200) NOT NULL,
    [ModifiedBy]                INT NOT NULL,
    [ValidFrom]                 DATETIME2 GENERATED ALWAYS AS ROW START,
    [ValidTo]                   DATETIME2 GENERATED ALWAYS AS ROW END,
    PERIOD FOR SYSTEM_TIME(ValidFrom, ValidTo),
    CONSTRAINT [PK_InstrumentReferenceData] PRIMARY KEY CLUSTERED (InstrumentReferenceDataId ASC)
)
WITH (SYSTEM_VERSIONING = ON (HISTORY_TABLE = reference.InstrumentReferenceDataHistory));

在Kotlin代码中，开发者期望能够这样创建记录：

val rec = InstrumentreferencedataRecord(0, "", 0)

但实际上，由于代码生成器为ValidFrom和ValidTo生成了非空约束，开发者被迫为这些自动生成的列提供值，这显然是不合理的。

技术背景分析

这个问题涉及两个层面的技术考量：

1. 计算列的本质：计算列的值由数据库自动计算得出，应用程序不应也不能提供这些值。这与DEFAULT约束列类似，都是数据库自动维护的列。

2. Kotlin空安全特性：jOOQ的Kotlin集成支持通过配置生成非空属性(isKotlinNotNullRecordAttributes=true)，这对于确保类型安全很有帮助，但对于自动生成的列，这种严格性反而成为了负担。

jOOQ的解决方案

jOOQ团队在3.20.0版本中修复了这个问题，主要做了以下改进：

1. 计算列的空值处理：现在代码生成器会将计算列视为与DEFAULT约束列或IDENTITY列类似，在生成代码时考虑其实际可空性。

2. 系统版本控制列的特殊处理：对于SQL Server的系统版本控制列(ValidFrom/ValidTo)，jOOQ会识别它们作为特殊的计算列，确保在代码生成时正确处理其空值约束。

对开发者的影响

这一变更虽然是一个bug修复，但从API兼容性角度看，它实际上是一个不兼容的变更：

1. 写入操作：这是一个兼容性改进，使插入操作更符合直觉。

2. 读取操作：这是一个不兼容变更，因为之前标记为非空的属性现在可能变为可空类型(尽管实际上这些列的值永远不会为null)。

最佳实践建议

对于使用jOOQ和Kotlin的开发者，建议：

1. 升级到3.20.0或更高版本：以获得更合理的计算列处理。

2. 理解自动生成列的特性：区分哪些列是应用需要提供的，哪些是由数据库自动维护的。

3. 谨慎处理版本升级：由于这是一个不兼容变更，升级后需要检查所有相关代码，特别是涉及计算列读取操作的部分。

未来发展方向

jOOQ团队还在考虑进一步增强对系统版本控制表的支持，包括：

1. 更好的周期信息生成：为系统版本控制表生成更丰富的元数据信息。

2. 专用API支持：可能为时间旅行查询(FOR SYSTEM_TIME AS OF等)提供更友好的API支持。

这些改进将进一步提升jOOQ在处理现代数据库特性时的开发体验和类型安全性。