HarmonyOS 6.0 剪贴板与跨应用数据共享
复制粘贴看着简单不就是往剪贴板塞点文本吗等到产品说复制一段文字到另一个应用自动识别“复制图片要能粘贴”“跨设备同步剪贴板”你才发现坑不少——权限管控、数据类型适配、跨应用数据共享方案选择每个都能卡半天。这篇把剪贴板读写、跨应用数据共享、组件间数据传递的完整方案讲清楚。剪贴板基础读写HarmonyOS 的剪贴板通过pasteboard模块访问它来自kit.BasicServicesKit——注意不是kit.ArkData。核心 API 就三个getSystemPasteboard()获取实例setData()写入getData()读取。import{pasteboard}fromkit.BasicServicesKit;import{BusinessError}fromkit.BasicServicesKit;asynccopyToClipboard(text:string):Promisevoid{constsystemPasteboard:pasteboard.SystemPasteboardpasteboard.getSystemPasteboard();constpasteData:pasteboard.PasteDatapasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN,text);try{awaitsystemPasteboard.setData(pasteData);console.info(复制成功);}catch(e){consterreasBusinessError;console.error(复制失败:${err.code}-${err.message});}}asyncpasteFromClipboard():Promisestring{constsystemPasteboard:pasteboard.SystemPasteboardpasteboard.getSystemPasteboard();try{constpasteData:pasteboard.PasteDataawaitsystemPasteboard.getData();if(pasteData.getRecordCount()0){constrecord:pasteboard.PasteDataRecordpasteData.getRecord(0);returnrecord.toPlainText();}return;}catch(e){consterreasBusinessError;console.error(粘贴失败:${err.code});return;}}createData是工厂方法第一个参数指定 MIME 类型第二个是内容。写入后系统剪贴板立刻生效其他应用可以读取。读取时getData()返回完整的PasteData对象用getRecord(0)取第一条记录。注意API 12 起读取剪贴板需要ohos.permission.READ_PASTEBOARD权限或者使用安全控件PasteButton获取临时授权。不申请权限直接getData()会报错。还有一个容易忽略的点setData是覆盖式写入——每次调用都会把剪贴板之前的内容全部替换掉。如果你想往剪贴板追加内容必须先getData读出来往 PasteData 里 addRecord再setData写回去。否则前一次复制的数据就丢了。多类型数据读写剪贴板不只支持纯文本。它支持 HTML 富文本、URI、Want、PixelMap 等多种类型。一条 PasteData 可以包含多个 Record每个 Record 还可以用addEntry添加不同格式的副本。interfaceRichCopyParams{plainText:string;htmlText:string;}asynccopyRichText(params:RichCopyParams):Promisevoid{constsystemPasteboardpasteboard.getSystemPasteboard();// 创建纯文本类型再追加 HTML 格式constpasteData:pasteboard.PasteDatapasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN,params.plainText);constrecord:pasteboard.PasteDataRecordpasteData.getRecord(0);// 同一条记录添加 HTML 副本粘贴方按需选择格式record.addEntry(pasteboard.MIMETYPE_TEXT_HTML,params.htmlText);awaitsystemPasteboard.setData(pasteData);}asyncpasteAsHtml():Promisestring{constsystemPasteboardpasteboard.getSystemPasteboard();constpasteData:pasteboard.PasteDataawaitsystemPasteboard.getData();constrecord:pasteboard.PasteDataRecordpasteData.getRecord(0);// 尝试获取 HTML 格式没有则回退纯文本consthtml:stringrecord.toHtmlText();if(html.length0){returnhtml;}returnrecord.toPlainText();}addEntry的核心价值是一条数据多种格式——纯文本给简单应用用HTML 给富文本编辑器用URI 给文件管理器用。粘贴方按自己能力选择最合适的格式读取这就是跨应用兼容的基础。关键区别addEntry是往同一条 Record 加不同格式的数据而addRecord是加一条全新的 Record比如多文件复制时每个文件一个 Record。两者用途不同别混用。多类型数据的典型场景是富文本编辑器用户选中一段图文混排的内容复制你需要同时存纯文本给记事本粘贴、HTML给浏览器粘贴、PixelMap给图片编辑器粘贴。粘贴方根据自己的能力选择最合适的格式读取这样无论粘贴到哪个 App 都能保持最佳效果。URI 类型与文件共享复制文件不是把整个文件塞进剪贴板而是复制文件的 URI。粘贴方拿到 URI 后通过fileIo读取或拷贝文件内容。这是跨应用共享文件的正确方式。import{fileIoasfs}fromkit.CoreFileKit;asynccopyFileUri(fileUri:string):Promisevoid{constsystemPasteboardpasteboard.getSystemPasteboard();constpasteData:pasteboard.PasteDatapasteboard.createData(pasteboard.MIMETYPE_TEXT_URI,fileUri);awaitsystemPasteboard.setData(pasteData);}asyncpasteFileUri():Promisestring{constsystemPasteboardpasteboard.getSystemPasteboard();constpasteData:pasteboard.PasteDataawaitsystemPasteboard.getData();constrecord:pasteboard.PasteDataRecordpasteData.getRecord(0);consturi:stringrecord.toUri();// 用 fileIo 拷贝文件到自己的沙箱constcontextgetContext(this);constdestPath${context.filesDir}/pasted_file.dat;fs.copySync(uri,destPath);returndestPath;}URI 类型的好处是零拷贝——不需要把文件内容序列化到剪贴板128MB 上限也扛不住大文件只传一个引用粘贴方按需读取。注意URI 指向的文件可能受原应用的权限控制。如果原应用设置了shareMode限制粘贴方可能读不到。建议用系统文件管理器或 Photo Picker 选择的文件 URI权限最宽松。还有一点剪贴板的数据总大小上限是 128MB。纯文本和 URI 类型不可能触顶但如果你往剪贴板塞大图片的 PixelMap就要注意这个上限。超过限制setData会直接报错不会截断。剪贴板变化监听有些场景需要在剪贴板内容变化时自动响应——比如电商 App 检测用户复制了口令码自动弹窗提示跳转。这就需要监听剪贴板变化事件。privateonClipboardChange():void{this.checkClipboardForCode();};asyncstartClipboardListener():Promisevoid{constsystemPasteboardpasteboard.getSystemPasteboard();systemPasteboard.on(update,this.onClipboardChange);}asyncstopClipboardListener():Promisevoid{constsystemPasteboardpasteboard.getSystemPasteboard();systemPasteboard.off(update,this.onClipboardChange);}asynccheckClipboardForCode():Promisevoid{constsystemPasteboardpasteboard.getSystemPasteboard();// 先检查是否包含文本数据避免无谓读取consthasText:booleansystemPasteboard.hasDataType(pasteboard.MIMETYPE_TEXT_PLAIN);if(!hasText){return;}constpasteData:pasteboard.PasteDataawaitsystemPasteboard.getData();constrecord:pasteboard.PasteDataRecordpasteData.getRecord(0);consttext:stringrecord.toPlainText();// 检测口令码格式if(text.startsWith()text.length8){console.info(检测到口令码弹窗提示跳转);}}on(update)在剪贴板内容被任何应用修改时触发。先hasDataType检查是否有感兴趣的数据类型避免每次都getData触发权限弹窗。注意监听回调里调getData()同样需要 READ_PASTEBOARD 权限。没有权限的 App 只能知道剪贴板变了但读不到内容。另外在aboutToDisappear里必须off掉监听否则会内存泄漏。跨应用数据共享DataShare剪贴板适合一次性复制粘贴但如果两个应用需要持续共享结构化数据比如配置中心 App 给业务 App 推送开关就要用 DataShare。DataShare 是 HarmonyOS 的跨应用数据共享机制支持发布-订阅模式。import{dataShare}fromkit.ArkData;interfaceSharedConfig{uri:string;value:string;allowList:Arraystring;}asyncpublishSharedConfig(config:SharedConfig):Promisevoid{consthandle:dataShare.DataProxyHandleawaitdataShare.createDataProxyHandle();constproxyData:dataShare.ProxyData{uri:config.uri,value:config.value,allowList:config.allowList,};awaithandle.publish(proxyData);console.info(配置发布成功:${config.uri});}asyncreadSharedConfig(uri:string):Promisestring{consthandle:dataShare.DataProxyHandleawaitdataShare.createDataProxyHandle();constproxyData:dataShare.ProxyDataawaithandle.get(uri);returnproxyData.value;}DataShare 的 URI 格式是datashareproxy://{bundleName}/{path}allowList控制哪些 App 可以读取。发布方统一管理配置访问方只读——这是比剪贴板更适合持久共享的方案。关键区别DataShare 是发布-订阅模式数据长期有效直到发布方删除剪贴板是复制-粘贴模式数据会被下一次复制覆盖。按场景选择。DataShare 还支持变更监听——访问方可以订阅某个 URI 的数据变化发布方修改后自动通知。这对配置类场景特别有用配置中心改了个开关业务 App 立刻收到通知刷新 UI不需要轮询。AppStorage 跨组件数据传递回到应用内部组件之间共享数据最轻量的方案是AppStorage。它是一个全局的 KV 存储任何组件都可以通过StorageLink或StorageProp读写同一个 key。interfaceClipboardState{lastCopiedText:string;copyCount:number;}// 在 Entry 页面初始化EntryComponentstruct ClipboardDemoPage{StorageLink(lastCopiedText)lastCopiedText:string;StorageLink(copyCount)copyCount:number0;asynconCopy():Promisevoid{constsystemPasteboardpasteboard.getSystemPasteboard();constpasteDatapasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN,示例文本);awaitsystemPasteboard.setData(pasteData);// 通过 AppStorage 同步到其他组件this.lastCopiedText示例文本;this.copyCount;}build(){Column({space:16}){Text(最近复制:${this.lastCopiedText})Text(复制次数:${this.copyCount})Button(复制文本).onClick((){this.onCopy();})}}}StorageLink是双向绑定——组件修改会同步到 AppStorageAppStorage 变化也会同步回组件。StorageProp是单向的只从 AppStorage 读组件内修改不会回写。注意AppStorage是进程级单例只在当前应用内有效不能跨应用。跨应用要用 DataShare 或剪贴板。分布式数据同步概览HarmonyOS 还有一个更上层的能力——分布式数据同步。同一账号下的多台设备手机、平板、手表可以自动同步数据不需要你写网络传输逻辑。核心是distributedData模块。import{distributedData}fromkit.ArkData;interfaceSyncConfig{storeId:string;key:string;value:string;}asynccreateDistributedStore(config:SyncConfig):Promisevoid{constoptions:distributedData.Options{createIfMissing:true,autoSync:true,securityLevel:distributedData.SecurityLevel.S1,};conststore:distributedData.KVStoreawaitdistributedData.createKVStore(config.storeId,options);awaitstore.put(config.key,config.value);// 数据会自动同步到同账号的其他设备}分布式同步的底层是系统自动完成的——你在 A 设备 put 一个 key-valueB 设备的 KVStore 会自动收到更新事件。适合配置同步、草稿同步这类轻量数据。关键区别分布式数据同步需要设备在同一账号下且网络互通DataShare 是同设备跨应用剪贴板可以跨设备跨设备剪贴板也可以跨应用。三者的适用范围不同。分布式数据同步最适合的场景是轻量配置同步比如用户的主题设置、字体大小、输入习惯等。这些数据量小、变更频率低用 KVStore autoSync 就能自动搞定。但要注意分布式同步不是实时的——网络延迟、设备休眠都可能导致同步有几秒到几十秒的延迟不要依赖它做实时性要求高的场景。完整剪贴板演示页面把剪贴板读写、变化监听、AppStorage 同步组合成一个演示页面。EntryComponentstruct ClipboardSharePage{StateinputText:string;StatepastedText:string;StatecopyCount:number0;StorageLink(globalClipText)globalClipText:string;aboutToAppear():void{this.startClipboardListener();}aboutToDisappear():void{this.stopClipboardListener();}asyncstartClipboardListener():Promisevoid{constsystemPasteboardpasteboard.getSystemPasteboard();systemPasteboard.on(update,():void{this.onClipboardUpdated();});}asyncstopClipboardListener():Promisevoid{constsystemPasteboardpasteboard.getSystemPasteboard();systemPasteboard.off(update);}asynconClipboardUpdated():Promisevoid{constsystemPasteboardpasteboard.getSystemPasteboard();consthasTextsystemPasteboard.hasDataType(pasteboard.MIMETYPE_TEXT_PLAIN);if(!hasText){return;}constpasteData:pasteboard.PasteDataawaitsystemPasteboard.getData();if(pasteData.getRecordCount()0){consttext:stringpasteData.getRecord(0).toPlainText();this.pastedTexttext;this.globalClipTexttext;}}asyncdoCopy():Promisevoid{if(this.inputText.length0){return;}constsystemPasteboardpasteboard.getSystemPasteboard();constpasteDatapasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN,this.inputText);awaitsystemPasteboard.setData(pasteData);this.copyCount;this.globalClipTextthis.inputText;}asyncdoPaste():Promisevoid{constsystemPasteboardpasteboard.getSystemPasteboard();constpasteData:pasteboard.PasteDataawaitsystemPasteboard.getData();if(pasteData.getRecordCount()0){this.pastedTextpasteData.getRecord(0).toPlainText();}}build(){Column({space:16}){Text(剪贴板与数据共享).fontSize(24).fontWeight(FontWeight.Bold)TextInput({placeholder:输入要复制的文本,text:this.inputText}).width(90%).onChange((value:string){this.inputTextvalue;})Row({space:12}){Button(复制).onClick((){this.doCopy();})Button(粘贴).onClick((){this.doPaste();})}Text(粘贴内容:${this.pastedText}).fontSize(16)Text(复制次数:${this.copyCount}).fontSize(16)Text(全局同步文本:${this.globalClipText}).fontSize(14).fontColor(#888888)}.width(100%).height(100%).padding(20)}}这个页面覆盖了文本复制粘贴、剪贴板变化监听、AppStorage 跨组件同步三个核心能力。监听回调里用hasDataType先判断类型再读取既节省权限开销又避免无谓 IO。踩坑清单问题原因解决getData 报权限错误API 12 需 READ_PASTEBOARD申请权限或用 PasteButton 安全控件剪贴板监听不触发未注册 on(‘update’)aboutToAppear 注册aboutToDisappear 注销复制图片粘贴出来是文本读取方式不对检查 MIMETYPE 用 toPixelMap 而非 toPlainTextaddEntry 和 addRecord 混淆两者含义不同addEntry 同一记录加格式addRecord 加新记录连续 setData 数据丢失剪贴板同一时间只支持一次写入串行 await不要并发写入AppStorage 修改不刷新 UI用了 StorageProp 而非 StorageLink需要双向绑定用 StorageLinkDataShare get 返回空allowList 未包含当前应用发布时 allowList 加入目标 bundleNameURI 类型粘贴报文件不存在原应用已关闭文件描述符及时拷贝到自身沙箱不要延迟读取分布式同步不生效设备不在同一账号或网络不通确认同账号且同一 WiFiPasteButton 样式不定制安全控件样式受限接受系统样式或改用权限申请方式