Компонент NAPI

Обзор
Структура каталога
Сценарии использования
Описание интерфейсов
Шаги разработки
Связанные репозитории

Обзор

Компонент NAPI (Native API) представляет собой расширяемую систему разработки модулей на основе стандартов Node.js N-API.

Рис. 1 Структура компонента NAPI

NativeEngine

Абстрактный слой движка JavaScript, который унифицирует поведение интерфейсов движка JavaScript на уровне NAPI.
ModuleManager

Менеджер модулей, используемый для загрузки модулей и кэширования информации о модулях.
ScopeManager

Менеджер жизненного цикла NativeValue.
ReferenceManager

Менеджер жизненного цикла NativeReference.

Структура каталога

Исходный код компонент NAPI расположен в директории /foundation/arkui/napi. Структура каталога представлена на следующем рисунке:

foundation/arkui/napi
   ├── interfaces
   │   └── kits
   │       └── napi           # Директория заголовочных файлов NAPI
   ├── module_manager         # Менеджер модулей
   ├── native_engine          # Абстрактный слой NativeEngine
   │   └── impl
   │       └── ark            # Реализация NativeEngine на основе Ark
   ├── scope_manager          # Менеджер области видимости
   └── test                   # Тестовый каталог
```## Сценарии использования<a name="section11759141594811"></a>

NAPI подходит для упаковки функций, таких как ввод-вывод, вычисления на основе ЦПУ, работа с низкоуровневыми функциями операционной системы и т.д., и для предоставления соответствующих интерфейсов JavaScript. С помощью NAPI можно организовать взаимодействие между JavaScript и кодом на C/C++. С помощью NAPI можно создавать модули, такие как сетевое взаимодействие, доступ к последовательным портам, декодирование мультимедиа и сбор данных с датчиков.

## Описание интерфейсов<a name="section1611515555510"></a>

Детали реализации интерфейсов см. в директории **foundation/arkui/napi**.**Таблица 1** Описание интерфейсов NAPI<a name="table10789351555"></a>
  <table><thead align="left"><tr id="row1878635175515"><th class="cellrowborder" valign="top" width="19.439999999999998%" id="mcps1.2.3.1.1"><p id="p27816352556"><a name="p27816352556"></a><a name="p27816352556"></a>Классификация интерфейсов</p>
  </th>
  <th class="cellrowborder" valign="top" width="80.56%" id="mcps1.2.3.1.2"><p id="p078835105514"><a name="p078835105514"></a><a name="p078835105514"></a>Описание</p>
  </th>
  </tr>
  </thead>
  <tbody><tr id="row17863535520"><td class="cellrowborder" valign="top" width="19.439999999999998%" headers="mcps1.2.3.1.1 "><p id="p678143512552"><a name="p678143512552"></a><a name="p678143512552"></a>Регистрация модуля</p>
  </td>
  <td class="cellrowborder" valign="top" width="80.56%" headers="mcps1.2.3.1.2 "><p id="p4781035185515"><a name="p4781035185515"></a><a name="p4781035185515"></a>Интерфейс для регистрации информации о модуле в модульном менеджере.</p>
  </td>
  </tr>
  <tr id="row67951538205618"><td class="cellrowborder" valign="top" width="19.439999999999998%" headers="mcps1.2.3.1.1 "><p id="p127961438195616"><a name="p127961438195616"></a><a name="p127961438195616"></a>Обработка исключений и ошибок</p>
  </td>
  <td class="cellrowborder" valign="top" width="80.56%" headers="mcps1.2.3.1.2 "><p id="p47961338195617"><a name="p47961338195617"></a><a name="p47961338195617"></a>Интерфейс для выброса исключений в JavaScript.</p>
  </td>
  </tr>
  <tr id="row778417510579"><td class="cellrowborder" valign="top" width="19.439999999999998%" headers="mcps1.2.3.1.1 "><p id="p1878575185715"><a name="p1878575185715"></a><a name="p1878575185715"></a>Управление жизненным циклом объектов</p>
  </td>
  <td class="cellrowborder" valign="top" width="80.56%" headers="mcps1.2.3.1.2 "><p id="p1178565175711"><a name="p1178565175711"></a><a name="p1178565175711"></a>Управление областью видимости для управления жизненным циклом объектов NAPI в определенной области видимости.</p>
  </td>
  </tr>
  </tbody>
  </table><table>
<tbody>
<tr id="row1531786125717">
<td class="cellrowborder" valign="top" width="19.44%">
<p id="p1531786125717"><a name="p1531786125717"></a><a name="p1531786125717"></a>Создание объектов JavaScript</p>
</td>
<td class="cellrowborder" valign="top" width="80.56%">
<p id="p12317663572"><a name="p12317663572"></a><a name="p12317663572"></a>Создание стандартных типов объектов.</p>
</td>
</tr>
<tr id="row163859616579">
<td class="cellrowborder" valign="top" width="19.44%">
<p id="p163859616579"><a name="p163859616579"></a><a name="p163859616579"></a>Доступ к свойствам объектов</p>
</td>
<td class="cellrowborder" valign="top" width="80.56%">
<p id="p173859616579"><a name="p173859616579"></a><a name="p173859616579"></a>Интерфейс для доступа к свойствам объектов.</p>
</td>
</tr>
<tr id="row438696165720">
<td class="cellrowborder" valign="top" width="19.44%">
<p id="p438696165720"><a name="p438696165720"></a><a name="p438696165720"></a>Преобразование типов C в типы NAPI</p>
</td>
<td class="cellrowborder" valign="top" width="80.56%">
<p id="p14386462570"><a name="p14386462570"></a><a name="p14386462570"></a>Преобразование типов C в типы NAPI.</p>
</td>
</tr>
<tr id="row13451116115716">
<td class="cellrowborder" valign="top" width="19.44%">
<p id="p13451116115716"><a name="p13451116115716"></a><a name="p13451116115716"></a>Преобразование типов NAPI в типы C</p>
</td>
<td class="cellrowborder" valign="top" width="80.56%">
<p id="p12451464574"><a name="p12451464574"></a><a name="p12451464574"></a>Преобразование типов NAPI в типы C.</p>
</td>
</tr>
<tr id="row155147625713">
<td class="cellrowborder" valign="top" width="19.44%">
<p id="p155147625713"><a name="p155147625713"></a><a name="p155147625713"></a>Функция получения глобального экземпляра</p>
</td>
<td class="cellrowborder" valign="top" width="80.56%">
<p id="p551466195713"><a name="p551466195713"></a><a name="p551466195713"></a>Получение глобального экземпляра.</p>
</td>
</tr>
</tbody>
</table>```markdown
<tr id="row65815617579"><td class="cellrowborder" valign="top" width="19.439999999999998%" headers="mcps1.2.3.1.1"><p id="p458119617577"><a name="p458119617577"></a><a name="p458119617577"></a>Операции со значениями JS</p></td><td class="cellrowborder" valign="top" width="80.56%" headers="mcps1.2.3.1.2"><p id="p125818625711"><a name="p125818625711"></a><a name="p125818625711"></a>Операции с операторами ===, typeof, instanceof и другими для NAPI.</p></td></tr>
<tr id="row10649166145711"><td class="cellrowborder" valign="top" width="19.439999999999998%" headers="mcps1.2.3.1.1"><p id="p18649196195716"><a name="p18649196195716"></a><a name="p18649196195716"></a>Операции с атрибутами объектов JS</p></td><td class="cellrowborder" valign="top" width="80.56%" headers="mcps1.2.3.1.2"><p id="p164919615574"><a name="p164919615574"></a><a name="p164919615574"></a>Набор функций для работы с атрибутами объектов.</p></td></tr>
<tr id="row0714260574"><td class="cellrowborder" valign="top" width="19.439999999999998%" headers="mcps1.2.3.1.1"><p id="p37143675714"><a name="p37143675714"></a><a name="p37143675714"></a>Операции с функциями JS</p></td><td class="cellrowborder" valign="top" width="80.56%" headers="mcps1.2.3.1.2"><p id="p714260574"><a name="p714260574"></a><a name="p714260574"></a>Набор функций для работы с функциями JS.</p></td></tr>
<tr id="row771466115711"><td class="cellrowborder" valign="top" width="19.439999999999998%" headers="mcps1.2.3.1.1"><p id="p771466115711"><a name="p771466115711"></a><a name="p771466115711"></a>Методы вызова, создание экземпляров.</p></td><td class="cellrowborder" valign="top" width="80.56%" headers="mcps1.2.3.1.2"><p id="p871466115711"><a name="p871466115711"></a><a name="p871466115711"></a>Методы вызова, создание экземпляров.</p></td></tr>
<tr id="row1578176155717"><td class="cellrowborder" valign="top" width="19.439999999999998%" headers="mcps1.2.3.1.1"><p id="p1782126155711"><a name="p1782126155711"></a><a name="p1782126155711"></a>Объектное упаковывание</p></td><td class="cellrowborder" valign="top" width="80.56%" headers="mcps1.2.3.1.2"><p id="p87821967572"><a name="p87821967572"></a><a name="p87821967572"></a>Привязка внешнего контекста объекта JavaScript.</p></td></tr>
```<p id="p1685414619578"><a name="p1685414619578"></a><a name="p1685414619578"></a>Простая асинхронность</p>
</td>
<td class="cellrowborder" valign="top" width="80.56%" headers="mcps1.2.3.1.2">
<p id="p1685411612574"><a name="p1685411612574"></a><a name="p1685411612574"></a>Создание асинхронных задач.</p>
</td>
</tr>
<tr id="row109154635718">
<td class="cellrowborder" valign="top" width="19.44%" headers="mcps1.2.3.1.1">
<p id="p391556195720"><a name="p391556195720"></a><a name="p391556195720"></a>Promises</p>
</td>
<td class="cellrowborder" valign="top" width="80.56%" headers="mcps1.2.3.1.2">
<p id="p1091566135717"><a name="p1091566135717"></a><a name="p1091566135717"></a>Набор функций для создания объектов Promise.</p>
</td>
</tr>
<tr id="row1671493313016">
<td class="cellrowborder" valign="top" width="19.44%" headers="mcps1.2.3.1.1">
<p id="p1971512331709"><a name="p1971512331709"></a><a name="p1971512331709"></a>Выполнение скриптов</p>
</td>
<td class="cellrowborder" valign="top" width="80.56%" headers="mcps1.2.3.1.2">
<p id="p371517332013"><a name="p371517332013"></a><a name="p371517332013"></a>Выполнение кода JavaScript.</p>
</td>
</tr>
</tbody>
</table>
```## Шаги разработки<a name="section937267212"></a>```В качестве примера рассмотрим разработку JS-интерфейса для получения имени пакета приложения с использованием NAPI.

Наш JS-интерфейс будет иметь следующий прототип:

function getAppName(): string;


Вот реализация кода:

// app.cpp #include <stdio.h> #include <string.h> #include "napi/native_api.h" #include "napi/native_node_api.h"

struct AsyncCallbackInfo { napi_env env; napi_async_work asyncWork; napi_deferred deferred; };

// Реализация функции для получения имени пакета приложения napi_value JSGetAppName(napi_env env, napi_callback_info info) { napi_deferred deferred; napi_value promise; // Создание промиса NAPI_CALL(env, napi_create_promise(env, &deferred, &promise));

AsyncCallbackInfo* asyncCallbackInfo = new AsyncCallbackInfo {
    .env = env,
    .asyncWork = nullptr,
    .deferred = deferred,
};

napi_value resourceName;
napi_create_string_latin1(env, "GetAppName", NAPI_AUTO_LENGTH, &resourceName);
// Создание асинхронной задачи
napi_create_async_work(
    env, nullptr, resourceName,
    // Коллбэк асинхронной задачи
    [](napi_env env, void* data) {},
    // Коллбэк завершения асинхронной задачи
    [](napi_env env, napi_status status, void* data) {
        AsyncCallbackInfo* asyncCallbackInfo = (AsyncCallbackInfo*)data;
        napi_value appName;
        const char* str = "com.example.helloworld";
        napi_create_string_utf8(env, str, strlen(str), &appName);
        // Вызов коллбэка
        napi_resolve_deferred(asyncCallbackInfo->env, asyncCallbackInfo->deferred, appName);
        napi_delete_async_work(env, asyncCallbackInfo->asyncWork);
        delete asyncCallbackInfo;
    },
    (void*)asyncCallbackInfo, &asyncCallbackInfo->asyncWork);
napi_queue_async_work(env, asyncCallbackInfo->asyncWork);
return promise;

}

static napi_value AppExport(napi_env env, napi_value exports)
{
    static napi_property_descriptor desc[] = {
        DECLARE_NAPI_FUNCTION("get_app_name", JSGetAppName),
    };
    NAPI_CALL(env, napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc));
    return exports;
}// Описание модуля app
static napi_module appModule = {
    .nm_version = 1,
    .nm_flags = 0,
    .nm_filename = nullptr,
    .nm_register_func = AppExport,
    .nm_modname = "app",
    .nm_priv = ((void*)0),
    .reserved = {0}
};
```## Регистрация модуля
```c
extern "C" __attribute__((constructor)) void AppRegister()
{
    napi_module_register(&appModule);
}

Соответствующий скрипт сборки:

// BUILD.gn
import("//build/ohos.gni")
ohos_shared_library("app") {
  # Указание исходных файлов для компиляции
  sources = [
    "app.cpp",
  ]
  # Указание зависимостей для компиляции
  deps = [ "//foundation/arkui/napi:ace_napi" ]
  # Указание пути для размещения сгенерированных библиотек
  relative_install_dir = "module"
  subsystem_name = "arkui"
  part_name = "napi"
}

Пример тестового кода на JS для приложения:

import app from '@ohos/app'
export default {
  testGetAppName() {
    app.getAppName().then(function (data) {
      console.info('app name: ' + data);
    });
  }
}

Связанные репозитории

Подсистема ArkUI-фреймворка

arkui_ace_engine

arkui_ace_engine_lite

arkui_napi

OSCHINA-MIRROR/openharmony-arkui_napi

Компонент NAPI

Обзор

Структура каталога

Соответствующий скрипт сборки:

Пример тестового кода на JS для приложения:

Связанные репозитории

Опубликовать ( 0 )

Введение

Обновления

Участники

Язык

Недавние действия

OSCHINA-MIRROR/openharmony-arkui_napi .gitee-modal { min-width: 500px !important; } .gitee-modal .close { right: 0.6rem !important; }

Компонент NAPI

Обзор

Структура каталога

Соответствующий скрипт сборки:

Пример тестового кода на JS для приложения:

Связанные репозитории

Опубликовать ( 0 )

Введение

Обновления

Участники

Язык

Недавние действия

OSCHINA-MIRROR/openharmony-arkui_napi