性能打點

說明：
開發(fā)前請熟悉鴻蒙開發(fā)指導(dǎo)文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

• 從API Version 8開始，該接口不再維護，推薦使用新接口[@ohos.hiTraceMeter]
• 本模塊首批接口從API version 7開始支持。后續(xù)版本的新增接口，采用上角標單獨標記接口的起始版本。

導(dǎo)入模塊

import bytrace from '@ohos.bytrace';

bytrace.startTrace

startTrace(name: string, taskId: number, expectedTime?: number): void

標記一個預(yù)追蹤耗時任務(wù)的開始，expectedTime是可選參數(shù)，標識該任務(wù)的期望耗時。

系統(tǒng)能力： SystemCapability.Developtools.Bytrace

參數(shù)：

說明： 如果有多個相同name的任務(wù)需要追蹤或者對同一個任務(wù)要追蹤多次，并且這些會同時被執(zhí)行，則每次調(diào)用startTrace的taskId必須不一致。如果具有相同name的任務(wù)是串行執(zhí)行的，則taskId可以相同。在下面bytrace.finishTrace的示例中會舉例說明。

示例：

bytrace.startTrace("myTestFunc", 1);
bytrace.startTrace("myTestFunc", 1, 5); //從startTrace到finishTrace流程的耗時期望為5ms

bytrace.finishTrace

finishTrace(name: string, taskId: number): void

標記一個預(yù)追蹤耗時任務(wù)的結(jié)束。

系統(tǒng)能力： SystemCapability.Developtools.Bytrace

參數(shù)：

說明： finishTrace的name和taskId必須與流程開始的startTrace對應(yīng)參數(shù)值一致。

示例：

bytrace.finishTrace("myTestFunc", 1);

//追蹤并行執(zhí)行的同名任務(wù)
bytrace.startTrace("myTestFunc", 1);
//業(yè)務(wù)流程...... 
bytrace.startTrace("myTestFunc", 2);  //第二個追蹤的任務(wù)開始，同時第一個追蹤的同名任務(wù)還沒結(jié)束，出現(xiàn)了并行執(zhí)行，對應(yīng)接口的taskId需要不同。
//業(yè)務(wù)流程...... 
bytrace.finishTrace("myTestFunc", 1);
//業(yè)務(wù)流程...... 
bytrace.finishTrace("myTestFunc", 2);

//追蹤串行執(zhí)行的同名任務(wù)
bytrace.startTrace("myTestFunc", 1);
//業(yè)務(wù)流程...... 
bytrace.finishTrace("myTestFunc", 1);  //第一個追蹤的任務(wù)結(jié)束
//業(yè)務(wù)流程...... 
bytrace.startTrace("myTestFunc", 1);   //第二個追蹤的同名任務(wù)開始，同名的待追蹤任務(wù)串行執(zhí)行。
//業(yè)務(wù)流程...... 
bytrace.finishTrace("myTestFunc", 1);

bytrace.traceByValue

traceByValue(name: string, count: number): void

用來標記一個預(yù)追蹤的數(shù)值變量，該變量的數(shù)值會不斷變化。

系統(tǒng)能力： SystemCapability.Developtools.Bytrace

參數(shù)：

示例：

let traceCount = 3;
bytrace.traceByValue("myTestCount", traceCount);
traceCount = 4;
bytrace.traceByValue("myTestCount", traceCount);
//業(yè)務(wù)流程......

審核編輯 黃宇