
文件上传是web应用中常见的交互功能,而对上传文件的类型、大小乃至尺寸进行验证,是确保数据质量和用户体验的关键环节。特别是在处理图片上传时,限制图片的尺寸(宽度和高度)变得尤为重要。本教程将深入探讨如何在客户端,特别是使用 javascript/typescript 环境下,实现对上传图片尺寸的有效验证。
在浏览器环境中,要获取一个本地文件(File 对象)的图片尺寸,我们不能直接从 File 对象本身获取。需要借助 Image 对象和 URL.createObjectURL 方法。
以下是获取图片尺寸的基础代码示例:
// 假设 x 是一个 File 对象
if (x?.type.includes('image/')) {
const url = URL.createObjectURL(x); // 创建一个临时的对象 URL
const img = new Image();
img.onload = function () {
console.log(`图片宽度: ${img.width}, 图片高度: ${img.height}`);
URL.revokeObjectURL(img.src); // 释放内存
};
img.onerror = function () {
console.error('图片加载失败');
URL.revokeObjectURL(img.src); // 即使失败也要释放
};
img.src = url; // 设置图片源,开始加载
}由于 img.onload 是一个异步回调,直接在同步的验证器中使用会比较困难。为了更好地集成到现代 JavaScript/TypeScript 的异步流程中,我们可以将这个过程封装成一个返回 Promise 的方法。这样,我们就可以使用 async/await 来“同步”地等待尺寸结果。
/**
* 从 File 对象中异步获取图片的宽度和高度。
* @param file - 要获取尺寸的 File 对象。
* @returns 一个 Promise,解析为包含 width 和 height 的对象。
*/
function getDimensions(file: File): Promise<{ width: number; height: number }> {
return new Promise((resolve, reject) => {
if (!file.type.includes('image/')) {
reject(new Error('非图片文件'));
return;
}
const url = URL.createObjectURL(file);
const img = new Image();
img.onload = () => {
URL.revokeObjectURL(img.src); // 释放内存
resolve({ width: img.width, height: img.height });
};
img.onerror = () => {
URL.revokeObjectURL(img.src); // 即使加载失败也要释放
reject(new Error('图片加载失败或无法获取尺寸'));
};
img.src = url;
});
}在前端框架(如 Angular)中,验证器通常是同步函数,返回 ValidationErrors | null。然而,获取图片尺寸是一个异步操作。因此,如果要在验证器内部执行此操作,该验证器本身也需要是异步的,即返回 Promise<ValidationErrors | null> 或 Observable<ValidationErrors | null>。
立即学习“Java免费学习笔记(深入)”;
下面我们将创建一个异步验证器,它将结合文件大小验证和图片尺寸验证。
import { AbstractControl, AsyncValidatorFn, ValidationErrors } from '@angular/forms';
// 假设 IUploadFileControl 是你的文件上传控件值类型,allFiles 包含 File 数组
interface IUploadFileControl {
allFiles: File[];
// ...其他属性
}
const VALIDATION_LABEL_ATTACHMENT_MAX_SIZE = '文件大小超出限制';
const VALIDATION_LABEL_IMAGE_DIMENSIONS = '图片尺寸不符合要求';
/**
* 从 File 对象中异步获取图片的宽度和高度。
* @param file - 要获取尺寸的 File 对象。
* @returns 一个 Promise,解析为包含 width 和 height 的对象。
*/
function getDimensions(file: File): Promise<{ width: number; height: number }> {
return new Promise((resolve, reject) => {
if (!file.type.includes('image/')) {
// 如果不是图片,直接拒绝或返回默认值,取决于业务需求
reject(new Error('非图片文件'));
return;
}
const url = URL.createObjectURL(file);
const img = new Image();
img.onload = () => {
URL.revokeObjectURL(img.src);
resolve({ width: img.width, height: img.height });
};
img.onerror = () => {
URL.revokeObjectURL(img.src);
reject(new Error('图片加载失败或无法获取尺寸'));
};
img.src = url;
});
}
/**
* 异步文件上传验证器,检查文件大小和图片尺寸。
* @param maxFileSize - 允许的最大文件大小(字节)。
* @param maxWidth - 允许的最大图片宽度。
* @param maxHeight - 允许的最大图片高度。
* @returns 一个 AsyncValidatorFn。
*/
export const filesDimensionAndSizeValidator =
(maxFileSize: number, maxWidth: number, maxHeight: number): AsyncValidatorFn =>
async (control: AbstractControl): Promise<ValidationErrors | null> => {
const value: IUploadFileControl = control.value;
if (value == null || value.allFiles.length === 0) {
return null; // 没有文件,无需验证
}
for (const x of value.allFiles) {
// 1. 文件大小验证
if (x.size > maxFileSize) {
return { file_max_size: VALIDATION_LABEL_ATTACHMENT_MAX_SIZE };
}
// 2. 图片尺寸验证 (仅对图片文件)
if (x.type.includes('image/')) {
try {
const { width, height } = await getDimensions(x);
if (width > maxWidth || height > maxHeight) {
return { image_dimensions: VALIDATION_LABEL_IMAGE_DIMENSIONS };
}
} catch (error) {
// 可以在这里处理图片加载失败的情况,例如返回一个特定的错误
console.error(`处理文件 ${x.name} 时出错:`, error);
// return { image_processing_error: '图片处理失败' };
// 或者,如果图片加载失败不应阻止上传,则忽略此错误并继续
}
}
}
return null; // 所有文件通过验证
};使用示例:
在 Angular 的 FormBuilder 或 FormControl 中使用此异步验证器:
import { FormBuilder, Validators } from '@angular/forms';
// ...
constructor(private fb: FormBuilder) {
this.uploadForm = this.fb.group({
// 假设 'fileUploader' 是你的文件上传控件名称
fileUploader: [
null,
// 同步验证器(如果需要)
// [Validators.required],
// 异步验证器
[filesDimensionAndSizeValidator(5 * 1024 * 1024, 1920, 1080)] // 5MB, 1920x1080
]
});
}
// ...通过 Image 对象和 URL.createObjectURL 结合 Promise 封装,我们能够有效地在客户端实现对上传图片尺寸的精确验证。将这个异步逻辑集成到前端框架的异步验证器中,可以确保在文件上传前就满足所有预设的尺寸要求,从而提升应用的数据质量和用户体验。在实现过程中,关注 MIME 类型检查、内存管理和错误处理等最佳实践,将使你的文件上传功能更加健壮和高效。
以上就是JavaScript/TypeScript 文件上传:实现图片尺寸验证教程的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号