expo Creating a native module

Tutorial: Creating a native module
A tutorial on creating a native module that persists settings with Expo Modules API.

这个 Expo 官方文档的示例(native-module-tutorial)是一个教程,教你如何在 Expo 中创建一个原生模块(Native Module)。它包含了一个完整的流程,包括如何开发、测试以及如何将模块集成到其他项目中。下面是对这个示例的解释:

1. 示例的目的

这个教程的目的是指导开发者如何在 Expo 环境中创建一个自定义的原生模块。Expo 默认提供了很多内置功能,但有时候你需要扩展这些功能,或者实现某些平台特定的功能(例如访问特定的传感器或设备功能)。通过这个教程,你可以学会如何将原生功能封装到一个模块中,并且在 Expo 项目中使用。

2. 目录结构

example 目录是教程项目的一部分,用于演示如何在实际项目中使用你创建的模块。它相当于一个“小型的项目”,用来验证和测试你创建的模块是否工作正常。

3. 开发完成后如何安装到别的项目

开发完成后,你可以将这个模块作为一个独立的 npm 包发布,或者手动安装到其他项目中。以下是安装的方法:

发布到 npm 并安装到其他项目

  1. 发布到 npm

    • 首先,你需要创建一个 npm 账户(如果还没有的话)。
    • 在模块开发完成后,运行以下命令将模块发布到 npm:
      npm publish
      
    • 这将把你的模块发布到 npm 仓库。
  2. 在其他项目中安装

    • 在你的其他 Expo 或 React Native 项目中,可以通过 npm 或 yarn 安装你发布的模块:
      npm install your-module-name
      
      或者:
      yarn add your-module-name
      

手动安装到其他项目

如果你不想发布到 npm,也可以通过以下步骤手动安装:

  1. 本地引用

    • 将你的模块代码保存在本地某个文件夹中,并通过 npm/yarn 以本地路径的方式安装:
      npm install ../path-to-your-module
      
      或者:
      yarn add ../path-to-your-module
      
  2. 将模块作为 Git 依赖

    • 如果你将模块代码托管在 Git 仓库中,可以直接通过 Git 安装:
      npm install git+https://github.com/yourusername/your-module-repo.git
      
      或者:
      yarn add https://github.com/yourusername/your-module-repo.git
      

4. 总结

这个 demo 主要是展示如何创建原生模块,并包含一个用于测试的 example 目录。完成开发后,你可以将模块发布到 npm,或通过本地引用或 Git 安装到其他项目中。这为你在 Expo 环境中扩展功能提供了灵活性。