HarmonyOS Next跨應用跨裝置資料共享實戰：從拖拽到同步

SameX發表於2024-10-24

本文旨在深入探討華為鴻蒙HarmonyOS Next系統（截止目前API12）的技術細節，基於實際開發實踐進行總結。主要作為技術分享與交流載體，難免錯漏，歡迎各位同仁提出寶貴意見和問題，以便共同進步。本文為原創內容，任何形式的轉載必須註明出處及原作者。

概述

在當今的多終端裝置生態中，實現應用與裝置間的資料無縫互動已成為現代軟體開發的重點需求之一。華為HarmonyOS的方舟資料管理（ArkData）和統一資料管理框架（UDMF）提供了一套靈活的跨應用、跨裝置資料共享解決方案。本文將透過一個實戰案例，展示如何使用標準化資料結構實現跨應用拖拽，並利用分散式資料物件實現跨裝置資料同步，打造多終端資料共享體驗。

實戰場景

我們將在兩個不同的HarmonyOS應用之間實現資料拖拽，具體包括圖片和文字的資料互動。同時，藉助分散式資料物件，在不同裝置之間同步拖拽的資料，確保多終端資料共享。

1. 建立並使用標準化資料結構實現跨應用拖拽

HarmonyOS透過標準化資料結構，能夠有效處理不同型別的資料拖拽與共享。我們首先需要定義資料結構，使其能夠被多個應用理解並正確處理。

步驟一：定義標準化資料型別

在專案的utd.json5檔案中，定義我們需要拖拽和共享的資料型別。以圖片和純文字為例：

{
  "UniformDataTypeDeclarations": [
    {
      "TypeId": "com.example.image",
      "BelongingToTypes": ["general.image"],
      "FilenameExtensions": [".jpg", ".png"],
      "MIMETypes": ["image/jpeg", "image/png"],
      "Description": "Shared image",
      "ReferenceURL": ""
    },
    {
      "TypeId": "com.example.text",
      "BelongingToTypes": ["general.plain-text"],
      "Description": "Shared plain text",
      "ReferenceURL": ""
    }
  ]
}

步驟二：拖拽圖片和文字資料

在應用A中，實現拖拽功能，將圖片和文字資料封裝為標準化資料結構。

import { uniformDataStruct, uniformTypeDescriptor, unifiedDataChannel } from '@kit.ArkData';

let imageDetails: Record<string, string> = {
  'attr1': 'image_attribute_1',
  'attr2': 'image_attribute_2',
};

let image: uniformDataStruct.Image = {
  uniformDataType: 'com.example.image',
  url: 'path/to/image.jpg',
  description: 'This is an example image',
  details: imageDetails,
};

// 建立純文字資料
let plainTextDetails: Record<string, string> = {
  'attr1': 'text_attribute_1',
  'attr2': 'text_attribute_2',
};

let plainText: uniformDataStruct.PlainText = {
  uniformDataType: 'com.example.text',
  textContent: 'This is a plain text example',
  abstract: 'Text abstract',
  details: plainTextDetails,
};

// 將資料放入統一資料物件
let unifiedData = new unifiedDataChannel.UnifiedData();
let imageRecord = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.IMAGE, image);
let plainTextRecord = new unifiedDataChannel.UnifiedRecord(uniformTypeDescriptor.UniformDataType.PLAIN_TEXT, plainText);

unifiedData.addRecord(imageRecord);
unifiedData.addRecord(plainTextRecord);

// 將資料拖拽至目標區域
unifiedDataChannel.setDragData(unifiedData);

2. 分散式資料物件的建立、同步及跨裝置資料共享

透過分散式資料物件，我們可以輕鬆實現跨裝置的資料共享。每一個分散式資料物件例項都可以跨裝置自動同步資料。

步驟三：建立分散式資料物件

為了實現跨裝置同步，我們需要為圖片和文字資料建立分散式資料物件。首先，在裝置A上建立資料物件：

import { distributedDataObject } from '@kit.ArkData';

let sessionId = distributedDataObject.genSessionId();
let dataObject = distributedDataObject.create(this.context, unifiedData);

// 設定同步的sessionId
dataObject.setSessionId(sessionId);

// 監聽同步狀態
dataObject.on('status', (sessionId: string, networkId: string, status: string) => {
  if (status == 'restored') {
    console.log(`Data restored on device: ${networkId}`);
  }
});

// 儲存資料到其他裝置
let targetDeviceId = 'device_B_network_id';  // 目標裝置的網路ID
dataObject.save(targetDeviceId);

步驟四：在裝置B上恢復資料

在目標裝置B上接收並恢復同步的資料物件：

let receivedDataObject = distributedDataObject.create(this.context, null);

// 設定相同的sessionId進行同步
receivedDataObject.setSessionId(sessionId);

// 監聽同步資料變化
receivedDataObject.on('change', (sessionId: string, fields: Array<string>) => {
  fields.forEach((field) => {
    console.log(`Field changed: ${field}, new value: ${receivedDataObject[field]}`);
  });
});

3. 監聽跨裝置的資料變化，並處理同步衝突

分散式資料物件在跨裝置同步時，可能會出現資料衝突。HarmonyOS提供了資料監聽和衝突處理的機制，確保不同裝置的同步資料能夠保持一致。

步驟五：處理同步衝突

在資料同步過程中，可以透過監聽資料變化來捕獲衝突。以下示例展示如何處理同步時的衝突：

dataObject.on('change', (sessionId: string, fields: Array<string>) => {
  fields.forEach((field) => {
    console.log(`Data field ${field} has changed on session ${sessionId}`);
    
    // 解決衝突：我們可以根據業務邏輯手動處理衝突
    if (field === 'textContent') {
      if (receivedDataObject[field] !== dataObject[field]) {
        console.log(`Conflict detected in ${field}.`);
        // 手動解決衝突邏輯，例如保留最新的值
        dataObject[field] = receivedDataObject[field];
      }
    }
  });
});

總結

透過本文的實戰案例，我們展示瞭如何在HarmonyOS中利用標準化資料結構實現跨應用的資料拖拽與共享，並使用分散式資料物件實現多裝置間的資料同步。透過這種方法，開發者可以輕鬆打造多終端資料互動的無縫體驗。

關鍵步驟包括：

  1. 定義並建立標準化資料結構，確保跨應用資料互動的一致性。
  2. 使用分散式資料物件實現多裝置資料同步，減少開發複雜度。
  3. 監聽資料同步中的變化與衝突，確保資料在多個裝置間的一致性。

透過這些技術，我們日常開發不僅可以提升使用者體驗，還能大幅減少跨終端應用的開發難度，快速實現HarmonyOS生態下的多裝置協同互動。

PS：感謝觀看，祝大家1024程式設計師快樂吖~

相關文章