后端微服务【免费下载链接】loopback-nextLoopBack makes it easy to build modern API applications that require complex integrations.项目地址https://gitcode.com/gh_mirrors/lo/loopback-next点击查看免费下载loopback/model-api-builder是 LoopBack 4loopback-next 仓库中定义模型 API 构建器扩展点契约的基础包它只提供类型与辅助工具本身不含业务实现。读完本文你将掌握ModelApiBuilder接口、ModelApiConfig配置结构与asModelApiBuilder绑定模板的完整用法能够基于此契约编写自己的 API 构建扩展例如仿照loopback/rest-crud实现输入一个 Model 类、自动产出 Repository 与 Controller的能力并理解它与ModelApiBooter在应用启动阶段是如何协作的。一、Overview这个包解决什么问题在常规的 LoopBack 4 开发中为一个模型对外提供 REST API你需要手写两样东西Repository类负责数据访问和Controller类负责 HTTP 路由。当模型数量很多时这些类高度重复。loopback/model-api-builder定义的思路是用户只提供 Model 类 一段配置扩展方负责按模型构建出 Repository 和 Controller。仓库中的packages/model-api-builder/src/index.ts包文档把契约概括为Provides a contract for extensions that contribute builders for repositories and controllers. Users provide both the model class and an extension. The extension is then used to build their repository and controller based on the model class.也就是说这个包扮演的是插件插槽extension point角色真正的构建逻辑由其他包最典型的是loopback/rest-crud以扩展extension的身份贡献。它定义了三个关键导出ModelApiBuilder扩展必须实现的接口ModelApiConfig描述单个模型配置文件的类型asModelApiBuilder把实现类注册到扩展点的绑定模板binding template。三者均定义在packages/model-api-builder/src下model-api-builder.ts、model-api-config.ts并由index.ts统一导出。二、安装作为运行依赖安装到你的包中npm install --save loopback/model-api-builder需要说明的依赖关系见 packages/model-api-builder/package.json该包以peerDependencies声明了loopback/core^7.0.0提供injectable、extensionFor等扩展点基础设施与loopback/repository^8.0.1提供ApplicationWithRepositories与Model类型因此请确保宿主应用已安装这两个包。仓库中该包版本为 7.0.16engines.node声明支持 Node.js 22 / 24 / 26。三、核心契约一ModelApiConfig 配置类型配置类型定义于 packages/model-api-builder/src/model-api-config.ts它描述的是public-models/{model-name}.config.json在 boot 约定下实际是model-endpoints/*.config.{js,ts}这类单模型配置文件的完整结构export type ModelApiConfig { /** * The model class that the repository and controller are to be built from. * e.g. Product (a Model class) */ model: typeof Model {prototype: Model}; /** * Name of>export interface ModelApiBuilder { readonly pattern: string; // e.g. CrudRest build( application: ApplicationWithRepositories, modelClass: typeof Model {prototype: Model}, config: ModelApiConfig, ): Promisevoid; }每个实现类必须提供pattern一个只读字符串标识该构建器支持的数据访问模式。ModelApiBooter会依据配置文件中的pattern字段精确匹配到唯一的构建器匹配逻辑见下文第五节。build()核心方法接收三个参数——应用实例application类型为ApplicationWithRepositories即混入了 Repository 能力的 Application、modelClass要为其构建 API 的模型类、config上文ModelApiConfig。方法返回Promisevoid实现者在此方法内负责完成 Repository 与 Controller 的搭建 注册。4.1 官方 README 的最小实现示例loopback/model-api-builder的 README 给出了一个骨架级实现展示如何声明一个可被扩展点拾取的构建器import { asModelApiBuilder, ModelApiBuilder, ModelApiConfig, } from loopback/model-api-builder; injectable(asModelApiBuilder) export class SampleApiBuilder implements ModelApiBuilder { readonly pattern: string Sample; build( application: ApplicationWithRepositories, modelClass: typeof Model {prototype: Model}, config: ModelApiConfig, ): Promisevoid { // define repository setup here // ... // define controller setup here // ... } }关键点是injectable(asModelApiBuilder)injectable来自loopback/core括号中的asModelApiBuilder是一个binding template它负责把类绑定到扩展点上从而让loopback/core的扩展点机制能够按需收集所有模型 API 构建器。真正的 Repository / Controller 定义逻辑写在build()的注释位置——README 用注释// define repository setup here与// define controller setup here明确划分了这两个职责区块。五、核心契约三asModelApiBuilder 绑定模板asModelApiBuilder的实现同样在 model-api-builder.tsexport const MODEL_API_BUILDER_PLUGINS model-api-builders; export const asModelApiBuilder: BindingTemplate binding { extensionFor(MODEL_API_BUILDER_PLUGINS)(binding); binding.tag({namespace: model-api-builders}); };它做了两件事声明扩展点归属通过extensionFor(MODEL_API_BUILDER_PLUGINS)把绑定标记为名为model-api-builders的扩展点extension point下的扩展常量MODEL_API_BUILDER_PLUGINS model-api-builders是扩展点名称的唯一定义处打上命名空间标签binding.tag({namespace: model-api-builders})便于依赖注入与调试时按标签筛选。在运行期loopback/core的extensionPoint(MODEL_API_BUILDER_PLUGINS)与extensions()注入器见下文ModelApiBooter会把所有经过asModelApiBuilder注册的构建器聚合成一个GetterModelApiBuilder[]供消费方惰性获取。六、与 ModelApiBooter 的协作启动时如何自动装配loopback/model-api-builder定义了契约真正消费契约的是loopback/boot包中的ModelApiBooter实现见 packages/boot/src/booters/model-api.booter.ts。ModelApiBooter是 LoopBack 4 boot 体系中的一个 booter通过booter(modelApi)声明默认约定如下扫描目录model-endpoints/文件扩展名-config.js实际以.rest-config.js、.rest-config.ts等形式出现允许嵌套子目录nested: true它通过extensionPoint(MODEL_API_BUILDER_PLUGINS)注解与extensions() getModelApiBuilders: GetterModelApiBuilder[]注入拿到全部构建器然后对每个配置文件执行setupModel(configFile)model-api.booter.tsrequire(configFile)加载配置对象校验cfg.model必须是函数即 Model 类否则抛出Invalid model field. Expected a Model class, found ...调用getApiBuilderForPattern(cfg.pattern)在所有已注册构建器中用find(b b.pattern pattern)精确匹配若无匹配构建器抛出Unsupported API pattern pattern并附带当前可用 patterns 列表命中后调用builder.build(this.app, modelClass, cfg)完成装配。完整调用链为配置文件 → ModelApiBooter → 按 pattern 匹配 ModelApiBuilder → build() 注册 Repository 与 Controller。packages/boot/src/__tests__/acceptance/model-api.booter.acceptance.ts中的测试精确验证了这套行为正确 pattern 会触发对应构建器、重复 pattern 使用先注册者、不存在的 pattern 抛出Unsupported API pattern、非法model字段抛出Invalid model field。测试夹具 stub-model-api-builder.ts 展示了最简构建器的组件封装方式——把构建器类通过createBindingFromClass放进 Component 的bindings再app.component(...)注册。七、参考实现loopback/rest-crud 如何基于该契约落地loopback/rest-crud是该契约最典型的官方实现其CrudRestApiBuilder见 packages/rest-crud/src/crud-rest.api-builder.tsinjectable(asModelApiBuilder) export class CrudRestApiBuilder implements ModelApiBuilder { readonly pattern: string CrudRest; build( application: ApplicationWithRepositories, modelClass: typeof Model {prototype: Model}, cfg: ModelApiConfig, ): Promisevoid { const modelName modelClass.name; const config cfg as ModelCrudRestApiConfig; if (!config.basePath) { throw new Error( Missing required field basePath in configuration for model ${modelName}., ); } // ... const repositoryClass setupCrudRepository(entityClass, config); application.repository(repositoryClass); // ... const controllerClass setupCrudRestController(entityClass, config); application.controller(controllerClass); // ... } }它展示了build()的两个典型动作调用defineCrudRepositoryClass生成 Repository 类并application.repository(...)注册调用defineCrudRestController生成 Controller 类并application.controller(...)注册同时通过inject装饰第一个构造参数注入数据源datasources.${config.dataSource}与仓库绑定repositories.${entityClass.name}Repository。另外两点工程细节值得注意CrudRestComponentpackages/rest-crud/src/crud-rest.component.ts把CrudRestApiBuilder包装成组件bindings [createBindingFromClass(CrudRestApiBuilder)]使用者只需this.component(CrudRestComponent)即可注册该构建器ModelCrudRestApiConfig用basePath与readonly扩展了基础ModelApiConfig正是第四节所述索引签名灵活性的实际体现。defineCrudRestController生成的控制器packages/rest-crud/src/crud-rest.controller.ts包含完整 CRUD 端点GET /、GET /{id}、GET /count属于只读控制器非只读模式额外提供POST /、PATCH /、PATCH /{id}、PUT /{id}、DELETE /{id}当readonly: true时仅暴露前三个查询类 API。其行为由 default-model-crud-rest.acceptance.ts 等验收测试覆盖例如创建后返回 200、拒绝请求体携带id等。八、端到端示例Todo 模型零手写 Repository / Controller仓库中的examples/rest-crud是单模型 单数据源、使用默认 CRUD REST 仓库与控制器的最小可运行示例。在应用构造器中注册组件examples/rest-crud/src/application.tsthis.component(RestExplorerComponent); this.component(CrudRestComponent);然后在model-endpoints/目录下放置模型端点配置文件examples/rest-crud/src/model-endpoints/todo.rest-config.tsimport {ModelCrudRestApiConfig} from loopback/rest-crud; import {Todo} from ../models; module.exports ModelCrudRestApiConfig{ model: Todo, pattern: CrudRest, dataSource: db, basePath: /todos, };这段配置表达的是为Todo模型使用CrudRest模式、底层数据源为db、控制器挂载在/todos基路径下。启动应用从示例根目录npm start服务默认运行于 http://127.0.0.1:3000后Todo即拥有默认的 Repository 与 Controller无需再编写任何 repository 或 controller 类文件——这比完整版 todo 示例 精简了整整两个手写类。九、编写自己的 Model API 构建器步骤清单结合以上契约从零实现一个自定义 API 构建器只需四步实现接口定义类并实现ModelApiBuilder为pattern赋一个全局唯一字符串如MyPattern应用绑定模板在类上使用injectable(asModelApiBuilder)使其成为model-api-builders扩展点的一员实现 build()在方法体内根据modelClass与config生成 Repository / Controller 类并注册到application可复用loopback/repository的defineCrudRepositoryClass与loopback/rest-crud的defineCrudRestController等工厂函数也可完全自定义注册到应用把类包进 Component参考CrudRestComponent的createBindingFromClass写法或直接app.bind(...).toClass(...)随后在model-endpoints/下编写对应pattern的配置文件即可被ModelApiBooter自动拾取。如果配置文件中写入了未注册的pattern启动时会得到明确的错误提示Unsupported API pattern pattern. Available patterns: none可用列表来自所有已注册构建器的pattern字段。十、进一步阅读契约源码packages/model-api-builder/src/model-api-builder.ts、packages/model-api-builder/src/model-api-config.ts、packages/model-api-builder/src/index.ts契约消费方packages/boot/src/booters/model-api.booter.ts 与其验收测试 packages/boot/src/tests/acceptance/model-api.booter.acceptance.ts官方参考实现packages/rest-crud/src/crud-rest.api-builder.ts、packages/rest-crud/src/crud-rest.controller.ts可运行示例examples/rest-crud/README.md 与 examples/rest-crud/src/model-endpoints/todo.rest-config.ts赞分享后端微服务【免费下载链接】loopback-nextLoopBack makes it easy to build modern API applications that require complex integrations.项目地址https://gitcode.com/gh_mirrors/lo/loopback-next点击查看免费下载相关推荐扩展 LoopBack 4 Model API Builder为模型定制 Repository 与 Controller 生成器扩展 LoopBack 4 Model API Builder为模型定制 Repository 与 Controller 生成器 loopback/mode后端微服务LoopBack 4 Model 生成器lb4 model完全指南交互式创建 Entity 与 Model 类LoopBack 4 Model 生成器lb4 model完全指南交互式创建 Entity 与 Model 类 lb4 model 是 LoopBack后端微服务LoopBack 4 迁移指南将 LoopBack 3 自定义模型方法迁移到 Model / Repository / Controller 架构LoopBack 4 迁移指南将 LoopBack 3 自定义模型方法迁移到 Model / Repository / Controller 架构 本文是 L后端微服务上一篇CANN/asc-devkit TopK排序示例下一篇JSS主题切换性能优化避免重排重绘的技巧创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考