ngx-mqtt 项目使用教程

ngx-mqtt 项目使用教程

1. 项目的目录结构及介绍

ngx-mqtt 是一个用于 Angular 项目的 MQTT 客户端库，它不仅是一个 MQTT.js 的包装器，还提供了 observables 和订阅管理等功能。以下是 ngx-mqtt 项目的目录结构及其介绍：

ngx-mqtt/
├── dist/
│   ├── bundles/
│   ├── esm2015/
│   ├── esm5/
│   ├── fesm2015/
│   ├── fesm5/
│   ├── lib/
│   └── ngx-mqtt.d.ts
├── src/
│   ├── lib/
│   │   ├── client/
│   │   ├── message/
│   │   ├── observable/
│   │   ├── plugin/
│   │   ├── shared/
│   │   └── util/
│   ├── public_api.ts
│   └── test.ts
├── .editorconfig
├── .gitignore
├── .npmignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── angular.json
├── package.json
├── tsconfig.json
├── tslint.json
└── yarn.lock

目录结构介绍

• dist/: 编译后的文件目录，包含不同模块格式的输出。
• src/: 源代码目录，包含库的主要实现和测试文件。
  • lib/: 库的核心实现，包括客户端、消息处理、 observables 等模块。
  • public_api.ts: 库的公共 API 入口。
  • test.ts: 测试配置文件。
• .editorconfig, .gitignore, .npmignore, .travis.yml: 项目配置文件。
• CHANGELOG.md, LICENSE, README.md: 项目文档。
• angular.json, package.json, tsconfig.json, tslint.json, yarn.lock: 项目构建和依赖管理文件。

2. 项目的启动文件介绍

ngx-mqtt 项目的启动文件主要是 public_api.ts，它是库的入口文件，导出了所有公共 API。

/* src/public_api.ts */

/*
 * Public API Surface of ngx-mqtt
 */

export * from './lib/client';
export * from './lib/message';
export * from './lib/observable';
export * from './lib/plugin';
export * from './lib/shared';
export * from './lib/util';

启动文件介绍

• public_api.ts: 导出了库的所有模块，包括客户端、消息处理、 observables 等，使得用户可以方便地引入和使用这些模块。

3. 项目的配置文件介绍

ngx-mqtt 项目的配置文件主要包括 angular.json, package.json, tsconfig.json, 和 tslint.json。

angular.json

angular.json 是 Angular 项目的配置文件，包含了项目的构建和开发配置。

{
  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
  "version": 1,
  "newProjectRoot": "projects",
  "projects": {
    "ngx-mqtt": {
      "projectType": "library",
      "root": "projects/ngx-mqtt",
      "sourceRoot": "projects/ngx-mqtt/src",
      "prefix": "lib",
      "architect": {
        "build": {
          "builder": "@angular-devkit/build-ng-packagr:build",
          "options": {
            "tsConfig": "projects/ngx-mqtt/tsconfig.lib.json",
            "project": "projects/ngx-mqtt/ng-package.json"
          },
          "configurations": {
            "production": {
              "tsConfig": "projects/ngx-mqtt/tsconfig.lib.prod.json"
            }
          }
        },
        "test": {
          "builder": "@angular-devkit/build-angular:karma",
          "options": {
            "main": "projects/ngx-mqtt/src/test.ts",
            "tsConfig": "projects/ng