跳到主要内容
版本:v7

从文件系统加载照片

我们已经实现了拍照和保存到文件系统的功能。还缺少最后一个功能:照片存储在文件系统中,但我们需要一种方法来保存每个文件的指针,以便它们可以再次显示在相册中。

幸运的是,这很简单:我们将利用 Capacitor Preferences API 将照片数组存储在键值存储中。

Preferences API

打开 usePhotoGallery.ts,首先定义一个常量变量作为存储的键。

export const usePhotoGallery = () => {
const photos = ref<UserPhoto[]>([]);

// 变更:添加照片存储的键
const PHOTO_STORAGE = 'photos';

// ...existing code...
};

接下来,在 usePhotoGallery() 方法的末尾,添加对 cachePhotos 方法的调用来保存 photos 数组。通过在这里添加,每次拍摄新照片时都会存储 photos 数组。这样,无论应用用户关闭应用还是切换到其他应用,所有照片数据都会被保存。

import { ref } from 'vue';
import { Camera, CameraResultType, CameraSource } from '@capacitor/camera';
import type { Photo } from '@capacitor/camera';
import { Filesystem, Directory } from '@capacitor/filesystem';
// 变更:添加导入
import { Preferences } from '@capacitor/preferences';

export const usePhotoGallery = () => {
// ...existing code...

// 变更:添加 `cachePhotos()` 方法
const cachePhotos = () => {
Preferences.set({
key: PHOTO_STORAGE,
value: JSON.stringify(photos.value),
});
};

return {
photos,
addNewToGallery,
};
};

接下来,使用 Vue 的 watch 方法来监听 photos 数组。每当数组被修改时(在本例中,拍照或删除照片),触发 cachePhotos 方法。这样不仅能重用代码,而且无论应用用户关闭应用还是切换到其他应用,照片数据始终会被保存。

usePhotoGallery() 的返回语句上方添加对 watch() 方法的调用。

// 变更:更新导入
import { ref, watch } from 'vue';
import { Camera, CameraResultType, CameraSource } from '@capacitor/camera';
import type { Photo } from '@capacitor/camera';
import { Filesystem, Directory } from '@capacitor/filesystem';
import { Preferences } from '@capacitor/preferences';

export const usePhotoGallery = () => {
// ...existing code...

// 变更:添加对 `watch` 的调用,监听 `photos` 数组并调用 `cachePhotos` 方法
watch(photos, cachePhotos);

return {
photos,
addNewToGallery,
};
};

保存了照片数组数据后,在 usePhotoGallery() 中创建一个名为 loadSaved() 的新方法,用于检索照片数据。我们使用相同的键以 JSON 格式检索 photos 数组,然后将其解析为数组。

export const usePhotoGallery = () => {
// ...existing code...

// 变更:添加 `loadSaved()` 方法
const loadSaved = async () => {
const photoList = await Preferences.get({ key: PHOTO_STORAGE });
const photosInPreferences = photoList.value ? JSON.parse(photoList.value) : [];
};

watch(photos, cachePhotos);

return {
photos,
addNewToGallery,
};
};

在移动设备上(接下来会介绍),我们可以直接将图片标签的源 <img src="x" /> 设置为 Filesystem 上的每个照片文件,从而自动显示它们。然而,在 Web 上,我们必须从 Filesystem 中将每张图片读取为 base64 格式,使用 Photo 对象上新增加的 base64 属性。这是因为 Filesystem API 在底层使用了 IndexedDB。添加以下代码来完成 loadSaved() 方法。

export const usePhotoGallery = () => {
// ...existing code...

// 变更:更新 `loadSaved()` 方法
const loadSaved = async () => {
const photoList = await Preferences.get({ key: PHOTO_STORAGE });
const photosInPreferences = photoList.value ? JSON.parse(photoList.value) : [];

// 变更:通过读取为 base64 格式来显示照片
for (const photo of photosInPreferences) {
const readFile = await Filesystem.readFile({
path: photo.filepath,
directory: Directory.Data,
});
photo.webviewPath = `data:image/jpeg;base64,${readFile.data}`;
}

photos.value = photosInPreferences;
};

watch(photos, cachePhotos);

return {
photos,
addNewToGallery,
};
};

usePhotoGallery.ts 现在应该是这样的:

import { ref, watch } from 'vue';
import { Camera, CameraResultType, CameraSource } from '@capacitor/camera';
import type { Photo } from '@capacitor/camera';
import { Filesystem, Directory } from '@capacitor/filesystem';
import { Preferences } from '@capacitor/preferences';

export const usePhotoGallery = () => {
const photos = ref<UserPhoto[]>([]);

const PHOTO_STORAGE = 'photos';

const addNewToGallery = async () => {
// 拍照
const capturedPhoto = await Camera.getPhoto({
resultType: CameraResultType.Uri,
source: CameraSource.Camera,
quality: 100,
});

const fileName = Date.now() + '.jpeg';
const savedImageFile = await savePicture(capturedPhoto, fileName);

photos.value = [savedImageFile, ...photos.value];
};

const savePicture = async (photo: Photo, fileName: string): Promise<UserPhoto> => {
// 获取照片,读取为 blob,然后转换为 base64 格式
const response = await fetch(photo.webPath!);
const blob = await response.blob();
const base64Data = (await convertBlobToBase64(blob)) as string;

const savedFile = await Filesystem.writeFile({
path: fileName,
data: base64Data,
directory: Directory.Data,
});

// 使用 webPath 显示新图片而不是 base64,因为它
// 已经加载到内存中了
return {
filepath: fileName,
webviewPath: photo.webPath,
};
};

const convertBlobToBase64 = (blob: Blob) => {
return new Promise((resolve, reject) => {
const reader = new FileReader();
reader.onerror = reject;
reader.onload = () => {
resolve(reader.result);
};
reader.readAsDataURL(blob);
});
};

const cachePhotos = () => {
Preferences.set({
key: PHOTO_STORAGE,
value: JSON.stringify(photos.value),
});
};

const loadSaved = async () => {
const photoList = await Preferences.get({ key: PHOTO_STORAGE });
const photosInPreferences = photoList.value ? JSON.parse(photoList.value) : [];

for (const photo of photosInPreferences) {
const readFile = await Filesystem.readFile({
path: photo.filepath,
directory: Directory.Data,
});
photo.webviewPath = `data:image/jpeg;base64,${readFile.data}`;
}

photos.value = photosInPreferences;
};

watch(photos, cachePhotos);

return {
addNewToGallery,
photos,
};
};

export interface UserPhoto {
filepath: string;
webviewPath?: string;
}

我们的 usePhotoGallery() 现在可以加载已保存的图片,但我们需要更新文件以使新代码生效。我们将在 onMounted 生命周期方法中调用 loadSaved,这样当用户首次导航到相册时,所有照片都会加载并显示在屏幕上。

更新 usePhotoGallery.ts 如下所示:

// 变更:更新导入
import { ref, watch, onMounted } from 'vue';
import { Camera, CameraResultType, CameraSource } from '@capacitor/camera';
import type { Photo } from '@capacitor/camera';
import { Filesystem, Directory } from '@capacitor/filesystem';
import { Preferences } from '@capacitor/preferences';

export const usePhotoGallery = () => {
const photos = ref<UserPhoto[]>([]);

const PHOTO_STORAGE = 'photos';

const addNewToGallery = async () => {
// 拍照
const capturedPhoto = await Camera.getPhoto({
resultType: CameraResultType.Uri,
source: CameraSource.Camera,
quality: 100,
});

const fileName = Date.now() + '.jpeg';
const savedImageFile = await savePicture(capturedPhoto, fileName);

photos.value = [savedImageFile, ...photos.value];
};

const savePicture = async (photo: Photo, fileName: string): Promise<UserPhoto> => {
// 获取照片,读取为 blob,然后转换为 base64 格式
const response = await fetch(photo.webPath!);
const blob = await response.blob();
const base64Data = (await convertBlobToBase64(blob)) as string;

const savedFile = await Filesystem.writeFile({
path: fileName,
data: base64Data,
directory: Directory.Data,
});

// 使用 webPath 显示新图片而不是 base64,因为它
// 已经加载到内存中了
return {
filepath: fileName,
webviewPath: photo.webPath,
};
};

const convertBlobToBase64 = (blob: Blob) => {
return new Promise((resolve, reject) => {
const reader = new FileReader();
reader.onerror = reject;
reader.onload = () => {
resolve(reader.result);
};
reader.readAsDataURL(blob);
});
};

const cachePhotos = () => {
Preferences.set({
key: PHOTO_STORAGE,
value: JSON.stringify(photos.value),
});
};

const loadSaved = async () => {
const photoList = await Preferences.get({ key: PHOTO_STORAGE });
const photosInPreferences = photoList.value ? JSON.parse(photoList.value) : [];

for (const photo of photosInPreferences) {
const readFile = await Filesystem.readFile({
path: photo.filepath,
directory: Directory.Data,
});
photo.webviewPath = `data:image/jpeg;base64,${readFile.data}`;
}

photos.value = photosInPreferences;
};

// 变更:添加对 `onMounted()` 的调用,配合 `loadSaved()` 方法
onMounted(loadSaved);
watch(photos, cachePhotos);

return {
addNewToGallery,
photos,
};
};

export interface UserPhoto {
filepath: string;
webviewPath?: string;
}
备注

如果按照这些步骤操作后看到损坏的图片链接或照片丢失,你可能需要打开浏览器的开发者工具,清除 localStorageIndexedDB

在 localStorage 中,查找域名 http://localhost:8100 和键 CapacitorStorage.photos。在 IndexedDB 中,查找名为 "FileStorage" 的存储。你的照片将具有类似 /DATA/123456789012.jpeg 的键。

就是这样!我们已经构建了一个完整的相册功能,可以在 Web 上运行。接下来,我们将把它转变为 iOS 和 Android 的移动应用!