純前端也可以訪問文件系統(tǒng)!
前言
周末逛github的時(shí)候,發(fā)現(xiàn)我們只需要在github域名上加上1s他就能夠打開一個(gè)vscode窗口來閱讀代碼,比起在github倉庫中查看更加方便
圖片
然后我就想網(wǎng)頁端vscode能不能打開我本地的項(xiàng)目呢,帶著這個(gè)疑惑我打開了網(wǎng)頁版vscode,它居然真的可以打開我本地的項(xiàng)目代碼!
圖片
難道又出了新的API讓前端的能力更進(jìn)一步了?打開MDN查了一下相關(guān)文檔,發(fā)現(xiàn)了幾個(gè)新的API
showOpenFilePicker
用來選擇文件
圖片
語法
showOpenFilePicker()
參數(shù)
- 「options」:(可選)包含以下屬性
multiple:布爾值,默認(rèn)為false。為true表示允許用戶選擇多個(gè)文件
excludeAcceptAllOption:布爾值,默認(rèn)為false。默認(rèn)情況下,文件選擇器帶有一個(gè)允許用戶選擇所有類型文件的過濾選項(xiàng)(展開于文件類型選項(xiàng)中)。設(shè)置此選項(xiàng)為 true 以使該過濾選項(xiàng)不可用。
types:表示允許選擇的文件類型的數(shù)組
返回值
返回一個(gè)promise對象,會(huì)兌現(xiàn)一個(gè)包含 FileSystemFileHandle 對象的 Array 數(shù)組。
體驗(yàn)
<template>
<div class="open_file" @click="openFile">打開文件</div>
</template>
<script setup lang="ts">
const openFile = async () => {
const res = await window.showOpenFilePicker();
console.log(res);
};
</script>
默認(rèn)只能打開一個(gè)文件,可以傳入multiple:true打開多個(gè)文件
圖片
showDirectoryPicker
用來選擇目錄
圖片
語法
屬于瀏覽器全局方法,直接調(diào)用即可
showDirectoryPicker()
參數(shù)
- 「options」:(可選)包含以下屬性
multiple:布爾值,默認(rèn)為false。為true表示允許用戶選擇多個(gè)文件
excludeAcceptAllOption:布爾值,默認(rèn)為false。默認(rèn)情況下,文件選擇器帶有一個(gè)允許用戶選擇所有類型文件的過濾選項(xiàng)(展開于文件類型選項(xiàng)中)。設(shè)置此選項(xiàng)為 true 以使該過濾選項(xiàng)不可用。
types:表示允許選擇的文件類型的數(shù)組
返回值
返回一個(gè)promise對象,會(huì)兌現(xiàn)一個(gè)包含 FileSystemFileHandle 對象的 Array 數(shù)組。
體驗(yàn)
<template>
<div class="open_file" @click="openFile">打開文件</div>
<div class="open_file" @click="openDir">打開文件夾</div>
</template>
<script setup lang="ts">
const openFile = async () => {
const res = await window.showOpenFilePicker({
// multiple: true,
});
console.log(res.length);
};
const openDir = async () => {
const res = await window.showDirectoryPicker();
console.log(res);
};
</script>
圖片
擴(kuò)展
FileSystemFileHandle
FileSystemFileHandle提供了一些方法可以用來獲取和操作文件
- getFile:返回一個(gè)Promise對象,用于獲取文件;
- createSyncAccessHandle:返回一個(gè)FileSystemSyncAccessHandle對象,用于同步訪問文件;
- createWritable:返回一個(gè)Promise對象,用于創(chuàng)建一個(gè)可寫流,用于寫入文件;
FileSystemDirectoryHandle
FileSystemDirectoryHandle對象是一個(gè)代表文件系統(tǒng)中的目錄的對象,它同樣提供了方法來獲取和操作目錄
- entries:返回一個(gè)AsyncIterable對象,用于獲取目錄中的所有文件和目錄;
- keys:返回一個(gè)AsyncIterable對象,用于獲取目錄中的所有文件和目錄的名稱;
- values:返回一個(gè)AsyncIterable對象,用于獲取目錄中的所有文件和目錄的FileSystemHandle對象;
- getFileHandle:返回一個(gè)Promise對象,用于獲取目錄中的文件;
- getDirectoryHandle:返回一個(gè)Promise對象,用于獲取目錄中的目錄;
- removeEntry:返回一個(gè)Promise對象,用于刪除目錄中的文件或目錄;
- resolve:返回一個(gè)Promise對象,用于獲取目錄中的文件或目錄;
entries、keys、values這三個(gè)方法都是用來獲取目錄中的所有文件和目錄的,它們返回的都是一個(gè)AsyncIterable對象,我們可以通過for await...of語法來遍歷它。
開發(fā)編輯器
了解完這些知識(shí)點(diǎn),我們就可以來開發(fā)一個(gè)簡陋網(wǎng)頁版編輯器了,初期只包含打開文件、打開文件夾、查看文件、切換文件
編輯器大概長這樣:
圖片
打開文件夾
const openDir = async () => {
const res = await window.showDirectoryPicker({});
const detalAction = async (obj: any) => {
if (obj.entries) {
const dirs = obj.entries();
for await (const entry of dirs) {
if (entry[1].entries) {
// 文件夾,遞歸處理
detalAction(entry[1]);
} else {
// 文件
fileList.value.push({
name: entry[0],
path: obj.name,
fileHandle: entry[1],
});
}
}
}
};
await detalAction(res);
showCode(fileList.value[0], 0);
console.log("--fileList--", fileList);
};
這里主要是遞歸處理文件夾,返回一個(gè)文件列表
讀取文件內(nèi)容
const showCode = async (item: any, index: number) => {
const file = await item.fileHandle.getFile();
const text = await file.text();
codeText.value = text;
currentIndex.value = index;
};
展示文件內(nèi)容
使用highlight.js來高亮展示代碼
<div class="show_code">
<pre v-highlight>
<code class="lang-dart">
{{ codeText }}
</code>
</pre>
</div>
最終效果如下:
圖片
想不到吧,這種功能現(xiàn)在純前端就能夠?qū)崿F(xiàn)了,當(dāng)然還可以做的更復(fù)雜一點(diǎn),包括修改保存等功能,保存可以使用showSaveFilePickerAPI,它可以寫入文件,同樣是返回一個(gè)promise。感興趣的可以試著完善編輯器的功能。