Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
207ce063
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
207ce063
编写于
6月 30, 2022
作者:
Mr-YX
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update api documents
Signed-off-by:
mr-yx
<
496043997@qq.com
>
上级
9c046975
变更
5
展开全部
隐藏空白更改
内联
并排
Showing
5 changed file
with
253 addition
and
298 deletion
+253
-298
zh-cn/application-dev/internationalization/i18n-guidelines.md
...n/application-dev/internationalization/i18n-guidelines.md
+135
-140
zh-cn/application-dev/internationalization/intl-guidelines.md
...n/application-dev/internationalization/intl-guidelines.md
+86
-102
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
+1
-12
zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md
...tion-dev/reference/apis/js-apis-bundle-ApplicationInfo.md
+0
-8
zh-cn/application-dev/reference/apis/js-apis-bytrace.md
zh-cn/application-dev/reference/apis/js-apis-bytrace.md
+31
-36
未找到文件。
zh-cn/application-dev/internationalization/i18n-guidelines.md
浏览文件 @
207ce063
此差异已折叠。
点击以展开。
zh-cn/application-dev/internationalization/intl-guidelines.md
浏览文件 @
207ce063
...
...
@@ -6,313 +6,297 @@ Intl开发指导提供了ECMA 402中定义的国际化能力接口的使用方
调用
[
Locale
](
../reference/apis/js-apis-intl.md
)
的相关接口实现最大化区域信息或最小化区域信息。
### 接口说明
| 模块 | 接口名称 | 描述 |
| -------- | -------- | -------- |
| ohos.intl | constructor()
<sup>
8+
</sup>
| 实例化Locale对象。 |
| ohos.intl | constructor(locale:
string,
options?:
LocaleOptions) | 基于locale参数及其选项实例化Locale对象。 |
| ohos.intl | toString():
string | 将Locale信息转换为字符串。 |
| ohos.intl | maximize():
Locale | 最大化区域信息。 |
| ohos.intl | minimize():
Locale | 最小化区域信息。 |
| ohos.intl | constructor(locale:string,options?:LocaleOptions) | 基于locale参数及其选项实例化Locale对象。 |
| ohos.intl | toString():string | 将Locale信息转换为字符串。 |
| ohos.intl | maximize():Locale | 最大化区域信息。 |
| ohos.intl | minimize():Locale | 最小化区域信息。 |
### 开发步骤
1.
实例化Locale对象
1.
实例化Locale对象
。
使用Locale的构造函数创建Locale对象,该方法接收一个表示Locale的字符串及可选的
[
属性
](
../reference/apis/js-apis-intl.md
)
列表(intl为导入的模块名)。
表示Locale的字符串参数可以分为以下四部分:语言、脚本、地区、扩展参数。各个部分按照顺序使用中划线“-”进行连接。
-
语言:必选,使用2个或3个小写英文字母表示(可参考ISO-639标准),例如英文使用“en”表示,中文使用“zh”表示。
-
脚本:可选,使用4个英文字母表示,其中首字母需要大写,后面3个使用小写字母(可参考ISO-15924)。例如,中文繁体使用脚本“Hant”表示,中文简体使用脚本“Hans”表示。
-
国家或地区:可选,使用两个大写字母表示(可参考ISO-3166),例如中国使用“CN”表示,美国使用“US”表示;
-
扩展参数:可选,由key和value两部分组成,目前支持以下扩展参数(可参考BCP 47扩展)。各个扩展参数之间没有严格的顺序,使用“-key-value”的格式书写。扩展参数整体使用“-u”连接到语言、脚本、地区后面。例如“zh-u-nu-latn-ca-chinese”表示使用“latn”数字系统,使用“chinese”日历系统、“latn”数字系统。扩展参数也可以通过第二个参数传入。
| 扩展参数ID | 扩展参数说明 |
| -------- | -------- |
| ca | 表示日历系统 |
| co | 表示排序规则 |
| hc | 表示守时惯例 |
| nu | 表示数字系统 |
| kn | 表示字符串排序、比较时是否考虑数字的实际值 |
| kf | 表示字符串排序、比较时是否考虑大小写 |
```
```
js
var
locale
=
"
zh-CN
"
;
var
options
=
{
caseFirst
:
false
,
calendar
:
"
chinese
"
,
collation
:
pinyin
};
var
localeObj
=
new
intl
.
Locale
(
locale
,
options
);
```
2.
获取Locale的字符串表示
2.
获取Locale的字符串表示。
调用toString方法来获取Locale对象的字符串表示,其中包括了语言、区域及其他选项信息。
```
```
js
var
localeStr
=
localeObj
.
toString
();
```
3.
最大化区域信息
3.
最大化区域信息。
调用maximize方法来最大化区域信息,即当缺少脚本与地区信息时,对其进行补全。
```
```
js
var
maximizedLocale
=
localeObj
.
maximize
();
```
4.
最小化区域信息
4.
最小化区域信息。
调用minimize方法来最小化区域信息,即当存在脚本与地区信息时,对其进行删除。
```
```
js
var
minimizedLocale
=
localeObj
.
minimize
();
```
## 格式化日期时间
调用日期时间格式化
[
DateTimeFormat
](
../reference/apis/js-apis-intl.md
)
的接口,实现针对特定Locale的日期格式化以及时间段格式化功能。
### 接口说明
| 模块 | 接口名称 | 描述 |
| -------- | -------- | -------- |
| ohos.intl | constructor()
<sup>
8+
</sup>
| 创建日期时间格式化对象。 |
| ohos.intl | constructor(locale:
string
\|
Array
<
string
>
,
options?:
DateTimeOptions) | 创建日期时间格式化对象,并设置提供的Locale和格式化相关属性。 |
| ohos.intl | format(date:
Date):
string | 依据DateTimeFormat对象的Locale及其他格式化属性,计算日期时间的格式化表示。 |
| ohos.intl | formatRange(startDate:
Date,
endDate:
Date):
string | 依据DateTimeFormat对象的Locale及其他格式化属性,计算时间段的格式化表示。 |
| ohos.intl | resolvedOptions():
DateTimeOptions | 获取DateTimeFormat对象的相关属性。 |
| ohos.intl | constructor(locale:string
\|
Array
<
string
>
,options?:DateTimeOptions) | 创建日期时间格式化对象,并设置提供的Locale和格式化相关属性。 |
| ohos.intl | format(date:Date):string | 依据DateTimeFormat对象的Locale及其他格式化属性,计算日期时间的格式化表示。 |
| ohos.intl | formatRange(startDate:Date,endDate:Date):string | 依据DateTimeFormat对象的Locale及其他格式化属性,计算时间段的格式化表示。 |
| ohos.intl | resolvedOptions():DateTimeOptions | 获取DateTimeFormat对象的相关属性。 |
### 开发步骤
1.
实例化日期时间格式化对象
1.
实例化日期时间格式化对象。
一种方法是使用DateTimeFormat提供的默认构造函数,通过访问系统语言和地区设置,获取系统默认Locale,并将其作为DateTimeFormat对象内部的Locale(intl为导入的模块名)。
```
```
js
var
dateTimeFormat
=
new
intl
.
DateTimeFormat
();
```
另一种方法是使用开发者提供的Locale和格式化参数来创建日期时间格式化对象。其中,格式化参数是可选的,完整的格式化参数列表见[DateTimeOptions](../reference/apis/js-apis-intl.md)。
```
```
js
var
options
=
{
dateStyle
:
"
full
"
,
timeStyle
:
"
full
"
};
var
dateTimeFormat
=
new
intl
.
DateTimeFormat
(
"
zh-CN
"
,
options
);
```
2.
格式化日期时间
2.
格式化日期时间。
使用DateTimeFormat的format方法对一个Date对象进行格式化,该方法会返回一个字符串作为格式化的结果。
```
```
js
Date
date
=
new
Date
();
var
formatResult
=
dateTimeFormat
.
format
(
date
);
```
3.
格式化时间段
3.
格式化时间段。
使用DateTimeFormat的formatRange方法对一个时间段进行格式化。该方法需要传入两个Date对象,分别表示时间段的起止时间,返回一个字符串作为格式化的结果。
```
```
js
Date
startDate
=
new
Date
();
Date
endDate
=
new
Date
();
var
formatResult
=
dateTimeFormat
.
formatRange
(
startDate
,
endDate
);
```
4.
访问日期时间格式化对象的相关属性
4.
访问日期时间格式化对象的相关属性。
DateTimeFormat的resolvedOptions方法会返回一个对象,该对象包含了DateTimeFormat对象的所有相关属性及其值。
```
```
js
var
options
=
dateTimeFormat
.
resolvedOptions
();
```
## 数字格式化
调用数字格式化
[
NumberFormat
](
../reference/apis/js-apis-intl.md
)
的接口,实现针对特定Locale的数字格式化功能。
### 接口说明
| 模块 | 接口名称 | 描述 |
| -------- | -------- | -------- |
| ohos.intl | constructor()
<SUP>
8+
</SUP>
| 创建数字格式化对象。 |
| ohos.intl | constructor(locale:
string
\|
Array
<
string
>
,
options?:
NumberOptions) | 创建数字格式化对象,并设置提供的locale和格式化相关属性。 |
| ohos.intl | format(number:
number):
string | 依据NumberFormat对象的Locale及其他格式化属性,计算数字的格式化表示。 |
| ohos.intl | resolvedOptions():
NumberOptions | 获取NumberFormat对象的相关属性。 |
| ohos.intl | constructor(locale:string
\|
Array
<
string
>
,options?:NumberOptions) | 创建数字格式化对象,并设置提供的locale和格式化相关属性。 |
| ohos.intl | format(number:number):string | 依据NumberFormat对象的Locale及其他格式化属性,计算数字的格式化表示。 |
| ohos.intl | resolvedOptions():NumberOptions | 获取NumberFormat对象的相关属性。 |
### 开发步骤
1.
实例化数字格式化对象
1.
实例化数字格式化对象。
一种方法是使用NumberFormat提供的默认构造函数,通过访问系统的语言和地区以获取系统默认Locale并进行设置(intl为导入的模块名)。
```
```
js
var
numberFormat
=
new
intl
.
NumberFormat
();
```
另一种方法是使用开发者提供的Locale和格式化参数来创建数字格式化对象。其中,格式化参数是可选的,完整的格式化参数列表参见[NumberOptions](../reference/apis/js-apis-intl.md)。
```
```
js
var
options
=
{
compactDisplay
:
"
short
"
,
notation
:
"
compact
"
};
var
numberFormat
=
new
intl
.
NumberFormat
(
"
zh-CN
"
,
options
);
```
2.
数字格式化
2.
数字格式化。
使用NumberFormat的format方法对传入的数字进行格式化。该方法返回一个字符串作为格式化的结果。
```
```
js
var
number
=
1234.5678
var
formatResult
=
numberFormat
.
format
(
number
);
```
3.
访问数字格式化对象的相关属性
3.
访问数字格式化对象的相关属性。
NumberFormat的resolvedOptions方法会返回一个对象,该对象包含了NumberFormat对象的所有相关属性及其值。
```
```
js
var
options
=
numberFormat
.
resolvedOptions
();
```
## 字符串排序
不同区域的用户对于字符串排序具有不同的需求。调用字符串排序
[
Collator
](
../reference/apis/js-apis-intl.md
)
的接口,实现针对特定Locale的字符串排序功能。
### 接口说明
| 模块 | 接口名称 | 描述 |
| -------- | -------- | -------- |
| ohos.intl | constructor()
<sup>
8+
</sup>
| 创建排序对象。 |
| ohos.intl | constructor(locale:
string
\|
Array
<
string
>
,
options?:
CollatorOptions)
<sup>
8+
</sup>
| 创建排序对象,并设置提供的locale和其他相关属性。 |
| ohos.intl | compare(first:
string,
second:
string):
number
<sup>
8+
</sup>
| 依据排序对象的Locale及其属性,计算两个字符串的比较结果。 |
| ohos.intl | resolvedOptions():
CollatorOptions
<sup>
8+
</sup>
| 获取排序对象的相关属性。 |
| ohos.intl | constructor(locale:string
\|
Array
<
string
>
,options?:CollatorOptions)
<sup>
8+
</sup>
| 创建排序对象,并设置提供的locale和其他相关属性。 |
| ohos.intl | compare(first:string,second:string):number
<sup>
8+
</sup>
| 依据排序对象的Locale及其属性,计算两个字符串的比较结果。 |
| ohos.intl | resolvedOptions():CollatorOptions
<sup>
8+
</sup>
| 获取排序对象的相关属性。 |
### 开发步骤
1.
实例化排序对象
1.
实例化排序对象。
一种方法是使用Collator提供的默认构造函数,通过访问系统的语言和地区以获取系统默认Locale并进行设置(intl为导入的模块名)。
```
```
js
var
collator
=
new
intl
.
Collator
();
```
另一种方法是使用开发者提供的Locale和其他相关参数来创建Collator对象,完整的参数列表参见[CollatorOptions](../reference/apis/js-apis-intl.md)。
```
```
js
var
collator
=
new
intl
.
Collator
(
"
zh-CN
"
,
{
localeMatcher
:
"
best fit
"
,
usage
:
"
sort
"
};
```
2.
比较字符串
2.
比较字符串。
使用Collator的compare方法对传入的两个字符串进行比较。该方法返回一个数值作为比较的结果,返回-1表示第一个字符串小于第二个字符串,返回1表示第一个字符大于第二个字符串,返回0表示两个字符串相同。
```
```
js
var
str1
=
"
first string
"
;
var
str2
=
"
second string
"
;
var
compareResult
=
collator
.
compare
(
str1
,
str2
);
```
3.
访问排序对象的相关属性
3.
访问排序对象的相关属性。
Collator的resolvedOptions方法会返回一个对象,该对象包含了Collator对象的所有相关属性及其值。
```
```
js
var
options
=
collator
.
resolvedOptions
();
```
## 判定单复数类别
在一些语言的语法中,当数字后面存在名词时,名词需要根据数字的值采用不同的形式。调用单复数
[
PluralRules
](
../reference/apis/js-apis-intl.md
)
的接口,可以实现针对特定Locale计算数字单复数类别的功能,从而选择合适的名词单复数表示。
### 接口说明
| 模块 | 接口名称 | 描述 |
| -------- | -------- | -------- |
| ohos.intl | constructor()
<sup>
8+
</sup>
| 创建单复数对象。 |
| ohos.intl | constructor(locale:
string
\|
Array
<
string
>
,
options?:
PluralRulesOptions)
<sup>
8+
</sup>
| 创建单复数对象,并设置提供的locale和其他相关属性。 |
| ohos.intl | select(n:
number):
string
<sup>
8+
</sup>
| 依据单复数对象的Locale及其他格式化属性,计算数字的单复数类别。 |
| ohos.intl | constructor(locale:
string
\|
Array
<
string
>
,options?:
PluralRulesOptions)
<sup>
8+
</sup>
| 创建单复数对象,并设置提供的locale和其他相关属性。 |
| ohos.intl | select(n:
number):
string
<sup>
8+
</sup>
| 依据单复数对象的Locale及其他格式化属性,计算数字的单复数类别。 |
### 开发步骤
1.
实例化单复数对象
1.
实例化单复数对象。
一种方法是使用PluralRules提供的默认构造函数,通过访问系统的语言和地区以获取系统默认Locale并进行设置(intl为导入的模块名)。
```
```
js
var
pluralRules
=
new
intl
.
PluralRules
();
```
另一种方法是使用开发者提供的Locale和其他相关参数来创建单复数对象
,
完整的参数列表参见[PluralRulesOptions](../reference/apis/js-apis-intl.md)。
另一种方法是使用开发者提供的Locale和其他相关参数来创建单复数对象
。
完整的参数列表参见[PluralRulesOptions](../reference/apis/js-apis-intl.md)。
```
```
js
var
plurals
=
new
intl
.
PluralRules
(
"
zh-CN
"
,
{
localeMatcher
:
"
best fit
"
,
type
:
"
cardinal
"
};
```
2.
计算数字单复数类别
2.
计算数字单复数类别。
使用PluralRules的select方法计算传入数字的单复数类别。该方法返回一个字符串作为传入数字的类别,包括:"zero", "one", "two", "few", "many", "other"六个类别。
```
```
js
var
number
=
1234.5678
var
categoryResult
=
plurals
.
select
(
number
);
```
## 相对时间格式化
调用相对时间格式化
[
RelativeTimeFormat
](
../reference/apis/js-apis-intl.md
)
的接口,实现针对特定Locale的相对时间格式化功能。
### 接口说明
| 模块 | 接口名称 | 描述 |
| -------- | -------- | -------- |
| ohos.intl | constructor()
<sup>
8+
</sup>
| 创建相对时间格式化对象。 |
| ohos.intl | constructor(locale:
string
\|
Array
<
string
>
,
options?:
RelativeTimeFormatInputOptions)
<sup>
8+
</sup>
| 创建相对时间格式化对象,并设置提供的locale和格式化相关属性。 |
| ohos.intl | format(value:
number,
unit:
string):
string
<sup>
8+
</sup>
| 依据相对时间格式化对象的Locale及其他格式化属性,计算相对时间的格式化表示。 |
| ohos.intl | formatToParts(value:
number,
unit:
string):
Array
<
object
>
<sup>
8+
</sup>
| 依据相对时间格式化对象的Locale及其他格式化属性,返回相对时间格式化表示的各个部分。 |
| ohos.intl | resolvedOptions():
RelativeTimeFormatResolvedOptions
<sup>
8+
</sup>
| 获取相对时间格式化对象的相关属性。 |
| ohos.intl | constructor(locale:string
\|
Array
<
string
>
,options?:RelativeTimeFormatInputOptions)
<sup>
8+
</sup>
| 创建相对时间格式化对象,并设置提供的locale和格式化相关属性。 |
| ohos.intl | format(value:number,unit:string):string
<sup>
8+
</sup>
| 依据相对时间格式化对象的Locale及其他格式化属性,计算相对时间的格式化表示。 |
| ohos.intl | formatToParts(value:number,unit:string):Array
<
object
>
<sup>
8+
</sup>
| 依据相对时间格式化对象的Locale及其他格式化属性,返回相对时间格式化表示的各个部分。 |
| ohos.intl | resolvedOptions():RelativeTimeFormatResolvedOptions
<sup>
8+
</sup>
| 获取相对时间格式化对象的相关属性。 |
### 开发步骤
1.
实例化相对时间格式化对象
一种方法是使用RelativeTimeFormat提供的默认构造函数,通过访问系统的语言和地区以获取系统默认Locale并进行设置(intl为导入的模块名)。
1.
实例化相对时间格式化对象。
一种方法是使用RelativeTimeFormat提供的默认构造函数,通过访问系统的语言和地区以获取系统默认Locale并进行设置(intl为导入的模块名)。
```
```
js
var
relativeTimeFormat
=
new
intl
.
RelativeTimeFormat
();
```
另一种方法是使用开发者提供的Locale和格式化参数来创建相对时间格式化对象。其中,格式化参数是可选的,完整的参数列表参见[ RelativeTimeFormatInputOptions](../reference/apis/js-apis-intl.md)。
```
```
js
var
relativeTimeFormat
=
new
intl
.
RelativeTimeFormat
(
"
zh-CN
"
,
{
numeric
:
"
always
"
,
style
:
"
long
"
};
```
2.
相对时间格式化
2.
相对时间格式化。
使用RelativeTimeFormat的format方法对相对时间进行格式化。方法接收一个表示相对时间长度的数值和表示单位的字符串,其中单位包括:"year", "quarter", "month", "week", "day", "hour", "minute", "second"。方法返回一个字符串作为格式化的结果。
```
```
js
var
number
=
2
;
var
unit
=
"
year
"
var
formatResult
=
relativeTimeFormat
.
format
(
number
,
unit
);
```
3.
获取相对时间格式化结果的各个部分
3.
获取相对时间格式化结果的各个部分。
获取相对时间格式化结果的各个部分,从而自定义格式化结果。
```
```
js
var
number
=
2
;
var
unit
=
"
year
"
var
formatResult
=
relativeTimeFormat
.
formatToParts
(
number
,
unit
);
```
4.
访问相对时间格式化对象的相关属性
4.
访问相对时间格式化对象的相关属性。
RelativeTimeFormat的resolvedOptions方法会返回一个对象,该对象包含了RelativeTimeFormat对象的所有相关属性及其值,完整的属性列表参见[ RelativeTimeFormatResolvedOptions](../reference/apis/js-apis-intl.md)。
```
```
js
var
options
=
numberFormat
.
resolvedOptions
();
```
...
...
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
浏览文件 @
207ce063
...
...
@@ -7,7 +7,7 @@
> API9 当前为Canary版本,仅供试用,不保证接口可稳定调用。
## 导入模块
```
```
js
import
bundle
from
'
@ohos.bundle
'
;
```
...
...
@@ -67,8 +67,6 @@ bundle.getApplicationInfo(bundleName, bundleFlags, userId)
})
```
## bundle.getApplicationInfo
getApplicationInfo(bundleName: string, bundleFlags: number, userId: number, callback: AsyncCallback
\<
ApplicationInfo>): void
...
...
@@ -107,7 +105,6 @@ bundle.getApplicationInfo(bundleName, bundleFlags, userId, (err, data) => {
})
```
## bundle.getApplicationInfo
getApplicationInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback
\<
ApplicationInfo>): void
...
...
@@ -144,7 +141,6 @@ bundle.getApplicationInfo(bundleName, bundleFlags, (err, data) => {
})
```
## bundle.getAllBundleInfo
getAllBundleInfo(bundleFlag: BundleFlag, userId?: number): Promise
<Array
\<
BundleInfo
>
>
...
...
@@ -185,8 +181,6 @@ bundle.getAllBundleInfo(bundleFlag, userId)
})
```
## bundle.getAllBundleInfo
getAllBundleInfo(bundleFlag: BundleFlag, callback: AsyncCallback
<Array
\<
BundleInfo
>
>): void
...
...
@@ -221,7 +215,6 @@ bundle.getAllBundleInfo(bundleFlag, (err, data) => {
})
```
## bundle.getAllBundleInfo
getAllBundleInfo(bundleFlag: BundleFlag, userId: number, callback: AsyncCallback
<Array
\<
BundleInfo
>
>): void
...
...
@@ -258,8 +251,6 @@ bundle.getAllBundleInfo(bundleFlag, userId, (err, data) => {
})
```
## bundle.getBundleInfo
getBundleInfo(bundleName: string, bundleFlags: number, options?: BundleOptions): Promise
\<
BundleInfo>
...
...
@@ -304,8 +295,6 @@ bundle.getBundleInfo(bundleName, bundleFlags, options)
})
```
## bundle.getBundleInfo
getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback
\<
BundleInfo>): void
...
...
zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md
浏览文件 @
207ce063
# ApplicationInfo
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
应用程序信息
**系统能力**
: 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------------------- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------------ |
| name | string | 是 | 否 | 应用程序的名称 |
...
...
zh-cn/application-dev/reference/apis/js-apis-bytrace.md
浏览文件 @
207ce063
# 性能打点
>
![icon-note.gif](public_sys-resources/icon-note.gif)
**说明:**
> **说明:**
> - 从API Version 8开始,该接口不再维护,推荐使用新接口[`@ohos.hiTraceMeter`](js-apis-hitracemeter.md)。
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
```
js
import
bytrace
from
'
@ohos.bytrace
'
;
```
## bytrace.startTrace
startTrace(name: string, taskId: number, expectedTime?: number): void
标记一个
预追踪耗时任务的开始,expectedTime是可选参数,标识该任务的期望耗时
。
标记一个
时间片跟踪事件的开始
。
**系统能力:**
SystemCapability.Developtools.Bytrace
...
...
@@ -25,26 +22,25 @@ startTrace(name: string, taskId: number, expectedTime?: number): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 |
要追踪的
任务名称 |
| name | string | 是 |
跟踪
任务名称 |
| taskId | number | 是 | 任务id |
| expectedTime | number | 否 | 期望的耗时时间
,单位:ms
|
| expectedTime | number | 否 | 期望的耗时时间
(单位:ms),可选参数
|
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 如果有多个相同name的任务需要追踪或者对同一个任务要追踪多次,并且这些
会同时被执行,则每次调用startTrace的taskId必须不一致。如果具有相同name的
任务是串行执行的,则taskId可以相同。在下面bytrace.finishTrace的示例中会举例说明。
> 如果有多个相同name的任务需要追踪或者对同一个任务要追踪多次,并且这些
跟踪任务会同时被执行,则每次调用startTrace的taskId必须不一致。如果具有相同name的跟踪
任务是串行执行的,则taskId可以相同。在下面bytrace.finishTrace的示例中会举例说明。
**示例:**
```
```
js
bytrace
.
startTrace
(
"
myTestFunc
"
,
1
);
bytrace.startTrace("myTestFunc", 1, 5); //
从startTrace到finishTrace流程的耗时期望
为5ms
bytrace
.
startTrace
(
"
myTestFunc
"
,
1
,
5
);
//
从startTrace到finishTrace流程的期望耗时
为5ms
```
## bytrace.finishTrace
finishTrace(name: string, taskId: number): void
标记一个
预追踪耗时任务
的结束。
标记一个
时间片跟踪事件
的结束。
**系统能力:**
SystemCapability.Developtools.Bytrace
...
...
@@ -52,61 +48,60 @@ finishTrace(name: string, taskId: number): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 |
要追踪的
任务名称 |
| name | string | 是 |
跟踪
任务名称 |
| taskId | number | 是 | 任务id |
>
![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
>
**说明:**<br>
> finishTrace的name和taskId必须与流程开始的startTrace对应参数值一致。
**示例:**
```
```
js
bytrace
.
finishTrace
(
"
myTestFunc
"
,
1
);
```
```
//
追
踪并行执行的同名任务
```
js
//
跟
踪并行执行的同名任务
bytrace
.
startTrace
(
"
myTestFunc
"
,
1
);
//业务流程......
bytrace.startTrace("myTestFunc", 2); //
第二个追踪的任务开始,同时第一个追踪的同名任务还没结束,出现了并行执行,对应接口的taskId需要不同。
//业务流程......
//
业务流程......
bytrace
.
startTrace
(
"
myTestFunc
"
,
2
);
//
第二个跟踪任务开始,同时第一个同名跟踪任务还没结束,出现了并行执行,对应接口的taskId需要不同
//
业务流程......
bytrace
.
finishTrace
(
"
myTestFunc
"
,
1
);
//业务流程......
//
业务流程......
bytrace
.
finishTrace
(
"
myTestFunc
"
,
2
);
```
```
//
追
踪串行执行的同名任务
```
js
//
跟
踪串行执行的同名任务
bytrace
.
startTrace
(
"
myTestFunc
"
,
1
);
//业务流程......
bytrace.finishTrace("myTestFunc", 1); //
第一个追踪的
任务结束
//业务流程......
bytrace.startTrace("myTestFunc", 1); //
第二个追踪的同名任务开始,同名的待追踪任务串行执行。
//业务流程......
//
业务流程......
bytrace
.
finishTrace
(
"
myTestFunc
"
,
1
);
//
第一个跟踪
任务结束
//
业务流程......
bytrace
.
startTrace
(
"
myTestFunc
"
,
1
);
//
第二个跟踪任务开始,同名跟踪任务串行执行
//
业务流程......
bytrace
.
finishTrace
(
"
myTestFunc
"
,
1
);
```
## bytrace.traceByValue
traceByValue(name: string, count: number): void
用来标记一个预追踪
的数值变量,该变量的数值会不断变化。
标记预追踪耗时任务
的数值变量,该变量的数值会不断变化。
**系统能力:**
SystemCapability.Developtools.Bytrace
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| name | string | 是 |
要追踪的数值变量
名称 |
| count | number | 是 | 变量的值 |
| name | string | 是 |
数值变量的
名称 |
| count | number | 是 |
数值
变量的值 |
**示例:**
```
```
js
let
traceCount
=
3
;
bytrace
.
traceByValue
(
"
myTestCount
"
,
traceCount
);
traceCount
=
4
;
bytrace
.
traceByValue
(
"
myTestCount
"
,
traceCount
);
//业务流程......
```
//
业务流程......
```
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录