关于angular:Angular-原理图-Schematics-学习-动手开发一个实际的例子

当 ng add 命令向我的项目中增加某个库时，就会运行原理图。ng generate 命令则会运行原理图，来创立利用、库和 Angular 代码块。

一些术语：

在原理图中，是指一个在文件树上运行的函数，用于以指定形式创立、删除或批改文件，并返回一个新的 Tree 对象。

在 schematics 中，一个用 Tree 类示意的虚构文件系统。Schematic 规定以一个 tree 对象作为输出，对它们进行操作，并且返回一个新的 tree 对象。

开发人员能够创立下列三种原理图：

装置原理图，以便 ng add 能够把你的库增加到我的项目中。
生成原理图，以便 ng generate 能够为我的项目中的已定义工件（组件，服务，测试等）提供反对。
更新原理图，以便 ng update 能够更新你的库的依赖，并提供一些迁徙来毁坏新版本中的更改。

上面咱们动手做一个例子。

在库的根文件夹中，创立一个 schematics/ 文件夹。

在 schematics/ 文件夹中，为你的第一个原理图创立一个 ng-add/ 文件夹。

在 schematics/ 文件夹的根级，创立一个 collection.json 文件。

编辑 collection.json 文件来定义你的汇合的初始模式定义。

如下图所示：

collection.json 文件内容如下：

{
  "$schema": "../../../node_modules/@angular-devkit/schematics/collection-schema.json",
  "schematics": {
    "ng-add": {
      "description": "Add my library to the project.",
      "factory": "./ng-add/index#ngAdd"
    },
    "my-service": {
      "description": "Generate a service in the project.",
      "factory": "./my-service/index#myService",
      "schema": "./my-service/schema.json"
    }
  }
}

下图高亮行的意思是：执行 ng add 时，调用文件夹 ng-add 上面的 index.ts 文件。

即这个文件：

咱们须要在 my-lib 库的根目录下的 package.json 里，申明对上图 collection.json 文件的援用：

ng add 命令的原理图能够加强用户的初始装置过程。能够按如下步骤定义这种原理图。

(1) 进入 <lib-root>/schematics/ng-add/ 目录。
(2) 创立主文件 index.ts。
(3) 关上 index.ts 并增加原理图工厂函数的源代码:

import {Rule, SchematicContext, Tree} from '@angular-devkit/schematics';
import {NodePackageInstallTask} from '@angular-devkit/schematics/tasks';

// Just return the tree
export function ngAdd(options: any): Rule {return (tree: Tree, context: SchematicContext) => {context.addTask(new NodePackageInstallTask());
    return tree;
  };
}

提供初始 ng add 反对所需的惟一步骤是应用 SchematicContext 来触发装置工作。该工作会借助用户首选的包管理器将该库增加到宿主我的项目的 package.json 配置文件中，并将其装置到该项目标 node_modules 目录下。

在这个例子中，该函数会接管以后的 Tree 并返回它而不作任何批改。如果须要，你也能够在装置软件包时进行额定的设置，例如生成文件、更新配置、或者库所需的任何其它初始设置。

如果该库应该增加到 dependencies 中、devDepedencies 中，或者不必保留到我的项目的 package.json 配置文件中，请应用 ng-add 的 save 选项进行配置

"ng-add": {"save": "devDependencies"}

可能的值有：

false – 不把此包增加到 package.json
true – 把此包增加到 dependencies
“dependencies” – 把此包增加到 dependencies
“devDependencies” – 把此包增加到 devDependencies

必须首先构建库自身，而后再构建 Schematics.

你的库须要一个自定义的 Typescript 配置文件，外面带有如何把原理图编译进库的公布版的一些指令。

要把这些原理图增加到库的公布包中，就要把这些脚本增加到该库的 package.json 文件中。

假如你在 Angular 工作区中有一个库我的项目 my-lib。要想通知库如何构建原理图，就要在生成的 tsconfig.lib.json 库配置文件旁增加一个 tsconfig.schematics.json 文件。

新建一个 tsconfig.schematics.json 文件，保护如下的源代码：

{
  "compilerOptions": {
    "baseUrl": ".",
    "lib": [
      "es2018",
      "dom"
    ],
    "declaration": true,
    "module": "commonjs",
    "moduleResolution": "node",
    "noEmitOnError": true,
    "noFallthroughCasesInSwitch": true,
    "noImplicitAny": true,
    "noImplicitThis": true,
    "noUnusedParameters": true,
    "noUnusedLocals": true,
    "rootDir": "schematics",
    "outDir": "../../dist/my-lib/schematics",
    "skipDefaultLibCheck": true,
    "skipLibCheck": true,
    "sourceMap": true,
    "strictNullChecks": true,
    "target": "es6",
    "types": [
      "jasmine",
      "node"
    ]
  },
  "include": ["schematics/**/*"],
  "exclude": ["schematics/*/files/**/*"]
}

rootDir 指出在你的 schematics/ 文件夹中蕴含要编译的输出文件，即下图高亮的文件：

outDir 映射到了库的输入目录下。默认状况下，这是工作区根目录下的 dist/my-lib 文件夹，即下图这些文件：

要确保你的原理图源文件会被编译进库包中，请把下列脚本增加到库我的项目的根文件夹（projects/my-lib）下的 package.json 文件中。

{
  "name": "my-lib",
  "version": "0.0.1",
  "scripts": {
    "build": "../../node_modules/.bin/tsc -p tsconfig.schematics.json",
    "copy:schemas": "cp --parents schematics/*/schema.json ../../dist/my-lib/",
    "copy:files": "cp --parents -p schematics/*/files/** ../../dist/my-lib/",
    "copy:collection": "cp schematics/collection.json ../../dist/my-lib/schematics/collection.json",
    "postbuild": "npm run copy:schemas && npm run copy:files && npm run copy:collection"
  },
  "peerDependencies": {
    "@angular/common": "^7.2.0",
    "@angular/core": "^7.2.0"
  },
  "schematics": "./schematics/collection.json",
  "ng-add": {"save": "devDependencies"}
}

build 脚本应用自定义的 tsconfig.schematics.json 文件来编译你的原理图。

copy:* 语句将已编译的原理图文件复制到库的输入目录下的正确地位，以放弃目录的构造。

postbuild 脚本会在 build 脚本实现后复制原理图文件。

你能够把一个命名原理图增加到汇合中，让你的用户能够应用 ng generate 命令来创立你在库中定义的工件。

咱们假如你的库定义了一项须要进行某些设置的服务 my-service。你心愿用户可能用上面的 CLI 命令来生成它。

ng generate my-lib:my-service

首先，在 schematics 文件夹中新建一个子文件夹 my-service.

编辑一下 schematics/collection.json 文件，指向新的原理图子文件夹，并附上一个指向模式文件的指针，该文件将会指定新原理图的输出。

进入 <lib-root>/schematics/my-service/ 目录。

创立一个 schema.json 文件并定义该原理图的可用选项。

每个选项都会把 key 与类型、形容和一个可选的别名关联起来。该类型定义了你所冀望的值的状态，并在用户申请你的原理图给出用法帮忙时显示这份形容。

创立一个 schema.ts 文件，并定义一个接口，用于寄存 schema.json 文件中定义的各个选项的值。

export interface Schema {
  // The name of the service.
  name: string;

  // The path to create the service.
  path?: string;

  // The name of the project.
  project?: string;
}

name：你要为创立的这个服务指定的名称。

path：笼罩为原理图提供的门路。默认状况下，门路是基于当前工作目录的。

project：提供一个具体我的项目来运行原理图。在原理图中，如果用户没有给出该选项，你能够提供一个默认值。

要把工件增加到我的项目中，你的原理图就须要本人的模板文件。原理图模板反对非凡的语法来执行代码和变量替换。

在 schematics/my-service/ 目录下创立一个 files/ 文件夹。

创立一个名叫 __name@dasherize__.service.ts… 的文件，它定义了一个能够用来生成文件的模板。这里的模板会生成一个已把 Angular 的 HttpClient 注入到其构造函数中的服务。

文件内容如下：

// #docregion template
import {Injectable} from '@angular/core';
import {HttpClient} from '@angular/common/http';

@Injectable({providedIn: 'root'})
export class <%= classify(name) %>Service {constructor(private http: HttpClient) {}}

classify 和 dasherize 办法是实用函数，你的原理图会用它们来转换你的模板源码和文件名。

name 是工厂函数提供的一个属性。它与你在模式中定义的 name 是一样的。

当初，你曾经有了基础设施，能够开始定义一个 main 函数来执行要对用户我的项目做的各种批改了。

Schematics 框架提供了一个文件模板零碎，它反对门路和内容模板。零碎会操作在这个输出文件树（Tree）中加载的文件内或门路中定义的占位符，用传给 Rule 的值来填充它们。

对于这些数据结构和语法的详细信息，请参阅 Schematics 的 README。

创立主文件 index.ts 并为你的原理图工厂函数增加源代码。

首先，导入你须要的原理图定义。Schematics 框架提供了许多实用函数来创立规定或在执行原理图时和应用规定。

代码如下：

import {
  Rule, Tree, SchematicsException,
  apply, url, applyTemplates, move,
  chain, mergeWith
} from '@angular-devkit/schematics';

import {strings, normalize, virtualFs, workspaces} from '@angular-devkit/core';

导入已定义的模式接口，应用别名重定义为 MyServiceSchema，它会为你的原理图选项提供类型信息。

要想构建 “ 生成器原理图 ”，咱们从一个空白的规定工厂开始。

index.js 文件里：

export function myService(options: MyServiceSchema): Rule {return (tree: Tree) => {return tree;};
}

这个规定工厂返回树而不做任何批改。这些选项都是从 ng generate 命令传过来的选项值。

咱们当初有了一个框架，可用来创立一些真正批改用户程序的代码，以便对库中定义的服务进行设置。

用户装置过此库的 Angular 工作区中会蕴含多个我的项目（利用和库）。用户能够在命令行中指定一个我的项目，也能够应用它的默认值。在任何一种状况下，你的代码都须要晓得应该在哪个我的项目上利用此原理图，这样能力从该项目标配置中检索信息。

你能够应用传给工厂函数的 Tree 对象来做到这一点。通过 Tree 的一些办法，你能够拜访此工作区的残缺文件树，以便在运行原理图时读写文件。

要确定指标我的项目，能够应用 workspaces.readWorkspace 办法在工作区的根目录下读取工作区配置文件 angular.json 的内容。要想应用 workspaces.readWorkspace，你要先从这个 Tree 创立出一个 workspaces.WorkspaceHost。将以下代码增加到工厂函数中。

function createHost(tree: Tree): workspaces.WorkspaceHost {
  return {async readFile(path: string): Promise<string> {const data = tree.read(path);
      if (!data) {throw new SchematicsException('File not found.');
      }
      return virtualFs.fileBufferToString(data);
    },
    async writeFile(path: string, data: string): Promise<void> {return tree.overwrite(path, data);
    },
    async isDirectory(path: string): Promise<boolean> {return !tree.exists(path) && tree.getDir(path).subfiles.length > 0;
    },
    async isFile(path: string): Promise<boolean> {return tree.exists(path);
    },
  };
}

export function myService(options: MyServiceSchema): Rule {return async (tree: Tree) => {const host = createHost(tree);
    const {workspace} = await workspaces.readWorkspace('/', host);

  };
}

workspaces 是从 @angular-devkit/core 导出的，readWorkspace 是其规范办法。该办法须要的第二个输出参数 host，是从另一个自定义函数 createHost 返回的。

上面这行 default 逻辑解决：

if (!options.project) {options.project = workspace.extensions.defaultProject;}

此 workspace.extensions 属性中蕴含一个 defaultProject 值，用来确定如果没有提供该参数，要应用哪个我的项目。如果 ng generate 命令中没有明确指定任何我的项目，咱们就会把它作为后备值。

有了项目名称之后，用它来检索指定我的项目的配置信息。

const project = workspace.projects.get(options.project);
if (!project) {throw new SchematicsException(`Invalid project name: ${options.project}`);
}

const projectType = project.extensions.projectType === 'application' ? 'app' : 'lib';

options.path 决定了利用原理图之后，要把原理图模板文件挪动到的地位。
原理图模式中的 path 选项默认会替换为当前工作目录。如果未定义 path，就应用我的项目配置中的 sourceRoot 和 projectType 来确定。

逻辑体现在上面的代码里：

if (options.path === undefined) {options.path = `${project.sourceRoot}/${projectType}`;
}

sourceRoot 在 angular.json 里定义：

Rule 能够应用内部模板文件，对它们进行转换，并应用转换后的模板返回另一个 Rule 对象。你能够应用模板来生成原理图所需的任意自定义文件。

将以下代码增加到工厂函数中。

const templateSource = apply(url('./files'), [
  applyTemplates({
    classify: strings.classify,
    dasherize: strings.dasherize,
    name: options.name
  }),
  move(normalize(options.path as string))
]);

apply() 办法会把多个规定利用到源码中，并返回转换后的源代码。它须要两个参数，一个源代码和一个规定数组。

url() 办法会从文件系统中绝对于原理图的门路下读取源文件。

applyTemplates() 办法会接管一个参数，它的办法和属性可用在原理图模板和原理图文件名上。它返回一条 Rule。你能够在这里定义 classify() 和 dasherize() 办法，以及 name 属性。

classify() 办法承受一个值，并返回题目格局（title case）的值。比方，如果提供的名字是 my service，它就会返回 MyService。Title case 和驼峰命名法相似，是一种变量拼写规定。

dasherize() 办法承受一个值，并以中线分隔并小写的模式返回值。比方，如果提供的名字是 MyService，它就会返回“my-service”的模式。

当利用了此原理图之后，move 办法会把所提供的源文件挪动到目的地。所以，my service 被转换为 MyService，进而为 my-service.

规定工厂必须返回一条规定。

return chain([mergeWith(templateSource)
]);

该 chain() 办法容许你把多个规定组合到一个规定中，这样就能够在一个原理图中执行多个操作。这里你只是把模板规定和原理图要执行的代码合并在一起。

至此这个 Angular 库的 Schematics 就开发结束了，请继续关注 Jerry 后续文章，我会介绍如何生产这个 Schematics.

更多 Jerry 的原创文章，尽在：” 汪子熙 ”:

关于angular:Angular-原理图-Schematics-学习-动手开发一个实际的例子

规定

文件树

定义依赖类型

构建你的原理图

提供生成器反对

增加工厂函数

定义一个生成器规定

获取我的项目配置

定义规定