鴻蒙OS 剪貼板開發(fā)指導(dǎo)

場景介紹

同一設(shè)備的應(yīng)用程序 A、B 之間可以借助系統(tǒng)剪貼板服務(wù)完成簡單數(shù)據(jù)的傳遞，即應(yīng)用程序 A 向剪貼板服務(wù)寫入數(shù)據(jù)后，應(yīng)用程序 B 可以從中讀取出數(shù)據(jù)。在滿足分布式剪貼板服務(wù)的使用條件時，應(yīng)用程序 A、B 也可以來自組網(wǎng)內(nèi)的不同設(shè)備。

圖1 剪貼板服務(wù)示意圖

在使用剪貼板服務(wù)時，需要注意以下幾點：

• 只有在前臺獲取到焦點的應(yīng)用才有讀取系統(tǒng)剪貼板的權(quán)限（系統(tǒng)默認(rèn)輸入法應(yīng)用除外）。
• 寫入到剪貼板服務(wù)中的剪貼板數(shù)據(jù)不會隨應(yīng)用程序結(jié)束而銷毀。
• 對同一用戶而言，寫入剪貼板服務(wù)的數(shù)據(jù)會被下一次寫入的剪貼板數(shù)據(jù)所覆蓋。
• 如果設(shè)備滿足分布式組網(wǎng)條件，且進(jìn)行復(fù)制操作的設(shè)備打開了剪貼板分布式開關(guān)，未配置“僅在本地”標(biāo)志位的剪貼板數(shù)據(jù)里的 MIME 類型為純文本和 HTML 的內(nèi)容可以被組網(wǎng)內(nèi)其他打開了剪貼板分布式開關(guān)的設(shè)備粘貼出來。
• 在同一設(shè)備內(nèi)，剪貼板單次傳遞內(nèi)容不應(yīng)超過 800KB。在分布式場景下多設(shè)備間傳遞時，每次傳遞內(nèi)容不應(yīng)超過 64KB。

接口說明

SystemPasteboard 提供系統(tǒng)剪貼板操作的相關(guān)接口，比如復(fù)制、粘貼、配置回調(diào)等。PasteData 是剪貼板服務(wù)操作的數(shù)據(jù)對象，一個 PasteData 由若干個內(nèi)容節(jié)點（PasteData.Record）和一個屬性集合對象（PasteData.DataProperty）組成。Record 是存放剪貼板數(shù)據(jù)內(nèi)容信息的最小單位，每個 Record 都有其特定的 MIME 類型，如純文本、HTML、URI、Intent。剪貼板數(shù)據(jù)的屬性信息存在放 DataProperty 中，包括標(biāo)簽、時間戳、“僅在本地”標(biāo)記位等。

• SystemPasteboard

SystemPasteboard 提供系統(tǒng)剪貼板服務(wù)的操作接口，比如復(fù)制、粘貼、配置回調(diào)等。

• PasteData

PasteData 是剪貼板服務(wù)操作的數(shù)據(jù)對象，其中內(nèi)容節(jié)點定義為 PasteData.Record，屬性集合定義為 PasteData.DataProperty。

• PasteData.Record

一個 PasteData 中包含若干個特定MIME類型的 PasteData.Record，每個 Record 是存放剪貼板數(shù)據(jù)內(nèi)容信息的最小單位。

• PasteData.DataProperty

每個 PasteData 中都有一個 PasteData.DataProperty 成員，其中存放著該數(shù)據(jù)對象的屬性集合，例如自定義標(biāo)簽、MIME 類型集合列表，“僅在本地”標(biāo)記位等。

• IPasteDataChangedListener

IPasteDataChangedListener 是定義剪貼板數(shù)據(jù)變化回調(diào)的接口類，開發(fā)者需要實現(xiàn)此接口來編碼觸發(fā)回調(diào)時的處理邏輯。

開發(fā)步驟

• 應(yīng)用A獲取系統(tǒng)剪貼板服務(wù)。

SystemPasteboard pasteboard = SystemPasteboard.getSystemPasteboard(appContext);

• 應(yīng)用A向系統(tǒng)剪貼板中寫入一條純文本數(shù)據(jù)。

 if (pasteboard != null) {
       pasteboard.setPasteData(PasteData.creatPlainTextData("Hello, world!"));
   }

• 應(yīng)用 B 從系統(tǒng)剪貼板讀取數(shù)據(jù)，將數(shù)據(jù)對象中的首個文本類型（純文本/HTML）內(nèi)容信息在控件中顯示，忽略其他類型內(nèi)容。

 PasteData pasteData = pasteboard.getPasteData();
   if (pasteData == null) {
       return;
   }
   DataProperty dataProperty = pasteData.getProperty();
   boolean hasHtml = dataProperty.hasMimeType(PasteData.MIMETYPE_TEXT_HTML);
   boolean hasText = dataProperty.hasMimeType(PasteData.MIMETYPE_TEXT_PLAIN);
   if (hasHtml || hasText) {
       for (int i = 0; i < pasteData.getRecordCount(); i++) {
           Record record = pasteData.getRecordAt(i);
           String mimeType = record.getMimeType();
           if (mimeType.equals(PasteData.MIMETYPE_TEXT_HTML)) {
               text.setText(record.getHtmlText());
               break;
           } else if (mimeType.equals(PasteData.MIMETYPE_TEXT_PLAIN)) {
               text.setText(record.getPlainText().toString());
               break;
           }
       }
   }

• 應(yīng)用 C 注冊添加系統(tǒng)剪貼板數(shù)據(jù)變化回調(diào)，當(dāng)系統(tǒng)剪貼板數(shù)據(jù)發(fā)生變化時觸發(fā)處理邏輯。

   IPasteDataChangedListener listener = new IPasteDataChangedListener() {
       @Override
       public void onChanged() {
           PasteData pasteData = pasteboard.getPasteData();
           if (pasteData == null) {
               return;
           }
           // Operations to handle data change on the system pasteboard
       }
   };
   pasteboard.addPasteDataChangedListener(listener);·