pj_admin_cloud/src/components/Upload/Image.vue

<template>
	<div class="upload-box">
		<el-upload
			action="#"
			:id="uuid"
			:class="['upload', self_disabled ? 'disabled' : '', drag ? 'no-border' : '']"
			:multiple="false"
			:disabled="self_disabled"
			:show-file-list="false"
			:http-request="handleHttpUpload"
			:before-upload="beforeUpload"
			:on-success="uploadSuccess"
			:on-error="uploadError"
			:drag="drag"
			:accept="fileType.join(',')"
		>
			<template v-if="imageUrl">
				<!-- 如果返回的是OSS 地址则不需要增加 baseURL -->
				<img :src="$fileUrl(imageUrl)" class="upload-image"  @error="$fileRetry(imageUrl)" />
				<div class="upload-handle" @click.stop>
					<div class="handle-icon" @click="editImg" v-if="!self_disabled">
						<el-icon :size="props.iconSize"><Edit /></el-icon>
						<span v-if="!props.iconSize">{{ $t("common.editBtn") }}</span>
					</div>
					<div class="handle-icon" @click="imgViewVisible = true">
						<el-icon :size="props.iconSize"><ZoomIn /></el-icon>
						<span v-if="!props.iconSize">{{ $t("common.viewBtn") }}</span>
					</div>
					<div class="handle-icon" @click="deleteImg" v-if="!self_disabled">
						<el-icon :size="props.iconSize"><Delete /></el-icon>
						<span v-if="!props.iconSize">{{ $t("common.delBtn") }}</span>
					</div>
				</div>
			</template>
			<template v-else>
				<div class="upload-empty">
					<slot name="empty">
						<el-icon><Plus /></el-icon>
						<!-- <span>请上传图片</span> -->
					</slot>
				</div>
			</template>
		</el-upload>
		<div class="el-upload__tip">
			<slot name="tip"></slot>
		</div>
		<el-image-viewer
			:teleported="true"
			v-if="imgViewVisible"
			@close="imgViewVisible = false"
			:url-list="$fileUrls([imageUrl])"
		/>
	</div>
</template>

<script setup lang="ts" name="UploadImg">
import { ref, computed, inject } from "vue"
import { ElNotification, formContextKey, formItemContextKey } from "element-plus"
import type { UploadProps, UploadRequestOptions } from "element-plus"
import { generateUUID } from "/@/utils/other"
import request from "/@/utils/request"

interface UploadFileProps {
	imageUrl?: string // 图片地址 ==> 必传
	uploadFileUrl?: string // 上传图片的 api 方法，一般项目上传都是同一个 api 方法，在组件里直接引入即可 ==> 非必传
	drag?: boolean // 是否支持拖拽上传 ==> 非必传（默认为 true）
	disabled?: boolean // 是否禁用上传组件 ==> 非必传（默认为 false）
	fileSize?: number // 图片大小限制 ==> 非必传（默认为 5M）
	fileType?: string[] // 图片类型限制 ==> 非必传（默认 JPEG、PNG、GIF、WebP）
	height?: string // 组件高度 ==> 非必传（默认为 150px）
	width?: string // 组件宽度 ==> 非必传（默认为 150px）
	borderRadius?: string // 组件边框圆角 ==> 非必传（默认为 8px）
	iconSize?: number
	dir?: string // 文件目录
	listType?: string
}

// 接受父组件参数
const props = withDefaults(defineProps<UploadFileProps>(), {
	imageUrl: "",
	uploadFileUrl: "/admin/sys-file/upload",
	drag: true,
	disabled: false,
	fileSize: 5,
	fileType: () => ["image/jpeg", "image/png", "image/gif", "image/webp"],
	height: "150px",
	width: "150px",
	borderRadius: "8px",
	dir: "",
	listType: "",
})

// 生成组件唯一id
const uuid = ref("id-" + generateUUID())

// 查看图片
const imgViewVisible = ref(false)
// 获取 el-form 组件上下文
const formContext = inject(formContextKey, void 0)
// 获取 el-form-item 组件上下文
const formItemContext = inject(formItemContextKey, void 0)
// 判断是否禁用上传和删除
const self_disabled = computed(() => {
	return props.disabled || formContext?.disabled
})

/**
 * @description 图片上传
 * @param options upload 所有配置项
 * */
interface UploadEmits {
	(e: "update:imageUrl", value: string): void
}
const emit = defineEmits<UploadEmits>()
const handleHttpUpload = async (options: UploadRequestOptions) => {
	let formData = new FormData()
	formData.append("file", options.file)
	formData.append("dir", props.dir)
	const { data } = await request({
		url: props.uploadFileUrl,
		method: "post",
		headers: {
			"Content-Type": "multipart/form-data",
		},
		data: formData,
	})
	emit("update:imageUrl", data.url)
	// 调用 el-form 内部的校验方法（可自动校验）
	formItemContext?.prop && formContext?.validateField([formItemContext.prop as string])
}

/**
 * @description 删除图片
 * */
const deleteImg = () => {
	emit("update:imageUrl", "")
}

/**
 * @description 编辑图片
 * */
const editImg = () => {
	const dom = document.querySelector(`#${uuid.value} .el-upload__input`)
	dom && dom.dispatchEvent(new MouseEvent("click"))
}

/**
 * @description 文件上传之前判断
 * @param rawFile 选择的文件
 * */
const beforeUpload: UploadProps["beforeUpload"] = (rawFile) => {
	const imgSize = rawFile.size / 1024 / 1024 < props.fileSize
	const imgType = props.fileType.includes(rawFile.type)
	if (!imgType)
		ElNotification({
			title: "温馨提示",
			message: "上传图片不符合所需的格式！",
			type: "warning",
		})
	if (!imgSize)
		setTimeout(() => {
			ElNotification({
				title: "温馨提示",
				message: `上传图片大小不能超过 ${props.fileSize}M！`,
				type: "warning",
			})
		}, 0)
	return imgType && imgSize
}

/**
 * @description 图片上传成功
 * */
const uploadSuccess = () => {
	ElNotification({
		title: "温馨提示",
		message: "图片上传成功！",
		type: "success",
	})
}

/**
 * @description 图片上传错误
 * */
const uploadError = (error: any) => {
	ElNotification({
		title: "温馨提示",
		message: error?.msg || error?.message || "图片上传失败，请您重新上传！",
		type: "error",
	})
}
</script>
<style scoped lang="scss">
.is-error {
	.upload {
		:deep(.el-upload),
		:deep(.el-upload-dragger) {
			border: 1px dashed var(--el-color-danger) !important;
			&:hover {
				border-color: var(--el-color-primary) !important;
			}
		}
	}
}
:deep(.disabled) {
	.el-upload,
	.el-upload-dragger {
		cursor: not-allowed !important;
		background: var(--el-disabled-bg-color);
		border: 1px dashed var(--el-border-color-darker) !important;
		&:hover {
			border: 1px dashed var(--el-border-color-darker) !important;
		}
	}
}
.upload-box {
	.no-border {
		:deep(.el-upload) {
			border: none !important;
		}
	}
	:deep(.upload) {
		.el-upload {
			position: relative;
			display: flex;
			align-items: center;
			justify-content: center;
			width: v-bind(width);
			height: v-bind(height);
			overflow: hidden;
			border: 1px dashed var(--el-border-color-darker);
			border-radius: v-bind(borderRadius);
			transition: var(--el-transition-duration-fast);
			&:hover {
				border-color: var(--el-color-primary);
				.upload-handle {
					opacity: 1;
				}
			}
			.el-upload-dragger {
				display: flex;
				align-items: center;
				justify-content: center;
				width: 100%;
				height: 100%;
				padding: 0;
				overflow: hidden;
				background-color: transparent;
				border: 1px dashed var(--el-border-color-darker);
				border-radius: v-bind(borderRadius);
				&:hover {
					border: 1px dashed var(--el-color-primary);
				}
			}
			.el-upload-dragger.is-dragover {
				background-color: var(--el-color-primary-light-9);
				border: 2px dashed var(--el-color-primary) !important;
			}
			.upload-image {
				width: 100%;
				height: 100%;
				object-fit: contain;
			}
			.upload-empty {
				position: relative;
				display: flex;
				flex-direction: column;
				align-items: center;
				justify-content: center;
				font-size: 12px;
				line-height: 30px;
				color: var(--el-color-info);
				.el-icon {
					font-size: 28px;
					color: var(--el-text-color-secondary);
				}
			}
			.upload-handle {
				position: absolute;
				top: 0;
				right: 0;
				box-sizing: border-box;
				display: flex;
				align-items: center;
				justify-content: center;
				width: 100%;
				height: 100%;
				cursor: pointer;
				background: rgb(0 0 0 / 60%);
				opacity: 0;
				transition: var(--el-transition-duration-fast);
				.handle-icon {
					display: flex;
					flex-direction: column;
					align-items: center;
					justify-content: center;
					padding: 0 6%;
					color: aliceblue;
					.el-icon {
						margin-bottom: 40%;
						font-size: 130%;
						line-height: 130%;
					}
					span {
						font-size: 85%;
						line-height: 85%;
					}
				}
			}
		}
	}
	.el-upload__tip {
		line-height: 18px;
		text-align: center;
	}
}
</style>