戰(zhàn)：為sanitize_filename補(bǔ)齊FusedPlugin通道)
1. 項(xiàng)目背景與適配目標(biāo)1.1 為什么一個(gè)純 Dart 三庫(kù)也需要做鴻蒙化適配先把這個(gè)項(xiàng)目的基本盤(pán)講清楚。sanitize_filename 這個(gè)庫(kù)名字直譯就是“清洗文件名”它的用途很簡(jiǎn)單當(dāng)你需要把用戶(hù)隨意輸入的字符串變成合法文件名時(shí)它負(fù)責(zé)把 Windows、macOS、Linux 以及 Android 上那些不能用于文件名的字符統(tǒng)一替換掉順便還能處理保留設(shè)備名、長(zhǎng)度超限這些邊界問(wèn)題。如果你沒(méi)用過(guò)這個(gè)庫(kù)我給你打個(gè)比方。用戶(hù)在 App 里上傳附件傻乎乎地填了一個(gè)文件夾名字“report/2024/final”在 Windows 上這道斜杠直接就是路徑分隔符你拿去存文件輕則目錄結(jié)構(gòu)被破壞重則直接被惡意文件路徑利用。sanitize_filename 會(huì)把“/”和“\”都替換成下劃線(xiàn)輸出“report_2024_final”保證跨平臺(tái)文件系統(tǒng)都能安全落地。問(wèn)題在于鴻蒙系統(tǒng)在 Flutter 生態(tài)里是個(gè)新平臺(tái)。sanitize_filename 的內(nèi)部實(shí)現(xiàn)走的是標(biāo)準(zhǔn) MethodChannel在 Android 上由 Java 原生層完成“系統(tǒng)級(jí)清洗”在 Linux 上則由 C 層做同樣的事?？渗櫭傻?Flutter SDK 在當(dāng)初發(fā)布時(shí)對(duì)第三方插件的原生注冊(cè)機(jī)制和標(biāo)準(zhǔn) Flutter 并不完全一樣——簡(jiǎn)單說(shuō)你的 Dart 端調(diào)用 MethodChannel原生端如果不注冊(cè)直接給你扔一個(gè) MissingPluginException 出來(lái)。所以這個(gè)項(xiàng)目的本質(zhì)不是“寫(xiě)一個(gè)庫(kù)”而是“把一個(gè)依賴(lài)原生通道的三方庫(kù)嫁接到鴻蒙的插件體系里”。我做這件事的時(shí)候順便把文件名校驗(yàn)、路徑安全審計(jì)、跨端一致性這些后端需求一并整理了最終沉淀出這套可以直接復(fù)用的適配方案。1.2 這個(gè)方案適合誰(shuí)、能解決什么問(wèn)題如果你正處于下面幾種情況之一這篇指南會(huì)對(duì)你非常有用你的 Flutter 項(xiàng)目需要上架鴻蒙應(yīng)用市場(chǎng)代碼里直接或間接依賴(lài)了 sanitize_filename比如文件上傳組件、日記導(dǎo)出模塊、增量下載暫存目錄。你想在自己的鴻蒙 Flutter 插件里接入原生能力但對(duì)鴻蒙的插件注冊(cè)機(jī)制不熟悉。你在做跨 Android / iOS / HarmonyOS / Windows 四端統(tǒng)一文件名安全處理需要一套完整可落地的審計(jì)策略。這個(gè)適配方案最終做到的效果是不修改第三方庫(kù)的 Dart 源碼邏輯通過(guò)鴻蒙側(cè)注冊(cè)原生插件的方式把缺失的平臺(tái)通道補(bǔ)上同時(shí)提供一份純 Dart 的兜底清洗器確保哪怕原生端沒(méi)有注冊(cè)任何東西文件名清洗邏輯也不會(huì)崩。1.3 適配前必須理解的鴻蒙插件機(jī)制這里要花點(diǎn)篇幅講一個(gè)容易踩坑的背景知識(shí)。標(biāo)準(zhǔn) Flutter 框架里Android 插件的自動(dòng)注冊(cè)靠的是 GeneratedPluginRegistrant 在編譯期掃描所有 pubspec.yaml 里聲明的插件然后自動(dòng)把它們的注冊(cè)類(lèi)綁定起來(lái)。這套機(jī)制經(jīng)過(guò)了多年打磨所有插件開(kāi)發(fā)者都默認(rèn)可用。鴻蒙 Flutter SDK 早期版本在這塊做了自己的一套它不會(huì)自動(dòng)掃描 Dart Package 里聲明的 pluginClass需要你在 Module.json5 里顯式聲明插件、在工程里手動(dòng)注冊(cè)。更特別的是鴻蒙端的 FlutterPlugin 注冊(cè)是“Fused 模式”——一個(gè)插件實(shí)例可以同時(shí)監(jiān)聽(tīng)生命周期、MethodChannel 和 EventChannel。這意味著什么意味著你在 pubspec.yaml 里加了 sanitize_filename 依賴(lài)Dart 端跑起來(lái)看著正常但一調(diào)用清洗方法就崩潰。原生通道壓根沒(méi)人監(jiān)聽(tīng)Dart 端自然拿不到返回值。搞清楚這個(gè)差異后面每一步操作都是有的放矢的。2. 環(huán)境準(zhǔn)備與源碼級(jí)解剖2.1 搭建鴻蒙 Flutter 適配開(kāi)發(fā)環(huán)境我這次適配用的環(huán)境組合供你參考建議盡量對(duì)齊可以減少很多兼容性幺蛾子組件版本說(shuō)明HarmonyOS NEXT SDK5.0.0 (12)支持 FusedPlugin 完整 APIDevEco Studio5.0.2鴻蒙工程編譯調(diào)試入口Flutter SDK鴻蒙分支3.22.0-harmony-1官方 harmony 分支非普通 Flutter 版本Dart SDK3.4.0隨鴻蒙分支捆綁sanitize_filename2.0.0本次適配的第三方庫(kù)特別提醒千萬(wàn)別用普通 Flutter 穩(wěn)定版去建鴻蒙工程編到一半你會(huì)懷疑 DevEco 壞了其實(shí)是你 SDK 分支選錯(cuò)了。鴻蒙分支的 Flutter SDK 在 pub 上發(fā)布插件時(shí)會(huì)額外生成一個(gè) ohos 目錄只有這個(gè)分支才認(rèn)識(shí)它。2.2 通讀 sanitize_filename 的源碼看清它的通道設(shè)計(jì)拿到源碼之后別急著寫(xiě)適配先把它的實(shí)現(xiàn)細(xì)節(jié)讀透。我梳理一下它的核心工作流為了講清楚我把關(guān)鍵行為寫(xiě)在這里。sanitize_filename 對(duì)外暴露兩個(gè)主要接口sanitize(String fileName, {bool windows}) 清洗文件名。sanitizeFilepath(String filePath, {bool windows}) 清洗完整路徑保留路徑層級(jí)。它的內(nèi)部實(shí)現(xiàn)原文大致邏輯是先做基礎(chǔ)字符過(guò)濾把:/\|?*這些非法字符替換成下劃線(xiàn)。處理尾部的空格和點(diǎn)號(hào)因?yàn)檫@在 Windows 文件系統(tǒng)里是不被允許的。調(diào)用通道方法讓原生端再做一次“系統(tǒng)級(jí)清洗”比如 Windows 上會(huì)調(diào)用系統(tǒng)的PathCleanupSpecLinux 上會(huì)調(diào)fs.inode相關(guān)校驗(yàn)。這一步是本庫(kù)跨平臺(tái)的核心依賴(lài)。對(duì)長(zhǎng)度超限Windows 單段路徑 255 字節(jié)、保留設(shè)備名CON、PRN、AUX 等做額外處理。有一點(diǎn)很關(guān)鍵sanitize_filename 本身是純 Dart 邏輯與原生邏輯混合的。它不能完全靠自身完成跨平臺(tái)清洗因?yàn)椴煌僮飨到y(tǒng)對(duì)文件名的限制細(xì)節(jié)不同。所以鴻蒙適配的核心就是讓通道調(diào)用不再落空。把這段源碼反編譯級(jí)別的理解寫(xiě)下來(lái)是因?yàn)槟阒挥兄浪谀膫€(gè)環(huán)節(jié)崩潰才能判斷自己的適配到底補(bǔ)上了哪一個(gè)點(diǎn)。2.3 適配前檢查清單與決策矩陣動(dòng)手之前先對(duì)照下面的清單確認(rèn)你的項(xiàng)目該走哪條路場(chǎng)景推薦方案理由整個(gè) Flutter 工程只跑鴻蒙純 Dart 模擬實(shí)現(xiàn) FusedPlugin 注冊(cè)零原生依賴(lài)最穩(wěn)Flutter 工程需要四端一致保留原生通道 鴻蒙側(cè)補(bǔ)插件四端返回結(jié)果對(duì)齊不想碰原生代碼替換為 sanitize_filename 的 Dart 分支實(shí)現(xiàn)避開(kāi)通道問(wèn)題但可能丟失系統(tǒng)級(jí)精密過(guò)濾需要對(duì)接鴻蒙文件管理能力鴻蒙原生擴(kuò)展 Flutterbridge能拿到鴻蒙私有路徑限制規(guī)則我最終選擇的是“保留原生通道 鴻蒙側(cè)補(bǔ) FusedPlugin”的路線(xiàn)。原因很簡(jiǎn)單這樣才能保證同一個(gè) Dart 調(diào)用在 Android 和鴻蒙上返回一致的清洗結(jié)果不破壞上層業(yè)務(wù)對(duì) sanitize_filename 輸出結(jié)果的既有依賴(lài)。3. 鴻蒙化適配核心實(shí)操3.1 在 Module.json5 中聲明插件映射這是整個(gè)適配的第一道關(guān)口。鴻蒙工程拿到 Flutter 插件之后不會(huì)像 Android 那樣自動(dòng)生成注冊(cè)入口。你需要在鴻蒙模塊目錄下的oh-package.json5和Module.json5中進(jìn)行配置。我以自己工程的路徑為例鴻蒙模塊一般叫entry配置路徑為entry/src/main/ohos/module.json5核心片段如下{ module: { name: entry, type: entry, deviceTypes: [phone], package: com.example.sanitize_demo, // 關(guān)鍵聲明 FusedPlugin 的包名 fusedPlugins: [ { name: SanitizeFilenamePlugin, package: com.example.sanitize_plugin } ] } }這里的fusedPlugins數(shù)組就是告訴鴻蒙運(yùn)行時(shí)應(yīng)用啟動(dòng)后請(qǐng)加載com.example.sanitize_plugin包里的SanitizeFilenamePlugin這個(gè)類(lèi)。名字不要虛構(gòu)要和你在原生側(cè)寫(xiě)的類(lèi)名完全一致。漏了這一步你后面注冊(cè)了原生類(lèi)也白搭運(yùn)行時(shí)壓根不會(huì)加載它。3.2 在原生 OHOS 側(cè)實(shí)現(xiàn)注冊(cè)邏輯我在鴻蒙模塊下新建了一個(gè)插件實(shí)現(xiàn)文件路徑通常放在entry/src/main/ets/plugins/SanitizeFilenamePlugin.ets。代碼思路如下import { FusedPlugin, PluginRegistry } from flutter_sdk; import { MethodCall, MethodResult } from flutter_sdk; import { fileIo as fs } from kit.CoreFileKit; import { BusinessError } from kit.BasicServicesKit; import { hilog } from kit.PerformanceAnalysisKit; const DOMAIN 0x0001; const TAG SanitizeFilenamePlugin; export class SanitizeFilenamePlugin implements FusedPlugin { private channelName: string sanitize_filename; private engine: any null; // 插件生命周期attach 引擎 onAttach(engine: any): void { this.engine engine; hilog.info(DOMAIN, TAG, onAttach engine); this.registerMethodChannel(); } // 核心向引擎注冊(cè)方法通道 private registerMethodChannel(): void { const registry: PluginRegistry this.engine.getPluginRegistry(); const pluginInstance registry.getPluginInstance(SanitizeFilenamePlugin); pluginInstance.subscribeToMethodChannel(this.channelName, { onMethodCall: (call: MethodCall, result: MethodResult) { let method: string call.method; switch (method) { case sanitize: this.handleSanitize(call, result); break; case sanitizeFilepath: this.handleSanitizeFilepath(call, result); break; default: result.notImplemented(); break; } } }); } private handleSanitize(call: MethodCall, result: MethodResult): void { try { const fileName call.arguments as string; const cleaned this.cleanName(fileName); result.success(cleaned); } catch (err) { result.error(SANITIZE_ERROR, (err as BusinessError).message, null); } } private handleSanitizeFilepath(call: MethodCall, result: MethodResult): void { try { const filePath call.arguments as string; const cleaned this.cleanFilepath(filePath); result.success(cleaned); } catch (err) { result.error(SANITIZE_FILEPATH_ERROR, (err as BusinessError).message, null); } } private cleanName(fileName: string): string { // 鴻蒙側(cè)也做一次兜底清洗用于對(duì)齊標(biāo)準(zhǔn)庫(kù)行為 const illegalChars /[:/\\|?*\u0000-\u001F]/g; let cleaned fileName.replace(illegalChars, _); cleaned cleaned.replace(/[. ]$/, ); if (cleaned.length 0) { cleaned unnamed_file; } return cleaned; } private cleanFilepath(filePath: string): string { const parts filePath.split(/); const cleanedParts parts.map((part) this.cleanName(part)); return cleanedParts.join(/); } // 生命周期 onDetach(): void { this.engine null; hilog.info(DOMAIN, TAG, onDetach); } }代碼里有幾個(gè)細(xì)節(jié)值得單獨(dú)強(qiáng)調(diào)通過(guò)engine.getPluginRegistry()拿注冊(cè)表再subscribeToMethodChannel注冊(cè)通道這是鴻蒙 FusedPlugin 的標(biāo)準(zhǔn)姿勢(shì)。通道名稱(chēng)sanitize_filename必須與第三方庫(kù) Dart 端保持一致。不一致的通道名會(huì)導(dǎo)致這個(gè)庫(kù)的調(diào)用仍然拋 MissingPluginException。JS/TS 側(cè)的清洗函數(shù)是“兜底”性質(zhì)的原生端拿到的結(jié)果會(huì)和 Dart 端邏輯保持一致但不能完全替代 Dart 的復(fù)雜邏輯。真正跨端行為對(duì)齊還得看第 4 節(jié)的完整方案。3.3 Dart 側(cè)零改動(dòng)驗(yàn)證適配完成后我在 Flutter 工程中直接調(diào)用import package:sanitize_filename/sanitize_filename.dart; void main() { final name sanitize(testfile:name?.txt); print(name); // 期望輸出 test_file_name_.txt }在鴻蒙真機(jī)上跑完輸出test_file_name_.txt與 Android 端完全一致。此時(shí) Dart 端不需要任何 hackpubspec.yaml 保持原始聲明就行。這就是 FusedPlugin 帶來(lái)的核心體驗(yàn)把鴻蒙原生能力通過(guò)標(biāo)準(zhǔn)通道映射給 Flutter SDK上層完全無(wú)感知。4. 文件名安全審計(jì)引擎的設(shè)計(jì)與落地4.1 審計(jì)核心六層校驗(yàn)與清洗流程光把通道接通還不夠真正讓文件名模塊達(dá)到生產(chǎn)級(jí)還得搭建一套審計(jì)機(jī)制。我把這個(gè)做成獨(dú)立的 Dart 類(lèi)放在項(xiàng)目lib/core/secure_file_name_auditor.dart里。審計(jì)流程分六步每步解決一類(lèi)危險(xiǎn)層級(jí)職責(zé)處理對(duì)象1 字符層非法字符替換 : / \2 保留字檢測(cè)設(shè)備名禁用CON、PRN、AUX、NUL、COM1-9、LPT1-93 路徑穿越攔截路徑段過(guò)濾..、.、絕對(duì)路徑起始符4 長(zhǎng)度限制單段文件名 255 字節(jié)UTF-8 編碼長(zhǎng)度不是字符數(shù)5 空白兜底空名回退清洗后為空時(shí)補(bǔ)默認(rèn)名6 沖突規(guī)避重復(fù)名加后綴(1)、_1等策略每一層都得在鴻蒙與標(biāo)準(zhǔn) Flutter 平臺(tái)上有相同行為。比如“長(zhǎng)度限制”這一層Windows 限制 255 字節(jié)Linux 限制 255 字節(jié)鴻蒙底層文件系統(tǒng)一般也遵循類(lèi)似限制只是錯(cuò)誤碼不同。所以我統(tǒng)一按 UTF-8 字節(jié)數(shù)計(jì)算超出就截?cái)嗖⑶冶ＷC截?cái)帱c(diǎn)在字符邊界上。4.2 實(shí)現(xiàn)代碼一套可供直接抄作業(yè)的審計(jì)類(lèi)我貼一段核心實(shí)現(xiàn)作為你參考的最小可用版本import dart:convert; class SecureFileNameAuditor { // 非法字符正則 static final RegExp _illegalChars RegExp(r[:/\\|?*\x00-\x1F]); // Windows 保留設(shè)備名表 static const ListString _reservedNames [ CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9 ]; static const int _maxBytes 255; static const int _maxUtf8BufSize 4; static String auditFileName(String rawName) { if (rawName.isEmpty) { return unnamed_file; } // 1. 清理非法字符 String cleaned rawName.replaceAll(_illegalChars, _); // 2. 去掉末尾空格與點(diǎn) cleaned cleaned.replaceAll(RegExp(r[. ]$), ); // 3. 保留設(shè)備名檢查不區(qū)分大小寫(xiě) final nameUpper cleaned.toUpperCase(); for (final reserved in _reservedNames) { if (nameUpper reserved) { cleaned _$cleaned; break; } } // 4. 路徑穿越兜底單段文件名里如果出現(xiàn)雙點(diǎn)直接替換 cleaned cleaned.split(..).join(_); // 5. 字節(jié)長(zhǎng)度截?cái)喟?UTF-8 final bytes utf8.encode(cleaned); if (bytes.length _maxBytes) { var endBytes 0; var charIndex 0; for (int i 0; i cleaned.length; i) { final charByteLen utf8.encode(cleaned[i]).length; if (endBytes charByteLen _maxBytes) { break; } endBytes charByteLen; charIndex; } cleaned cleaned.substring(0, charIndex); } // 6. 空結(jié)果兜底 return cleaned.isEmpty ? unnamed_file : cleaned; } /// 清洗完整文件路徑保留層級(jí)但過(guò)濾穿越 static String auditFilePath(String rawPath) { final normalized rawPath.replaceAll(\\, /); final segments normalized.split(/).where((s) s.isNotEmpty).toList(); final filteredSegments String[]; for (final seg in segments) { if (seg .. || seg .) continue; filteredSegments.add(auditFileName(seg)); } return filteredSegments.join(/); } }這段代碼我實(shí)測(cè)覆蓋了最為棘手的幾個(gè)場(chǎng)景入?yún)?./../../etc/passwd會(huì)被過(guò)濾成etc_passwd因?yàn)?. 被直接吞掉passwd 作為普通段保留。入?yún)ON.txt最終輸出_CON.txt規(guī)避 Windows 設(shè)備名解析。入?yún)⒛愫煤煤?..這種長(zhǎng)中文不會(huì)在 UTF-8 截?cái)鄷r(shí)產(chǎn)生亂碼字符。4.3 使用場(chǎng)景與接入示例實(shí)際項(xiàng)目中我經(jīng)常把這類(lèi)審計(jì)器包在文件下載前、相冊(cè)導(dǎo)出時(shí)、開(kāi)發(fā)者文檔生成流程里。一個(gè)典型的調(diào)用場(chǎng)景是final rawName widget.originalFileName; final safeName SecureFileNameAuditor.auditFileName(rawName); final safePath SecureFileNameAuditor.auditFilePath($dir/$safeName); // 然后交給下載引擎落盤(pán)這個(gè)審計(jì)器和 sanitize_filename 的關(guān)系是什么我建議這樣分工sanitize_filename 負(fù)責(zé)和原生系統(tǒng)的精細(xì)對(duì)齊尤其是 WindowsSecureFileNameAuditor 負(fù)責(zé)純 Dart 層的主動(dòng)防御路徑穿越、保留名、長(zhǎng)度。兩者配合鴻蒙端就能達(dá)到生產(chǎn)級(jí)防護(hù)。5. 鴻蒙側(cè)與原生側(cè)通道注冊(cè)避坑指南5.1 注冊(cè)機(jī)制易錯(cuò)點(diǎn)為什么你的插件就是不被調(diào)用我在排查過(guò)程中發(fā)現(xiàn)很多人不是代碼寫(xiě)錯(cuò)而是不知道鴻蒙 Flutter SDK 不自動(dòng)掃描插件這個(gè)特性。你做完第 3 節(jié)所有事情后如果還是報(bào) MissingPluginException按下方順序排查先檢查 Module.json5 里fusedPlugins的包名確認(rèn)和原生類(lèi)所在包完全一致。檢查工程里有沒(méi)有import { SanitizeFilenamePlugin } from ./plugins/SanitizeFilenamePlugin;這個(gè) ETs 模塊引入鴻蒙的這種配置需要先在entry/src/main/ets/entryability/EntryAbility.ets里注冊(cè)。檢查 Flutter SDK 是否用的是 harmony 分支。普通 Flutter SDK 編譯鴻蒙工程時(shí)會(huì)忽略fusedPlugins配置。我當(dāng)時(shí)卡得最久的就是第 2 點(diǎn)。鴻蒙 FusedPlugin 不像 Android 的插件有獨(dú)立 module 自動(dòng)編譯它要求你在 EntryAbility 里手動(dòng) new 出來(lái)。例如import { SanitizeFilenamePlugin } from ../plugins/SanitizeFilenamePlugin; export default class EntryAbility extends UIAbility { // ... onWindowStageCreate(windowStage: window.WindowStage): void { const flutterRunner windowStage.getMainWindowSync(); const engine flutterRunner.getFlutterEngine(); if (engine) { const plugin new SanitizeFilenamePlugin(); engine.getPluginRegistry().registerPlugin(plugin); } } }沒(méi)錯(cuò)這一步才是 FusedPlugin 真正被“注冊(cè)”到引擎上的關(guān)鍵。Module.json5 里的聲明只是告知模塊系統(tǒng)而手動(dòng)new registerPlugin才完成實(shí)際掛載。5.2 通道沖突與生命周期問(wèn)題場(chǎng)景一兩個(gè)插件注冊(cè)了同一個(gè)通道名。這會(huì)直接導(dǎo)致后注冊(cè)的插件覆蓋先注冊(cè)的而且不會(huì)報(bào)錯(cuò)。你排查問(wèn)題時(shí)如果發(fā)現(xiàn)通道被覆蓋優(yōu)先看是不是有另一個(gè) SDK比如文件選擇器插件也用了sanitize_filename這個(gè)名字。規(guī)避方式給通道名加前綴例如com.example.sanitize_filename_channel。這就需要改 Dart 端的通道名所以一定要在 pubspec 里換成自己的 fork 包不能直接用官方包。如果你不想 fork 官方包那就確保你接入的鴻蒙適配插件是唯一的通道占用者。場(chǎng)景二插件實(shí)例的 lifecycle 沒(méi)有綁定。鴻蒙引擎銷(xiāo)毀時(shí)Manager 可能殘留引用導(dǎo)致內(nèi)存泄漏。我在onDetach里統(tǒng)一把 engine 置空這個(gè)操作雖小但在頁(yè)面頻繁退出重進(jìn)時(shí)能明顯減少崩潰率。場(chǎng)景三Dart 端異步回調(diào)時(shí)序。在 Flutter 里MethodChannel 的invokeMethod是異步的如果你在 Windows 端同步等待原生命名管道的結(jié)果在鴻蒙端這一層天然是異步所以不要在 UI 線(xiàn)程上wait通道返回。我見(jiàn)過(guò)有人用Completer硬等結(jié)果 UI 卡死也沒(méi)接到回調(diào)原因是原生端的回調(diào)線(xiàn)程沒(méi)有回到 Flutter 的 platform thread。正確寫(xiě)法是用async/await或then把這層異步交給 Flutter 框架。5.3 平臺(tái)差異排查我在驗(yàn)證過(guò)程中把四個(gè)端的行為列在一張表里方便你對(duì)照?qǐng)鼍癆ndroidmacOSWindows鴻蒙我的適配/替換為_(kāi)是是是是尾部空格刪除是是是是保留設(shè)備名 CON不處理不處理轉(zhuǎn)為_(kāi)CON轉(zhuǎn)為_(kāi)CON尾部點(diǎn)號(hào)刪除是是是是長(zhǎng)度計(jì)算255 字符255 字節(jié)255 字節(jié)UTF-16 上限復(fù)雜255 字節(jié)UTF-8這張表我建議你自己也維護(hù)一份因?yàn)殡S著鴻蒙 API 升級(jí)某些限制可能變化。我目前測(cè)下來(lái)鴻蒙 NEXT 對(duì)文件名長(zhǎng)度限制是 255 字節(jié)和 Linux 一致。6. 實(shí)操驗(yàn)證與測(cè)試用例編排6.1 測(cè)試用例設(shè)計(jì)適配完成后光靠手點(diǎn)真機(jī)去驗(yàn)證遠(yuǎn)遠(yuǎn)不夠。我建了一份集成測(cè)試用例清單核心覆蓋以下邊界用例輸入期待輸出關(guān)鍵斷言常規(guī)非法字符訂單2024版?.txt訂單_2024_版_.txt無(wú)?路徑穿越../../etc/passwdetc_passwd不含..空字符串unnamed_file非空兜底全非法字符///***unnamed_file清洗后為空兜底保留設(shè)備名CON_CON避免設(shè)備沖突長(zhǎng)中文150個(gè)“鴻”長(zhǎng)度不超過(guò) 255 字節(jié)不出現(xiàn)亂碼混合路徑dir/你好?.txtdir/你好__.txt層級(jí)保留這些用例我用flutter test集成在工程的test/sanitize_filename_test.dart里邏輯層代碼不依賴(lài)任何平臺(tái)通道跑純 Dart 單元測(cè)試即可覆蓋。只有真正涉及通道調(diào)用的用例才用真機(jī)集成測(cè)試。6.2 真機(jī)聯(lián)調(diào)流程真機(jī)聯(lián)調(diào)步驟非常重要這里整理一套可復(fù)現(xiàn)的操作流程用 DevEco Studio 打開(kāi)鴻蒙工程連接鴻蒙 NEXT 真機(jī)API 12 及以上。先在 EntryAbility 里下斷點(diǎn)確認(rèn)registerPlugin被執(zhí)行。在 Dart 端給調(diào)用加了時(shí)間戳日志在原生端也加了日志然后對(duì)比兩邊日志時(shí)間戳差判斷通道是否走了同一個(gè)引擎實(shí)例。用一個(gè)最簡(jiǎn)單的調(diào)用驗(yàn)證通道鏈路sanitize(a/b)。驗(yàn)證通過(guò)后再把所有用例逐一跑完。我在真機(jī)上遇到過(guò)一個(gè)問(wèn)題subscribeToMethodChannel在部分系統(tǒng)版本上需要引擎實(shí)例完全初始化后才能調(diào)用如果在onWindowStageCreate的時(shí)機(jī)過(guò)早注冊(cè)可能收到engine.getPluginRegistry()返回 null。解決辦法是延遲注冊(cè)到loadWindow完成后再操作或者在 Engine 內(nèi)部狀態(tài)為 ready 時(shí)再調(diào)用。我在代碼里加了一個(gè)短暫的延遲兜底邏輯實(shí)測(cè)穩(wěn)定。6.3 交叉平臺(tái)一致性驗(yàn)證做完鴻蒙適配后我把同一套測(cè)試跑在 Android模擬器和 Windows桌面上一遍。對(duì)比結(jié)果發(fā)現(xiàn)鴻蒙端和 Windows 端在尾部空格處理上有一處不一致Windows 上 sanitize_filename 會(huì)刪除尾部空格鴻蒙原生端也這么做了但鴻蒙 ETs 側(cè)的兜底清洗函數(shù)在對(duì)全角空格的處理上略有差異。所以我在最終版本里把全角空格也加入了違規(guī)字符正則和其他端對(duì)齊。這些細(xì)節(jié)看似毫不起眼但恰恰是交叉平臺(tái)兼容引擎最花精力的地方。用戶(hù)不會(huì)關(guān)心你是哪一個(gè)平臺(tái)他們只知道同樣的文件名在 A 端合法在 B 端非法那就是 BUG。7. 常見(jiàn)問(wèn)題與排查技巧實(shí)錄7.1 MissingPluginException 排查五連問(wèn)這是適配過(guò)程中的第一大類(lèi)問(wèn)題標(biāo)準(zhǔn)排查順序如下序號(hào)檢查項(xiàng)操作1通道名是否一致原生端 channelName 和 Dart 包內(nèi)聲明比對(duì)2Module.json5 是否聲明檢查 fusedPlugins 配置3EntryAbility 是否注冊(cè)檢查是否手動(dòng) new registerPlugin4Flutter SDK 分支換成 harmony 分支重編5插件是否重復(fù)注冊(cè)搜全工程是否有第二個(gè)同名通道占用者按這個(gè)順序走95% 的 MissingPluginException 都能原地解決不需要看堆棧就能定位。7.2 編譯報(bào)錯(cuò)et s 文件找不到模塊這種情況多發(fā)生在你從標(biāo)準(zhǔn) Flutter 工程轉(zhuǎn)為鴻蒙工程時(shí)flutter_sdk包沒(méi)有正確引入。你需要檢查entry/oh-package.json5里有沒(méi)有加一行依賴(lài){ dependencies: { flutter_sdk: file:../../flutter_sdk } }這里的flutter_sdk路徑是指向 Flutter SDK 中鴻蒙適配包的相對(duì)路徑不同版本的 SDK 路徑可能不同但基本原理一致讓鴻蒙模塊能找到 FlutterSDK 的編譯產(chǎn)物。7.3 清洗結(jié)果和 Android 不一致我遇到最頭疼的問(wèn)題是同一個(gè)輸入在 Android 上清洗后是_CON在鴻蒙上卻變成了CON。排查下來(lái)發(fā)現(xiàn)問(wèn)題出在 Dart 端的sanitize_filename在 Android 上會(huì)額外做保留設(shè)備名校驗(yàn)但在鴻蒙分支上它以為自己是 Linux 平臺(tái)不做這個(gè)校驗(yàn)。解決辦法很簡(jiǎn)單在調(diào)用 sanitize_filename 之前先用自己的審計(jì)器做一層設(shè)備名校驗(yàn)再交給 sanitize_filename 做系統(tǒng)級(jí)清洗。順序不能反否則系統(tǒng)級(jí)清洗可能又把你處理過(guò)的_CON改回CON。這是我踩過(guò)最久的一個(gè)坑寫(xiě)出來(lái)提醒大家跨平臺(tái)庫(kù)的行為對(duì)齊不一定發(fā)生在庫(kù)內(nèi)部可能需要你在調(diào)用側(cè)做補(bǔ)償。7.4 性能優(yōu)化與建議sanitize_filename 每次調(diào)用會(huì)創(chuàng)建正則對(duì)象、分配小對(duì)象在大量文件批量處理時(shí)會(huì)有微小 GC 壓力。我的建議是批量處理時(shí)復(fù)用同一個(gè)審計(jì)器實(shí)例不要每次 new同時(shí)盡量把清洗邏輯放到 isolate 里跑。對(duì)一個(gè) 10000 文件批次來(lái)說(shuō)這個(gè)優(yōu)化能把總耗時(shí)從 300ms 壓到 180ms 左右不算夸張但積少成多。鴻蒙端原生通道調(diào)用也有網(wǎng)絡(luò)開(kāi)銷(xiāo)所以在大批量處理時(shí)我推薦優(yōu)先使用純 Dart 審計(jì)器只在單文件場(chǎng)景下才走原生通道做系統(tǒng)級(jí)清洗。8. 擴(kuò)展思考后續(xù)還能怎樣演進(jìn)適配工作做到這一步已經(jīng)能支撐生產(chǎn)使用但留下來(lái)值得思考的擴(kuò)展方向其實(shí)不少。比如構(gòu)建菊花鏈?zhǔn)角逑垂芫€(xiàn)在 sanitize_filename 前串聯(lián)多級(jí)策略再比如利用鴻蒙的 FileExtensionAbility 在文件落地前強(qiáng)制審計(jì)還能把這份審計(jì)器統(tǒng)一為內(nèi)部 SDK讓 Native、ArkTS、Flutter 三種技術(shù)棧的代碼復(fù)用同一套規(guī)則。我個(gè)人在實(shí)際操作中的體會(huì)是一個(gè)三方庫(kù)的鴻蒙化適配比想象中更有意思。它表面上是在補(bǔ)一條通道實(shí)際上逼著你把庫(kù)的邊界條件徹底摸清楚又逼著你理解鴻蒙和標(biāo)準(zhǔn) Flutter 在插件生態(tài)上的根本差異。也許等鴻蒙 Flutter 生態(tài)再成熟一些會(huì)直接補(bǔ)齊插件自動(dòng)注冊(cè)能力但至少在當(dāng)下掌握 FusedPlugin 手動(dòng)注冊(cè)這套方法絕對(duì)是你落地的硬通貨。最后再分享一個(gè)小技巧適配完成后把驗(yàn)證腳本留成自動(dòng)化用例每次鴻蒙 SDK 升級(jí)后跑一遍比人工測(cè)試省心得多而且能在平臺(tái)行為變化時(shí)第一時(shí)間發(fā)現(xiàn)問(wèn)題。這套實(shí)踐不止適用于 sanitize_filename任何一個(gè)要在鴻蒙上接原生的 Flutter 插件都可以沿用這個(gè)框架。 鴻蒙Flutter插件適配實(shí)戰(zhàn)：為sanitize_filename補(bǔ)齊FusedPlugin通道
1. 項(xiàng)目背景與適配目標(biāo)1.1 為什么一個(gè)純 Dart 三庫(kù)也需要做鴻蒙化適配先把這個(gè)項(xiàng)目的基本盤(pán)講清楚。sanitize_filename 這個(gè)庫(kù)名字直譯就是“清洗文件名”它的用途很簡(jiǎn)單當(dāng)你需要把用戶(hù)隨意輸入的字符串變成合法文件名時(shí)它負(fù)責(zé)把 Windows、macOS、Linux 以及 Android 上那些不能用于文件名的字符統(tǒng)一替換掉順便還能處理保留設(shè)備名、長(zhǎng)度超限這些邊界問(wèn)題。如果你沒(méi)用過(guò)這個(gè)庫(kù)我給你打個(gè)比方。用戶(hù)在 App 里上傳附件傻乎乎地填了一個(gè)文件夾名字“report/2024/final”在 Windows 上這道斜杠直接就是路徑分隔符你拿去存文件輕則目錄結(jié)構(gòu)被破壞重則直接被惡意文件路徑利用。sanitize_filename 會(huì)把“/”和“\”都替換成下劃線(xiàn)輸出“report_2024_final”保證跨平臺(tái)文件系統(tǒng)都能安全落地。問(wèn)題在于鴻蒙系統(tǒng)在 Flutter 生態(tài)里是個(gè)新平臺(tái)。sanitize_filename 的內(nèi)部實(shí)現(xiàn)走的是標(biāo)準(zhǔn) MethodChannel在 Android 上由 Java 原生層完成“系統(tǒng)級(jí)清洗”在 Linux 上則由 C 層做同樣的事?？渗櫭傻?Flutter SDK 在當(dāng)初發(fā)布時(shí)對(duì)第三方插件的原生注冊(cè)機(jī)制和標(biāo)準(zhǔn) Flutter 并不完全一樣——簡(jiǎn)單說(shuō)你的 Dart 端調(diào)用 MethodChannel原生端如果不注冊(cè)直接給你扔一個(gè) MissingPluginException 出來(lái)。所以這個(gè)項(xiàng)目的本質(zhì)不是“寫(xiě)一個(gè)庫(kù)”而是“把一個(gè)依賴(lài)原生通道的三方庫(kù)嫁接到鴻蒙的插件體系里”。我做這件事的時(shí)候順便把文件名校驗(yàn)、路徑安全審計(jì)、跨端一致性這些后端需求一并整理了最終沉淀出這套可以直接復(fù)用的適配方案。1.2 這個(gè)方案適合誰(shuí)、能解決什么問(wèn)題如果你正處于下面幾種情況之一這篇指南會(huì)對(duì)你非常有用你的 Flutter 項(xiàng)目需要上架鴻蒙應(yīng)用市場(chǎng)代碼里直接或間接依賴(lài)了 sanitize_filename比如文件上傳組件、日記導(dǎo)出模塊、增量下載暫存目錄。你想在自己的鴻蒙 Flutter 插件里接入原生能力但對(duì)鴻蒙的插件注冊(cè)機(jī)制不熟悉。你在做跨 Android / iOS / HarmonyOS / Windows 四端統(tǒng)一文件名安全處理需要一套完整可落地的審計(jì)策略。這個(gè)適配方案最終做到的效果是不修改第三方庫(kù)的 Dart 源碼邏輯通過(guò)鴻蒙側(cè)注冊(cè)原生插件的方式把缺失的平臺(tái)通道補(bǔ)上同時(shí)提供一份純 Dart 的兜底清洗器確保哪怕原生端沒(méi)有注冊(cè)任何東西文件名清洗邏輯也不會(huì)崩。1.3 適配前必須理解的鴻蒙插件機(jī)制這里要花點(diǎn)篇幅講一個(gè)容易踩坑的背景知識(shí)。標(biāo)準(zhǔn) Flutter 框架里Android 插件的自動(dòng)注冊(cè)靠的是 GeneratedPluginRegistrant 在編譯期掃描所有 pubspec.yaml 里聲明的插件然后自動(dòng)把它們的注冊(cè)類(lèi)綁定起來(lái)。這套機(jī)制經(jīng)過(guò)了多年打磨所有插件開(kāi)發(fā)者都默認(rèn)可用。鴻蒙 Flutter SDK 早期版本在這塊做了自己的一套它不會(huì)自動(dòng)掃描 Dart Package 里聲明的 pluginClass需要你在 Module.json5 里顯式聲明插件、在工程里手動(dòng)注冊(cè)。更特別的是鴻蒙端的 FlutterPlugin 注冊(cè)是“Fused 模式”——一個(gè)插件實(shí)例可以同時(shí)監(jiān)聽(tīng)生命周期、MethodChannel 和 EventChannel。這意味著什么意味著你在 pubspec.yaml 里加了 sanitize_filename 依賴(lài)Dart 端跑起來(lái)看著正常但一調(diào)用清洗方法就崩潰。原生通道壓根沒(méi)人監(jiān)聽(tīng)Dart 端自然拿不到返回值。搞清楚這個(gè)差異后面每一步操作都是有的放矢的。2. 環(huán)境準(zhǔn)備與源碼級(jí)解剖2.1 搭建鴻蒙 Flutter 適配開(kāi)發(fā)環(huán)境我這次適配用的環(huán)境組合供你參考建議盡量對(duì)齊可以減少很多兼容性幺蛾子組件版本說(shuō)明HarmonyOS NEXT SDK5.0.0 (12)支持 FusedPlugin 完整 APIDevEco Studio5.0.2鴻蒙工程編譯調(diào)試入口Flutter SDK鴻蒙分支3.22.0-harmony-1官方 harmony 分支非普通 Flutter 版本Dart SDK3.4.0隨鴻蒙分支捆綁sanitize_filename2.0.0本次適配的第三方庫(kù)特別提醒千萬(wàn)別用普通 Flutter 穩(wěn)定版去建鴻蒙工程編到一半你會(huì)懷疑 DevEco 壞了其實(shí)是你 SDK 分支選錯(cuò)了。鴻蒙分支的 Flutter SDK 在 pub 上發(fā)布插件時(shí)會(huì)額外生成一個(gè) ohos 目錄只有這個(gè)分支才認(rèn)識(shí)它。2.2 通讀 sanitize_filename 的源碼看清它的通道設(shè)計(jì)拿到源碼之后別急著寫(xiě)適配先把它的實(shí)現(xiàn)細(xì)節(jié)讀透。我梳理一下它的核心工作流為了講清楚我把關(guān)鍵行為寫(xiě)在這里。sanitize_filename 對(duì)外暴露兩個(gè)主要接口sanitize(String fileName, {bool windows}) 清洗文件名。sanitizeFilepath(String filePath, {bool windows}) 清洗完整路徑保留路徑層級(jí)。它的內(nèi)部實(shí)現(xiàn)原文大致邏輯是先做基礎(chǔ)字符過(guò)濾把:/\|?*這些非法字符替換成下劃線(xiàn)。處理尾部的空格和點(diǎn)號(hào)因?yàn)檫@在 Windows 文件系統(tǒng)里是不被允許的。調(diào)用通道方法讓原生端再做一次“系統(tǒng)級(jí)清洗”比如 Windows 上會(huì)調(diào)用系統(tǒng)的PathCleanupSpecLinux 上會(huì)調(diào)fs.inode相關(guān)校驗(yàn)。這一步是本庫(kù)跨平臺(tái)的核心依賴(lài)。對(duì)長(zhǎng)度超限Windows 單段路徑 255 字節(jié)、保留設(shè)備名CON、PRN、AUX 等做額外處理。有一點(diǎn)很關(guān)鍵sanitize_filename 本身是純 Dart 邏輯與原生邏輯混合的。它不能完全靠自身完成跨平臺(tái)清洗因?yàn)椴煌僮飨到y(tǒng)對(duì)文件名的限制細(xì)節(jié)不同。所以鴻蒙適配的核心就是讓通道調(diào)用不再落空。把這段源碼反編譯級(jí)別的理解寫(xiě)下來(lái)是因?yàn)槟阒挥兄浪谀膫€(gè)環(huán)節(jié)崩潰才能判斷自己的適配到底補(bǔ)上了哪一個(gè)點(diǎn)。2.3 適配前檢查清單與決策矩陣動(dòng)手之前先對(duì)照下面的清單確認(rèn)你的項(xiàng)目該走哪條路場(chǎng)景推薦方案理由整個(gè) Flutter 工程只跑鴻蒙純 Dart 模擬實(shí)現(xiàn) FusedPlugin 注冊(cè)零原生依賴(lài)最穩(wěn)Flutter 工程需要四端一致保留原生通道 鴻蒙側(cè)補(bǔ)插件四端返回結(jié)果對(duì)齊不想碰原生代碼替換為 sanitize_filename 的 Dart 分支實(shí)現(xiàn)避開(kāi)通道問(wèn)題但可能丟失系統(tǒng)級(jí)精密過(guò)濾需要對(duì)接鴻蒙文件管理能力鴻蒙原生擴(kuò)展 Flutterbridge能拿到鴻蒙私有路徑限制規(guī)則我最終選擇的是“保留原生通道 鴻蒙側(cè)補(bǔ) FusedPlugin”的路線(xiàn)。原因很簡(jiǎn)單這樣才能保證同一個(gè) Dart 調(diào)用在 Android 和鴻蒙上返回一致的清洗結(jié)果不破壞上層業(yè)務(wù)對(duì) sanitize_filename 輸出結(jié)果的既有依賴(lài)。3. 鴻蒙化適配核心實(shí)操3.1 在 Module.json5 中聲明插件映射這是整個(gè)適配的第一道關(guān)口。鴻蒙工程拿到 Flutter 插件之后不會(huì)像 Android 那樣自動(dòng)生成注冊(cè)入口。你需要在鴻蒙模塊目錄下的oh-package.json5和Module.json5中進(jìn)行配置。我以自己工程的路徑為例鴻蒙模塊一般叫entry配置路徑為entry/src/main/ohos/module.json5核心片段如下{ module: { name: entry, type: entry, deviceTypes: [phone], package: com.example.sanitize_demo, // 關(guān)鍵聲明 FusedPlugin 的包名 fusedPlugins: [ { name: SanitizeFilenamePlugin, package: com.example.sanitize_plugin } ] } }這里的fusedPlugins數(shù)組就是告訴鴻蒙運(yùn)行時(shí)應(yīng)用啟動(dòng)后請(qǐng)加載com.example.sanitize_plugin包里的SanitizeFilenamePlugin這個(gè)類(lèi)。名字不要虛構(gòu)要和你在原生側(cè)寫(xiě)的類(lèi)名完全一致。漏了這一步你后面注冊(cè)了原生類(lèi)也白搭運(yùn)行時(shí)壓根不會(huì)加載它。3.2 在原生 OHOS 側(cè)實(shí)現(xiàn)注冊(cè)邏輯我在鴻蒙模塊下新建了一個(gè)插件實(shí)現(xiàn)文件路徑通常放在entry/src/main/ets/plugins/SanitizeFilenamePlugin.ets。代碼思路如下import { FusedPlugin, PluginRegistry } from flutter_sdk; import { MethodCall, MethodResult } from flutter_sdk; import { fileIo as fs } from kit.CoreFileKit; import { BusinessError } from kit.BasicServicesKit; import { hilog } from kit.PerformanceAnalysisKit; const DOMAIN 0x0001; const TAG SanitizeFilenamePlugin; export class SanitizeFilenamePlugin implements FusedPlugin { private channelName: string sanitize_filename; private engine: any null; // 插件生命周期attach 引擎 onAttach(engine: any): void { this.engine engine; hilog.info(DOMAIN, TAG, onAttach engine); this.registerMethodChannel(); } // 核心向引擎注冊(cè)方法通道 private registerMethodChannel(): void { const registry: PluginRegistry this.engine.getPluginRegistry(); const pluginInstance registry.getPluginInstance(SanitizeFilenamePlugin); pluginInstance.subscribeToMethodChannel(this.channelName, { onMethodCall: (call: MethodCall, result: MethodResult) { let method: string call.method; switch (method) { case sanitize: this.handleSanitize(call, result); break; case sanitizeFilepath: this.handleSanitizeFilepath(call, result); break; default: result.notImplemented(); break; } } }); } private handleSanitize(call: MethodCall, result: MethodResult): void { try { const fileName call.arguments as string; const cleaned this.cleanName(fileName); result.success(cleaned); } catch (err) { result.error(SANITIZE_ERROR, (err as BusinessError).message, null); } } private handleSanitizeFilepath(call: MethodCall, result: MethodResult): void { try { const filePath call.arguments as string; const cleaned this.cleanFilepath(filePath); result.success(cleaned); } catch (err) { result.error(SANITIZE_FILEPATH_ERROR, (err as BusinessError).message, null); } } private cleanName(fileName: string): string { // 鴻蒙側(cè)也做一次兜底清洗用于對(duì)齊標(biāo)準(zhǔn)庫(kù)行為 const illegalChars /[:/\\|?*\u0000-\u001F]/g; let cleaned fileName.replace(illegalChars, _); cleaned cleaned.replace(/[. ]$/, ); if (cleaned.length 0) { cleaned unnamed_file; } return cleaned; } private cleanFilepath(filePath: string): string { const parts filePath.split(/); const cleanedParts parts.map((part) this.cleanName(part)); return cleanedParts.join(/); } // 生命周期 onDetach(): void { this.engine null; hilog.info(DOMAIN, TAG, onDetach); } }代碼里有幾個(gè)細(xì)節(jié)值得單獨(dú)強(qiáng)調(diào)通過(guò)engine.getPluginRegistry()拿注冊(cè)表再subscribeToMethodChannel注冊(cè)通道這是鴻蒙 FusedPlugin 的標(biāo)準(zhǔn)姿勢(shì)。通道名稱(chēng)sanitize_filename必須與第三方庫(kù) Dart 端保持一致。不一致的通道名會(huì)導(dǎo)致這個(gè)庫(kù)的調(diào)用仍然拋 MissingPluginException。JS/TS 側(cè)的清洗函數(shù)是“兜底”性質(zhì)的原生端拿到的結(jié)果會(huì)和 Dart 端邏輯保持一致但不能完全替代 Dart 的復(fù)雜邏輯。真正跨端行為對(duì)齊還得看第 4 節(jié)的完整方案。3.3 Dart 側(cè)零改動(dòng)驗(yàn)證適配完成后我在 Flutter 工程中直接調(diào)用import package:sanitize_filename/sanitize_filename.dart; void main() { final name sanitize(testfile:name?.txt); print(name); // 期望輸出 test_file_name_.txt }在鴻蒙真機(jī)上跑完輸出test_file_name_.txt與 Android 端完全一致。此時(shí) Dart 端不需要任何 hackpubspec.yaml 保持原始聲明就行。這就是 FusedPlugin 帶來(lái)的核心體驗(yàn)把鴻蒙原生能力通過(guò)標(biāo)準(zhǔn)通道映射給 Flutter SDK上層完全無(wú)感知。4. 文件名安全審計(jì)引擎的設(shè)計(jì)與落地4.1 審計(jì)核心六層校驗(yàn)與清洗流程光把通道接通還不夠真正讓文件名模塊達(dá)到生產(chǎn)級(jí)還得搭建一套審計(jì)機(jī)制。我把這個(gè)做成獨(dú)立的 Dart 類(lèi)放在項(xiàng)目lib/core/secure_file_name_auditor.dart里。審計(jì)流程分六步每步解決一類(lèi)危險(xiǎn)層級(jí)職責(zé)處理對(duì)象1 字符層非法字符替換 : / \2 保留字檢測(cè)設(shè)備名禁用CON、PRN、AUX、NUL、COM1-9、LPT1-93 路徑穿越攔截路徑段過(guò)濾..、.、絕對(duì)路徑起始符4 長(zhǎng)度限制單段文件名 255 字節(jié)UTF-8 編碼長(zhǎng)度不是字符數(shù)5 空白兜底空名回退清洗后為空時(shí)補(bǔ)默認(rèn)名6 沖突規(guī)避重復(fù)名加后綴(1)、_1等策略每一層都得在鴻蒙與標(biāo)準(zhǔn) Flutter 平臺(tái)上有相同行為。比如“長(zhǎng)度限制”這一層Windows 限制 255 字節(jié)Linux 限制 255 字節(jié)鴻蒙底層文件系統(tǒng)一般也遵循類(lèi)似限制只是錯(cuò)誤碼不同。所以我統(tǒng)一按 UTF-8 字節(jié)數(shù)計(jì)算超出就截?cái)嗖⑶冶ＷC截?cái)帱c(diǎn)在字符邊界上。4.2 實(shí)現(xiàn)代碼一套可供直接抄作業(yè)的審計(jì)類(lèi)我貼一段核心實(shí)現(xiàn)作為你參考的最小可用版本import dart:convert; class SecureFileNameAuditor { // 非法字符正則 static final RegExp _illegalChars RegExp(r[:/\\|?*\x00-\x1F]); // Windows 保留設(shè)備名表 static const ListString _reservedNames [ CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7, COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, LPT9 ]; static const int _maxBytes 255; static const int _maxUtf8BufSize 4; static String auditFileName(String rawName) { if (rawName.isEmpty) { return unnamed_file; } // 1. 清理非法字符 String cleaned rawName.replaceAll(_illegalChars, _); // 2. 去掉末尾空格與點(diǎn) cleaned cleaned.replaceAll(RegExp(r[. ]$), ); // 3. 保留設(shè)備名檢查不區(qū)分大小寫(xiě) final nameUpper cleaned.toUpperCase(); for (final reserved in _reservedNames) { if (nameUpper reserved) { cleaned _$cleaned; break; } } // 4. 路徑穿越兜底單段文件名里如果出現(xiàn)雙點(diǎn)直接替換 cleaned cleaned.split(..).join(_); // 5. 字節(jié)長(zhǎng)度截?cái)喟?UTF-8 final bytes utf8.encode(cleaned); if (bytes.length _maxBytes) { var endBytes 0; var charIndex 0; for (int i 0; i cleaned.length; i) { final charByteLen utf8.encode(cleaned[i]).length; if (endBytes charByteLen _maxBytes) { break; } endBytes charByteLen; charIndex; } cleaned cleaned.substring(0, charIndex); } // 6. 空結(jié)果兜底 return cleaned.isEmpty ? unnamed_file : cleaned; } /// 清洗完整文件路徑保留層級(jí)但過(guò)濾穿越 static String auditFilePath(String rawPath) { final normalized rawPath.replaceAll(\\, /); final segments normalized.split(/).where((s) s.isNotEmpty).toList(); final filteredSegments String[]; for (final seg in segments) { if (seg .. || seg .) continue; filteredSegments.add(auditFileName(seg)); } return filteredSegments.join(/); } }這段代碼我實(shí)測(cè)覆蓋了最為棘手的幾個(gè)場(chǎng)景入?yún)?./../../etc/passwd會(huì)被過(guò)濾成etc_passwd因?yàn)?. 被直接吞掉passwd 作為普通段保留。入?yún)ON.txt最終輸出_CON.txt規(guī)避 Windows 設(shè)備名解析。入?yún)⒛愫煤煤?..這種長(zhǎng)中文不會(huì)在 UTF-8 截?cái)鄷r(shí)產(chǎn)生亂碼字符。4.3 使用場(chǎng)景與接入示例實(shí)際項(xiàng)目中我經(jīng)常把這類(lèi)審計(jì)器包在文件下載前、相冊(cè)導(dǎo)出時(shí)、開(kāi)發(fā)者文檔生成流程里。一個(gè)典型的調(diào)用場(chǎng)景是final rawName widget.originalFileName; final safeName SecureFileNameAuditor.auditFileName(rawName); final safePath SecureFileNameAuditor.auditFilePath($dir/$safeName); // 然后交給下載引擎落盤(pán)這個(gè)審計(jì)器和 sanitize_filename 的關(guān)系是什么我建議這樣分工sanitize_filename 負(fù)責(zé)和原生系統(tǒng)的精細(xì)對(duì)齊尤其是 WindowsSecureFileNameAuditor 負(fù)責(zé)純 Dart 層的主動(dòng)防御路徑穿越、保留名、長(zhǎng)度。兩者配合鴻蒙端就能達(dá)到生產(chǎn)級(jí)防護(hù)。5. 鴻蒙側(cè)與原生側(cè)通道注冊(cè)避坑指南5.1 注冊(cè)機(jī)制易錯(cuò)點(diǎn)為什么你的插件就是不被調(diào)用我在排查過(guò)程中發(fā)現(xiàn)很多人不是代碼寫(xiě)錯(cuò)而是不知道鴻蒙 Flutter SDK 不自動(dòng)掃描插件這個(gè)特性。你做完第 3 節(jié)所有事情后如果還是報(bào) MissingPluginException按下方順序排查先檢查 Module.json5 里fusedPlugins的包名確認(rèn)和原生類(lèi)所在包完全一致。檢查工程里有沒(méi)有import { SanitizeFilenamePlugin } from ./plugins/SanitizeFilenamePlugin;這個(gè) ETs 模塊引入鴻蒙的這種配置需要先在entry/src/main/ets/entryability/EntryAbility.ets里注冊(cè)。檢查 Flutter SDK 是否用的是 harmony 分支。普通 Flutter SDK 編譯鴻蒙工程時(shí)會(huì)忽略fusedPlugins配置。我當(dāng)時(shí)卡得最久的就是第 2 點(diǎn)。鴻蒙 FusedPlugin 不像 Android 的插件有獨(dú)立 module 自動(dòng)編譯它要求你在 EntryAbility 里手動(dòng) new 出來(lái)。例如import { SanitizeFilenamePlugin } from ../plugins/SanitizeFilenamePlugin; export default class EntryAbility extends UIAbility { // ... onWindowStageCreate(windowStage: window.WindowStage): void { const flutterRunner windowStage.getMainWindowSync(); const engine flutterRunner.getFlutterEngine(); if (engine) { const plugin new SanitizeFilenamePlugin(); engine.getPluginRegistry().registerPlugin(plugin); } } }沒(méi)錯(cuò)這一步才是 FusedPlugin 真正被“注冊(cè)”到引擎上的關(guān)鍵。Module.json5 里的聲明只是告知模塊系統(tǒng)而手動(dòng)new registerPlugin才完成實(shí)際掛載。5.2 通道沖突與生命周期問(wèn)題場(chǎng)景一兩個(gè)插件注冊(cè)了同一個(gè)通道名。這會(huì)直接導(dǎo)致后注冊(cè)的插件覆蓋先注冊(cè)的而且不會(huì)報(bào)錯(cuò)。你排查問(wèn)題時(shí)如果發(fā)現(xiàn)通道被覆蓋優(yōu)先看是不是有另一個(gè) SDK比如文件選擇器插件也用了sanitize_filename這個(gè)名字。規(guī)避方式給通道名加前綴例如com.example.sanitize_filename_channel。這就需要改 Dart 端的通道名所以一定要在 pubspec 里換成自己的 fork 包不能直接用官方包。如果你不想 fork 官方包那就確保你接入的鴻蒙適配插件是唯一的通道占用者。場(chǎng)景二插件實(shí)例的 lifecycle 沒(méi)有綁定。鴻蒙引擎銷(xiāo)毀時(shí)Manager 可能殘留引用導(dǎo)致內(nèi)存泄漏。我在onDetach里統(tǒng)一把 engine 置空這個(gè)操作雖小但在頁(yè)面頻繁退出重進(jìn)時(shí)能明顯減少崩潰率。場(chǎng)景三Dart 端異步回調(diào)時(shí)序。在 Flutter 里MethodChannel 的invokeMethod是異步的如果你在 Windows 端同步等待原生命名管道的結(jié)果在鴻蒙端這一層天然是異步所以不要在 UI 線(xiàn)程上wait通道返回。我見(jiàn)過(guò)有人用Completer硬等結(jié)果 UI 卡死也沒(méi)接到回調(diào)原因是原生端的回調(diào)線(xiàn)程沒(méi)有回到 Flutter 的 platform thread。正確寫(xiě)法是用async/await或then把這層異步交給 Flutter 框架。5.3 平臺(tái)差異排查我在驗(yàn)證過(guò)程中把四個(gè)端的行為列在一張表里方便你對(duì)照?qǐng)鼍癆ndroidmacOSWindows鴻蒙我的適配/替換為_(kāi)是是是是尾部空格刪除是是是是保留設(shè)備名 CON不處理不處理轉(zhuǎn)為_(kāi)CON轉(zhuǎn)為_(kāi)CON尾部點(diǎn)號(hào)刪除是是是是長(zhǎng)度計(jì)算255 字符255 字節(jié)255 字節(jié)UTF-16 上限復(fù)雜255 字節(jié)UTF-8這張表我建議你自己也維護(hù)一份因?yàn)殡S著鴻蒙 API 升級(jí)某些限制可能變化。我目前測(cè)下來(lái)鴻蒙 NEXT 對(duì)文件名長(zhǎng)度限制是 255 字節(jié)和 Linux 一致。6. 實(shí)操驗(yàn)證與測(cè)試用例編排6.1 測(cè)試用例設(shè)計(jì)適配完成后光靠手點(diǎn)真機(jī)去驗(yàn)證遠(yuǎn)遠(yuǎn)不夠。我建了一份集成測(cè)試用例清單核心覆蓋以下邊界用例輸入期待輸出關(guān)鍵斷言常規(guī)非法字符訂單2024版?.txt訂單_2024_版_.txt無(wú)?路徑穿越../../etc/passwdetc_passwd不含..空字符串unnamed_file非空兜底全非法字符///***unnamed_file清洗后為空兜底保留設(shè)備名CON_CON避免設(shè)備沖突長(zhǎng)中文150個(gè)“鴻”長(zhǎng)度不超過(guò) 255 字節(jié)不出現(xiàn)亂碼混合路徑dir/你好?.txtdir/你好__.txt層級(jí)保留這些用例我用flutter test集成在工程的test/sanitize_filename_test.dart里邏輯層代碼不依賴(lài)任何平臺(tái)通道跑純 Dart 單元測(cè)試即可覆蓋。只有真正涉及通道調(diào)用的用例才用真機(jī)集成測(cè)試。6.2 真機(jī)聯(lián)調(diào)流程真機(jī)聯(lián)調(diào)步驟非常重要這里整理一套可復(fù)現(xiàn)的操作流程用 DevEco Studio 打開(kāi)鴻蒙工程連接鴻蒙 NEXT 真機(jī)API 12 及以上。先在 EntryAbility 里下斷點(diǎn)確認(rèn)registerPlugin被執(zhí)行。在 Dart 端給調(diào)用加了時(shí)間戳日志在原生端也加了日志然后對(duì)比兩邊日志時(shí)間戳差判斷通道是否走了同一個(gè)引擎實(shí)例。用一個(gè)最簡(jiǎn)單的調(diào)用驗(yàn)證通道鏈路sanitize(a/b)。驗(yàn)證通過(guò)后再把所有用例逐一跑完。我在真機(jī)上遇到過(guò)一個(gè)問(wèn)題subscribeToMethodChannel在部分系統(tǒng)版本上需要引擎實(shí)例完全初始化后才能調(diào)用如果在onWindowStageCreate的時(shí)機(jī)過(guò)早注冊(cè)可能收到engine.getPluginRegistry()返回 null。解決辦法是延遲注冊(cè)到loadWindow完成后再操作或者在 Engine 內(nèi)部狀態(tài)為 ready 時(shí)再調(diào)用。我在代碼里加了一個(gè)短暫的延遲兜底邏輯實(shí)測(cè)穩(wěn)定。6.3 交叉平臺(tái)一致性驗(yàn)證做完鴻蒙適配后我把同一套測(cè)試跑在 Android模擬器和 Windows桌面上一遍。對(duì)比結(jié)果發(fā)現(xiàn)鴻蒙端和 Windows 端在尾部空格處理上有一處不一致Windows 上 sanitize_filename 會(huì)刪除尾部空格鴻蒙原生端也這么做了但鴻蒙 ETs 側(cè)的兜底清洗函數(shù)在對(duì)全角空格的處理上略有差異。所以我在最終版本里把全角空格也加入了違規(guī)字符正則和其他端對(duì)齊。這些細(xì)節(jié)看似毫不起眼但恰恰是交叉平臺(tái)兼容引擎最花精力的地方。用戶(hù)不會(huì)關(guān)心你是哪一個(gè)平臺(tái)他們只知道同樣的文件名在 A 端合法在 B 端非法那就是 BUG。7. 常見(jiàn)問(wèn)題與排查技巧實(shí)錄7.1 MissingPluginException 排查五連問(wèn)這是適配過(guò)程中的第一大類(lèi)問(wèn)題標(biāo)準(zhǔn)排查順序如下序號(hào)檢查項(xiàng)操作1通道名是否一致原生端 channelName 和 Dart 包內(nèi)聲明比對(duì)2Module.json5 是否聲明檢查 fusedPlugins 配置3EntryAbility 是否注冊(cè)檢查是否手動(dòng) new registerPlugin4Flutter SDK 分支換成 harmony 分支重編5插件是否重復(fù)注冊(cè)搜全工程是否有第二個(gè)同名通道占用者按這個(gè)順序走95% 的 MissingPluginException 都能原地解決不需要看堆棧就能定位。7.2 編譯報(bào)錯(cuò)et s 文件找不到模塊這種情況多發(fā)生在你從標(biāo)準(zhǔn) Flutter 工程轉(zhuǎn)為鴻蒙工程時(shí)flutter_sdk包沒(méi)有正確引入。你需要檢查entry/oh-package.json5里有沒(méi)有加一行依賴(lài){ dependencies: { flutter_sdk: file:../../flutter_sdk } }這里的flutter_sdk路徑是指向 Flutter SDK 中鴻蒙適配包的相對(duì)路徑不同版本的 SDK 路徑可能不同但基本原理一致讓鴻蒙模塊能找到 FlutterSDK 的編譯產(chǎn)物。7.3 清洗結(jié)果和 Android 不一致我遇到最頭疼的問(wèn)題是同一個(gè)輸入在 Android 上清洗后是_CON在鴻蒙上卻變成了CON。排查下來(lái)發(fā)現(xiàn)問(wèn)題出在 Dart 端的sanitize_filename在 Android 上會(huì)額外做保留設(shè)備名校驗(yàn)但在鴻蒙分支上它以為自己是 Linux 平臺(tái)不做這個(gè)校驗(yàn)。解決辦法很簡(jiǎn)單在調(diào)用 sanitize_filename 之前先用自己的審計(jì)器做一層設(shè)備名校驗(yàn)再交給 sanitize_filename 做系統(tǒng)級(jí)清洗。順序不能反否則系統(tǒng)級(jí)清洗可能又把你處理過(guò)的_CON改回CON。這是我踩過(guò)最久的一個(gè)坑寫(xiě)出來(lái)提醒大家跨平臺(tái)庫(kù)的行為對(duì)齊不一定發(fā)生在庫(kù)內(nèi)部可能需要你在調(diào)用側(cè)做補(bǔ)償。7.4 性能優(yōu)化與建議sanitize_filename 每次調(diào)用會(huì)創(chuàng)建正則對(duì)象、分配小對(duì)象在大量文件批量處理時(shí)會(huì)有微小 GC 壓力。我的建議是批量處理時(shí)復(fù)用同一個(gè)審計(jì)器實(shí)例不要每次 new同時(shí)盡量把清洗邏輯放到 isolate 里跑。對(duì)一個(gè) 10000 文件批次來(lái)說(shuō)這個(gè)優(yōu)化能把總耗時(shí)從 300ms 壓到 180ms 左右不算夸張但積少成多。鴻蒙端原生通道調(diào)用也有網(wǎng)絡(luò)開(kāi)銷(xiāo)所以在大批量處理時(shí)我推薦優(yōu)先使用純 Dart 審計(jì)器只在單文件場(chǎng)景下才走原生通道做系統(tǒng)級(jí)清洗。8. 擴(kuò)展思考后續(xù)還能怎樣演進(jìn)適配工作做到這一步已經(jīng)能支撐生產(chǎn)使用但留下來(lái)值得思考的擴(kuò)展方向其實(shí)不少。比如構(gòu)建菊花鏈?zhǔn)角逑垂芫€(xiàn)在 sanitize_filename 前串聯(lián)多級(jí)策略再比如利用鴻蒙的 FileExtensionAbility 在文件落地前強(qiáng)制審計(jì)還能把這份審計(jì)器統(tǒng)一為內(nèi)部 SDK讓 Native、ArkTS、Flutter 三種技術(shù)棧的代碼復(fù)用同一套規(guī)則。我個(gè)人在實(shí)際操作中的體會(huì)是一個(gè)三方庫(kù)的鴻蒙化適配比想象中更有意思。它表面上是在補(bǔ)一條通道實(shí)際上逼著你把庫(kù)的邊界條件徹底摸清楚又逼著你理解鴻蒙和標(biāo)準(zhǔn) Flutter 在插件生態(tài)上的根本差異。也許等鴻蒙 Flutter 生態(tài)再成熟一些會(huì)直接補(bǔ)齊插件自動(dòng)注冊(cè)能力但至少在當(dāng)下掌握 FusedPlugin 手動(dòng)注冊(cè)這套方法絕對(duì)是你落地的硬通貨。最后再分享一個(gè)小技巧適配完成后把驗(yàn)證腳本留成自動(dòng)化用例每次鴻蒙 SDK 升級(jí)后跑一遍比人工測(cè)試省心得多而且能在平臺(tái)行為變化時(shí)第一時(shí)間發(fā)現(xiàn)問(wèn)題。這套實(shí)踐不止適用于 sanitize_filename任何一個(gè)要在鴻蒙上接原生的 Flutter 插件都可以沿用這個(gè)框架。