場景介紹

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

圖1 剪貼板服務示意圖

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

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

接口說明

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

• SystemPasteboard

SystemPasteboard 提供系統剪貼板服務的操作接口，比如復制、粘貼、配置回調等。

• PasteData

PasteData 是剪貼板服務操作的數據對象，其中內容節點定義為 PasteData.Record，屬性集合定義為 PasteData.DataProperty。

• PasteData.Record

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

• PasteData.DataProperty

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

• IPasteDataChangedListener

IPasteDataChangedListener 是定義剪貼板數據變化回調的接口類，開發者需要實現此接口來編碼觸發回調時的處理邏輯。

開發步驟

• 應用A獲取系統剪貼板服務。

SystemPasteboard pasteboard = SystemPasteboard.getSystemPasteboard(appContext);

• 應用A向系統剪貼板中寫入一條純文本數據。

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

• 應用 B 從系統剪貼板讀取數據，將數據對象中的首個文本類型（純文本/HTML）內容信息在控件中顯示，忽略其他類型內容。

 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;
           }
       }
   }

• 應用 C 注冊添加系統剪貼板數據變化回調，當系統剪貼板數據發生變化時觸發處理邏輯。

   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);·