前端Vue3+vant实现OSS上传图片全过程

 更新时间:2025年05月14日 09:39:32   作者:自信的飞  
这篇文章主要介绍了前端Vue3+vant实现OSS上传图片的相关资料,文中通过示例代码详细说明了上传文件的总流程,包括可能出现的跨域问题以及如何配置服务器以解决跨域问题,需要的朋友可以参考下

首先,下面这些信息从阿里云服务器OSS管理中获取

aliyun:
    oss:
        file:
            endpoint: "oss-cn-beijing.aliyuncs.com"
            keyid: "xxxxxxxxx"
            keysecret: "xxxxxxxxxxxx"
            bucketname: "xxxx"

一、安装OSS

npm install ali-oss

二、以下步骤中解决引入ts校验的,有些地方比较多余,想试试也行,直接跳过吧

在 TypeScript 中,如果你遇到“无法找到模块 'ali-oss' 的声明文件”的错误,通常是因为该模块没有提供类型定义文件

解决方法:

1.安装类型定义:

如果 ali-oss 没有提供类型定义文件,你可以尝试安装 @types/ali-oss,但目前可能没有可用的类型定义。

npm install --save-dev @types/ali-oss
pnpm add -D @types/ali-oss

如果没有这个包,你可以手动创建一个类型定义文件。

2.手动创建类型定义:

  • 在你的项目中创建一个类型定义文件,例如 src/types/ali-oss.d.ts,并添加以下内容:
declare module 'ali-oss' {
  export interface OSSClient {
    put(object: string, file: any, options?: any): Promise<any>;
    // 添加其他需要的方法和属性
  }

  export default function OSS(options: {
    region: string;
    accessKeyId: string;
    accessKeySecret: string;
    bucket: string;
  }): OSSClient;
}
  • 更新 tsconfig.json:

    • 确保 TypeScript 配置文件 (tsconfig.json) 中包含了类型定义文件的路径:
{
  "compilerOptions": {
    "typeRoots": [
      "./node_modules/@types",
      "./src/types"  // 添加自定义类型位置
    ]
  }
}

3.扩展:

使用 require:

  • 如果你不想定义类型,可以使用 require 来引入模块,这样 TypeScript 不会检查类型:
const OSS = require('ali-oss');

总结:通过手动创建类型定义文件或使用 require,可以解决无法找到模块声明文件的问题。

扩展:

endpoint

  • oss-cn-beijing.aliyuncs.com:
    • oss:表示这是 OSS 服务。
    • cn:表示中国区域。
    • beijing:表示具体的地理区域,即北京。

其他区域示例

如果你有其他的 endpoint,可以根据以下格式进行解析:

  • 上海: 

oss-cn-shanghai.aliyuncs.com -> region: 'cn-shanghai'

  • 广州: 

oss-cn-guangzhou.aliyuncs.com -> region: 'cn-guangzhou'

  • 香港: 

oss-ap-hongkong.aliyuncs.com -> region: 'ap-hongkong'

确认区域:

如果不确定,可以在阿里云控制台中查看你的 Bucket 的具体区域,或者查阅阿里云的官方文档,以获取更详细的信息。

三、配置阿里云 OSS:

// 配置阿里云 OSS
// Bucket名称,用于标识OSS存储空间
const BUCKET_NAME = 'xxxxx';
// OSS的地域节点,用于访问OSS服务的域名
const ENDPOINT = 'oss-cn-beijing.aliyuncs.com';

// 创建OSS客户端实例
const client = new OSS({
  region: 'oss-cn-beijing',    // 地域,例如:华北2(北京)
  accessKeyId: 'xxxxxxxxx',      // 访问密钥ID,用于身份验证
  accessKeySecret: 'xxxxxxxx',  // 访问密钥密码
  bucket: BUCKET_NAME,         // 指定操作的Bucket
  secure: true,               // 使用HTTPS协议
  cname: false,              // 是否使用自定义域名,false表示使用阿里云默认域名
});
  • secure : 默认为 false ,表示使用 HTTP 协议。不写的话可能会存在安全风险,建议在生产环境中设置为 true 使用 HTTPS。
  • cname : 默认为 false ,表示使用阿里云默认域名。如果不需要自定义域名,可以不写这个配置。
  • timeout : 默认为 60000 (60秒)。如果不写,上传超时时间就是默认的 60 秒,对于大多数场景来说已经足够。

Bucket 名称:

这个一般是未公开的,所以需要再定一一个在外面,OSS里面那个删除即可,不需要,也无法使用

  • 在对象的外面定义:
const BUCKET_NAME = 'xxxxx'; // 定义 Bucket 名称,这里换成你自己的

        2.并在需要生成文件 URL 时使用该常量,ENDPOINT同理:

// 生成文件的在线链接

const url = `https://${BUCKET_NAME}.${ENDPOINT}/${fileName}`;

ENDPOINT:

在生成 URL 时,client.options.endpoint 是用于获取 OSS 访问地址的一部分。然而,client.options 本身可能并不包含 endpoint 属性。通常,endpoint 是在创建 OSS 客户端时指定的配置选项之一,但它并不会直接暴露在 options 中。

可以在创建 OSS 客户端时直接保存 endpoint,然后在生成 URL 时使用这个值。以下是如何实现的示例代码:

const ENDPOINT = 'oss-cn-beijing.aliyuncs.com'; // 替换为实际 Endpoint

四、上传文件总流程:

<script setup lang="ts">
import { ref } from 'vue';
import { showToast } from 'vant'; // 导入 Vant 的类型
import type { UploaderFileListItem } from 'vant'; // 正确导入类型
import OSS from 'ali-oss';


// 声明 fileList,类型为 UploaderFilelistItem[]
const fileList = ref<UploaderFileListItem[]>([]);

// oversize 事件处理函数
const maxFileSize = 50 * 1024 * 1024; // 50MB
const onOversize = (file: File) => {
  if (file.size > maxFileSize) {
    showToast(`文件大小不能超过 ${maxFileSize / (1024 * 1024)}MB`);
    return false;
  }
  return true;
};
// 配置阿里云 OSS
// Bucket名称,用于标识OSS存储空间
const BUCKET_NAME = 'xxxxx'; // 替换成实际的
// OSS的地域节点,用于访问OSS服务的域名
const ENDPOINT = 'oss-cn-beijing.aliyuncs.com';

// 创建OSS客户端实例
const client = new OSS({
  region: 'oss-cn-beijing',    // 地域,例如:华北2(北京)
  accessKeyId: 'xxxxxxxx',      // 访问密钥ID,用于身份验证
  accessKeySecret: 'xxxxxxx',  // 访问密钥密码
  bucket: BUCKET_NAME,         // 指定操作的Bucket
  secure: true,               // 使用HTTPS协议
  cname: false,              // 是否使用自定义域名,false表示使用阿里云默认域名
  timeout: 60000             // 超时时间,单位:毫秒(这里设置为60秒)
});
// - secure : 默认为 false ,表示使用 HTTP 协议。不写的话可能会存在安全风险,建议在生产环境中设置为 true 使用 HTTPS。
// - cname : 默认为 false ,表示使用阿里云默认域名。如果不需要自定义域名,可以不写这个配置。
// - timeout : 默认为 60000 (60秒)。如果不写,上传超时时间就是默认的 60 秒,对于大多数场景来说已经足够。

// 上传文件的函数
const uploadFile = async (file: File) => {
  try {
    // 生成唯一文件名,包含文件夹路径
    // 获取当前日期
    const timestamp = new Date();
    const year = timestamp.getFullYear();
    const month = String(timestamp.getMonth() + 1).padStart(2, '0');
    const day = String(timestamp.getDate()).padStart(2, '0');
    const randomString = Math.random().toString(36).substring(2, 8);

    // 指定上传路径
    let filePath: string; // 添加变量声明

    // 判断文件类型
    const isImage = file.type.startsWith('image/');
    if (isImage) {
      // 添加随机字符串
      filePath = `png/${year}/${month}/${day}/${randomString}_${file.name}`;
    } else {
      filePath = `video/${year}/${month}/${day}/${randomString}_${file.name}`;
    }
    // 上传文件到 OSS
    // client.put() 方法会将文件上传到 OSS,其中:
    // - filePath 参数指定了文件在 OSS 中的存储路径
    //   - file 参数是要上传的文件对象
    const result = await client.put(filePath, file);
    // 生成文件的在线链接
    const url = `https://${BUCKET_NAME}.${ENDPOINT}/${filePath}`;
    console.log('上传成功:', result);
    console.log('文件在线链接:', url);
    return url;
  } catch (error) {
    console.error('上传失败:', error);
    return null; // 或者返回一个默认的错误链接
  }
};


const handleSubmit = async () => {
  fileList.value.forEach(item => {
    // 使用类型断言将 item.file 转换为 File 类型
    const file = item.file as File;
    uploadFile(file)
  });
};


// 提交文件函数
const submitFile = async () => {
  handleSubmit()
};

</script>
<template>
  <div>
    <van-uploader ref="mediaUploader" v-model="fileList" multiple class="uploader-container" accept="image/*,video/*"
      max-count="6" @oversize="onOversize" />
    <button @click="submitFile">点击上传</button>
  </div>
</template>

<style scoped>
/* 添加必要的样式 */
</style>

上传可能出现的问题:

  • 如果跨域,这个时候要去服务器配置允许访问的IP地址,防止出现跨域报错,这个是需要去官网到自己的服务器去配置的

关键点总结:

  • 获取服务器相关配置信息
  • 安装OSS
  • 使用自带的put方法上传图片
const result = await client.put(filePath, file);
  • 图片路径就是仓库路径拼接的,使用put方法上传会自动到那个仓库路径下去存 
  • 服务器需要配置跨域

总结 

到此这篇关于前端Vue3+vant实现OSS上传图片的文章就介绍到这了,更多相关Vue3 vant实现OSS上传图片内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 快速搭建vue2.0+boostrap项目的方法

    快速搭建vue2.0+boostrap项目的方法

    这篇文章主要介绍了快速搭建vue2.0+boostrap项目的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-04-04
  • 降低vue-router版本的2种解决方法实例

    降低vue-router版本的2种解决方法实例

    vue-router是Vue.js官方的路由插件,它和vue.js是深度集成的,适合用于构建单页面应用,下面这篇文章主要给大家介绍了关于降低vue-router版本的2种解决方法,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-07-07
  • 如何利用Vue3管理系统实现动态路由和动态侧边菜单栏

    如何利用Vue3管理系统实现动态路由和动态侧边菜单栏

    通常我们在vue项目中都是前端配置好路由的,但在一些项目中我们可能会遇到权限控制,这样我们就涉及到动态路由的设置了,下面这篇文章主要给大家介绍了关于如何利用Vue3管理系统实现动态路由和动态侧边菜单栏的相关资料,需要的朋友可以参考下
    2022-02-02
  • 详解vue数据渲染出现闪烁问题

    详解vue数据渲染出现闪烁问题

    本篇文章主要介绍了vue数据渲染出现闪烁问题,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-06-06
  • html+vue实现分页功能的示例代码

    html+vue实现分页功能的示例代码

    这篇文章主要为大家详细介绍了如何使用html+vue实现简单的分页功能,文中的示例代码简洁易懂,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-04-04
  • 详解基于element的区间选择组件校验(交易金额)

    详解基于element的区间选择组件校验(交易金额)

    这篇文章主要介绍了详解基于element的区间选择组件校验(交易金额),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01
  • Vue中的ESLint配置方式

    Vue中的ESLint配置方式

    这篇文章主要介绍了Vue中的ESLint配置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • Vue3封装自定义指令的操作步骤

    Vue3封装自定义指令的操作步骤

    在 Vue 3 中,封装自定义指令可以帮助你更好地复用一些常见的DOM操作逻辑,自定义指令可以用于处理一些特定的用户交互行为,本文给大家介绍了Vue3封装自定义指令的示例,需要的朋友可以参考下
    2024-11-11
  • Vue3 Reactive响应式原理逻辑详解

    Vue3 Reactive响应式原理逻辑详解

    这篇文章主要介绍了Vue3 Reactive响应式原理逻辑详解,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-07-07
  • vue+element实现手机号验证码注册的示例

    vue+element实现手机号验证码注册的示例

    本文主要介绍了vue+element实现手机号验证码注册的示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01

最新评论