HarmonyOS 应用开发之ArkData标准化数据定义，2024年最新移动端app开发流程_业界新闻

发布时间:2024-08-03 09:16

阅读量:0

工作原理

基于标准类型的层级结构，业务声明自己支持的数据类型标识符时，需要声明该类型标识符的层级逻辑，例如业务自定义图片类型UTD标识符“com.company.x-image”，并归属到general.image类中。UTD会检验自定义类型标识符，确保归属关系中不出现环状结构。

应用安装时，UTD会读取应用中自定义的数据类型进行安装，校验自定义类型数据符合约束条件后，应用自定义数据类型将被安装到设备中。应用启动
后能正常读取到应用自定义的数据类型。如果引用其他应用定义的自定义数据类型，需要在应用开发时一并写入自定义数据类型配置文件中。

约束限制

针对自定义的类型描述各字段，有以下相关要求和限制：

typeId： 定义标准化数据类型的ID，该ID具有唯一性，由应用bundleName + 具体类型名组成，不可缺省，允许包含数字、大小写字母、-和.。
belongingToTypes： 定义标准化数据类型的归属关系，即该标准化数据类型归属于哪个更高层级的类型，所属类型可以为多个，但是必须为已存在的数据
类型（标准化数据类型预置类型或其他新增自定义数据类型），不能为应用自定义类型本身，不能为空，且与现有标准化数据类型、其他新增自定义数据类型不能形成环行依赖结构。
FilenameExtensions： 应用自定义标准化数据类型所关联的文件后缀。可以缺省；可以为多个，每个后缀为以.开头且长度不超过127的字符串。
mimeTypes： 应用自定义标准化数据类型所关联的web消息数据类型。可以缺省；可以为多个，每个类型为长度不超过127的字符串。
description： 应用自定义标准化数据类型的简要说明。可以缺省；填写时，长度为不超过255的字符串。
referenceURL： 应用自定义标准化数据类型的参考链接URL，用于描述类型的详细信息。可以缺省；填写时，长度为不超过255的字符串。

开发步骤

下面以新增媒体类文件类型场景为例，说明如何自定义UTD标准化数据类型。

当前应用在entry\src\main\resources\rawfile\arkdata\utd\目录下新增utd.json5文件。
在当前应用的utd.json5配置文件内新增所需的自定义数据类型。

{
“UniformDataTypeDeclarations”: [
{
“typeId”: “com.example.myFirstHap.image”,
“belongingToTypes”: [“general.image”],
“FilenameExtensions”: [“.myImage”, “.khImage”],
“mimeTypes”: [“application/myImage”, “application/khImage”],
“description”: “My Image.”,
“referenceURL”: “”
},
{
“typeId”: “com.example.myFirstHap.audio”,
“belongingToTypes”: [“general.audio”],
“FilenameExtensions”: [“.myAudio”, “.khAudio”],
“mimeTypes”: [“application/myAudio”, “application/khAudio”],
“description”: “My audio.”,
“referenceURL”: “”
},
{
“typeId”: “com.example.myFirstHap.video”,
“belongingToTypes”: [“general.video”],
“FilenameExtensions”: [“.myVideo”, “.khVideo”],
“mimeTypes”: [“application/myVideo”, “application/khVideo”],
“description”: “My video.”,
“referenceURL”: “”
}
]
}

如果其他应用要直接使用当前应用内的自定义数据类型，需要在其应用的entry\src\main\resources\rawfile\arkdata\utd\目录下新增utd.json5文件。

然后在utd.json5配置文件中进行以下声明：

{
“ReferenceUniformDataTypeDeclarations”: [
{
“typeId”: “com.example.myFirstHap.image”,
“belongingToTypes”: [“general.image”],
“FilenameExtensions”: [“.myImage”, “.khImage”],
“mimeTypes”: [“application/myImage”, “application/khImage”],
“description”: “My Image.”,
“referenceURL”: “”
}
]
}

其他应用也可以在引用当前应用内的自定义数据类型之后，基于已引用的自定义数据类型进行自定义。utd.json5配置文件示例如下：

{
“UniformDataTypeDeclarations”: [
{
“typeId”: “com.example.mySecondHap.image”,
“belongingToTypes”: [“com.example.myFirstHap.image”],
“FilenameExtensions”: [“.myImageEx”, “.khImageEx”],
“mimeTypes”: [“application/my-ImageEx”, “application/khImageEx”],
“description”: “My Image extension.”,
“referenceURL”: “”
}
]
}

接口说明

以下是UTD常用接口说明，对于预置数据类型和应用自定义数据类型同样适用，更多接口和详细说明。

接口名称	描述
UniformDataType	OpenHarmony标准化数据类型的枚举定义。此处不再展开列举各枚举。
belongsTo(type: string): boolean	判断当前标准化数据类型是否归属于指定的标准化数据类型。
isLowerLevelType(type: string): boolean	判断当前标准化数据类型是否是指定标准化数据类型的低层级类型。
isHigherLevelType(type: string): boolean	判断当前标准化数据类型是否是指定标准化数据类型的高层级类型。
getUniformDataTypeByFilenameExtension(filenameExtension: string, belongsTo?: string): string	根据给定的文件后缀名和所归属的标准化数据类型查询标准化数据类型的ID。
getUniformDataTypeByMIMEType(mimeType: string, belongsTo?: string): string	根据给定的MIME类型和所归属的标准化数据类型查询标准化数据类型的ID。

开发步骤

下面以媒体类文件的归属类型查询场景为例，说明如何使用UTD。

导入@ohos.data.uniformTypeDescriptor模块。
可根据 “.mp3” 文件后缀查询对应UTD数据类型，并查询对应UTD数据类型的具体属性。
可根据 “audio/mp3” MIMEType查询对应UTD数据类型，并查询对应UTD数据类型的具体属性。
将上述步骤查询出来的数据类型进行比较，确认类型是否相等。
根据上述步骤中查询到的标准数据类型“general.mp3”与表示音频数据的已知标准数据类型“general.audio”做比较查询，确认是否存在归属关系。

// 1.导入模块
import uniformTypeDescriptor from ‘@ohos.data.uniformTypeDescriptor’;

try {
// 2.可根据 “.mp3” 文件后缀查询对应UTD数据类型，并查询对应UTD数据类型的具体属性
let fileExtention = ‘.mp3’;
let typeId1 = uniformTypeDescriptor.getUniformDataTypeByFilenameExtension(fileExtention);
let typeObj1 = uniformTypeDescriptor.getTypeDescriptor(typeId1);
console.info(‘typeId:’ + typeObj1.typeId);
console.info(‘belongingToTypes:’ + typeObj1.belongingToTypes);
console.info(‘description:’ + typeObj1.description);
console.info(‘referenceURL:’ + typeObj1.referenceURL);

// 3.可根据 “audio/mp3” MIMEType查询对应UTD数据类型，并查询对应UTD数据类型的具体属性。
let mineType = ‘audio/mp3’;
let typeId2 = uniformTypeDescriptor.getUniformDataTypeByMIMEType(mineType);
let typeObj2 = uniformTypeDescriptor.getTypeDescriptor(typeId2);
console.info(‘typeId:’ + typeObj2.typeId);
console.info(‘belongingToTypes:’ + typeObj2.belongingToTypes);
console.info(‘description:’ + typeObj2.description);
console.info(‘referenceURL:’ + typeObj2.referenceURL);

// 4.将数据类型进行比较，确认是否同一种数据类型
if (typeObj1 != null && typeObj2 != null) {
let ret = typeObj1.equals(typeObj2);
console.info(‘typeObj1 equals typeObj2, ret:’ + ret);
}

// 5.将查询到的标准数据类型“general.mp3”与表示音频数据的已知标准数据类型“general.audio”做比较查询，确认是否存在归属关系。
if (typeObj1 != null) {
let ret = typeObj1.belongsTo(‘general.audio’);
console.info(‘belongsTo, ret:’ + ret);
let mediaTypeObj = uniformTypeDescriptor.getTypeDescriptor(‘general.media’);
ret = mediaTypeObj.isHigherLevelType(‘general.audio’); // 确认是否存在归属关系
console.info(‘isHigherLevelType, ret:’ + ret);
}
} catch (err) {
console.error(‘err message:’ + err.message + ‘, err code:’ + err.code);
}

标准化数据结构

场景介绍

针对一些UTD标准化数据类型，为了方便业务使用，我们提供了标准化数据结构，例如OpenHarmony系统定义的桌面卡片类型（对应的标准化数据类型标识为为’openharmony.form’），我们明确定义了该数据结构对应的相关描述信息。

某些业务场景下应用可以直接使用我们具体定义的UTD标准化数据结构，例如跨应用拖拽场景。拖出方应用可以按照标准化数据结构将拖拽数据写入拖拽事件，拖入方应用从拖拽事件中读取拖拽数据并按照标准化数据结构进行数据的解析。这使得不同应用间的数据交互遵从相同的标准定义，有效减少了跨应用数据交互的开发工作量。

当前支持的标准化数据结构

UDMF针对部分标准化数据类型定义的标准化数据结构如下所示：

数据类型	数据结构	说明
‘general.text’	Text	文本
‘general.plain-text’	PlainText	纯文本
‘general.hyperlink’	Hyperlink	超链接
‘general.html’	HTML	富文本
‘general.file’	File	文件
‘general.image’	Image	图片
‘general.video’	Video	视频
‘general.audio’	Audio	音频
‘general.folder’	Folder	文件夹
‘openharmony.form’	SystemDefinedForm	卡片
‘openharmony.app-item’	SystemDefinedAppItem	图标
‘openharmony.pixel-map’	SystemDefinedPixelMap	二进制图片

约束限制

UDMF支持批量数据记录的分组管理，每个分组整体大小不超过200MB，其中PlainText、Hyperlink、HTML内单个属性值数据上限20M。

接口说明

UDMF提供了统一数据对象UnifiedData，用于封装一组数据记录UnifiedRecord。数据记录UnifiedRecord则是对UDMF支持的数据内容的抽象定义，例如一条文本记录、一条图片记录等。数据记录中的数据内容类型对应为各数据类型UniformDataType。

以下是标准化数据结构的常用接口说明，更多接口和具体说明，请见标准化数据通路和标准化数据定义与描述。

类名称	接口名称	描述
UnifiedRecord	getType(): string	获取当前数据记录对应的具体数据类型。
UnifiedData	constructor(record: UnifiedRecord)	用于创建带有一条数据记录的统一数据对象。
UnifiedData	addRecord(record: UnifiedRecord): void	在当前统一数据对象中添加一条数据记录。
UnifiedData	getRecords(): Array	将当前统一数据对象中的所有数据记录取出，通过本接口取出的数据为UnifiedRecord类型，需通过getType获取数据类型后转为子类再使用。