@ 起源cap/ event- type- codegen
创建时间 TypeScript 创建事件接口 DETAILS 有效载荷,从没有运行服务器的克特林PAL事件处理器中发现.
配置
启用通过 genx.config.* 或 genx 编号 : genesis 键入 package.json数字 :
{
"genx": {
"eventTypes": {
"enabled": true,
"serverModule": "../server/my-app",
"kotlinSources": [
"src/main/kotlin/**/dto/**/*.kt",
"src/main/genesis/scripts/**/*.kts"
],
"generatedDaoSources": [
"build/internal-modules/**/*-generated-dao/build/generated/sources/dao/global/genesis/gen/dao/**/*.kt"
],
"handlerScan": [
"src/main/kotlin/**/*.kt",
"src/main/genesis/scripts/**/*.kts"
],
"output": "src/generated/genesis-event-types.ts",
"runOnBuild": true
}
}
}
何时 enabled 错误或块被省略,代码被跳过.
generatedDaoSources globs通过两个应用模块解决(serverModule)及其父缓冲 server/ 目录(字典-cache DAOs通常居住的地方). 默认覆盖之后常见的单重排布局 ./gradlew … 已经生成 DAO 源 。 自定义 data class DTO 总是使用相同的类名覆盖生成的 DAO .
国 际
从客户端应用程序目录 :
genx generate event-types
genx build 当 eventTypes.enabled 财务报告和审定财务报表 runOnBuild (默认) true 当启用时).
在显示服务器Gradle构建中, generateDao 实值 finalizedBy generateEventTypes,运行中 genx generate event-types 内 react-client 何时 genx 可用(在单发靴后)。 禁用为 -PenableEventTypeCodegen=false。 。 。 .
限制(v1)
- 发现使用克特林源解析,而不是编译器或活的JSON Schema.
- 只有具有可解决的 DETAILS 形状的处理器( Custom DTO 或生成的表格/索引来自
generatedDaoSources获得*Details类型和类型EventDetailsMap条目。 其他任何东西都列在生成文件顶端的注释中. - 完整的表格 DAO 处理器(例如 .
eventHandler<Trade>("TRADE_INSERT"))和索引处理器(例如.eventHandler<Trade.ById>("TRADE_DELETE"))在生成 DAO 时被映射.kt资料来源列于下generatedDaoSources。 。 。 . - 基于类的处理器源命名
*EventHandler.kta 项下dto/路径被跳过。 这个dto/**glob 用于输入data class只有; 这些文件通常是SyncValidatingEventHandler执行,而不是PALeventHandler { }剧本. PAL 处理器在*-eventhandler.kts(和其他handlerScan路径)仍然被发现. - 在 CI 中客户端代码源之前生成 DAO 源( Gradle) 如果树没有被执行 .
- 词典 国家网 字段:字符串字符串
enum class和/或伴侣Field.Type.ENUMvalues = "…"出现在generatedDaoSources(单位:千美元)gen/dao/**/*.kt) (中文(简体) ). - Enum 出口以 Kotlin enum 来命名, 并且只能使用自有表格
当声明不一致时。 创世纪也发出一个谜题 未覆盖,在平顶楼
global.genesis.gen.dao.enums,或 表格范围d输入…enums.<dictionary>.<table>这样啊 多个宣言可以共享一个简单的名称. 同值套件共用一个导出; 不同者有资格(AxeStatus编号 :RfqStatus编号 :OrderStatus所以没有桌子的地盘 以另一个值为单位。 在他们之中,有未加明镜的申报,那确是隐讳的, 因为这是 PAL 脚本默认导入决定的 . - 一个字段的enum解决了克特林解决这个名字的方式,与写它的文件相对:
输入文件声明本身,然后显示
import,然后是文件自己的软件包,然后 恒星导入。 每跑一跑就把下面的人蒙入阴影中import那个名字 在生成的树产量之外unknown,从不使用同名生成的enum. - PAL 脚本(
.kts下级genesis/scripts/附加默认进口 创世纪编译器用品 (单位:千美元)…gen.dao.enums.*, (中文(简体) ),…gen.dao.*和生成的配置/视图 软件包),这就是为什么val feeType: FeeType解决那里没有import线条。 星号 进口不再重复,所以 表格范围d 仍然没有导入脚本的 enum 名称 决定:unknown:创世纪确实通过tables-info.json,但该等级尚未建模。 一个平地.kt来源,什么的 下级genesis/cfg/中,没有默认值.
输入
*Details接口 Kotlin DTO的DETAILS有效载荷.GenesisEvent(从)@genesislcap/foundation-comms)——抽象基础;子类集MESSAGE_TYPE。 。 。 .- 每个手执班 - 比如说.
EventAqsCounterpartyInsert。 。 。 .
import { commitGenesisEvent } from '@genesislcap/foundation-comms';
import { EventAqsCounterpartyInsert } from './generated/genesis-event-types';
await commitGenesisEvent(
connect,
new EventAqsCounterpartyInsert({ COUNTERPARTY_ID: 'x' }),
);
元数据堆放路径(FUI-2608)
由活服务器快照生成,而不是(或除此之外)克特林源扫描:
- 在与
foundation-header按钮 Ctrl/Cmd+Shift+E 电源 下载( 仅建为 dev )event-metadata.json。 。 。 . - 运行 :
genx generate event-types --from-metadata event-metadata.json
这使用了入境的JSON Schema DETAILS(域名, JSON_TYPE作为合同——对于比较克特林-扫描输出和对于处理者来说,源扫描仪丢失是有用的.
Kotlin 路径的电线字段命名匹配起源- 服务器 toUpperUnderscoreWithAcronyms (例如:. addressLine1 → ADDRESS_LINE_1) (中文(简体) ). 日期/时间 Kotlin 类型映射到类型脚本 number (时代小米/ JSON_TYPE: integer) (中文(简体) ).
移徙
| 应用 | 行动 |
|---|---|
| 新建 genx 模板 | 启用 eventTypes、 承诺或 gitignore 生成输出 |
| 遗产 | 添加配置, 运行 genx generate event-types,并逐步输入 |
| 没有克特林DTO | 离开已禁用 |