Angular 9核心模块改造成支持路径导入的公共库问题咨询
实现自定义目录结构Angular公共库配置步骤
- 第一步:初始化标准Angular库后调整目录结构
首先通过ng generate library @core-lib生成官方标准的Angular库项目,删除默认生成的src/lib目录,将你现有main/core下的所有文件原封不动迁移到库项目的src目录下,迁移后库的src目录结构和你原有结构完全一致:src/ |-- abstract |-- models |-- mapped-property-class.ts |-- json-objects.ts |-- abstract-model.ts |-- components |-- abstract-base-component.ts |-- components // 实现abstract-base-component |-- services |-- public-api.ts - 第二步:配置二级入口点(实现按需路径导入的核心)
你需要的短路径导入能力依赖ng-packagr原生支持的二级入口点特性,不需要在根public-api.ts导出所有内容,只需要在每个要对外暴露的导入路径对应的目录下新增两个配置文件即可:
以你示例的导入路径为例,在src/abstract/models目录下新建两个文件:index.ts:作为该路径的导出入口,声明要对外暴露的内容:
export * from './mapped-property-class'; export * from './json-objects'; export * from './abstract-model';ng-package.json:该二级入口的打包配置,内容固定如下:
你需要暴露多少个导入路径,就对应在多少个目标目录下新增上述两个文件即可。如果需要自定义导入路径和实际目录的映射关系,可通过后续tsconfig路径别名调整。{ "lib": { "entryFile": "index.ts" } } - 第三步:修改库根配置
打开库项目根目录的ng-package.json,修改默认的入口路径配置,示例如下:
根目录下的{ "$schema": "../../node_modules/ng-packagr/ng-package.schema.json", "dest": "../../dist/core-lib", "lib": { "entryFile": "src/public-api.ts" } }public-api.ts作为库的根入口,可存放需要从@core-lib直接导出的公共内容,无相关需求可以留空。 - 第四步:配置开发阶段路径别名
在工作区根目录的tsconfig.json中添加路径映射,保证开发阶段IDE能正确识别导入路径、不报错:{ "compilerOptions": { "paths": { "@core-lib/*": ["projects/core-lib/src/*"], "@core-lib": ["projects/core-lib/src/public-api.ts"] } } } - 第五步:打包验证
执行ng build @core-lib完成打包,查看dist/core-lib目录下的产出,会对应生成你配置的所有二级入口文件夹,直接发布或者本地link到主项目测试即可,完全支持你期望的导入写法。
注意事项
- 所有要对外暴露的类、组件、服务、接口都必须在对应路径的
index.ts中显式导出,不要依赖隐式导出,否则打包后会丢失类型定义,运行时也可能报错 - Angular 9对应的ng-packagr版本已经原生支持二级入口点,不需要额外安装第三方插件
- 如果需要兼容低版本Angular应用,记得在库的
package.json中配置正确的peerDependencies约束 - 建议尽量保持导入路径和实际目录结构一一对应,降低后续维护成本
内容的提问来源于stack exchange,提问作者Eugene
相关产品推荐
相关产品推荐

