新闻详情

新闻详情

首页 / 资讯中心 / 详情

在原生 JavaScript 中使用 MikroORM:defineEntity 与 EntitySchema 完整实战指南

发布时间:2026/9/28 13:00:46来源:尧图网络
在原生 JavaScript 中使用 MikroORM:defineEntity 与 EntitySchema 完整实战指南
后端【免费下载链接】mikro-ormTypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, MariaDB, MS SQL Server, PostgreSQL and SQLite/libSQL databases.项目地址https://gitcode.com/gh_mirrors/mi/mikro-orm点击查看免费下载MikroORM 并非只能搭配 TypeScript 装饰器使用。通过defineEntity属性构建器p或EntitySchema你可以在纯 JavaScriptVanilla JS项目中获得与装饰器方案完全一致的功能实体定义、关系映射、生命周期钩子、Identity Map 与 Unit of Work 能力一应俱全。本文将基于 MikroORM 7.2 文档与仓库源码系统讲解如何在无 TypeScript、无装饰器的环境下用两种方式定义实体、注册实体并完成增删改查同时深入底层源码说明其工作原理。两种无装饰器方案总览在 JavaScript 项目中MikroORM 提供两条实体定义路径均不需要 TypeScript 或装饰器方案适用场景说明defineEntity 属性构建器p推荐方式基于EntitySchema构建运行时零依赖、类型信息在构建期自动推导EntitySchema直接实例化需要更底层控制手动书写每个属性的完整选项对象控制力更强、代码更啰嗦从源码看defineEntity本质上仍是返回一个EntitySchema实例——在 packages/core/src/entity/defineEntity.ts 的实现中defineEntity会遍历传入的properties对象对函数形式的属性关系属性必须写成函数使用 getter 惰性求值并缓存结果对普通构建器直接取选项最后return new EntitySchema({ properties, ...options })。因此两种方案的底层元数据模型是同一套。使用defineEntity定义实体推荐defineEntity配合属性构建器pp是defineEntity.properties的别名见 packages/core/src/entity/defineEntity.ts是官方推荐的方式。以典型的作者-书籍-标签三实体模型为例import { defineEntity, p } from mikro-orm/core; import { Book } from ./Book.js; export const Author defineEntity({ name: Author, properties: { id: p.integer().primary(), name: p.string(), email: p.string().unique(), age: p.integer().nullable(), termsAccepted: p.boolean().default(false), born: p.date().nullable(), createdAt: p.datetime().onCreate(() new Date()), updatedAt: p.datetime().onCreate(() new Date()).onUpdate(() new Date()), books: () p.oneToMany(Book, { mappedBy: author }), favouriteBook: () p.manyToOne(Book).nullable(), }, });import { defineEntity, p } from mikro-orm/core; import { Author } from ./Author.js; import { BookTag } from ./BookTag.js; export const Book defineEntity({ name: Book, properties: { id: p.integer().primary(), title: p.string(), author: () p.manyToOne(Author), tags: () p.manyToMany(BookTag), }, });import { defineEntity, p } from mikro-orm/core; export const BookTag defineEntity({ name: BookTag, properties: { id: p.integer().primary(), name: p.string(), }, });几个要点关系属性必须写成函数如() p.oneToMany(...)这与EntitySchema中entity: () Book的延迟引用写法一致目的是规避循环导入Author.js与Book.js互相引用。构建器方法如.primary()、.unique()、.nullable()、.default()、.onCreate()、.onUpdate()直接内联在属性定义上可读性与装饰器方案相当。p.integer()、p.string()、p.date()、p.datetime()、p.boolean()等标量构建器覆盖了 MikroORM 内置类型如需自定义类型可使用p.type(MyType)参见 自定义类型。defineEntity与 class 结合使用如果不满足于纯对象定义可以把defineEntity与普通 ES class 结合class 负责承载属性和自定义方法defineEntity负责描述数据库映射。此时实体名会自动从 class 名推断无需再传nameimport { defineEntity, p } from mikro-orm/core; export class Author { id; name; email; getDisplayName() { return ${this.name} ${this.email}; } } export const AuthorSchema defineEntity({ class: Author, properties: { id: p.integer().primary(), name: p.string(), email: p.string().unique(), }, });当使用 class 时实体名从 class 名推断ORM 中既可以传入 classAuthor也可以传入 schemaAuthorSchema作为实体引用。从源码看setClass()会同步更新元数据中的class、prototype、className并注册到EntitySchema.REGISTRY见 packages/core/src/metadata/EntitySchema.ts。更进阶的用法是class Author extends AuthorSchema.class {}加AuthorSchema.setClass(Author)的组合可以在自动生成的类上扩展自定义方法与属性初始化器详见 defineEntity 完整指南。注册实体并初始化 ORM定义好实体后在MikroORM.init的配置中通过entities数组注册即可。以下以mikro-orm/sqlite为例import { MikroORM } from mikro-orm/sqlite; import { Author } from ./entities/Author.js; import { Book } from ./entities/Book.js; import { BookTag } from ./entities/BookTag.js; const orm await MikroORM.init({ entities: [Author, Book, BookTag], dbName: my-db-name, });这里的entities数组既可以是 classAuthorSchema场景下用Author也可以是defineEntity返回的 schema 对象本身纯对象定义场景下直接用Author导出常量。MikroORM 会在启动时执行实体发现discovery流程从这些引用中构建完整元数据并验证关系映射的正确性——这正是两者提供完整功能的关键所在。创建与持久化实体实体注册完成后通过EntityManager的em.create()创建实例配合em.flush()一次性提交Unit of Work 会负责排序 INSERT 语句并处理级联关系const author em.create(Author, { name: Jon Snow, email: jonwall.st, }); const book em.create(Book, { title: My Life on the Wall, author, }); await em.flush();em.create()会返回实体实例若基于 schema 则会创建内部自动生成的类实例并自动处理onCreate钩子如示例中的createdAt: () new Date()以及关联对象这里book.author直接传入已创建的author实例flush 时会按外键关系自动排序写入。使用EntitySchema的替代方案当需要更细粒度的控制时可以直接实例化EntitySchema。与defineEntity的区别在于属性不再使用构建器而是手写完整的选项对象关系通过kind字段声明import { EntitySchema } from mikro-orm/core; export const Author new EntitySchema({ name: Author, properties: { id: { type: number, primary: true }, name: { type: string }, email: { type: string, unique: true }, age: { type: number, nullable: true }, termsAccepted: { type: boolean, default: false }, born: { type: Date, nullable: true }, createdAt: { type: Date, onCreate: () new Date() }, updatedAt: { type: Date, onCreate: () new Date(), onUpdate: () new Date() }, books: { kind: 1:m, entity: () Book, mappedBy: author }, favouriteBook: { kind: m:1, entity: () Book, nullable: true }, }, });注意entity字段同样需要函数形式() Book以支持循环依赖。type的值也可以是String/Number/Boolean/Date等构造函数或 MikroORM 内置类型的名称如int、text、json。关系的kind取值EntitySchema中关系的kind参数可选值如下ValueRelationship1:1One-to-onem:1Many-to-one1:mOne-to-manym:nMany-to-manyembeddedEmbedded除字符串字面量外也可以使用ReferenceKind枚举例如ReferenceKind.MANY_TO_ONE。该枚举在 packages/core/src/enums.ts 中定义值为1:1/1:m/m:1/m:n/embedded五个成员与表格中的字符串完全等价。钩子Hooks与自定义仓库EntitySchema以及defineEntity返回的 schema还支持直接注册生命周期钩子。addHook方法会把处理器推入对应事件的钩子数组见 packages/core/src/metadata/EntitySchema.tsexport const Article defineEntity({ name: Article, properties: { id: p.integer().primary(), title: p.string(), slug: p.string(), }, }); Article.addHook(beforeCreate, async args { args.entity.slug args.entity.title.toLowerCase(); });args.entity即为当前实体实例可用的事件包括onInit、onLoad、beforeCreate、afterCreate、beforeUpdate、afterUpdate、beforeDelete、afterDelete等与装饰器方案中的生命周期钩子完全对齐。类似地setCustomRepository可以为实体指定自定义EntityRepository实现。完整可运行的示例要快速验证上述全部内容仓库中的测试是最佳参照tests/defineEntity.test.ts覆盖了defineEntity的属性构建器推导如字符串规范化trim().uppercase()、autoincrement、serializedPrimaryKey等并断言defineEntity生成的元数据与手写EntitySchema完全等价tests/defineEntity.test.ts。此外原文档还附带了完整的 Express JavaScript 示例应用express-js-example-app可作为真实项目脚手架参考。小结在 JavaScript 项目中用好 MikroORM 的关键就两条实体定义用defineEntityp构建器或需要底层控制时用EntitySchema关系属性一律写成函数以规避循环引用。两种方案在底层都收敛于EntitySchema元数据模型因此后续的查询、事务、迁移、序列化等能力与 TypeScript 装饰器方案完全一致没有任何功能阉割。更进一步defineEntity的类型推导设计也使其成为从纯 JS 平滑迁移到 TypeScript 的最佳起点——同一套实体定义在 TS 环境下即可获得完整的类型安全。若想深入掌握defineEntity的 class 扩展、属性复用与类型推导细节可继续阅读 defineEntity 完整指南。赞分享后端【免费下载链接】mikro-ormTypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, MariaDB, MS SQL Server, PostgreSQL and SQLite/libSQL databases.项目地址https://gitcode.com/gh_mirrors/mi/mikro-orm点击查看免费下载相关推荐在纯 JavaScript 中使用 MikroORMdefineEntity 与 EntitySchema 实体定义完全指南在纯 JavaScript 中使用 MikroORMdefineEntity 与 EntitySchema 实体定义完全指南 MikroORM 作为一款基于后端在纯 JavaScript 项目中使用 MikroORMdefineEntity、属性构建器与 EntitySchema 完整指南在纯 JavaScript 项目中使用 MikroORMdefineEntity、属性构建器与 EntitySchema 完整指南 MikroORM 是一款基后端在 Vanilla JavaScript 中使用 MikroORM用 EntitySchema 免装饰器定义实体在 Vanilla JavaScript 中使用 MikroORM用 EntitySchema 免装饰器定义实体 MikroORM 虽然以 TypeScrip后端上一篇Kaspresso配置完全手册灵活定制你的专属Android测试框架下一篇探索性能边界pprof-rs —— Rust 应用的CPU剖析利器创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
网站建设高端定制企业官网
RELATED

相关资讯

更多精彩内容,欢迎继续阅读

较早相关资讯

最新相关资讯

基于Three.js实现第一人称迷雾游戏:雾效与性能优化全解析 2026/9/28 15:30:45

基于Three.js实现第一人称迷雾游戏:雾效与性能优化全解析

1. 迷雾项目:从想法到可玩网页1.1 这个游戏到底做了什么《迷雾》是一个第一人称探索小游戏,玩家醒来时被困在一片灰白色浓雾笼罩的树林里,能见度不超过三四米,头顶没有阳光,四周静得只能听见自己的脚步声。手里唯一的光…

阅读更多 →
旧游戏手柄修复与怀旧玩法:从摇杆漂移到无线连接的全指南 2026/9/28 15:30:45

旧游戏手柄修复与怀旧玩法:从摇杆漂移到无线连接的全指南

1. 从一只旧手柄说起:为什么我要写这个系列前阵子收拾老房子,从床底翻出一个落满灰的纸箱,里面塞着好几只游戏手柄。有塑料已经发黏的,有摇杆胶皮磨破的,还有一只十字键按下去会“咯吱”响的。我随手拿起一只插到电脑上…

阅读更多 →
LangChain Agent入门:13行代码实现大模型工具调用 2026/9/28 15:30:45

LangChain Agent入门:13行代码实现大模型工具调用

1. 别被“Agent”这个词吓住:它根本不是什么新物种,而是你 already 在用的“自动化小助理”很多人看到“Agent”第一反应是科幻片里那种能自主思考、满世界跑任务的AI机器人——其实完全不是。我带过十几期大模型开发训练营,每次开场第一课都…

阅读更多 →
高效刷 GitHub Trending:五分钟筛选高价值开源项目的完整指南 2026/9/28 15:30:45

高效刷 GitHub Trending:五分钟筛选高价值开源项目的完整指南

每天打开 GitHub 的 Trending 页面已经成了我雷打不烂的习惯,很多人刷短视频,我刷的就是 github.com/trending 这一页。有人会觉得,一个日榜不就是几个 star 数字在跳动嘛,有什么好看的?但你要是把热榜当成"全球开…

阅读更多 →
手写轻量Agent教学样本:从面试题到可调试状态机 2026/9/28 15:30:45

手写轻量Agent教学样本:从面试题到可调试状态机

1. 项目概述:从“码上面试”切入,理解Agent开发的真实起点“码上面试”这个词最近在技术社区里出现频率很高,不是某个具体产品,而是一类面向开发者求职场景的实践型学习路径——它把面试中高频出现的算法题、系统设计题、工程协作…

阅读更多 →
LSTM+Attention预测蛋白-配体结合亲和力实战指南 2026/9/28 15:30:38

LSTM+Attention预测蛋白-配体结合亲和力实战指南

简介:本资源是一套基于深度学习的蛋白质-配体结合亲和力预测完整实现方案,面向计算机、人工智能、生物信息学等专业的本科生与研究生,适用于毕业设计、课程设计及科研入门实践。项目采用LSTM网络建模序列特征,并融合自注意力机制提…

阅读更多 →

今日资讯

本周资讯

本月资讯

看完文章仍有疑问?

联系尧图顾问,获取一对一建站咨询

立即免费咨询 📞 400-888-8888
📞 ✉