随着Angular6的发布,Angular CLI在一定程度上可以说是有了很大的提升。Angular CLI集成ng-packagr构建生成Angular库就是其中之一。ng-packagr是由David Herges创建的一个很棒的工具,用于将你的库代码转换成官方约定的Angular包格式。
其实官方文档中对于Angular库的创建已经介绍的很详细了,本文只简单记录一下整个流程。
创建库
你可以创建和发布新库来扩展 Angular 的功能。如果你发现需要在多个应用中解决同样的问题(或者想与其他开发者共享你的解决方案),你就有了一个潜在的库。
一个简单的例子就是把用户带到你公司网站上的按钮,该按钮会包含在你公司构建的所有应用中。
快速起步
使用Angular CLI,用以下命令生成一个新的Angular项目:
ng new my-app
进入项目根目录,再用以下命令生成一个新库的骨架:
ng generate library my-lib
这会在你的工作区中创建 projects/my-lib 文件夹,里面包含 NgModule 中的一个组件和一个服务。该工作区的配置文件 angular.json 中也添加了一个 'library' 类型的项目。
"projects": {
...
"my-lib": {
"root": "projects/my-lib",
"sourceRoot": "projects/my-lib/src",
"projectType": "library",
"prefix": "lib",
"architect": {
"build": {
"builder": "@angular-devkit/build-ng-packagr:build",
...
你可以使用CLI命令来创建、测试和lint这个项目:
ng build my-lib
ng test my-lib
ng lint my-lib
注意,该项目配置的构建器与应用类项目的默认构建器不同。此构建器可以确保库永远使用 AoT 编译器构建,而不必再指定--prod
标志。
类库内创建组件
在类库内创建组件,服务等都和普通的Angular应用一样,使用ng generate命令即可。
但要注意的是,我们需要在public-api.ts中将其导出,这样当我们在使用的时候就可以单独引入我们创建的组件。
发布你的库
使用 Angular CLI 和 npm 包管理器来把你的库构建并发布成 npm 包。默认情况下,库是在 AoT模式 下构建的,因此在构建发布时你不需要指定-prod
标志。
ng build my-lib
cd dist/my-lib
npm publish
注意我们使用ng build 命令编译生成类库,默认输出到my-app/dist/my-lib。
在应用中使用自己的库
你不必把库发布到 npm 包管理器上就可以在自己的应用中使用它,但必须先构建它。
要想在应用中使用你自己的库:
- 构建该库。在构建之前,无法使用库。
ng build my-lib
- 在你的应用中,按名字从库中导入:
import { MyLibModule } from 'my-lib';
@NgModule({
declarations: [
AppComponent,
],
imports: [
BrowserModule,
MyLibModule
],
providers: [],
bootstrap: [AppComponent]
})
然后我们就可以在模板中使用了,比如:
<lib-alert type="success"
#alert
message="{{message}}"
description="{{description}}"
[showIcon]="true"
[duration]="10000">
</lib-alert>