后端前端Web框架开发工具【免费下载链接】redwoodRedwoodGraphQL项目地址https://gitcode.com/gh_mirrors/re/redwood点击查看免费下载导读本文以 Redwood 框架RedwoodGraphQLv6 官方文档为核心深入讲解如何在 Prisma schema 中建模多对多关系以及这些关系模型如何与 Redwood 的 SDLSchema Definition Language生成器和 scaffold 生成器协作。你将掌握隐式/显式多对多关系的区别、CRUD 生成对id主键的硬性要求、显式关系表的标准写法以及当生成 SDL 时报出Unknown type错误时的高效排查与修复流程并理解自引用关系Self-Relations的建模注意事项。关联文档docs/versioned_docs/version-6.x/schema-relations.md本文同时参考了最新版文档 docs/docs/schema-relations.md 及仓库中的生成器源码。一、多对多关系Redwood 生成器视角的起点多对多many-to-many关系通过在两表之间建立一张连接表join table又称 lookup table来实现。典型的场景是一个Product产品可以拥有多个Tag标签而任意一个Tag也可以挂接多个Product。其数据库关系图如下┌───────────┐ ┌─────────────────┐ ┌───────────┐ │ Product │ │ ProductsOnTag │ │ Tag │ ├───────────┤ ├─────────────────┤ ├───────────┤ │ id │────│ productId │ ┌──│ id │ │ title │ │ tagId │──┘ │ name │ │ desc │ └─────────────────┘ └───────────┘ └───────────┘在schema.prisma中最直观的写法是让两个模型互相引用对方的数组字段model Product { id Int id default(autoincrement()) title String desc String tags Tag[] } model Tag { id Int id default(autoincrement()) name String products Product[] }这种写法在 Prisma 中被称为隐式implicit多对多关系——连接表ProductsOnTag由 Prisma 自动管理无需你在 schema 中显式声明。Prisma 官方对这种关系的详细说明可参考其多对多关系文档。关键点在于Redwood 的 SDL 生成器scaffold 生成器也在内部复用它在使用--crud标志生成时只支持显式explicit多对多关系。原因与 CRUD 操作对主键的要求有关详见下一节。二、为什么 CRUD 生成要求模型存在id主键Redwood 中的 CRUDCreate、Retrieve、Update、Delete操作需要单个唯一的字段来定位、更新或删除某条记录。该字段必须使用 Prisma 的id属性标注为表的主键因为主键保证唯一性可以被用来精确找到一条记录。而 Prisma 的隐式多对多关系生成的连接表没有任何单一字段带id属性。它使用的是另一种属性id用来定义一个多字段主键multi-field ID即用多个字段组合成这张表的主键。上面的关系图正是 Prisma 自动创建隐式关系的结果——连接表里只有productId和tagId没有自己的id。由于隐式连接表中没有单个id字段因此无法使用带--crud标志的 SDL 生成器同样无法使用 scaffold 生成器它在内部就是带--crud调用 SDL 生成器的。这一限制在源码中可以直接验证。packages/cli/src/commands/generate/sdl/sdl.js中的idType与idName函数会从模型中查找field.isId的字段若找不到就会调用missingIdConsoleMessage()打印黄色警告并抛出错误// packages/cli/src/commands/generate/sdl/sdl.js const missingIdConsoleMessage () { const line1 chalk.bold.yellow(WARNING) : Cannot generate CRUD SDL without an id database column. const line2 If you are trying to generate for a many-to-many join table const line3 youll need to update your schema definition to include const line4 an id column. Read more here: // ... } const idField model.fields.find((field) field.isId) if (!idField) { missingIdConsoleMessage() throw new Error(Failed: Could not generate SDL) }也就是说当你在一个隐式多对多连接模型上执行yarn rw g sdl Model --crud时会看到这条警告并导致生成失败。此时需要把隐式关系改写为显式关系为连接表补上一个真正的id主键。补充源码中的idType还处理了复合主键的情况——当model.primaryKey.fields非空时会返回主键字段数组用于生成XxxIdInput。这与文档强调的单字段id要求互为补充CRUD 生成优先使用单字段id没有时才考虑复合主键。三、受支持的显式关系表结构为了同时满足两个目标——既支持 CRUD 操作又与 Prisma 的多对多关系保持一致——推荐组合使用id与unique两个属性id在连接表上创建一个真正的主键例如自增的id字段供 CRUD 定位记录使用unique维持连接表的唯一索引。这个唯一性原本是由id组合主键提供的现在改由显式声明的唯一约束来保证。注意如果移除unique那么同一个Product就可以多次引用同一个Tag这通常会破坏多对多的语义需谨慎为之。具体做法是显式定义连接表结构例如model Product { id Int id default(autoincrement()) title String desc String tags ProductsOnTag[] } model Tag { id Int id default(autoincrement()) name String products ProductsOnTag[] } model ProductsOnTag { id Int id default(autoincrement()) tagId Int tag Tag relation(fields: [tagId], references: [id]) productId Int product Product relation(fields: [productId], references: [id]) unique([tagId, productId]) }对应的表结构如下┌───────────┐ ┌──────────────────┐ ┌───────────┐ │ Product │ │ ProductsOnTags │ │ Tag │ ├───────────┤ ├──────────────────┤ ├───────────┤ │ id │──┐ │ id │ ┌──│ id │ │ title │ └──│ productId │ │ │ name │ │ desc │ │ tagId │─┘ └───────────┘ └───────────┘ └──────────────────┘与隐式版本相比几乎一模一样唯一的差别就是多了id列——而正是这一列让 SDL/scaffold 生成器可以正常工作。除此之外显式写法还带来两个额外收益可以自定义连接表的名称例如把ProductsOnTag改名为ProductTags可以给连接表增加更多字段。比如想记录是谁给这个产品打的标签只需在ProductsOnTag中增加一个userId列并建立到User的关系即可。在编写 SDL 时模型字段到 GraphQL 类型的映射规则可以从 sdl.js 模板引擎 中看到Json映射为JSON、Decimal映射为Float、Bytes映射为Byte且列表字段与id字段总是必填输出为!。生成的 SDL 文件遵循 sdl.ts.template 的结构type Xxx、type Query、input CreateXxxInput、input UpdateXxxInput并在--crud开启时额外生成Mutation与XxxIdInput。了解这些模板有助于你预判生成器产出的 SDL 形态。四、排查生成器报错Unknown type的前因后果在使用 SDL 或 scaffold 生成器时还存在一个已知限制当为一个带有关系字段的 Prisma 模型生成 SDL 时如果关联模型的 SDL 尚未生成Redwood 的 GraphQL 类型生成会失败。用一个具体例子来说明。假设要建模书架场景Prisma schema 中有两个数据模型Book和Shelf属于一对多关系一个书架上有许多书一本书只能放在一个书架上model Book { id Int id default(autoincrement()) title String unique // highlight-start shelf Shelf? relation(fields: [shelfId], references: [id]) shelfId Int? // highlight-end } model Shelf { id Int id default(autoincrement()) name String unique // highlight-next-line books Book[] }数据模型没有问题。接着执行yarn rw g sdl Book命令前几步的输出看起来一切正常✔ Generating SDL files... ✔ Successfully wrote file ./api/src/graphql/books.sdl.js ✔ Successfully wrote file ./api/src/services/books/books.scenarios.js ✔ Successfully wrote file ./api/src/services/books/books.test.js ✔ Successfully wrote file ./api/src/services/books/books.jsSDL 与 service 文件都生成了。但随后在生成类型的步骤崩溃⠙ Generating types ... Failed to load schema # ... type Query { redwood: Redwood },graphql/**/*.sdl.{js,ts},directives/**/*.{js,ts}: Unknown type: Shelf. Error: Unknown type: Shelf.4.1 读懂报错信息遇到错误时的第一原则是仔细阅读错误信息。这里的核心线索是Unknown type: Shelf。原因很清楚Book的shelf字段的类型是Shelf但此时还没有为Shelf生成 SDL因此Shelf这个 GraphQL 类型在 schema 中不存在类型自然无法生成。在仓库源码中这一行为有明确对应。packages/internal/src/generate/graphqlSchema.ts在加载 schema 失败时会专门匹配错误消息中的Unknown type: (\w)模式如果捕获到的类型名在 Prisma schema 中存在对应的model它会打印一条heads up提示建议你也为关系另一端的模型生成 SDL 或 scaffold// packages/internal/src/generate/graphqlSchema.ts const match e.message.match(/Unknown type: (\w)/) const name match?.[1] // ... if (name schemaPrisma.includes(model ${name})) { errorObject.message [ errorObject.message, , ${chalk.bgYellow( ${chalk.black.bold(Heads up)} )}, , chalk.yellow( It looks like you have a ${name} model in your Prisma schema.), chalk.yellow( If its part of a relation, you may have to generate SDL or scaffolding for ${name} too., ), // ... ].join(\n) }4.2 两种修复思路修复方式有两种任选其一方式一一次性生成关系中的所有模型忽略中间报错。直接为关系涉及的每个模型都执行生成命令关系链中最后一个模型应能干净地生成成功。方式二先注释掉关系逐个生成再恢复关系并强制重新生成。第一步把Book与Shelf之间的关系字段注释掉model Book { id Int id default(autoincrement()) title String unique // highlight-start // Shelf Shelf? relation(fields: [shelfId], references: [id]) // shelfId Int? // highlight-end } model Shelf { id Int id default(autoincrement()) name String unique // highlight-next-line // books Book[] }第二步分别生成每个模型的 SDL或 scaffoldyarn rw g sdl Book # ... yarn rw g sdl Shelf # ...第三步把关系字段加回来取消注释并使用--force标志重新生成对应模型的 SDL 或 scaffold覆盖已有文件若不想覆盖已有的测试与场景文件可再加上--no-tests标志yarn rw g sdl Book --force --no-tests # ... yarn rw g sdl Shelf --force --no-tests # ...4.3 相关生成器标志说明从 sdl.js 的 builder/handler 可以看到generate sdl支持的主要标志包括标志类型默认值说明--crudbooleantrue同时生成 mutationcreate/update/delete--forcebooleanfalse覆盖已存在的同名文件--testsboolean取redwood.toml的generate.tests配置是否生成测试文件指定--no-tests可跳过--docsbooleanfalse为 SDL 与 GraphQL 字段生成文档注释--typescriptboolean取决于项目配置生成.ts类型文件--rollbackbooleantrue出错时回滚所有生成动作其中--crud默认开启这也解释了为什么常规yarn rw g sdl Book也会触发 CRUD 对id的要求而--force --no-tests的组合正是排错流程第三步的标准用法既覆盖 SDL/service 文件又保留已有的测试与场景文件。五、自引用关系Self-Relations自引用关系非常适合建模同类事物互为父子的层级结构。例如公司组织架构中每个人都是员工都有自己的职位role还可能有一个直接上级President总裁——没有直接上级在此例中Director总监——向 President 汇报Manager经理——向某位 Director 汇报Employee普通员工——向某位 Manager 汇报但没有直接下属用自引用关系建模如下model Employee { id Int id default(autoincrement()) name String jobTitle String // highlight-start reportsToId Int? unique reportsTo Employee? relation(OrgChart, fields: [reportsToId], references: [id]) directReports Employee? relation(OrgChart) // highlight-end }这里通过给两个关系字段加上同一个关系名OrgChart让 Prisma 知道reportsTo与directReports属于同一个自引用关系reportsTo通过fields: [reportsToId], references: [id]指向上级directReports是反向的列表端。对 Redwood 生成器而言关键要求是相关字段必须是可选的optional。reportsToId、reportsTo、directReports都使用了 Prisma 的?语法表示它们是可空/非必填的。如果试图强制这些字段为必填Redwood 生成器可能会报错或失败。这是符合业务直觉的如果你处于组织顶层比如你是 President就不会有reportsTo没有上级而如果只是普通 Employee则不会有任何人直接向你汇报directReports为空。可空字段恰好表达了顶层无上级、底层无下属这两种边界情况。六、小结与实践建议综合文档与源码可以归纳出 Redwood 中 Prisma 关系建模与生成器的协作要点多对多关系隐式写法简洁但连接表没有id一旦要生成 CRUD SDL 或 scaffold就必须改为显式连接表补上id主键并用unique保持唯一约束还能顺带扩展自定义字段。一对多/多对一关系为模型生成 SDL 时确保关系两端模型的 SDL 都已生成遇到Unknown type报错时按全部生成忽略报错或注释关系→逐个生成→恢复关系并--force --no-tests重新生成两种方式处理。自引用关系用带关系名的自引用建模层级结构并保证关系字段可空?避免生成器报错。相关源码与测试可以进一步深入SDL 生成器实现与警告逻辑packages/cli/src/commands/generate/sdl/sdl.jsSDL 输出模板packages/cli/src/commands/generate/sdl/templates/sdl.ts.templateSDL 生成器测试packages/cli/src/commands/generate/sdl/tests/sdl.test.jsschema 加载与Unknown type提示逻辑packages/internal/src/generate/graphqlSchema.tsscaffold 生成器packages/cli/src/commands/generate/scaffold/scaffold.js掌握这些关系建模与生成器协作的细节能让你在实际项目中少踩坑也能在遇到生成失败时快速定位并修复。赞分享后端前端Web框架开发工具【免费下载链接】redwoodRedwoodGraphQL项目地址https://gitcode.com/gh_mirrors/re/redwood点击查看免费下载相关推荐ToolJet 配置 GitHub SSO 单点登录从 OAuth App 创建到实例级/工作区级登录全流程指南ToolJet 配置 GitHub SSO 单点登录从 OAuth App 创建到实例级/工作区级登录全流程指南 GitHub SSO 是 ToolJet 提后端前端Web框架开发工具Redwood 中 Prisma 关系与生成器SDL / Scaffold实战指南Redwood 中 Prisma 关系与生成器SDL / Scaffold实战指南 Redwood 的 SDL 与 Scaffold 生成器基于 Prism后端前端Web框架开发工具RedwoodJS 中的 Prisma 关系与生成器多对多、自引用关系的 Schema 设计与 SDL/Scaffold 生成实战RedwoodJS 中的 Prisma 关系与生成器多对多、自引用关系的 Schema 设计与 SDL/Scaffold 生成实战 导读 本指南以 Redwo后端前端Web框架开发工具创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
