1# JSVM-API支持的数据类型和接口 2 3## JSVM-API的数据类型 4 5### JSVM_Status 6 7是一个枚举数据类型，表示JSVM-API接口返回的状态信息。 8 9每当调用一个JSVM-API函数，都会返回该值，表示操作成功与否的相关信息。 10 11```c++ 12typedef enum { 13 JSVM_OK, 14 JSVM_INVALID_ARG, 15 JSVM_OBJECT_EXPECTED, 16 JSVM_STRING_EXPECTED, 17 JSVM_NAME_EXPECTED, 18 JSVM_FUNCTION_EXPECTED, 19 JSVM_NUMBER_EXPECTED, 20 JSVM_BOOL_EXPECTED, 21 JSVM_ARRAY_EXPECTED, 22 JSVM_GENERIC_FAILURE, 23 JSVM_PENDING_EXCEPTION, 24 JSVM_CENCELLED, 25 JSVM_ESCAPE_CALLED_TWICE, 26 JSVM_HANDLE_SCOPE_MISMATCH, 27 JSVM_CALLBACK_SCOPE_MISMATCH, 28 JSVM_QUEUE_FULL, 29 JSVM_CLOSING, 30 JSVM_BIGINT_EXPECTED, 31 JSVM_DATA_EXPECTED, 32 JSVM_CALLBACK_SCOPE_MISMATCH, 33 JSVM_DETACHABLE_ARRAYBUFFER_EXPECTED, 34 JSVM_WOULD_DEADLOCK, /* unused */ 35 JSVM_NO_EXTERNAL_BUFFERS_ALLOWED, 36 JSVM_CANNOT_RUN_JS 37} JSVM_Status; 38``` 39 40### JSVM_ExtendedErrorInfo 41 42一个结构体，在调用函数不成功时存储了较为详细的错误信息。 43 44```c++ 45typedef struct { 46 const char* errorMessage; 47 void* engineReserved; 48 uint32_t engineErrorCode; 49 JSVM_Status errorCode; 50} JSVM_ExtendedErrorInfo; 51``` 52 53### JSVM_Value 54 55在C++代码中，表示一个JavaScript值。 56 57### JSVM_Env 58 59- 用于表示JSVM-API执行时的上下文，Native侧函数入参，并传递给函数中的JSVM-API接口。 60 61- 退出Native侧插件时，JSVM_Env将失效，该事件通过回调传递给OH_JSVM_SetInstanceData。 62 63- 禁止缓存JSVM_Env，禁止在不同Worker中传递JSVM_Env。 64 65- 在不同线程间共享JSVM_Env时，要保证在线程切换时在前一个线程中关闭env scope并在新的线程中打开新的env scope，以保证threadlocal变量的线程隔离。 66 67### JSVM_ValueType 68 69JSVM_Value的类型。包含了ECMAScript语言规范中定义的类型，其中JSVM_EXTERNAL表示外部数据类型。 70 71```c++ 72typedef enum { 73 JSVM_UNDEFINED, 74 JSVM_NULL, 75 JSVM_BOOLEAN, 76 JSVM_NUMBER, 77 JSVM_STRING, 78 JSVM_SYMBOL, 79 JSVM_OBJECT, 80 JSVM_FUNCTION, 81 JSVM_EXTERNAL, 82 JSVM_BIGINT, 83} JSVM_ValueType; 84``` 85 86### JSVM_TypedarrayType 87 88TypedArray的基本二进制标量数据类型。 89 90```c++ 91typedef enum { 92 JSVM_INT8_ARRAY, 93 JSVM_UINT8_ARRAY, 94 JSVM_UINT8_CLAMPED_ARRAY, 95 JSVM_INT16_ARRAY, 96 JAVM_UINT16_ARRAY, 97 JSVM_INT32_ARRAY, 98 JSVM_UINT32_ARRAY, 99 JSVM_FLOAT32_ARRAY, 100 JSVM_FLOAT64_ARRAY, 101 JSVM_BIGINT64_ARRAY, 102 JSVM_BIGUINT64_ARRAY, 103} JSVM_TypedarrayType; 104``` 105 106### JSVM_RegExpFlags 107正则表达式标志位。 108 109```c++ 110typedef enum { 111 JSVM_REGEXP_NONE = 0, 112 JSVM_REGEXP_GLOBAL = 1 << 0, 113 JSVM_REGEXP_IGNORE_CASE = 1 << 1, 114 JSVM_REGEXP_MULTILINE = 1 << 2, 115 JSVM_REGEXP_STICKY = 1 << 3, 116 JSVM_REGEXP_UNICODE = 1 << 4, 117 JSVM_REGEXP_DOT_ALL = 1 << 5, 118 JSVM_REGEXP_LINEAR = 1 << 6, 119 JSVM_REGEXP_HAS_INDICES = 1 << 7, 120 JSVM_REGEXP_UNICODE_SETS = 1 << 8, 121} JSVM_RegExpFlags; 122``` 123 124### 编译选项相关类型 125#### JSVM_CompileOptions 126 127配合编译接口 OH_JSVM_CompileScriptWithOptions 使用，是其参数中 options 数组的元素类型 128 129其中： 130- id 代表这个编译选项的类型 131- content 代表编译选项的内容 132 133id 的值和 content 的类型需要对应使用，详细对应关系参考下面对各个选项类型的介绍 134```c 135typedef struct { 136 /** compile option id. */ 137 JSVM_CompileOptionId id; 138 /** option content. */ 139 union { 140 /** ptr type. */ 141 void *ptr; 142 /** int type. */ 143 int num; 144 /** bool type. */ 145 _Bool boolean; 146 } content; 147} JSVM_CompileOptions; 148``` 149 150#### JSVM_CompileOptionId 151 152JSVM_CompileOptions 中的 id 对应类型， 每个值都有其对应的 content 类型, 其中 JSVM_COMPILE_ENABLE_SOURCE_MAP 对应的类型为 bool，当同时传入的 JSVM_ScriptOrigin 中 sourceMapUrl 不为空时生效 153```c 154typedef enum { 155 /** compile mode. */ 156 JSVM_COMPILE_MODE, 157 /** code cache content. */ 158 JSVM_COMPILE_CODE_CACHE, 159 /** script origin. */ 160 JSVM_COMPILE_SCRIPT_ORIGIN, 161 /** compile profile content. */ 162 JSVM_COMPILE_COMPILE_PROFILE, 163 /** switch for source map support. */ 164 JSVM_COMPILE_ENABLE_SOURCE_MAP, 165} JSVM_CompileOptionId; 166``` 167 168#### JSVM_CompileMode 169 170当 id 为 JSVM_COMPILE_MODE，content 的类型，每个值代表一种编译模式： 171 172- JSVM_COMPILE_MODE_DEFAULT : 默认的编译选项 173- JSVM_COMPILE_MODE_CONSUME_CODE_CACHE : 消耗 codecache 进行编译 174- JSVM_COMPILE_MODE_EAGER_COMPILE : 进行全量编译，不再进行 lazy compile 175- JSVM_COMPILE_MODE_PRODUCE_COMPILE_PROFILE/JSVM_COMPILE_MODE_CONSUME_COMPILE_PROFILE : 当前暂无效果，请等待后续更新 176 177```c 178typedef enum { 179 /** default mode. */ 180 JSVM_COMPILE_MODE_DEFAULT, 181 /** consume code cache. */ 182 JSVM_COMPILE_MODE_CONSUME_CODE_CACHE, 183 /** apply eager compile. */ 184 JSVM_COMPILE_MODE_EAGER_COMPILE, 185 /** preset for compile profile. */ 186 JSVM_COMPILE_MODE_PRODUCE_COMPILE_PROFILE, 187 /** consume compile profile. */ 188 JSVM_COMPILE_MODE_CONSUME_COMPILE_PROFILE, 189} JSVM_CompileMode; 190``` 191 192 193#### JSVM_CodeCache 194 195当 id 为 JSVM_COMPILE_CODE_CACHE 时，content 的类型： 196 197- cache : 指向 code cache 的指针 198- length : code cache 的大小 199 200```c 201typedef struct { 202 /** cache pointer. */ 203 uint8_t *cache; 204 /** length. */ 205 size_t length; 206} JSVM_CodeCache; 207``` 208 209#### JSVM_ScriptOrigin 210 211当 id 为 JSVM_COMPILE_SCRIPT_ORIGIN 时，content 的类型，存放待编译的源码信息： 212 213- sourceMapUrl : sourceMap 的路径，当前仅支持运行设备上的本地路径, 可以为空 214- resourceName : 待编译的 js script 的名字， 215```c 216typedef struct { 217 /** Sourcemap url. */ 218 const char* sourceMapUrl; 219 /** Resource name. */ 220 const char* resourceName; 221 /** Resource line offset. */ 222 size_t resourceLineOffset; 223 /** Resource column offset. */ 224 size_t resourceColumnOffset; 225} JSVM_ScriptOrigin; 226``` 227 228### JSVM 229### 内存管理类型 230 231JSVM-API包含以下内存管理类型： 232 233**JSVM_HandleScope** 234 235JSVM_HandleScope数据类型是用来管理JavaScript对象的生命周期的。它允许JavaScript对象在一定范围内保持活动状态，以便在JavaScript代码中使用。在创建JSVM_HandleScope时，所有在该范围内创建的JavaScript对象都会保持活动状态，直到结束。这样可以避免在JavaScript代码中使用已经被释放的对象，从而提高代码的可靠性和性能 236 237**JSVM_EscapableHandleScope** 238 239- 由OH_JSVM_OpenEscapableHandleScope接口创建，由OH_JSVM_CloseEscapableHandleScope接口关闭。 240 241- 表示一种特殊类型的句柄范围，用于将在JSVM_EscapableHandleScope范围内创建的值返回给父scope。 242 243- 用于OH_JSVM_EscapeHandle接口，将JSVM_EscapableHandleScope提升到JavaScript对象，以便在外部作用域使用。 244 245**JSVM_Ref** 246 247指向JSVM_Value，允许用户管理JavaScript值的生命周期。 248 249**JSVM_TypeTag** 250 251该结构体定义了一个包含两个无符号64位整数的类型标签，用于标识一个JSVM-API值的类型信息。 252 253```c++ 254typedef struct { 255 uint64_t lower; 256 uint64_t upper; 257} JSVM_TypeTag; 258``` 259 260- 存储了两个无符号64位整数的128位值，用它来标记JavaScript对象，确保它们属于某种类型。 261 262- 比OH_JSVM_Instanceof更强的类型检查，如果对象的原型被操纵，OH_JSVM_Instanceof可能会报告误报。 263 264- JSVM_TypeTag 在与 OH_JSVM_Wrap 结合使用时最有用，因为它确保从包装对象检索的指针可以安全地转换为与先前应用于JavaScript对象的类型标记相对应的Native类型。 265 266### 回调类型 267 268JSVM-API包含以下回调类型： 269 270**JSVM_CallbackInfo** 271 272表示用户定义的Native函数，暴露给JavaScript，即JS侧调用的接口；一般不在此Callback中创建Handle或者CallbackScope。 273 274**JSVM_CallbackStruct** 275 276用户提供的Native函数的回调函数指针和数据，JSVM_CallbackStruct将通过JSVM-API暴露给JavaScript。 277 278```c++ 279typedef struct { 280 JSVM_Value(*callback)(JSVM_Env env, JSVM_CallbackInfo info); 281 void* data; 282} JSVM_CallbackStruct; 283``` 284 285**JSVM_Callback** 286 287表示用户定义的Native函数，暴露给JavaScript，即JS侧调用的接口；除非在对象生命周期管理中有特殊要求，一般不在此callback中创建handle或者callback scope。 288 289基本用法如下: 290 291```c++ 292typedef JSVM_CallbackStruct* JSVM_Callback; 293``` 294 295**JSVM_Finalize** 296 297函数指针，用于传入OH_JSVM_SetInstanceData、OH_JSVM_CreateExternal、OH_JSVM_Wrap等接口。JSVM_Finalize在对象被回收时会被调用，可用于在JavaScript对象被垃圾回收时释放Native对象。 298 299写法如下： 300 301```c++ 302typedef void (JSVM_Finalize)(JSVM_Env env, void finalizeData, void* finalizeHint); 303``` 304 305**JSVM_PropertyHandlerConfigurationStruct** 306 307当执行对象的getter、setter、deleter和enumerator作时，对应的的回调将会触发。 308 309```c++ 310typedef struct { 311 JSVM_Value(JSVM_CDECL* genericNamedPropertyGetterCallback)(JSVM_Env env, 312 JSVM_Value name, 313 JSVM_Value thisArg, 314 JSVM_Value namedPropertyData); 315 JSVM_Value(JSVM_CDECL* genericNamedPropertySetterCallback)(JSVM_Env env, 316 JSVM_Value name, 317 JSVM_Value property, 318 JSVM_Value thisArg, 319 JSVM_Value namedPropertyData); 320 JSVM_Value(JSVM_CDECL* genericNamedPropertyDeleterCallback)(JSVM_Env env, 321 JSVM_Value name, 322 JSVM_Value thisArg, 323 JSVM_Value namedPropertyData); 324 JSVM_Value(JSVM_CDECL* genericNamedPropertyEnumeratorCallback)(JSVM_Env env, 325 JSVM_Value thisArg, 326 JSVM_Value namedPropertyData); 327 JSVM_Value(JSVM_CDECL* genericIndexedPropertyGetterCallback)(JSVM_Env env, 328 JSVM_Value index, 329 JSVM_Value thisArg, 330 JSVM_Value indexedPropertyData); 331 JSVM_Value(JSVM_CDECL* genericIndexedPropertySetterCallback)(JSVM_Env env, 332 JSVM_Value index, 333 JSVM_Value property, 334 JSVM_Value thisArg, 335 JSVM_Value indexedPropertyData); 336 JSVM_Value(JSVM_CDECL* genericIndexedPropertyDeleterCallback)(JSVM_Env env, 337 JSVM_Value index, 338 JSVM_Value thisArg, 339 JSVM_Value indexedPropertyData); 340 JSVM_Value(JSVM_CDECL* genericIndexedPropertyEnumeratorCallback)(JSVM_Env env, 341 JSVM_Value thisArg, 342 JSVM_Value indexedPropertyData); 343 JSVM_Value namedPropertyData; 344 JSVM_Value indexedPropertyData; 345} JSVM_PropertyHandlerConfigurationStruct; 346``` 347 348**JSVM_PropertyHandlerCfg** 349 350包含属性监听回调的结构的指针类型。 351 352基本用法如下: 353 354```c++ 355typedef JSVM_PropertyHandlerConfigurationStruct* JSVM_PropertyHandlerCfg; 356``` 357 358## 支持的JSVM-API接口 359 360标准JS引擎的能力通过JSVM-API提供。JSVM-API支持动态链接到不同版本的JS引擎库，从而为开发者屏蔽掉不同引擎接口的差异。JSVM-API提供引擎生命周期管理、JS context管理、JS代码执行、JS/C++互操作、执行环境快照、codecache等能力，具体可见下文。 361 362### 使用 JSVM-API 接口创建引擎实例及 JS 执行上下文环境 363 364#### 场景介绍 365 366执行JS代码需要先创建JavaScript VM，创建JS执行的上下文环境。 367 368#### 接口说明 369| 接口 | 功能说明 | 370| -------- | -------- | 371| OH_JSVM_Init| 初始化JavaScript引擎实例 | 372| OH_JSVM_CreateVM| 创建JavaScript引擎实例| 373| OH_JSVM_DestroyVM| 销毁JavaScript引擎实例 | 374| OH_JSVM_OpenVMScope| 打开一个新的VM scope，引擎实例只能在scope范围内使用，可以保证引擎实例不被销毁 | 375| OH_JSVM_CloseVMScope| 关闭VM scope | 376| OH_JSVM_CreateEnv| 创建一个新的JS执行上下文环境，并注册指定的Native函数 | 377| OH_JSVM_DestroyEnv| 销毁一个JS执行上下文环境 | 378| OH_JSVM_OpenEnvScope| 打开一个新的Env scope，Env只能在scope范围内使用 | 379| OH_JSVM_CloseEnvScope| 关闭Env scope | 380| OH_JSVM_OpenHandleScope| 打开一个Handle scope，确保scope范围内的JSVM_Value不被GC回收 | 381| OH_JSVM_CloseHandleScope| 关闭Handle scope | 382 383场景示例: 384创建及销毁JavaScript引擎实例，包含创建及销毁JS执行上下文环境 385 386```c++ 387bool VM_INIT = false; 388 389static JSVM_Value ConsoleInfo(JSVM_Env env, JSVM_CallbackInfo info) { 390 size_t argc = 1; 391 JSVM_Value args[1]; 392 char log[256] = ""; 393 size_t logLength; 394 OH_JSVM_GetCbInfo(env, info, &argc, args, NULL, NULL); 395 396 OH_JSVM_GetValueStringUtf8(env, args[0], log, 255, &logLength); 397 log[255] = 0; 398 OH_LOG_INFO(LOG_APP, "JSVM API TEST: %{public}s", log); 399 return nullptr; 400} 401 402static JSVM_Value Add(JSVM_Env env, JSVM_CallbackInfo info) { 403 size_t argc = 2; 404 JSVM_Value args[2]; 405 OH_JSVM_GetCbInfo(env, info, &argc, args, NULL, NULL); 406 double num1, num2; 407 env, OH_JSVM_GetValueDouble(env, args[0], &num1); 408 OH_JSVM_GetValueDouble(env, args[1], &num2); 409 JSVM_Value sum = nullptr; 410 OH_JSVM_CreateDouble(env, num1 + num2, &sum); 411 return sum; 412} 413 414static napi_value MyJSVMDemo([[maybe_unused]] napi_env _env, [[maybe_unused]] napi_callback_info _info) { 415 std::thread t([]() { 416 if (!VM_INIT) { 417 // JSVM only need init once 418 JSVM_InitOptions initOptions; 419 memset(&initOptions, 0, sizeof(initOptions)); 420 OH_JSVM_Init(&initOptions); 421 VM_INIT = true; 422 } 423 // create vm, and open vm scope 424 JSVM_VM vm; 425 JSVM_CreateVMOptions options; 426 memset(&options, 0, sizeof(options)); 427 OH_JSVM_CreateVM(&options, &vm); 428 429 JSVM_VMScope vmScope; 430 OH_JSVM_OpenVMScope(vm, &vmScope); 431 432 JSVM_CallbackStruct param[] = { 433 {.data = nullptr, .callback = ConsoleInfo}, 434 {.data = nullptr, .callback = Add}, 435 }; 436 JSVM_PropertyDescriptor descriptor[] = { 437 {"consoleinfo", NULL, ¶m[0], NULL, NULL, NULL, JSVM_DEFAULT}, 438 {"add", NULL, ¶m[1], NULL, NULL, NULL, JSVM_DEFAULT}, 439 }; 440 // create env, register native method, and open env scope 441 JSVM_Env env; 442 OH_JSVM_CreateEnv(vm, sizeof(descriptor) / sizeof(descriptor[0]), descriptor, &env); 443 444 JSVM_EnvScope envScope; 445 OH_JSVM_OpenEnvScope(env, &envScope); 446 447 // open handle scope 448 JSVM_HandleScope handleScope; 449 OH_JSVM_OpenHandleScope(env, &handleScope); 450 451 std::string sourceCodeStr = "\ 452{\ 453let value = add(4.96, 5.28);\ 454consoleinfo('Result is:' + value);\ 455}\ 456"; 457 // compile js script 458 JSVM_Value sourceCodeValue; 459 OH_JSVM_CreateStringUtf8(env, sourceCodeStr.c_str(), sourceCodeStr.size(), &sourceCodeValue); 460 JSVM_Script script; 461 OH_JSVM_CompileScript(env, sourceCodeValue, nullptr, 0, true, nullptr, &script); 462 JSVM_Value result; 463 // run js script 464 OH_JSVM_RunScript(env, script, &result); 465 JSVM_ValueType type; 466 OH_JSVM_Typeof(env, result, &type); 467 OH_LOG_INFO(LOG_APP, "JSVM API TEST type: %{public}d", type); 468 469 // exit vm and clean memory 470 OH_JSVM_CloseHandleScope(env, handleScope); 471 472 OH_JSVM_CloseEnvScope(env, envScope); 473 OH_JSVM_DestroyEnv(env); 474 475 OH_JSVM_CloseVMScope(vm, vmScope); 476 OH_JSVM_DestroyVM(vm); 477 }); 478 479 t.detach(); 480 481 return nullptr; 482} 483``` 484 485### 使用 JSVM-API 接口编译及执行 JS 代码 486 487#### 场景介绍 488 489编译及执行JS代码。 490 491#### 接口说明 492| 接口 | 功能说明 | 493| ------------------------------- | ---------------------------------------------------------------------------------- | 494| OH_JSVM_CompileScript | 编译JavaScript代码并返回绑定到当前环境的编译脚本 | 495| OH_JSVM_CompileScriptWithOrigin | 编译JavaScript代码并返回绑定到当前环境的编译脚本，同时传入包括 sourceMapUrl 和源文件名在内的源代码信息，用于处理 source map 信息 | 496| OH_JSVM_CompileScriptWithOptions | 通用的编译接口，通过传入 option 数组完成前面的 compile 接口全部功能，同时支持后续选项扩展 | 497| OH_JSVM_CreateCodeCache | 为编译脚本创建code cache | 498| OH_JSVM_RunScript | 执行编译脚本 | 499 500场景示例： 501编译及执行JS代码(创建vm，注册function，执行js，销毁vm)。 502 503```c++ 504#include <cstring> 505#include <fstream> 506#include <string> 507#include <vector> 508 509// 依赖libjsvm.so 510#include "ark_runtime/jsvm.h" 511 512using namespace std; 513 514static JSVM_Value Hello(JSVM_Env env, JSVM_CallbackInfo info) { 515 JSVM_Value output; 516 void* data = nullptr; 517 OH_JSVM_GetCbInfo(env, info, nullptr, nullptr, nullptr, &data); 518 OH_JSVM_CreateStringUtf8(env, (char*)data, strlen((char*)data), &output); 519 return output; 520} 521 522static JSVM_CallbackStruct hello_cb = { Hello, (void*)"Hello" }; 523 524static string srcGlobal = R"JS( 525const concat = (...args) => args.reduce((a, b) => a + b); 526)JS"; 527 528static void RunScriptWithOption(JSVM_Env env, string& src, 529 uint8_t** dataPtr = nullptr, 530 size_t* lengthPtr = nullptr) { 531 JSVM_HandleScope handleScope; 532 OH_JSVM_OpenHandleScope(env, &handleScope); 533 534 JSVM_Value jsSrc; 535 OH_JSVM_CreateStringUtf8(env, src.c_str(), src.size(), &jsSrc); 536 537 uint8_t* data = dataPtr ? *dataPtr : nullptr; 538 auto compilMode = data ? JSVM_COMPILE_MODE_CONSUME_CODE_CACHE : JSVM_COMPILE_MODE_DEFAULT; 539 size_t length = lengthPtr ? *lengthPtr : 0; 540 JSVM_Script script; 541 // 编译js代码 542 JSVM_ScriptOrigin origin { 543 // 以包名 helloworld 为例, 假如存在对应的 sourcemap, source map 的的路径可以是 /data/app/el2/100/base/com.example.helloworld/files/index.js.map 544 .sourceMapUrl = "/data/app/el2/100/base/com.example.helloworld/files/index.js.map", 545 // 源文件名字 546 .resourceName = "index.js", 547 // scirpt 在源文件中的起始行列号 548 .resourceLineOffset = 0, 549 .resourceColumnOffset = 0, 550 }; 551 JSVM_CompileOptions option[3]; 552 option[0] = { 553 .id = JSVM_COMPILE_MODE, 554 .content = { .num = compilMode } 555 }; 556 JSVM_CodeCache codeCache = { 557 .cache = data, 558 .length = length 559 }; 560 option[1] = { 561 .id = JSVM_COMPILE_CODE_CACHE, 562 .content = { .ptr = &codeCache } 563 }; 564 // JSVM_COMPILE_ENABLE_SOURCE_MAP 选项默认值为 false，若为 true 那么对应的 sourceMapUrl 必须不为空 565 option[2] = { 566 .id = JSVM_COMPILE_ENABLE_SOURCE_MAP, 567 .content = { .boolean = true } 568 }; 569 OH_JSVM_CompileScriptWithOptions(env, jsSrc, 3, option, &script); 570 571 JSVM_Value result; 572 // 执行js代码 573 OH_JSVM_RunScript(env, script, &result); 574 575 char resultStr[128]; 576 size_t size; 577 OH_JSVM_GetValueStringUtf8(env, result, resultStr, 128, &size); 578 printf("%s\n", resultStr); 579 if (dataPtr && lengthPtr && *dataPtr == nullptr) { 580 // 将js源码编译出的脚本保存到cache，可以避免重复编译，带来性能提升 581 OH_JSVM_CreateCodeCache(env, script, (const uint8_t**)dataPtr, lengthPtr); 582 printf("Code cache created with length = %ld\n", *lengthPtr); 583 } 584 585 OH_JSVM_CloseHandleScope(env, handleScope); 586} 587 588static void RunScript(JSVM_Env env, string& src, 589 bool withOrigin = false, 590 uint8_t** dataPtr = nullptr, 591 size_t* lengthPtr = nullptr) { 592 JSVM_HandleScope handleScope; 593 OH_JSVM_OpenHandleScope(env, &handleScope); 594 595 JSVM_Value jsSrc; 596 OH_JSVM_CreateStringUtf8(env, src.c_str(), src.size(), &jsSrc); 597 598 uint8_t* data = dataPtr ? *dataPtr : nullptr; 599 size_t length = lengthPtr ? *lengthPtr : 0; 600 bool cacheRejected = true; 601 JSVM_Script script; 602 // 编译js代码 603 if (withOrigin) { 604 JSVM_ScriptOrigin origin { 605 // 以包名 helloworld 为例, 假如存在对应的 sourcemap, source map 的的路径可以是 /data/app/el2/100/base/com.example.helloworld/files/index.js.map 606 .sourceMapUrl = "/data/app/el2/100/base/com.example.helloworld/files/index.js.map", 607 // 源文件名字 608 .resourceName = "index.js", 609 // scirpt 在源文件中的起始行列号 610 .resourceLineOffset = 0, 611 .resourceColumnOffset = 0, 612 }; 613 OH_JSVM_CompileScriptWithOrigin(env, jsSrc, data, length, true, &cacheRejected, &origin, &script); 614 } else { 615 OH_JSVM_CompileScript(env, jsSrc, data, length, true, &cacheRejected, &script); 616 } 617 printf("Code cache is %s\n", cacheRejected ? "rejected" : "used"); 618 619 JSVM_Value result; 620 // 执行js代码 621 OH_JSVM_RunScript(env, script, &result); 622 623 char resultStr[128]; 624 size_t size; 625 OH_JSVM_GetValueStringUtf8(env, result, resultStr, 128, &size); 626 printf("%s\n", resultStr); 627 if (dataPtr && lengthPtr && *dataPtr == nullptr) { 628 // 将js源码编译出的脚本保存到cache，可以避免重复编译，带来性能提升 629 OH_JSVM_CreateCodeCache(env, script, (const uint8_t**)dataPtr, lengthPtr); 630 printf("Code cache created with length = %ld\n", *lengthPtr); 631 } 632 633 OH_JSVM_CloseHandleScope(env, handleScope); 634} 635 636static void CreateSnapshot() { 637 JSVM_VM vm; 638 JSVM_CreateVMOptions options; 639 memset(&options, 0, sizeof(options)); 640 options.isForSnapshotting = true; 641 OH_JSVM_CreateVM(&options, &vm); 642 JSVM_VMScope vmScope; 643 OH_JSVM_OpenVMScope(vm, &vmScope); 644 645 JSVM_Env env; 646 // 将native函数注册成js可调用的方法，hello_cb中记录该native方法的指针和参数等信息 647 JSVM_PropertyDescriptor descriptors[] = { 648 { "hello", NULL, &hello_cb, NULL, NULL, NULL, JSVM_DEFAULT } 649 }; 650 OH_JSVM_CreateEnv(vm, 1, descriptors, &env); 651 652 JSVM_EnvScope envScope; 653 OH_JSVM_OpenEnvScope(env, &envScope); 654 // 执行js源码src，src中可以包含任何js语法。也可以调用已注册的native方法。 655 string src = srcGlobal + "concat(hello(), ', ', 'World from CreateSnapshot!');"; 656 RunScript(env, src, true); 657 658 // 创建snapshot，将当前的env保存到字符串，可以在某个时机通过该字符串还原出env，避免重复定义该env中的属性，带来性能提升。 659 const char* blobData = nullptr; 660 size_t blobSize = 0; 661 JSVM_Env envs[1] = { env }; 662 OH_JSVM_CreateSnapshot(vm, 1, envs, &blobData, &blobSize); 663 printf("Snapshot blob size = %ld\n", blobSize); 664 665 // 如果将snapshot保存到文件中，需要考虑应用中的文件读写权限 666 ofstream file("/data/storage/el2/base/files/blob.bin", ios::out | ios::binary | ios::trunc); 667 file.write(blobData, blobSize); 668 file.close(); 669 670 OH_JSVM_CloseEnvScope(env, envScope); 671 OH_JSVM_DestroyEnv(env); 672 OH_JSVM_CloseVMScope(vm, vmScope); 673 OH_JSVM_DestroyVM(vm); 674} 675 676void RunWithoutSnapshot(uint8_t** dataPtr, size_t* lengthPtr) { 677 // 创建虚拟机实例 678 JSVM_VM vm; 679 OH_JSVM_CreateVM(nullptr, &vm); 680 JSVM_VMScope vmScope; 681 OH_JSVM_OpenVMScope(vm, &vmScope); 682 683 JSVM_Env env; 684 // 将native函数注册成js可调用的方法，hello_cb中记录该native方法的指针和参数等信息 685 JSVM_PropertyDescriptor descriptors[] = { 686 { "hello", NULL, &hello_cb, NULL, NULL, NULL, JSVM_DEFAULT } 687 }; 688 OH_JSVM_CreateEnv(vm, 1, descriptors, &env); 689 JSVM_EnvScope envScope; 690 OH_JSVM_OpenEnvScope(env, &envScope); 691 // 执行js源码src，src中可以包含任何js语法。也可以调用已注册的native方法。 692 auto src = srcGlobal + "concat(hello(), ', ', 'World', ' from RunWithoutSnapshot!')"; 693 // 其中使用新增接口，可以覆盖原有 Compile 系列接口的功能且具有拓展性 694 RunScriptWithOption(env, src, dataPtr, lengthPtr); 695 696 OH_JSVM_CloseEnvScope(env, envScope); 697 OH_JSVM_DestroyEnv(env); 698 OH_JSVM_CloseVMScope(vm, vmScope); 699 OH_JSVM_DestroyVM(vm); 700} 701 702void RunWithSnapshot(uint8_t **dataPtr, size_t *lengthPtr) { 703 // The lifetime of blobData must not be shorter than that of the vm. 704 // 如果从文件中读取snapshot，需要考虑应用中的文件读写权限 705 vector<char> blobData; 706 ifstream file("/data/storage/el2/base/files/blob.bin", ios::in | ios::binary | ios::ate); 707 size_t blobSize = file.tellg(); 708 blobData.resize(blobSize); 709 file.seekg(0, ios::beg); 710 file.read(blobData.data(), blobSize); 711 file.close(); 712 713 // 创建虚拟机实例 714 JSVM_VM vm; 715 JSVM_CreateVMOptions options; 716 memset(&options, 0, sizeof(options)); 717 options.snapshotBlobData = blobData.data(); 718 options.snapshotBlobSize = blobSize; 719 OH_JSVM_CreateVM(&options, &vm); 720 JSVM_VMScope vmScope; 721 OH_JSVM_OpenVMScope(vm, &vmScope); 722 723 // 从快照中创建env 724 JSVM_Env env; 725 OH_JSVM_CreateEnvFromSnapshot(vm, 0, &env); 726 JSVM_EnvScope envScope; 727 OH_JSVM_OpenEnvScope(env, &envScope); 728 729 // 执行js脚本，因为快照记录的env中定义了hello()，所以无需重新定义。dataPtr中如果保存了编译后的js脚本，就能直接执行js脚本，避免从源码重复编译。 730 string src = "concat(hello(), ', ', 'World', ' from RunWithSnapshot!')"; 731 RunScript(env, src, true, dataPtr, lengthPtr); 732 733 OH_JSVM_CloseEnvScope(env, envScope); 734 OH_JSVM_DestroyEnv(env); 735 OH_JSVM_CloseVMScope(vm, vmScope); 736 OH_JSVM_DestroyVM(vm); 737} 738 739void PrintVmInfo() { 740 JSVM_VMInfo vmInfo; 741 OH_JSVM_GetVMInfo(&vmInfo); 742 printf("apiVersion: %d\n", vmInfo.apiVersion); 743 printf("engine: %s\n", vmInfo.engine); 744 printf("version: %s\n", vmInfo.version); 745 printf("cachedDataVersionTag: 0x%x\n", vmInfo.cachedDataVersionTag); 746} 747 748static intptr_t externals[] = { 749 (intptr_t)&hello_cb, 750 0, 751}; 752 753int main(int argc, char *argv[]) { 754 if (argc <= 1) { 755 printf("Usage: %s gen-snapshot|use-snapshot|no-snapshot\n", argv[0]); 756 return 0; 757 } 758 759 JSVM_InitOptions initOptions; 760 memset(&initOptions, 0, sizeof(initOptions)); 761 initOptions.externalReferences = externals; 762 // 初始化引擎，一个进程中只能初始化一次 763 OH_JSVM_Init(&initOptions); 764 PrintVmInfo(); 765 766 if (argv[1] == string("gen-snapshot")) { 767 CreateSnapshot(); 768 return 0; 769 } 770 771 // snapshot可以记录下某个时间的js执行环境，可以跨进程通过snapshot快速还原出js执行上下文环境，前提是保证snapshot数据的生命周期。 772 const auto useSnapshot = argv[1] == string("use-snapshot"); 773 const auto run = useSnapshot ? RunWithSnapshot : RunWithoutSnapshot; 774 uint8_t* data = nullptr; 775 size_t length = 0; 776 run(&data, &length); 777 run(&data, &length); 778 delete[] data; 779 780 return 0; 781} 782``` 783 784### 使用 JSVM-API WebAssembly 接口编译 wasm module 785 786#### 场景介绍 787 788JSVM-API WebAssembly 接口提供了 wasm 字节码编译、wasm 函数优化、wasm cache 序列化和反序列化的能力。 789 790#### 接口说明 791 792| 接口 | 功能说明 | 793| --------------------------- | ------------------------------------------------------------------------------------ | 794| OH_JSVM_CompileWasmModule | 将 wasm 字节码同步编译为 wasm module。如果提供了 cache 参数，先尝试将 cache 反序列为 wasm module，反序列化失败时再执行编译。 | 795| OH_JSVM_CompileWasmFunction | 将 wasm module 中指定编号的函数编译为优化后的机器码，目前只使能了最高的优化等级，函数编号的合法性由接口调用者保证。 | 796| OH_JSVM_IsWasmModuleObject | 判断传入的值是否是一个 wasm module。 | 797| OH_JSVM_CreateWasmCache | 将 wasm module 中的机器码序列化为 wasm cache，如果 wasm module 不包含机器码，则会序列化失败。 | 798| OH_JSVM_ReleaseCache | 释放由 JSVM 接口生成的 cache。传入的 cacheType 和 cacheData 必须匹配，否则会产生未定义行为。 | 799 800#### 场景示例 801 802详见[使用 JSVM-API WebAssembly 接口](use-jsvm-about-wasm.md)。 803 804### 异常处理 805 806#### 场景介绍 807 808获取、抛出、清理JS异常 809 810#### 接口说明 811| 接口 | 功能说明 | 812| -------- | -------- | 813| OH_JSVM_Throw| 抛出一个JS值 | 814| OH_JSVM_ThrowTypeError| 抛出一个JS TypeError | 815| OH_JSVM_ThrowRangeError| 抛出一个JS RangeError | 816| OH_JSVM_IsError| 判断JS值是否为JS异常 | 817| OH_JSVM_CreateError| 创建一个JS异常 | 818| OH_JSVM_CreateTypeError| 创建一个JS TypeError并返回 | 819| OH_JSVM_CreateRangeError| 创建一个JS RangeError并返回 | 820| OH_JSVM_ThrowError| 抛出一个JS异常 | 821| OH_JSVM_GetAndClearLastException| 清理并返回最后一个JS异常 | 822| OH_JSVM_IsExceptionPending| 判断当前是否有异常 | 823| OH_JSVM_GetLastErrorInfo| 获取最后一个异常的信息 | 824| OH_JSVM_ThrowSyntaxError| 抛出一个JS SyntaxError | 825| OH_JSVM_CreateSyntaxError| 创建一个JS SyntaxError并返回 | 826 827场景示例： 828以TypeError为例。创建，判断，并抛出JS TypeError。 829 830```c++ 831JSVM_Value code = nullptr; 832JSVM_Value message = nullptr; 833OH_JSVM_CreateStringUtf8(env, "500", JSVM_AUTO_LENGTH, &code); 834OH_JSVM_CreateStringUtf8(env, "type error 500", JSVM_AUTO_LENGTH, &message); 835JSVM_Value error = nullptr; 836OH_JSVM_CreateTypeError(env, code, message, &error); 837bool isError = false; 838OH_JSVM_IsError(env, error, &isError); 839OH_JSVM_ThrowTypeError(env, nullptr, "type error1"); 840``` 841 842使用OH_JSVM_GetAndClearLastException后将异常信息以字符串形式打印 843 844```c++ 845if (status != JSVM_OK) // 当执行失败出现异常时 846{ 847 bool isPending = false; 848 if (JSVM_OK == OH_JSVM_IsExceptionPending((env), &isPending) && isPending) 849 { 850 JSVM_Value error; 851 if (JSVM_OK == OH_JSVM_GetAndClearLastException((env), &error)) 852 { 853 // 获取异常堆栈 854 JSVM_Value stack; 855 OH_JSVM_GetNamedProperty((env), error, "stack", &stack); 856 857 JSVM_Value message; 858 OH_JSVM_GetNamedProperty((env), error, "message", &message); 859 860 char stackstr[256]; 861 OH_JSVM_GetValueStringUtf8(env, stack, stackstr, 256, nullptr); 862 OH_LOG_INFO(LOG_APP, "JSVM error stack: %{public}s", stackstr); 863 864 char messagestr[256]; 865 OH_JSVM_GetValueStringUtf8(env, message, messagestr, 256, nullptr); 866 OH_LOG_INFO(LOG_APP, "JSVM error message: %{public}s", messagestr); 867 } 868 } 869} 870``` 871 872### 对象生命周期管理 873 874在调用JSVM-API接口时，底层VM堆中的对象可能会作为JSVM_Values返回句柄。这些句柄必须在Native方法退出或主动释放掉前，使其关联的对象处于“活动”状态，防止被引擎回收掉。 875 876当对象句柄被返回时，它们与一个“scope”相关联。默认作用域的生命周期与本机方法调用的生命周期相关联，这些句柄及关联的对象将在Native方法的生命周期内保持活动状态。 877 878然而，在许多情况下，句柄必须保持有效的时间范围并不与Native方法的生命周期相同。下面将介绍可用于更改句柄的生命周期的JSVM-API方法。 879 880#### 对象生命周期管理接口说明 881| 接口 | 功能说明 | 882| -------- | -------- | 883| OH_JSVM_OpenHandleScope| 打开一个新的scope，在关闭该scope之前创建的对象在scope范围内不会被GC回收 | 884| OH_JSVM_CloseHandleScope| 关闭一个scope，在此scope范围内创建的对象在关闭scope后可以被GC回收| 885| OH_JSVM_OpenEscapableHandleScope| 打开一个新的scope逃逸handle scope，在关闭该scope之前创建的对象与父作用域有相同的生命周期 | 886| OH_JSVM_CloseEscapableHandleScope| 关闭一个scope，在此scope范围外创建的对象不受父作用域保护 | 887| OH_JSVM_EscapeHandle| 将 JavaScript 对象的句柄提升到外部作用域，确保在外部作用域中可以持续地使用该对象 | 888| OH_JSVM_CreateReference| 以指定的引用计数为JavaScript对象创建一个新的引用，该引用将指向传入的对象，引用允许在不同的上下文中使用和共享对象，并且可以有效地跟踪对象的生命周期 | 889| OH_JSVM_DeleteReference| 释放由 OH_JSVM_CreateReference 创建的引用，确保对象在不再被使用时能够被正确地释放和回收，避免内存泄漏 | 890| OH_JSVM_ReferenceRef| 增加由OH_JSVM_CreateReference 创建的引用的引用计数，以确保对象在有引用时不会被提前释放 | 891| OH_JSVM_ReferenceUnref| 减少由OH_JSVM_CreateReference 创建的引用的引用计数，以确保没有任何引用指向该对象时能正确地释放和回收 | 892| OH_JSVM_GetReferenceValue| 返回由 OH_JSVM_CreateReference 创建的引用的对象 | 893| OH_JSVM_RetainScript | 持久化保存一个 JSVM_Script, 使其能够跨过当前 scope 使用 | 894| OH_JSVM_ReleaseScript | 释放持久化保存过的 JSVM_Script，释放之后 JSVM_Script 不再可用，应当置为空 | 895 896场景示例： 897通过handlescope保护在scope范围内创建的对象在该范围内不被回收。 898 899```c++ 900JSVM_HandleScope scope; 901OH_JSVM_OpenHandleScope(env, &scope); 902JSVM_Value obj = nullptr; 903OH_JSVM_CreateObject(env, &obj); 904OH_JSVM_CloseHandleScope(env, scope); 905``` 906 907通过escapable handlescope保护在scope范围内创建的对象在父作用域范围内不被回收 908 909```c++ 910JSVM_EscapableHandleScope scope; 911JSVM_CALL(env, OH_JSVM_OpenEscapableHandleScope(env, &scope)); 912JSVM_Value output = NULL; 913JSVM_Value escapee = NULL; 914JSVM_CALL(env, OH_JSVM_CreateObject(env, &output)); 915JSVM_CALL(env, OH_JSVM_EscapeHandle(env, scope, output, &escapee)); 916JSVM_CALL(env, OH_JSVM_CloseEscapableHandleScope(env, scope)); 917return escapee; 918``` 919 920通过CreateReference创建对象引用和释放 921 922```c++ 923JSVM_Value obj = nullptr; 924OH_JSVM_CreateObject(env, &obj); 925// 创建引用 926JSVM_Ref reference; 927OH_JSVM_CreateReference(env, obj, 1, &reference); 928 929// 使用引用 930JSVM_Value result; 931OH_JSVM_GetReferenceValue(env, reference, &result); 932 933// 释放引用 934OH_JSVM_DeleteReference(env, reference); 935``` 936 937通过 RetainScript 持久化保存 JSVM_Script 并使用 938 939```c++ 940JSVM_HandleScope scope; 941OH_JSVM_OpenHandleScope(env, &scope); 942JSVM_Script script; 943JSVM_Value jsSrc; 944std::string src(R"JS( 945let a = 37; 946a = a * 9; 947)JS"); 948OH_JSVM_CreateStringUtf8(env, src.c_str(), src.size(), &jsSrc); 949OH_JSVM_CompileScriptWithOptions(env, jsSrc, 0, nullptr, &script); 950OH_JSVM_RetainScript(env, script); 951OH_JSVM_CloseHandleScope(env, scope); 952 953// 使用JSVM_Script 954OH_JSVM_OpenHandleScope(env, &scope); 955JSVM_Value result; 956OH_JSVM_RunScript(env, script, &result); 957 958// 释放JSVM_Script，并置空 959OH_JSVM_ReleaseScript(env, script); 960script = nullptr; 961OH_JSVM_CloseHandleScope(env, scope); 962``` 963 964### 创建JS对象类型和基本类型 965 966#### 场景介绍 967 968创建JS对象类型和基本类型 969 970#### 接口说明 971| 接口 | 功能说明 | 972| -------- | -------- | 973|OH_JSVM_CreateArray | 创建一个新的 JavaScript 数组对象 | 974|OH_JSVM_CreateArrayWithLength | 创建一个指定长度的 JavaScript 数组对象 | 975|OH_JSVM_CreateArraybuffer | 创建一个指定大小的 ArrayBuffer 对象 | 976|OH_JSVM_CreateDate | 创建了一个表示给定毫秒数的 Date 对象 | 977|OH_JSVM_CreateExternal | 创建一个包装了外部指针的 JavaScript 对象 | 978|OH_JSVM_CreateObject | 创建一个默认的JavaScript Object对象 | 979|OH_JSVM_CreateSymbol | 根据给定的描述符创建一个 Symbol 对象 | 980|OH_JSVM_SymbolFor | 在全局注册表中搜索具有给定描述的现有Symbol,如果该Symbol已经存在，它将被返回，否则将在注册表中创建一个新Symbol | 981|OH_JSVM_CreateTypedarray | 在现有的 ArrayBuffer 上创建一个 JavaScript TypedArray 对象,TypedArray 对象在底层数据缓冲区上提供类似数组的视图，其中每个元素都具有相同的底层二进制标量数据类型 | 982|OH_JSVM_CreateDataview | 在现有的 ArrayBuffer 上创建一个 JavaScript DataView 对象,DataView 对象在底层数据缓冲区上提供类似数组的视图 | 983|OH_JSVM_CreateInt32 | 根据 Int32_t 类型对象创建 JavaScript number 对象 | 984|OH_JSVM_CreateUint32 | 根据 Uint32_t 类型对象创建 JavaScript number 对象 | 985|OH_JSVM_CreateInt64 | 根据 Int64_t 类型对象创建 JavaScript number 对象 | 986|OH_JSVM_CreateDouble | 根据 Double 类型对象创建 JavaScript number 对象 | 987|OH_JSVM_CreateBigintInt64 | 根据 Int64 类型对象创建 JavaScript Bigint 对象 | 988|OH_JSVM_CreateBigintUint64 | 根据 Uint64 类型对象创建 JavaScript Bigint 对象 | 989|OH_JSVM_CreateBigintWords | 根据给定的 Uint64_t 数组创建一个 JavaScript BigInt 对象 | 990|OH_JSVM_CreateStringLatin1 | 根据 Latin-1 编码的字符串创建一个 JavaScript string 对象 | 991|OH_JSVM_CreateStringUtf16 | 根据 Utf16 编码的字符串创建一个 JavaScript string 对象 | 992|OH_JSVM_CreateStringUtf8 | 根据 Utf8 编码的字符串创建一个 JavaScript string 对象 | 993|OH_JSVM_CreateMap | 创建一个新的 JavaScript Map对象 | 994|OH_JSVM_CreateRegExp | 根据输入的字符串创建一个JavaScript 正则对象 | 995|OH_JSVM_CreateSet | 创建一个新的 JavaScript Set对象 | 996 997场景示例: 998创建指定长度的数组 999 1000```c++ 1001size_t arrayLength = 2; 1002JSVM_Value arr; 1003 1004OH_JSVM_CreateArrayWithLength(env, arrayLength, &arr); 1005for (uint32_t i = 0; i < arrayLength; i++) 1006{ 1007 JSVM_Value element; 1008 OH_JSVM_CreateUint32(env, i * 2, &element); 1009 OH_JSVM_SetElement(env, arr, i, element); 1010} 1011``` 1012 1013创建typedarray，以Int32Array为例： 1014 1015```c++ 1016JSVM_Value arrayBuffer = nullptr; 1017void *arrayBufferPtr = nullptr; 1018size_t arrayBufferSize = 16; 1019size_t typedArrayLength = 4; 1020OH_JSVM_CreateArraybuffer(env, arrayBufferSize, &arrayBufferPtr, &arrayBuffer); 1021 1022void *tmpArrayBufferPtr = nullptr; 1023size_t arrayBufferLength = 0; 1024OH_JSVM_GetArraybufferInfo(env, arrayBuffer, &tmpArrayBufferPtr, &arrayBufferLength); 1025 1026JSVM_Value result; 1027OH_JSVM_CreateTypedarray(env, JSVM_TypedarrayType::JSVM_INT32_ARRAY, typedArrayLength, arrayBuffer, 0, &result); 1028return result; 1029``` 1030 1031创建number和string: 1032 1033```c++ 1034const char *testStringStr = "test"; 1035JSVM_Value testString = nullptr; 1036OH_JSVM_CreateStringUtf8(env, testStringStr, strlen(testStringStr), &testString); 1037 1038JSVM_Value testNumber1 = nullptr; 1039JSVM_Value testNumber2 = nullptr; 1040OH_JSVM_CreateDouble(env, 10.1, &testNumber1); 1041OH_JSVM_CreateInt32(env, 10, &testNumber2); 1042``` 1043 1044创建Map: 1045 1046```c++ 1047JSVM_Value value = nullptr; 1048OH_JSVM_CreateMap(env, &value); 1049``` 1050 1051创建RegExp: 1052 1053```c++ 1054JSVM_Value value = nullptr; 1055const char testStr[] = "ab+c"; 1056OH_JSVM_CreateStringUtf8(env, testStr, strlen(testStr), &value); 1057JSVM_Value result = nullptr; 1058OH_JSVM_CreateRegExp(env, value, JSVM_RegExpFlags::JSVM_REGEXP_GLOBAL, &result); 1059``` 1060 1061创建Set: 1062 1063```c++ 1064JSVM_Value value; 1065OH_JSVM_CreateSet(env, &value); 1066``` 1067 1068### 从JS类型获取C类型&获取JS类型信息 1069 1070#### 场景介绍 1071 1072从JS类型获取C类型&获取JS类型信息。 1073 1074#### 接口说明 1075| 接口 | 功能说明 | 1076| -------- | -------- | 1077|OH_JSVM_GetArrayLength | 返回 Array 对象的长度 | 1078|OH_JSVM_GetArraybufferInfo | 检索 ArrayBuffer 的底层数据缓冲区及其长度 | 1079|OH_JSVM_GetPrototype | 获取给定 JavaScript 对象的原型 | 1080|OH_JSVM_GetTypedarrayInfo | 获取 TypedArray（类型化数组）对象的信息 | 1081|OH_JSVM_GetDataviewInfo | 获取 Dataview 对象的信息 | 1082|OH_JSVM_GetDateValue | 获取给定 JavaScript Date 的时间值的 Double 基础类型值 | 1083|OH_JSVM_GetValueBool | 获取给定 JavaScript Boolean 的 C 布尔基础类型值 | 1084|OH_JSVM_GetValueDouble | 获取给定 JavaScript number 的 Double 基础类型值 | 1085|OH_JSVM_GetValueBigintInt64 | 获取给定 JavaScript BigInt 的 Int64_t 基础类型值 | 1086|OH_JSVM_GetValueBigintUint64 | 获取给定 JavaScript BigInt 的 Uint64_t 基础类型值 | 1087|OH_JSVM_GetValueBigintWords | 获取给定 JavaScript BigInt 对象的底层数据，即 BigInt 数据的字词表示 | 1088|OH_JSVM_GetValueExternal | 获取先前传递给 OH_JSVM_CreateExternal 的外部数据指针 | 1089|OH_JSVM_GetValueInt32 | 获取给定 JavaScript number 的 Int32 基础类型值 | 1090|OH_JSVM_GetValueInt64 | 获取给定 JavaScript number 的 Int64 基础类型值 | 1091|OH_JSVM_GetValueStringLatin1 | 获取给定 JavaScript string 对象的 Latin1 编码字符串 | 1092|OH_JSVM_GetValueStringUtf8 | 获取给定 JavaScript string 对象的 Utf8 编码字符串 | 1093|OH_JSVM_GetValueStringUtf16 | 获取给定 JavaScript string 对象的 Utf16 编码字符串 | 1094|OH_JSVM_GetValueUint32 | 获取给定 JavaScript number 的 Uint32 基础类型值 | 1095|OH_JSVM_GetBoolean | 返回用于表示给定布尔值的 JavaScript 单例对象 | 1096|OH_JSVM_GetGlobal | 返回当前环境中的全局 global 对象 | 1097|OH_JSVM_GetNull | 返回 JavaScript null 对象 | 1098|OH_JSVM_GetUndefined | 返回 JavaScript Undefined 对象 | 1099 1100场景示例： 1101创建64位的BigInt，并获取64位int值。 1102 1103```c++ 1104int64_t testValue = INT64_MAX; 1105JSVM_Value result = nullptr; 1106OH_JSVM_CreateBigintInt64(env, testValue, &result); 1107int64_t resultValue = 0; 1108bool flag = false; 1109OH_JSVM_GetValueBigintInt64(env, result, &resultValue, &flag); 1110``` 1111 1112创建一个Int32Array，并获取其长度，byteoffset等信息。 1113 1114```c++ 1115JSVM_Value arrayBuffer = nullptr; 1116void *arrayBufferPtr = nullptr; 1117size_t arrayBufferSize = 16; 1118size_t typedArrayLength = 4; 1119OH_JSVM_CreateArraybuffer(env, arrayBufferSize, &arrayBufferPtr, &arrayBuffer); 1120 1121bool isArrayBuffer = false; 1122OH_JSVM_IsArraybuffer(env, arrayBuffer, &isArrayBuffer); 1123 1124JSVM_Value result; 1125OH_JSVM_CreateTypedarray(env, JSVM_TypedarrayType::JSVM_INT32_ARRAY, typedArrayLength, arrayBuffer, 0, &result); 1126 1127bool isTypedArray = false; 1128OH_JSVM_IsTypedarray(env, result, &isTypedArray); 1129 1130 1131JSVM_TypedarrayType type; 1132size_t length = 0; 1133void *data = nullptr; 1134JSVM_Value retArrayBuffer; 1135size_t byteOffset = -1; 1136OH_JSVM_GetTypedarrayInfo(env, result, &type, &length, &data, &retArrayBuffer, &byteOffset); 1137 1138 1139bool retIsArrayBuffer = false; 1140OH_JSVM_IsArraybuffer(env, retArrayBuffer, &retIsArrayBuffer); 1141void *tmpArrayBufferPtr = nullptr; 1142size_t arrayBufferLength = 0; 1143OH_JSVM_GetArraybufferInfo(env, retArrayBuffer, &tmpArrayBufferPtr, &arrayBufferLength); 1144``` 1145 1146创建utf8类型的String，并获取C字符串。 1147 1148```c++ 1149const char *testStringStr = "testString"; 1150JSVM_Value testString = nullptr; 1151OH_JSVM_CreateStringUtf8(env, testStringStr, strlen(testStringStr), &testString); 1152 1153char buffer[128]; 1154size_t bufferSize = 128; 1155size_t copied; 1156 1157OH_JSVM_GetValueStringUtf8(env, testString, buffer, bufferSize, &copied); 1158``` 1159 1160### JS值操作和抽象操作 1161 1162#### 场景介绍 1163 1164JS值操作和抽象操作。 1165 1166#### 接口说明 1167| 接口 | 功能说明 | 1168| -------- | -------- | 1169|OH_JSVM_CoerceToBool | 将目标值转换为 Boolean 类型对象| 1170|OH_JSVM_CoerceToNumber | 将目标值转换为 Number 类型对象 | 1171|OH_JSVM_CoerceToObject | 将目标值转换为 Object 类型对象 | 1172|OH_JSVM_CoerceToString | 将目标值转换为 String 类型对象 | 1173|OH_JSVM_CoerceToBigInt | 将目标值转换为 BigInt 类型对象 | 1174|OH_JSVM_Typeof | 返回 JavaScript 对象的类型 | 1175|OH_JSVM_Instanceof | 判断一个对象是否是某个构造函数的实例 | 1176|OH_JSVM_IsArray | 判断一个 JavaScript 对象是否为 Array 类型对象| 1177|OH_JSVM_IsArraybuffer | 判断一个 JavaScript 对象是否为 Arraybuffer 类型对象 | 1178|OH_JSVM_IsDate | 判断一个 JavaScript 对象是否为 Date 类型对象 | 1179|OH_JSVM_IsTypedarray | 判断一个 JavaScript 对象是否为 Typedarray 类型对象 | 1180|OH_JSVM_IsDataview | 判断一个 JavaScript 对象是否为 Dataview 类型对象 | 1181|OH_JSVM_IsUndefined | 此API检查传入的值是否为Undefined。这相当于JS中的`value === undefined`。 | 1182|OH_JSVM_IsNull | 此API检查传入的值是否为Null对象。这相当于JS中的`value === null`。 | 1183|OH_JSVM_IsNullOrUndefined | 此API检查传入的值是否为Null或Undefined。这相当于JS中的`value == null`。 | 1184|OH_JSVM_IsBoolean | 此API检查传入的值是否为Boolean。这相当于JS中的`typeof value === 'boolean'`。 | 1185|OH_JSVM_IsNumber | 此API检查传入的值是否为Number。这相当于JS中的`typeof value === 'number'`。 | 1186|OH_JSVM_IsString | 此API检查传入的值是否为String。这相当于JS中的`typeof value === 'string'`。 | 1187|OH_JSVM_IsSymbol | 此API检查传入的值是否为Symbol。这相当于JS中的`typeof value === 'symbol'`。 | 1188|OH_JSVM_IsFunction | 此API检查传入的值是否为Function。这相当于JS中的`typeof value === 'function'`。 | 1189|OH_JSVM_IsObject | 此API检查传入的值是否为Object。 | 1190|OH_JSVM_IsBigInt | 此API检查传入的值是否为BigInt。这相当于JS中的`typeof value === 'bigint'`。 | 1191|OH_JSVM_IsConstructor | 此API检查传入的值是否为构造函数。 | 1192|OH_JSVM_IsMap | 此API检查传入的值是否为Map。 | 1193|OH_JSVM_IsSet | 此API检查传入的值是否为Set。 | 1194|OH_JSVM_IsRegExp | 此API检查传入的值是否为RegExp。 | 1195|OH_JSVM_StrictEquals | 判断两个 JSVM_Value 对象是否严格相等 | 1196|OH_JSVM_Equals | 判断两个 JSVM_Value 对象是否宽松相等 | 1197|OH_JSVM_DetachArraybuffer | 调用 ArrayBuffer 对象的Detach操作 | 1198|OH_JSVM_IsDetachedArraybuffer | 检查给定的 ArrayBuffer 是否已被分离(detached) | 1199 1200场景示例: 1201判断JS值是否为数组类型 1202 1203```c++ 1204JSVM_Value array = nullptr; 1205OH_JSVM_CreateArray(env, &array); 1206bool isArray = false; 1207OH_JSVM_IsArray(env, array, &isArray); 1208``` 1209 1210将int32类型转换为string类型 1211 1212```c++ 1213int32_t num = 123; 1214JSVM_Value intValue; 1215OH_JSVM_CreateInt32(env, num, &intValue); 1216JSVM_Value stringValue; 1217OH_JSVM_CoerceToString(env, intValue, &stringValue); 1218 1219char buffer[128]; 1220size_t bufferSize = 128; 1221size_t copied = 0; 1222 1223OH_JSVM_GetValueStringUtf8(env, stringValue, buffer, bufferSize, &copied); 1224// buffer:"123"; 1225``` 1226 1227将boolean类型转换为bigint类型 1228 1229```c++ 1230JSVM_Value boolValue; 1231OH_JSVM_GetBoolean(env, false, &boolValue); 1232JSVM_Value bigIntValue; 1233OH_JSVM_CoerceToBigInt(env, boolValue, &bigIntValue); 1234``` 1235 1236判断两个JS值类型是否严格相同：先比较操作数类型，操作数类型不同就是不相等，操作数类型相同时，比较值是否相等，相等才返回true。 1237 1238```c++ 1239JSVM_Value value = nullptr; 1240JSVM_Value value1 = nullptr; 1241OH_JSVM_CreateArray(env, &value); 1242 1243OH_JSVM_CreateInt32(env, 10, &value1); 1244bool isArray = true; 1245OH_JSVM_StrictEquals(env, value, value, &isArray); 1246``` 1247 1248判断两个JS值类型是否宽松相同：判断两个操作数的类型是否相同，若不相同，且可以转换为相同的数据类型，转换为相同的数据类型后，值做严格相等比较，其他的都返回false。 1249 1250```c++ 1251JSVM_HandleScope handleScope; 1252OH_JSVM_OpenHandleScope(env, &handleScope); 1253const char testStr[] = "1"; 1254JSVM_Value lhs = nullptr; 1255OH_JSVM_CreateStringUtf8(env, testStr, strlen(testStr), &lhs); 1256JSVM_Value rhs; 1257OH_JSVM_CreateInt32(env, 1, &rhs); 1258bool isEquals = false; 1259OH_JSVM_Equals(env, lhs, rhs, &isEquals); // 这里isEquals的值是true 1260OH_JSVM_CloseHandleScope(env, handleScope); 1261``` 1262 1263判断JS值是否为构造函数 1264 1265```c++ 1266JSVM_Value SayHello(JSVM_Env env, JSVM_CallbackInfo info) 1267{ 1268 return nullptr; 1269} 1270JSVM_Value value = nullptr; 1271JSVM_CallbackStruct param; 1272param.data = nullptr; 1273param.callback = SayHello; 1274OH_JSVM_CreateFunction(env, "func", JSVM_AUTO_LENGTH, ¶m, &value); 1275bool isConstructor = false; 1276OH_JSVM_IsConstructor(env, value, &isConstructor); // 这里isConstructor的值是true 1277``` 1278 1279判断JS值是否为map类型 1280 1281```c++ 1282JSVM_Value value = nullptr; 1283OH_JSVM_CreateMap(env, &value); 1284bool isMap = false; 1285OH_JSVM_IsMap(env, value, &isMap); // 这里isMap的值是true 1286``` 1287 1288判断JS值是否为Set类型 1289 1290```c++ 1291JSVM_Value value; 1292OH_JSVM_CreateSet(env, &value); 1293bool isSet = false; 1294OH_JSVM_IsSet(env, value, &isSet); // 这里isSet的值是true 1295``` 1296 1297判断JS值是否为RegExp类型 1298 1299```c++ 1300JSVM_Value value = nullptr; 1301const char testStr[] = "ab+c"; 1302OH_JSVM_CreateStringUtf8(env, testStr, strlen(testStr), &value); 1303JSVM_Value result = nullptr; 1304OH_JSVM_CreateRegExp(env, value, JSVM_RegExpFlags::JSVM_REGEXP_GLOBAL, &result); 1305bool isRegExp = false; 1306OH_JSVM_IsRegExp(env, result, &isRegExp); 1307``` 1308 1309### JS属性操作 1310 1311#### 场景介绍 1312 1313JS对象属性的增删获取和判断 1314 1315#### 接口说明 1316| 接口 | 功能说明 | 1317| -------- | -------- | 1318|OH_JSVM_GetPropertyNames | 获取给定对象的所有可枚举属性名称, 结果变量将存储一个包含所有可枚举属性名称的JavaScript数组。 | 1319|OH_JSVM_GetAllPropertyNames | 获取给定对象的所有可用属性名称, 结果变量将存储一个包含所有可枚举属性名称的JavaScript数组。 | 1320|OH_JSVM_SetProperty | 为给定对象设置一个属性。 | 1321|OH_JSVM_GetProperty | 用给定的属性的名称，检索目标对象的属性。 | 1322|OH_JSVM_HasProperty | 用给定的属性的名称，查询目标对象是否有此属性。 | 1323|OH_JSVM_DeleteProperty | 用给定的属性的名称，删除目标对象属性。 | 1324|OH_JSVM_HasOwnProperty | 检查目标对象是否具有指定的自有属性。 | 1325|OH_JSVM_SetNamedProperty | 用给定的属性的名称为目标对象设置属性，此方法等效于使用从作为 utf8Name 传入的字符串创建的 JSVM_Value 调用 OH_JSVM_SetProperty。 | 1326|OH_JSVM_GetNamedProperty | 用给定的属性的名称，检索目标对象的属性，此方法等效于使用从作为 utf8Name 传入的字符串创建的 JSVM_Value 调用 OH_JSVM_GetProperty。 | 1327|OH_JSVM_HasNamedProperty | 用给定的属性的名称，查询目标对象是否有此属性，此方法等效于使用从作为 utf8Name 传入的字符串创建的 JSVM_Value 调用 OH_JSVM_HasProperty。 | 1328|OH_JSVM_SetElement | 在给定对象的指定索引处设置元素。 | 1329|OH_JSVM_GetElement | 获取给定对象指定索引处的元素。 | 1330|OH_JSVM_HasElement | 若给定对象的指定索引处拥有属性，获取该元素。 | 1331|OH_JSVM_DeleteElement | 尝试删除给定对象的指定索引处的元素。 | 1332|OH_JSVM_DefineProperties | 批量的向给定对象中定义属性。 | 1333|OH_JSVM_ObjectFreeze | 冻结给定的对象,防止向其添加新属性，删除现有属性，防止更改现有属性的可枚举性、可配置性或可写性，并防止更改现有属性的值。 | 1334|OH_JSVM_ObjectSeal | 密封给定的对象。这可以防止向其添加新属性，以及将所有现有属性标记为不可配置。 | 1335|OH_JSVM_ObjectSetPrototypeOf | 为给定对象设置一个原型。 | 1336|OH_JSVM_ObjectGetPrototypeOf | 获取给定JavaScript对象的原型。 | 1337 1338场景示例: 1339JS对象属性的增删获取和判断 1340 1341```c++ 1342// 创建一个空对象 1343JSVM_Value myObject = nullptr; 1344OH_JSVM_CreateObject(env, &myObject); 1345 1346// 设置属性 1347const char *testNameStr = "John Doe"; 1348JSVM_Value propValue = nullptr; 1349JSVM_Value key; 1350OH_JSVM_CreateStringUtf8(env, "name", JSVM_AUTO_LENGTH, &key); 1351OH_JSVM_CreateStringUtf8(env, testNameStr, strlen(testNameStr), &propValue); 1352OH_JSVM_SetProperty(env, myObject, key, propValue); 1353 1354// 获取属性 1355JSVM_Value propResult = nullptr; 1356OH_JSVM_GetProperty(env, myObject, key, &propResult); 1357 1358// 检查属性是否存在 1359bool hasProperty = false; 1360OH_JSVM_HasNamedProperty(env, myObject, "name", &hasProperty); 1361 // 属性存在，做相应处理... 1362 if (hasProperty) 1363 { 1364 // 获取对象的所有属性名 1365 JSVM_Value propNames = nullptr; 1366 OH_JSVM_GetPropertyNames(env, myObject, &propNames); 1367 1368 bool isArray = false; 1369 OH_JSVM_IsArray(env, propNames, &isArray); 1370 1371 uint32_t arrayLength = 0; 1372 OH_JSVM_GetArrayLength(env, propNames, &arrayLength); 1373 // 遍历属性元素 1374 for (uint32_t i = 0; i < arrayLength; i++) 1375 { 1376 bool hasElement = false; 1377 OH_JSVM_HasElement(env, propNames, i, &hasElement); 1378 1379 JSVM_Value propName = nullptr; 1380 OH_JSVM_GetElement(env, propNames, i, &propName); 1381 1382 bool hasProp = false; 1383 OH_JSVM_HasProperty(env, myObject, propName, &hasProp); 1384 1385 JSVM_Value propValue = nullptr; 1386 OH_JSVM_GetProperty(env, myObject, propName, &propValue); 1387 } 1388 } 1389 1390// 删除属性 1391OH_JSVM_DeleteProperty(env, myObject, key, &hasProperty); 1392 1393// 设置对象原型 1394JSVM_Value value; 1395OH_JSVM_CreateSet(env, &value); 1396OH_JSVM_ObjectSetPrototypeOf(env, myObject, value); 1397 1398// 获取对象原型 1399JSVM_Value proto; 1400OH_JSVM_ObjectGetPrototypeOf(env, myObject, &proto); 1401``` 1402 1403### JS函数操作 1404 1405#### 场景介绍 1406 1407JS函数操作。 1408 1409#### 接口说明 1410| 接口 | 功能说明 | 1411| -------- | -------- | 1412|OH_JSVM_CallFunction | 在C/C++侧调用JS方法 | 1413|OH_JSVM_CreateFunction | 用于创建JavaScript函数,用于从JavaScript环境中调用C/C++代码中的函数 | 1414|OH_JSVM_GetCbInfo | 从给定的callback info中获取有关调用的详细信息，如参数和this指针 | 1415|OH_JSVM_GetNewTarget | 获取构造函数调用的new.target | 1416|OH_JSVM_NewInstance | 通过给定的构造函数，构建一个实例 | 1417|OH_JSVM_CreateFunctionWithScript | 根据传入的函数体和函数参数列表，创建一个新的 JavaScript Function对象 | 1418 1419场景示例: 1420创建JavaScript函数操作 1421 1422```c++ 1423JSVM_Value SayHello(JSVM_Env env, JSVM_CallbackInfo info) 1424{ 1425 printf("Hello\n"); 1426 JSVM_Value ret; 1427 OH_JSVM_CreateInt32(env, 2, &ret); 1428 return ret; 1429} 1430 1431static JSVM_Value JsvmCreateFunction(JSVM_Env env, JSVM_CallbackInfo info) 1432{ 1433 JSVM_CallbackStruct param; 1434 param.data = nullptr; 1435 param.callback = SayHello; 1436 1437 JSVM_Value funcValue = nullptr; 1438 JSVM_Status status = OH_JSVM_CreateFunction(env, "func", JSVM_AUTO_LENGTH, ¶m, &funcValue); 1439 return funcValue; 1440} 1441``` 1442 1443在C/C++侧获取并调用JS方法 1444 1445```c++ 1446static JSVM_Value CallFunction(JSVM_Env env, JSVM_CallbackInfo info) 1447{ 1448 size_t argc = 1; 1449 JSVM_Value args[1]; 1450 JSVM_CALL(env, OH_JSVM_GetCbInfo(env, info, &argc, args, NULL, NULL)); 1451 1452 JSVM_ASSERT(env, argc >= 1, "Wrong number of arguments"); 1453 1454 JSVM_ValueType valuetype; 1455 JSVM_CALL(env, OH_JSVM_Typeof(env, args[0], &valuetype)); 1456 JSVM_ASSERT(env, valuetype == JSVM_ValueType::JSVM_FUNCTION, "Wrong type of argment. Expects a string."); 1457 1458 JSVM_Value global; 1459 JSVM_CALL(env, OH_JSVM_GetGlobal(env, &global)); 1460 1461 JSVM_Value ret; 1462 JSVM_CALL(env, OH_JSVM_CallFunction(env, global, args[0], 0, nullptr, &ret)); 1463 return ret; 1464} 1465``` 1466 1467创建Function: 1468 1469```c++ 1470JSVM_Value script; 1471OH_JSVM_CreateStringUtf8(env, "return a + b;", JSVM_AUTO_LENGTH, &script); 1472JSVM_Value param1; 1473JSVM_Value param2; 1474OH_JSVM_CreateStringUtf8(env, "a", JSVM_AUTO_LENGTH, ¶m1); 1475OH_JSVM_CreateStringUtf8(env, "b", JSVM_AUTO_LENGTH, ¶m2); 1476JSVM_Value argus[] = {param1, param2}; 1477JSVM_Value func; 1478OH_JSVM_CreateFunctionWithScript(env, "add", JSVM_AUTO_LENGTH, 2, argus, script, &func); 1479``` 1480 1481### 对象绑定操作 1482 1483#### 场景介绍 1484 1485对象绑定操作。 1486 1487#### 接口说明 1488| 接口 | 功能说明 | 1489| -------- | -------- | 1490|OH_JSVM_DefineClass| 用于在JavaScript中定义一个类，并与对应的C类进行封装和交互。它提供了创建类的构造函数、定义属性和方法的能力，以及在C和JavaScript之间进行数据交互的支持。 | 1491|OH_JSVM_Wrap| 在 JavaScript 对象中封装原生实例。稍后可以使用 OH_JSVM_Unwrap() 检索原生实例。 | 1492|OH_JSVM_Unwrap | 使用 OH_JSVM_Wrap() 检索先前封装在 JavaScript 对象中的原生实例。 | 1493|OH_JSVM_RemoveWrap | 检索先前封装在 JavaScript 对象中的原生实例并移除封装。 | 1494|OH_JSVM_TypeTagObject | 将 type_tag 指针的值与 JavaScript 对象或外部对象相关联。 | 1495|OH_JSVM_CheckObjectTypeTag | 检查给定的类型标签是否与对象上的类型标签匹配。 | 1496|OH_JSVM_AddFinalizer | 为对象添加 JSVM_Finalize 回调，以便在 JavaScript 对象被垃圾回收时调用来释放原生对象。 | 1497|OH_JSVM_DefineClassWithPropertyHandler | 定义一个具有给定类名、构造函数、属性和回调处理程序的JavaScript类，并作为函数回调进行调用。属性操作包括getter、setter、deleter、enumerator等。 | 1498 1499场景示例： 1500对象绑定操作。 1501 1502```c++ 1503static JSVM_Value AssertEqual(JSVM_Env env, JSVM_CallbackInfo info) 1504{ 1505 size_t argc = 2; 1506 JSVM_Value args[2]; 1507 JSVM_CALL(env, OH_JSVM_GetCbInfo(env, info, &argc, args, NULL, NULL)); 1508 1509 bool isStrictEquals = false; 1510 OH_JSVM_StrictEquals(env, args[0], args[1], &isStrictEquals); 1511 return nullptr; 1512} 1513 1514static napi_value TestWrap(napi_env env1, napi_callback_info info) 1515{ 1516 OH_LOG_ERROR(LOG_APP, "testWrap start"); 1517 JSVM_InitOptions init_options; 1518 memset(&init_options, 0, sizeof(init_options)); 1519 init_options.externalReferences = externals; 1520 if (aa == 0) { 1521 OH_JSVM_Init(&init_options); 1522 aa++; 1523 } 1524 JSVM_VM vm; 1525 JSVM_CreateVMOptions options; 1526 memset(&options, 0, sizeof(options)); 1527 OH_JSVM_CreateVM(&options, &vm); 1528 JSVM_VMScope vm_scope; 1529 OH_JSVM_OpenVMScope(vm, &vm_scope); 1530 JSVM_Env env; 1531 JSVM_CallbackStruct param[1]; 1532 param[0].data = nullptr; 1533 param[0].callback = AssertEqual; 1534 JSVM_PropertyDescriptor descriptor[] = { 1535 {"assertEqual", NULL, ¶m[0], NULL, NULL, NULL, JSVM_DEFAULT}, 1536 }; 1537 OH_JSVM_CreateEnv(vm, sizeof(descriptor) / sizeof(descriptor[0]), descriptor, &env); 1538 JSVM_EnvScope envScope; 1539 OH_JSVM_OpenEnvScope(env, &envScope); 1540 JSVM_HandleScope handlescope; 1541 OH_JSVM_OpenHandleScope(env, &handlescope); 1542 JSVM_Value testClass = nullptr; 1543 JSVM_CallbackStruct param1; 1544 param1.data = nullptr; 1545 param1.callback = [](JSVM_Env env, JSVM_CallbackInfo info) -> JSVM_Value { 1546 JSVM_Value thisVar = nullptr; 1547 OH_JSVM_GetCbInfo(env, info, nullptr, nullptr, &thisVar, nullptr); 1548 1549 return thisVar; 1550 }; 1551 OH_JSVM_DefineClass(env, "TestClass", JSVM_AUTO_LENGTH, ¶m1, 0, nullptr, &testClass); 1552 1553 JSVM_Value instanceValue = nullptr; 1554 OH_JSVM_NewInstance(env, testClass, 0, nullptr, &instanceValue); 1555 1556 const char *testStr = "test"; 1557 OH_JSVM_Wrap( 1558 env, instanceValue, (void *)testStr, [](JSVM_Env env, void *data, void *hint) {}, nullptr, nullptr); 1559 const char *tmpTestStr = nullptr; 1560 OH_JSVM_Unwrap(env, instanceValue, (void **)&tmpTestStr); 1561 const char *tmpTestStr1 = nullptr; 1562 OH_JSVM_RemoveWrap(env, instanceValue, (void **)&tmpTestStr1); 1563 OH_JSVM_Unwrap(env, instanceValue, (void **)&tmpTestStr1); 1564 OH_JSVM_CloseHandleScope(env, handlescope); 1565 OH_JSVM_CloseEnvScope(env, envScope); 1566 OH_JSVM_DestroyEnv(env); 1567 OH_JSVM_CloseVMScope(vm, vm_scope); 1568 OH_JSVM_DestroyVM(vm); 1569 OH_LOG_ERROR(LOG_APP, "testWrap pass"); 1570 return nullptr; 1571} 1572``` 1573 1574场景示例： 1575对象绑定及监听拦截属性操作。 1576 1577```c++ 1578static int aa = 0; 1579static JSVM_Value hello(JSVM_Env env, JSVM_CallbackInfo info) { 1580 JSVM_Value output; 1581 void *data = nullptr; 1582 OH_JSVM_GetCbInfo(env, info, nullptr, nullptr, nullptr, &data); 1583 OH_JSVM_CreateStringUtf8(env, (char *)data, strlen((char *)data), &output); 1584 return output; 1585} 1586 1587static JSVM_CallbackStruct hello_cb = {hello, (void *)"Hello"}; 1588static intptr_t externals[] = { 1589 (intptr_t)&hello_cb, 1590 0, 1591}; 1592 1593static void test1() { OH_LOG_INFO(LOG_APP, "test1 called"); } 1594 1595struct Test { 1596 void *ptr1; 1597 void *ptr2; 1598}; 1599 1600static JSVM_Value assertEqual(JSVM_Env env, JSVM_CallbackInfo info) { 1601 size_t argc = 2; 1602 JSVM_Value args[2]; 1603 JSVM_CALL(env, OH_JSVM_GetCbInfo(env, info, &argc, args, NULL, NULL)); 1604 1605 bool isStrictEquals = false; 1606 OH_JSVM_StrictEquals(env, args[0], args[1], &isStrictEquals); 1607 return nullptr; 1608} 1609 1610static JSVM_Value GetPropertyCbInfo(JSVM_Env env, JSVM_Value name, JSVM_Value thisArg, JSVM_Value data) { 1611 // 该回调是由对象上的获取请求触发的 1612 char strValue[100]; 1613 size_t size; 1614 OH_JSVM_GetValueStringUtf8(env, name, strValue, 300, &size); 1615 JSVM_Value newResult = nullptr; 1616 char newStr[] = "new return value hahaha from name listening"; 1617 OH_JSVM_CreateStringUtf8(env, newStr, strlen(newStr), &newResult); 1618 int signBit = 0; 1619 size_t wordCount = 2; 1620 uint64_t wordsOut[2] = {0ULL, 0ULL}; 1621 JSVM_Status status = OH_JSVM_GetValueBigintWords(env, data, &signBit, &wordCount, wordsOut); 1622 if (status == JSVM_OK) { 1623 OH_LOG_INFO(LOG_APP, "GetPropertyCbInfo wordCount is %{public}zu", wordCount); 1624 auto test = reinterpret_cast<Test *>(wordsOut); 1625 typedef void (*callTest1)(); 1626 callTest1 callTe = reinterpret_cast<callTest1>(test->ptr1); 1627 callTe(); 1628 } 1629 return nullptr; 1630} 1631 1632static JSVM_Value SetPropertyCbInfo(JSVM_Env env, JSVM_Value name, JSVM_Value property, JSVM_Value thisArg, JSVM_Value data) { 1633 // 该回调是由对象上的设置请求触发的 1634 char strValue[100]; 1635 size_t size; 1636 OH_JSVM_GetValueStringUtf8(env, name, strValue, 300, &size); 1637 JSVM_Value newResult = nullptr; 1638 char newStr[] = "new return value hahaha from name listening"; 1639 OH_JSVM_CreateStringUtf8(env, newStr, strlen(newStr), &newResult); 1640 int signBit = 0; 1641 size_t wordCount = 2; 1642 uint64_t wordsOut[2] = {0ULL, 0ULL}; 1643 JSVM_Status status = OH_JSVM_GetValueBigintWords(env, data, &signBit, &wordCount, wordsOut); 1644 if (status == JSVM_OK) { 1645 OH_LOG_INFO(LOG_APP, "SetPropertyCbInfo wordCount is %{public}zu", wordCount); 1646 auto test = reinterpret_cast<Test *>(wordsOut); 1647 typedef void (*callTest1)(); 1648 callTest1 callTe = reinterpret_cast<callTest1>(test->ptr1); 1649 callTe(); 1650 } 1651 return nullptr; 1652} 1653 1654static JSVM_Value DeleterPropertyCbInfo(JSVM_Env env, JSVM_Value name, JSVM_Value thisArg, JSVM_Value data) { 1655 // 该回调是由对象上的删除请求触发的 1656 char strValue[100]; 1657 size_t size; 1658 OH_JSVM_GetValueStringUtf8(env, name, strValue, 300, &size); 1659 JSVM_Value newResult = nullptr; 1660 bool returnValue = false; 1661 OH_JSVM_GetBoolean(env, returnValue, &newResult); 1662 int signBit = 0; 1663 size_t wordCount = 2; 1664 uint64_t wordsOut[2] = {0ULL, 0ULL}; 1665 JSVM_Status status = OH_JSVM_GetValueBigintWords(env, data, &signBit, &wordCount, wordsOut); 1666 if (status == JSVM_OK) { 1667 OH_LOG_INFO(LOG_APP, "DeleterPropertyCbInfo wordCount is %{public}zu", wordCount); 1668 auto test = reinterpret_cast<Test *>(wordsOut); 1669 typedef void (*callTest1)(); 1670 callTest1 callTe = reinterpret_cast<callTest1>(test->ptr1); 1671 callTe(); 1672 } 1673 return nullptr; 1674} 1675 1676static JSVM_Value EnumeratorPropertyCbInfo(JSVM_Env env, JSVM_Value thisArg, JSVM_Value data) { 1677 // 该回调是由获取对象上的所有属性请求触发的 1678 JSVM_Value testArray = nullptr; 1679 OH_JSVM_CreateArrayWithLength(env, 2, &testArray); 1680 JSVM_Value name1 = nullptr; 1681 char newStr1[] = "hahaha"; 1682 OH_JSVM_CreateStringUtf8(env, newStr1, strlen(newStr1), &name1); 1683 JSVM_Value name2 = nullptr; 1684 char newStr2[] = "heheheh"; 1685 OH_JSVM_CreateStringUtf8(env, newStr2, strlen(newStr2), &name2); 1686 1687 OH_JSVM_SetElement(env, testArray, 0, name1); 1688 OH_JSVM_SetElement(env, testArray, 1, name2); 1689 int signBit = 0; 1690 size_t wordCount = 2; 1691 uint64_t wordsOut[2] = {0ULL, 0ULL}; 1692 JSVM_Status status = OH_JSVM_GetValueBigintWords(env, data, &signBit, &wordCount, wordsOut); 1693 if (status == JSVM_OK) { 1694 OH_LOG_INFO(LOG_APP, "EnumeratorPropertyCbInfo wordCount is %{public}zu", wordCount); 1695 auto test = reinterpret_cast<Test *>(wordsOut); 1696 typedef void (*callTest1)(); 1697 callTest1 callTe = reinterpret_cast<callTest1>(test->ptr1); 1698 callTe(); 1699 } 1700 return nullptr; 1701} 1702 1703static JSVM_Value IndexedPropertyGet(JSVM_Env env, JSVM_Value index, JSVM_Value thisArg, JSVM_Value data) { 1704 // 该回调是由获取实例对象的索引属性触发的 1705 uint32_t value; 1706 OH_JSVM_GetValueUint32(env, index, &value); 1707 1708 JSVM_Value newResult = nullptr; 1709 char newStr[] = "new return value hahaha from index listening"; 1710 OH_JSVM_CreateStringUtf8(env, newStr, strlen(newStr), &newResult); 1711 int signBit = 0; 1712 size_t wordCount = 2; 1713 uint64_t wordsOut[2] = {0ULL, 0ULL}; 1714 JSVM_Status status = OH_JSVM_GetValueBigintWords(env, data, &signBit, &wordCount, wordsOut); 1715 if (status == JSVM_OK) { 1716 OH_LOG_INFO(LOG_APP, "IndexedPropertyGet wordCount is %{public}zu", wordCount); 1717 auto test = reinterpret_cast<Test *>(wordsOut); 1718 typedef void (*callTest1)(); 1719 callTest1 callTe = reinterpret_cast<callTest1>(test->ptr1); 1720 callTe(); 1721 } 1722 return nullptr; 1723} 1724 1725static JSVM_Value IndexedPropertySet(JSVM_Env env, JSVM_Value index, JSVM_Value property, JSVM_Value thisArg, JSVM_Value data) { 1726 // 该回调是由设置实例对象的索引属性触发的 1727 uint32_t value; 1728 OH_JSVM_GetValueUint32(env, index, &value); 1729 char str[100]; 1730 size_t size; 1731 OH_JSVM_GetValueStringUtf8(env, property, str, 100, &size); 1732 JSVM_Value newResult = nullptr; 1733 char newStr[] = "new return value hahaha from name listening"; 1734 OH_JSVM_CreateStringUtf8(env, newStr, strlen(newStr), &newResult); 1735 int signBit = 0; 1736 size_t wordCount = 2; 1737 uint64_t wordsOut[2] = {0ULL, 0ULL}; 1738 JSVM_Status status = OH_JSVM_GetValueBigintWords(env, data, &signBit, &wordCount, wordsOut); 1739 if (status == JSVM_OK) { 1740 OH_LOG_INFO(LOG_APP, "IndexedPropertySet wordCount is %{public}zu", wordCount); 1741 auto test = reinterpret_cast<Test *>(wordsOut); 1742 typedef void (*callTest1)(); 1743 callTest1 callTe = reinterpret_cast<callTest1>(test->ptr1); 1744 callTe(); 1745 } 1746 return nullptr; 1747} 1748 1749static JSVM_Value IndexedPropertyDeleter(JSVM_Env env, JSVM_Value index, JSVM_Value thisArg, JSVM_Value data) { 1750 // 该回调是由删除实例对象的索引属性触发的 1751 uint32_t value; 1752 OH_JSVM_GetValueUint32(env, index, &value); 1753 JSVM_Value newResult = nullptr; 1754 bool returnValue = false; 1755 OH_JSVM_GetBoolean(env, returnValue, &newResult); 1756 int signBit = 0; 1757 size_t wordCount = 2; 1758 uint64_t wordsOut[2] = {0ULL, 0ULL}; 1759 JSVM_Status status = OH_JSVM_GetValueBigintWords(env, data, &signBit, &wordCount, wordsOut); 1760 if (status == JSVM_OK) { 1761 OH_LOG_INFO(LOG_APP, "IndexedPropertyDeleter wordCount is %{public}zu", wordCount); 1762 auto test = reinterpret_cast<Test *>(wordsOut); 1763 typedef void (*callTest1)(); 1764 callTest1 callTe = reinterpret_cast<callTest1>(test->ptr1); 1765 callTe(); 1766 } 1767 return nullptr; 1768} 1769 1770static JSVM_Value IndexedPropertyEnumerator(JSVM_Env env, JSVM_Value thisArg, JSVM_Value data) { 1771 // 该回调是由获取对象上的所有索引属性请求触发的 1772 JSVM_Value testArray = nullptr; 1773 OH_JSVM_CreateArrayWithLength(env, 2, &testArray); 1774 JSVM_Value index1 = nullptr; 1775 OH_JSVM_CreateUint32(env, 1, &index1); 1776 JSVM_Value index2 = nullptr; 1777 OH_JSVM_CreateUint32(env, 2, &index2); 1778 OH_JSVM_SetElement(env, testArray, 0, index1); 1779 OH_JSVM_SetElement(env, testArray, 1, index2); 1780 int signBit = 0; 1781 size_t wordCount = 2; 1782 uint64_t wordsOut[2] = {0ULL, 0ULL}; 1783 JSVM_Status status = OH_JSVM_GetValueBigintWords(env, data, &signBit, &wordCount, wordsOut); 1784 if (status == JSVM_OK) { 1785 OH_LOG_INFO(LOG_APP, "IndexedPropertyDeleter wordCount is %{public}zu", wordCount); 1786 auto test = reinterpret_cast<Test *>(wordsOut); 1787 typedef void (*callTest1)(); 1788 callTest1 callTe = reinterpret_cast<callTest1>(test->ptr1); 1789 callTe(); 1790 } 1791 return nullptr; 1792} 1793 1794static napi_value TestDefineClassWithProperty(napi_env env1, napi_callback_info info) { 1795 OH_LOG_ERROR(LOG_APP, "TestDefineClassWithProperty start"); 1796 JSVM_InitOptions init_options; 1797 memset(&init_options, 0, sizeof(init_options)); 1798 init_options.externalReferences = externals; 1799 if (aa == 0) { 1800 OH_JSVM_Init(&init_options); 1801 aa++; 1802 } 1803 JSVM_VM vm; 1804 JSVM_CreateVMOptions options; 1805 memset(&options, 0, sizeof(options)); 1806 OH_JSVM_CreateVM(&options, &vm); 1807 JSVM_VMScope vm_scope; 1808 OH_JSVM_OpenVMScope(vm, &vm_scope); 1809 JSVM_Env env; 1810 JSVM_CallbackStruct param[1]; 1811 param[0].data = nullptr; 1812 param[0].callback = assertEqual; 1813 JSVM_PropertyDescriptor descriptor[] = { 1814 {"assertEqual", NULL, ¶m[0], NULL, NULL, NULL, JSVM_DEFAULT}, 1815 }; 1816 OH_JSVM_CreateEnv(vm, sizeof(descriptor) / sizeof(descriptor[0]), descriptor, &env); 1817 JSVM_EnvScope envScope; 1818 OH_JSVM_OpenEnvScope(env, &envScope); 1819 JSVM_HandleScope handlescope; 1820 OH_JSVM_OpenHandleScope(env, &handlescope); 1821 1822 1823 JSVM_CallbackStruct param1; 1824 param1.callback = [](JSVM_Env env, JSVM_CallbackInfo info) -> JSVM_Value { 1825 JSVM_Value thisVar = nullptr; 1826 OH_JSVM_GetCbInfo(env, info, nullptr, nullptr, &thisVar, nullptr); 1827 return thisVar; 1828 }; 1829 param1.data = nullptr; 1830 1831 JSVM_Value res = nullptr; 1832 Test *test = new Test(); 1833 test->ptr1 = (void *)test1; 1834 test->ptr2 = (void *)test1; 1835 OH_LOG_INFO(LOG_APP, "OH_JSVM_CreateBigintWords 111 word count %{public}d", 1836 sizeof(*test) / sizeof(uint64_t)); 1837 JSVM_Status status = OH_JSVM_CreateBigintWords(env, 1, 2, reinterpret_cast<const uint64_t *>(test), &res); 1838 1839 // 初始化propertyCfg 1840 JSVM_PropertyHandlerConfigurationStruct propertyCfg; 1841 propertyCfg.genericNamedPropertyGetterCallback = GetPropertyCbInfo; 1842 propertyCfg.genericNamedPropertySetterCallback = SetPropertyCbInfo; 1843 propertyCfg.genericNamedPropertyDeleterCallback = DeleterPropertyCbInfo; 1844 propertyCfg.genericNamedPropertyEnumeratorCallback = EnumeratorPropertyCbInfo; 1845 propertyCfg.genericIndexedPropertyGetterCallback = IndexedPropertyGet; 1846 propertyCfg.genericIndexedPropertySetterCallback = IndexedPropertySet; 1847 propertyCfg.genericIndexedPropertyDeleterCallback = IndexedPropertyDeleter; 1848 propertyCfg.genericIndexedPropertyEnumeratorCallback = IndexedPropertyEnumerator; 1849 propertyCfg.namedPropertyData = res; 1850 propertyCfg.indexedPropertyData = res; 1851 1852 JSVM_CallbackStruct callbackStruct; 1853 callbackStruct.callback = [](JSVM_Env env, JSVM_CallbackInfo info) -> JSVM_Value { 1854 OH_LOG_INFO(LOG_APP, "call as a function called"); 1855 JSVM_Value thisVar = nullptr; 1856 void *innerData; 1857 size_t argc = 1; 1858 JSVM_Value args[1]; 1859 OH_JSVM_GetCbInfo(env, info, &argc, args, &thisVar, &innerData); 1860 OH_LOG_INFO(LOG_APP, "function call as function result is %{public}s", reinterpret_cast<char *>(innerData)); 1861 uint32_t ret = 0; 1862 OH_JSVM_GetValueUint32(env, args[0], &ret); 1863 const char testStr[] = "hello world 111111"; 1864 JSVM_Value setvalueName = nullptr; 1865 JSVM_CALL(env, OH_JSVM_CreateStringUtf8(env, testStr, strlen(testStr), &setvalueName)); 1866 return setvalueName; 1867 }; 1868 char data[100] = "1111 hello world"; 1869 callbackStruct.data = data; 1870 JSVM_Value testWrapClass = nullptr; 1871 1872 // 将属性的访问监听注册在propertyCfg中 1873 OH_JSVM_DefineClassWithPropertyHandler(env, "TestWrapClass", NAPI_AUTO_LENGTH, ¶m1, 0, nullptr, &propertyCfg, 1874 &callbackStruct, &testWrapClass); 1875 JSVM_Value instanceValue = nullptr; 1876 OH_JSVM_NewInstance(env, testWrapClass, 0, nullptr, &instanceValue); 1877 const char testStr[] = "hello world"; 1878 JSVM_Value setvalueName = nullptr; 1879 OH_JSVM_CreateStringUtf8(env, testStr, strlen(testStr), &setvalueName); 1880 1881 // 1. 名称属性回调 1882 // 设置属性 1883 OH_JSVM_SetNamedProperty(env, instanceValue, "str11", setvalueName); 1884 OH_JSVM_SetNamedProperty(env, instanceValue, "str123", setvalueName); 1885 1886 // 获取属性 1887 JSVM_Value valueName = nullptr; 1888 OH_JSVM_GetNamedProperty(env, instanceValue, "str11", &valueName); 1889 char str[100]; 1890 size_t size; 1891 OH_JSVM_GetValueStringUtf8(env, valueName, str, 100, &size); 1892 1893 // 获取所有属性的名称 1894 JSVM_Value allPropertyNames = nullptr; 1895 OH_JSVM_GetAllPropertyNames(env, instanceValue, JSVM_KEY_OWN_ONLY, 1896 static_cast<JSVM_KeyFilter>(JSVM_KEY_ENUMERABLE | JSVM_KEY_SKIP_SYMBOLS), 1897 JSVM_KEY_NUMBERS_TO_STRINGS, &allPropertyNames); 1898 uint32_t nameSize = 0; 1899 OH_JSVM_GetArrayLength(env, allPropertyNames, &nameSize); 1900 JSVM_Value propertyName = nullptr; 1901 for (uint32_t i = 0; i < nameSize; ++i) { 1902 OH_JSVM_GetElement(env, allPropertyNames, i, &propertyName); 1903 char str[100]; 1904 size_t size; 1905 OH_JSVM_GetValueStringUtf8(env, propertyName, str, 100, &size); 1906 } 1907 1908 // 删除属性 1909 bool result = false; 1910 propertyName = nullptr; 1911 char propertyChar[] = "str11"; 1912 OH_JSVM_CreateStringUtf8(env, propertyChar, strlen(propertyChar), &propertyName); 1913 OH_JSVM_DeleteProperty(env, instanceValue, propertyName, &result); 1914 1915 // 2. 索引属性回调 1916 // 设置属性 1917 JSVM_Value jsIndex = nullptr; 1918 uint32_t index = 0; 1919 OH_JSVM_CreateUint32(env, index, &jsIndex); 1920 OH_JSVM_SetProperty(env, instanceValue, jsIndex, setvalueName); 1921 JSVM_Value jsIndex1 = nullptr; 1922 index = 1; 1923 OH_JSVM_CreateUint32(env, index, &jsIndex1); 1924 OH_JSVM_SetProperty(env, instanceValue, jsIndex1, setvalueName); 1925 1926 // 获取属性 1927 JSVM_Value valueName1 = nullptr; 1928 OH_JSVM_GetProperty(env, instanceValue, jsIndex, &valueName1); 1929 char str1[100]; 1930 size_t size1; 1931 OH_JSVM_GetValueStringUtf8(env, valueName1, str1, 100, &size1); 1932 1933 // 获取所有属性的名称 1934 JSVM_Value allPropertyNames1 = nullptr; 1935 OH_JSVM_GetAllPropertyNames(env, instanceValue, JSVM_KEY_OWN_ONLY, 1936 static_cast<JSVM_KeyFilter>(JSVM_KEY_ENUMERABLE | JSVM_KEY_SKIP_SYMBOLS), 1937 JSVM_KEY_NUMBERS_TO_STRINGS, &allPropertyNames1); 1938 uint32_t nameSize1 = 0; 1939 OH_JSVM_GetArrayLength(env, allPropertyNames1, &nameSize); 1940 JSVM_Value propertyName1 = nullptr; 1941 for (uint32_t i = 0; i < nameSize1; ++i) { 1942 OH_JSVM_GetElement(env, allPropertyNames1, i, &propertyName1); 1943 char str[100]; 1944 size_t size; 1945 OH_JSVM_GetValueStringUtf8(env, propertyName1, str, 100, &size); 1946 } 1947 1948 // 删除属性 1949 bool result1 = false; 1950 OH_JSVM_DeleteProperty(env, instanceValue, jsIndex, &result1); 1951 1952 // 3. 作为函数的回调 1953 JSVM_Value gloablObj = nullptr; 1954 OH_JSVM_GetGlobal(env, &gloablObj); 1955 OH_JSVM_SetNamedProperty(env, gloablObj, "myTestInstance", instanceValue); 1956 OH_LOG_INFO(LOG_APP, "set property on global object"); 1957 std::string innerSourcecodestr = R"( 1958 { 1959 let res = myTestInstance(12); 1960 })"; 1961 JSVM_Value innerSourcecodevalue; 1962 OH_JSVM_CreateStringUtf8(env, innerSourcecodestr.c_str(), innerSourcecodestr.size(), &innerSourcecodevalue); 1963 JSVM_Script innerscript; 1964 OH_JSVM_CompileScript(env, innerSourcecodevalue, nullptr, 0, true, nullptr, &innerscript); 1965 JSVM_Value innerResult; 1966 OH_JSVM_RunScript(env, innerscript, &innerResult); 1967 1968 OH_JSVM_CloseHandleScope(env, handlescope); 1969 OH_JSVM_CloseEnvScope(env, envScope); 1970 OH_JSVM_DestroyEnv(env); 1971 OH_JSVM_CloseVMScope(vm, vm_scope); 1972 OH_JSVM_DestroyVM(vm); 1973 OH_LOG_ERROR(LOG_APP, "TestDefineClassWithProperty pass"); 1974 return nullptr; 1975} 1976``` 1977 1978### 版本管理 1979 1980#### 场景介绍 1981 1982获取当前版本信息。 1983 1984#### 接口说明 1985| 接口 | 功能说明 | 1986| -------- | -------- | 1987|OH_JSVM_GetVersion| 返回JSVM运行时支持的最高JSVM API版本 | 1988|OH_JSVM_GetVMInfo| 返回虚拟机的信息 | 1989 1990场景示例： 1991获取当前版本信息。 1992 1993```c++ 1994JSVM_VMInfo result; 1995OH_JSVM_GetVMInfo(&result); 1996uint32_t versionId = 0; 1997OH_JSVM_GetVersion(env, &versionId); 1998``` 1999 2000### 内存管理 2001 2002#### 场景介绍 2003 2004内存管理 2005 2006#### 接口说明 2007| 接口 | 功能说明 | 2008| ------------------------------------------- | ------------------------------------------------------------------------------------------------------ | 2009| OH_JSVM_AdjustExternalMemory | 将因JavaScript对象而保持活跃的外部分配的内存大小及时通知给底层虚拟机，虚拟机后续触发GC时，就会综合内外内存状态来判断是否进行全局GC。即增大外部内存分配，则会增大触发全局GC的概率；反之减少。 | 2010| OH_JSVM_MemoryPressureNotification | 通知虚拟机系统内存压力层级，并有选择地触发垃圾回收。 | 2011| OH_JSVM_AllocateArrayBufferBackingStoreData | 申请一块 BackingStore 内存 | 2012| OH_JSVM_FreeArrayBufferBackingStoreData | 释放 BackingStore 内存 | 2013| OH_JSVM_CreateArrayBufferFromBackingStoreData | 基于申请的 BackingStore 内存创建 array buffer | 2014 2015> BackingStore 的使用属于高危操作，需要使用者自身保证内存的正确使用，请参考下方的正确示例，谨慎使用。 2016 2017场景示例： 2018内存管理。 2019 2020```c++ 2021// 分别在调用OH_JSVM_AdjustExternalMemory前后来查看底层虚拟机视角下外部分配的内存大小 2022int64_t result; 2023OH_JSVM_AdjustExternalMemory(env, 0, &result); // 假设外部分配内存的变化不变 2024OH_LOG_INFO(LOG_APP, "Before AdjustExternalMemory: %{public}lld\n", result); // 得到调整前的数值 2025// 调整外部分配的内存大小通知给底层虚拟机（此示例假设内存使用量增加） 2026int64_t memoryIncrease = 1024 * 1024; // 增加 1 MB 2027OH_JSVM_AdjustExternalMemory(env, memoryIncrease, &result); 2028OH_LOG_INFO(LOG_APP, "After AdjustExternalMemory: %{public}lld\n", result); // 得到调整后的数值 2029``` 2030```c++ 2031// 打开一个Handle scope，在scope范围内申请大量内存来测试函数功能； 2032// 分别在“完成申请后”、“关闭scope后”和“调用OH_JSVM_MemoryPressureNotification后”三个节点查看内存状态 2033JSVM_HandleScope tmpscope; 2034OH_JSVM_OpenHandleScope(env, &tmpscope); 2035for (int i = 0; i < 1000000; ++i) { 2036 JSVM_Value obj; 2037 OH_JSVM_CreateObject(env, &obj); 2038} 2039JSVM_HeapStatistics mem; 2040OH_JSVM_GetHeapStatistics(vm, &mem); // 获取虚拟机堆的统计数据 2041OH_LOG_INFO(LOG_APP, "%{public}zu\n", mem.usedHeapSize); // 申请完成后，内存处于最大状态 2042OH_JSVM_CloseHandleScope(env, tmpscope); // 关闭Handle scope 2043 2044OH_JSVM_GetHeapStatistics(vm, &mem); 2045OH_LOG_INFO(LOG_APP, "%{public}zu\n", mem.usedHeapSize); // 关闭scope后，GC并没有立即回收 2046 2047// 通知虚拟机系统内存压力层级，并有选择地触发垃圾回收 2048OH_JSVM_MemoryPressureNotification(env, JSVM_MEMORY_PRESSURE_LEVEL_CRITICAL); // 假设内存压力处于临界状态 2049 2050OH_JSVM_GetHeapStatistics(vm, &mem); 2051OH_LOG_INFO(LOG_APP, "%{public}zu\n", mem.usedHeapSize); // 触发垃圾回收后 2052``` 2053 2054BackingStore 正确使用示例 2055``` c++ 2056void *backingStore; 2057JSVM_Value arrayBuffer; 2058 2059// 申请一块大小为 100 字节的 BackingStore 内存 2060OH_JSVM_AllocateArrayBufferBackingStoreData(100, JSVM_ZERO_INITIALIZED, &backingStore); 2061 2062// 在之前申请的 BackingStore 上创建一个 ArrayBuffer，位置为距离 BackingStore 起始地址加 30 字节处，大小为 20 字节 2063OH_JSVM_CreateArrayBufferFromBackingStoreData(env, backingStore, 100, 30, 20, &arrayBuffer); 2064 2065// 在 JS 中使用创建的 ArrayBuffer 2066JSVM_Value js_global; 2067JSVM_Value name; 2068OH_JSVM_GetGlobal(jsvm_env, &js_global); 2069OH_JSVM_CreateStringUtf8(jsvm_env, "buffer", JSVM_AUTO_LENGTH, &name); 2070OH_JSVM_SetProperty(env, js_global, name, arrayBuffer); 2071 2072JSVM_Script script; 2073JSVM_Value scriptString; 2074JSVM_Value result; 2075const char *src = R"JS( 2076function writeBuffer(data) { 2077 let view = new Uint8Array(data); 2078 // Write some values to the ArrayBuffer 2079 for (let i = 0; i < view.length; i++) { 2080 view[i] = i % 256; 2081 } 2082} 2083writeBuffer(buffer) 2084)JS"; 2085OH_JSVM_CreateStringUtf8(env, src, JSVM_AUTO_LENGTH, &scriptString); 2086OH_JSVM_CompileScriptWithOptions(env, scriptString, 0, nullptr, &script); 2087OH_JSVM_RunScript(env, script, &result); 2088 2089// 检查 ArrayBuffer 的内容 2090uint8_t *array = static_cast<uint8_t*>(backingStore); 2091for (auto i = 0; i < 100; ++i) { 2092 if (array[i] != i % 25 % 256) { 2093 return false; 2094 } 2095} 2096 2097// 释放 array buffer. 注意对于这种方式创建的 ArrayBuffer, 在释放对应的 BackingStore 之前, 2098// 务必使用 OH_JSVM_DetachArraybuffer 将所有使用当前的 BackingStore 创建的 ArrayBuffer 释放 2099// 否则可能产生不可预测的内存问题，请谨慎使用 2100OH_JSVM_DetachArraybuffer(env, arrayBuffer); 2101 2102// 释放申请的 backing store 内存 2103OH_JSVM_FreeArrayBufferBackingStoreData(backingStore); 2104``` 2105### Promise操作 2106 2107#### 场景介绍 2108 2109Promise相关操作。 2110 2111#### 接口说明 2112| 接口 | 功能说明 | 2113| -------- | -------- | 2114|OH_JSVM_CreatePromise| 创建一个延迟对象和一个JavaScript promise | 2115|OH_JSVM_ResolveDeferred| 通过与之关联的延迟对象来解析JavaScript promise | 2116|OH_JSVM_RejectDeferred| 通过与之关联的延迟对象来拒绝JavaScript Promise | 2117|OH_JSVM_IsPromise| 查询Promise是否为原生Promise对象 | 2118 2119场景示例： 2120Promise相关操作。 2121 2122```c++ 2123JSVM_Deferred deferred; 2124JSVM_Value promise; 2125OH_JSVM_CreatePromise(env, &deferred, &promise); 2126 2127// 模拟异步操作 2128int result = 42; 2129bool success = true; 2130if (success) 2131{ 2132 // 解析Promise，并传递结果 2133 JSVM_Value value; 2134 OH_JSVM_CreateInt32(env, result, &value); 2135 OH_JSVM_ResolveDeferred(env, deferred, value); 2136} else { 2137 // 拒绝Promise，并传递错误信息 2138 JSVM_Value code = nullptr; 2139 JSVM_Value message = nullptr; 2140 OH_JSVM_CreateStringUtf8(env, "600", JSVM_AUTO_LENGTH, &code); 2141 OH_JSVM_CreateStringUtf8(env, "Async operation failed", JSVM_AUTO_LENGTH, &message); 2142 JSVM_Value error = nullptr; 2143 OH_JSVM_CreateError(env, code, message, &error); 2144 OH_JSVM_RejectDeferred(env, deferred, error); 2145} 2146``` 2147 2148### JSON操作 2149 2150#### 场景介绍 2151 2152JSON操作。 2153 2154#### 接口说明 2155 2156| 接口 | 功能说明 | 2157| -------- | -------- | 2158|OH_JSVM_JsonParse| 解析JSON字符串，并返回成功解析的值 | 2159|OH_JSVM_JsonStringify| 将对象字符串化，并返回成功转换后的字符串 | 2160 2161场景示例： 2162解析JSON操作。 2163 2164```c++ 2165std::string sourcecodestr = "{\"name\": \"John\", \"age\": 30, \"city\": \"New York\"}" ; 2166JSVM_Value jsonString; 2167OH_JSVM_CreateStringUtf8(env, sourcecodestr.c_str(), sourcecodestr.size(), &jsonString) 2168JSVM_Value result; 2169OH_JSVM_JsonParse(env, jsonString, &result); 2170``` 2171 2172### 创建和使用虚拟机的启动快照 2173 2174#### 场景介绍 2175 2176创建和使用虚拟机的启动快照 2177 2178#### 接口说明 2179| 接口 | 功能说明 | 2180| -------- | -------- | 2181|OH_JSVM_CreateSnapshot| 用于创建虚拟机的启动快照 | 2182|OH_JSVM_CreateEnvFromSnapshot| 基于启动快照创建jsvm环境 | 2183 2184场景示例： 2185[创建和使用虚拟机的启动快照。](use-jsvm-create-snapshot.md) 2186 2187### 检查传入的值是否可调用 2188 2189#### 场景介绍 2190 2191检查传入的值是否可调用 2192 2193#### 接口说明 2194| 接口 | 功能说明 | 2195| -------- | -------- | 2196|OH_JSVM_IsCallable| 检查传入的值是否可调用 | 2197 2198场景示例： 2199检查传入的值是否可调用 2200 2201```c++ 2202static JSVM_Value NapiIsCallable(JSVM_Env env, JSVM_CallbackInfo info) { 2203 JSVM_Value value, rst; 2204 size_t argc = 1; 2205 bool isCallable = false; 2206 JSVM_CALL(env, OH_JSVM_GetCbInfo(env, info, &argc, &value, NULL, NULL)); 2207 JSVM_CALL(env, OH_JSVM_IsCallable(env, value, &isCallable)); 2208 OH_JSVM_GetBoolean(env, isCallable, &rst); 2209 return rst; 2210} 2211 2212static napi_value MyJSVMDemo([[maybe_unused]] napi_env _env, [[maybe_unused]] napi_callback_info _info) { 2213 std::thread t([]() { 2214 // create vm, and open vm scope 2215 JSVM_VM vm; 2216 JSVM_CreateVMOptions options; 2217 memset(&options, 0, sizeof(options)); 2218 OH_JSVM_CreateVM(&options, &vm); 2219 JSVM_VMScope vmScope; 2220 OH_JSVM_OpenVMScope(vm, &vmScope); 2221 JSVM_CallbackStruct param[] = { 2222 {.data = nullptr, .callback = NapiIsCallable}, 2223 }; 2224 JSVM_PropertyDescriptor descriptor[] = { 2225 {"napiIsCallable", NULL, ¶m[0], NULL, NULL, NULL, JSVM_DEFAULT}, 2226 }; 2227 // create env, register native method, and open env scope 2228 JSVM_Env env; 2229 OH_JSVM_CreateEnv(vm, sizeof(descriptor) / sizeof(descriptor[0]), descriptor, &env); 2230 JSVM_EnvScope envScope; 2231 OH_JSVM_OpenEnvScope(env, &envScope); 2232 // open handle scope 2233 JSVM_HandleScope handleScope; 2234 OH_JSVM_OpenHandleScope(env, &handleScope); 2235 std::string sourceCodeStr = R"JS( 2236 function addNumbers(num1, num2) 2237 { 2238 var rst= num1 + num2; 2239 return rst; 2240 } 2241 let rst = napiIsCallable(addNumbers); 2242 )JS"; 2243 // compile js script 2244 JSVM_Value sourceCodeValue; 2245 OH_JSVM_CreateStringUtf8(env, sourceCodeStr.c_str(), sourceCodeStr.size(), &sourceCodeValue); 2246 JSVM_Script script; 2247 OH_JSVM_CompileScript(env, sourceCodeValue, nullptr, 0, true, nullptr, &script); 2248 JSVM_Value result; 2249 // run js script 2250 OH_JSVM_RunScript(env, script, &result); 2251 JSVM_ValueType type; 2252 OH_JSVM_Typeof(env, result, &type); 2253 OH_LOG_INFO(LOG_APP, "JSVM API TEST type: %{public}d", type); 2254 // exit vm and clean memory 2255 OH_JSVM_CloseHandleScope(env, handleScope); 2256 OH_JSVM_CloseEnvScope(env, envScope); 2257 OH_JSVM_DestroyEnv(env); 2258 OH_JSVM_CloseVMScope(vm, vmScope); 2259 OH_JSVM_DestroyVM(vm); 2260 }); 2261 t.detach(); 2262 return nullptr; 2263} 2264``` 2265 2266### Lock操作 2267 2268#### 场景介绍 2269 2270Lock操作 2271 2272#### 接口说明 2273| 接口 | 功能说明 | 2274| -------- | -------- | 2275|OH_JSVM_IsLocked| 判断当前线程是否持有指定环境的锁 | 2276|OH_JSVM_AcquireLock| 获取指定环境的锁 | 2277|OH_JSVM_ReleaseLock| 释放指定环境的锁 | 2278 2279场景示例： 2280加锁解锁操作 2281 2282```c++ 2283class LockWrapper { 2284 public: 2285 LockWrapper(JSVM_Env env) : env(env) { 2286 OH_JSVM_IsLocked(env, &isLocked); 2287 if (!isLocked) { 2288 OH_JSVM_AcquireLock(env); 2289 OH_JSVM_GetVM(env, &vm); 2290 OH_JSVM_OpenVMScope(vm, &vmScope); 2291 OH_JSVM_OpenEnvScope(env, &envScope); 2292 } 2293 } 2294 2295 ~LockWrapper() { 2296 if (!isLocked) { 2297 OH_JSVM_CloseEnvScope(env, envScope); 2298 OH_JSVM_CloseVMScope(vm, vmScope); 2299 OH_JSVM_ReleaseLock(env); 2300 } 2301 } 2302 2303 LockWrapper(const LockWrapper&) = delete; 2304 LockWrapper& operator=(const LockWrapper&) = delete; 2305 LockWrapper(LockWrapper&&) = delete; 2306 void* operator new(size_t) = delete; 2307 void* operator new[](size_t) = delete; 2308 2309 private: 2310 JSVM_Env env; 2311 JSVM_EnvScope envScope; 2312 JSVM_VMScope vmScope; 2313 JSVM_VM vm; 2314 bool isLocked; 2315}; 2316 2317static napi_value Add([[maybe_unused]] napi_env _env, [[maybe_unused]] napi_callback_info _info) { 2318 static JSVM_VM vm; 2319 static JSVM_Env env; 2320 if (aa == 0) { 2321 OH_JSVM_Init(nullptr); 2322 aa++; 2323 // create vm 2324 JSVM_CreateVMOptions options; 2325 memset(&options, 0, sizeof(options)); 2326 OH_JSVM_CreateVM(&options, &vm); 2327 // create env 2328 OH_JSVM_CreateEnv(vm, 0, nullptr, &env); 2329 } 2330 2331 std::thread t1([]() { 2332 LockWrapper lock(env); 2333 JSVM_HandleScope handleScope; 2334 OH_JSVM_OpenHandleScope(env, &handleScope); 2335 JSVM_Value value; 2336 JSVM_Status rst = OH_JSVM_CreateInt32(env, 32, &value); // 32: numerical value 2337 if (rst == JSVM_OK) { 2338 OH_LOG_INFO(LOG_APP, "JSVM:t1 OH_JSVM_CreateInt32 suc"); 2339 } else { 2340 OH_LOG_ERROR(LOG_APP, "JSVM:t1 OH_JSVM_CreateInt32 fail"); 2341 } 2342 int32_t num1; 2343 OH_JSVM_GetValueInt32(env, value, &num1); 2344 OH_LOG_INFO(LOG_APP, "JSVM:t1 num1 = %{public}d", num1); 2345 OH_JSVM_CloseHandleScope(env, handleScope); 2346 }); 2347 std::thread t2([]() { 2348 LockWrapper lock(env); 2349 JSVM_HandleScope handleScope; 2350 OH_JSVM_OpenHandleScope(env, &handleScope); 2351 JSVM_Value value; 2352 JSVM_Status rst = OH_JSVM_CreateInt32(env, 32, &value); // 32: numerical value 2353 if (rst == JSVM_OK) { 2354 OH_LOG_INFO(LOG_APP, "JSVM:t2 OH_JSVM_CreateInt32 suc"); 2355 } else { 2356 OH_LOG_ERROR(LOG_APP, "JSVM:t2 OH_JSVM_CreateInt32 fail"); 2357 } 2358 int32_t num1; 2359 OH_JSVM_GetValueInt32(env, value, &num1); 2360 OH_LOG_INFO(LOG_APP, "JSVM:t2 num1 = %{public}d", num1); 2361 OH_JSVM_CloseHandleScope(env, handleScope); 2362 }); 2363 t1.detach(); 2364 t2.detach(); 2365 return nullptr; 2366} 2367``` 2368 2369### 设置与获取和当前运行的JSVM环境相关联的数据 2370 2371#### 场景介绍 2372 2373检索通过OH_JSVM_SetInstanceData()与当前运行的JSVM环境相关联的数据 2374 2375#### 接口说明 2376| 接口 | 功能说明 | 2377| -------- | -------- | 2378|OH_JSVM_SetInstanceData| 设置与当前运行的JSVM环境相关联的数据 | 2379|OH_JSVM_GetInstanceData| 获取与当前运行的JSVM环境相关联的数据 | 2380 2381场景示例： 2382设置并获取与当前运行的JSVM环境相关联的数据。 2383 2384```c++ 2385JSVM_VM vm; 2386JSVM_CreateVMOptions options; 2387JSVM_VMScope vm_scope; 2388JSVM_Env env; 2389JSVM_EnvScope envScope; 2390JSVM_HandleScope handlescope; 2391 2392static int aa = 0; 2393struct InstanceData { 2394 int32_t value; 2395}; 2396 2397// 初始化虚拟机，创建JSVM运行环境 2398void init_JSVM_environment(){ 2399 JSVM_InitOptions init_options; 2400 memset(&init_options, 0, sizeof(init_options)); 2401 if (aa == 0) { 2402 OH_JSVM_Init(&init_options); 2403 aa++; 2404 } 2405 memset(&options, 0, sizeof(options)); 2406 OH_JSVM_CreateVM(&options, &vm); 2407 OH_JSVM_OpenVMScope(vm, &vm_scope); 2408 OH_JSVM_CreateEnv(vm, 0, nullptr, &env); 2409 OH_JSVM_OpenEnvScope(env, &envScope); 2410 OH_JSVM_OpenHandleScope(env, &handlescope); 2411} 2412 2413// 退出虚拟机，释放对应的环境 2414napi_value close_JSVM_environment(napi_env env1, napi_callback_info info) 2415{ 2416 OH_JSVM_CloseHandleScope(env, handlescope); 2417 OH_JSVM_CloseEnvScope(env, envScope); 2418 OH_JSVM_DestroyEnv(env); 2419 OH_JSVM_CloseVMScope(vm, vm_scope); 2420 OH_JSVM_DestroyVM(vm); 2421 napi_value result; 2422 char* s = "ok"; 2423 napi_create_string_latin1(env1, s, strlen(s), &result); 2424 return result; 2425} 2426 2427//清除和释放与实例相关联的内存资源 2428void InstanceFinalizeCallback(JSVM_Env env, void *finalizeData, void *finalizeHint) 2429{ 2430 if (finalizeData) { 2431 InstanceData *data = reinterpret_cast<InstanceData *>(finalizeData); 2432 free(data); 2433 *(InstanceData **)finalizeData = nullptr; 2434 } 2435} 2436 2437static napi_value GetInstanceData(napi_env env1, napi_callback_info info) 2438{ 2439 InstanceData *instanceData = reinterpret_cast<InstanceData *>(malloc(sizeof(InstanceData))); 2440 if (instanceData == nullptr) { 2441 printf("Memory allocation failed!\n"); 2442 return nullptr; 2443 } 2444 size_t argc = 1; 2445 napi_value args[1] = {nullptr}; 2446 //用于获取回调函数参数 2447 napi_get_cb_info(env1, info, &argc, args , nullptr, nullptr); 2448 napi_valuetype valuetype0; 2449 napi_typeof(env1, args[0], &valuetype0); 2450 int32_t tmp = 0; 2451 napi_get_value_int32(env1, args[0], &tmp); 2452 instanceData->value = tmp; 2453 //将获得的参数与当前运行的JSVM环境关联起来 2454 OH_JSVM_SetInstanceData(env, instanceData, InstanceFinalizeCallback, nullptr); 2455 InstanceData *resData = nullptr; 2456 //获取与当前运行的JSVM环境相关联的数据 2457 OH_JSVM_GetInstanceData(env, (void **)&resData); 2458 napi_value result; 2459 napi_create_uint32(env1, resData->value, &result); 2460 return result; 2461} 2462``` 2463 2464### 任务队列 2465 2466#### 场景介绍 2467 2468在虚拟机内部启动任务队列的运行，检查是否有微任务在队列中等待，这个任务队列可以由外部事件循环执行 2469 2470#### 接口说明 2471| 接口 | 功能说明 | 2472| -------- | -------- | 2473|OH_JSVM_PumpMessageLoop| 启动任务队列的运行 | 2474|OH_JSVM_PerformMicrotaskCheckpoint| 执行任务队列里的微任务 | 2475 2476场景示例： 2477[启动任务队列，执行任务。](use-jsvm-execute_tasks.md)