Docs 菜单
Docs 主页
/
MongoDB Atlas
/
Atlas Device SDKs

安装 Node.js SDK

在此页面上

  • Overview
  • 先决条件
  • 安装
  • 创建 Node.js 项目
  • 使用 NPM 安装 SDK
  • 启用 TypeScript（可选）
  • 物联网安装
  • 安装 C++ 编译器
  • 创建 Node.js 项目
  • 使用 NPM 安装 SDK
  • 启用 TypeScript（可选）
  • 导入 SDK

Overview

Atlas Device SDK for Node.js 支持使用 JavaScript 和 TypeScript 语言开发应用程序。Node.js SDK 最适合编写服务器端应用程序。Node.js 应用程序可能是较广泛的堆栈中的组件，该堆栈还包括 iOS 和 Android 应用程序。

Node.js SDK 不适合前端应用程序开发。

  • 由于浏览器环境的限制，无法使用此 SDK 构建基于浏览器的 Web 应用。对于前端 Web 应用程序，请使用 Web SDK。

  • 要进行跨平台移动应用程序开发，请使用 React Native SDK。

先决条件

在开始之前，请确保您的开发环境满足以下前提条件：

  • Node.js 版本12 .x 或更高版本（包括 Node.js 版本14 ）

  • Linux、macOS 10.8（或更高版本）或 Windows 8（或更高版本）

安装

按照以下步骤创建 Node.js 项目并向其中添加 Node.js SDK。

提示

Atlas Device SDK 和 Realm

SDK 使用 Realm Core 数据库来实现设备数据持久化。安装 Node.js SDK 时，软件包名称会反映 Realm 命名方式。

1

创建 Node.js 项目

创建 Node.js 项目的方式：为项目新建目录并在该目录中运行 npm init。在下面的示例中，将 MyApp 替换为所需的项目名称。回答所有提示以填写项目的详细信息。

mkdir MyApp && cd MyApp && npm init
2

使用 NPM 安装 SDK

在 Node.js 项目目录中，使用以下命令将 SDK 添加到项目：

npm install realm
3

启用 TypeScript（可选）

Typescript是JavaScript的超集，增加了静态类型检查和其他功能，旨在使应用程序级开发更加稳健。 如果您想使用Typescript ，请遵循Typescript 团队的官方 Node Starter 指南 。该 SDK 原生支持Typescript ，并可轻松集成到Typescript项目中。

物联网安装

提示

Atlas Device SDK 和 Realm

SDK 使用 Realm Core 数据库来实现设备数据持久化。安装 Node.js SDK 时，软件包名称会反映 Realm 命名方式。

要创建 Node.js 项目并在运行 Raspberry Pi OS（以前称为 Raspbian）的物联网 (IoT) 平台（例如 Raspberry Pi 2、3 或 4）上添加 Node.js SDK，请执行以下步骤：

1

安装 C++ 编译器

Node.js SDK 的物联网库不以二进制形式分发，因此必须从源代码进行构建。为此，您需要一个可用的 C++ 编译器。要在物联网设备上安装此类编译器，请运行以下命令：

sudo apt install build-essential g++ libssl-dev
2

创建 Node.js 项目

通过为项目创建新目录并在该目录中运行 npm init 来创建 Node.js 项目。在下面的示例中，将 MyApp 替换为所需的项目名称。回答所有提示以填写项目的详细信息。

mkdir MyApp && cd MyApp && npm init
3

使用 NPM 安装 SDK

在 Node.js 项目目录中，使用以下命令将 SDK 添加到项目：

npm install realm
4

启用 TypeScript（可选）

Typescript是JavaScript的超集，增加了静态类型检查和其他功能，旨在使应用程序级开发更加稳健。 如果您想使用Typescript ，请遵循Typescript 团队的官方 Node Starter 指南 。该 SDK 原生支持Typescript ，并可轻松集成到Typescript项目中。

导入 SDK

将以下行添加到要使用 SDK 的源文件（JavaScript 或 TypeScript）的顶部：

import Realm from "realm";

来年

欢迎使用 Atlas Device SDK 文档