vue3如何使用el-upload上传文件

其他教程   发布日期:2023年07月06日   浏览次数:969

这篇文章主要讲解了“vue3如何使用el-upload上传文件”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“vue3如何使用el-upload上传文件”吧!

el-upload上传文件

在项目开发的过程中上传文件的需求是经常会遇到的,这篇文章我们就详细介绍使用elementplus中el-upload来上传文件了。

我们先来看一下el-upload可以配置哪些属性和事件。

属性

  • action: 请求url

  • headers: 设置上传的请求头部

  • method: 设置上传请求方法

  • multiple: 是否支持多选文件

  • data: 上传时附带的额外参数

  • name: 上传的文件字段名

  • with-credentials: 支持发送cookie凭证信息

以上这些参数都是采用action的默认方式请求时使用的,如果我们使用自定义的请求方法,这些属性基本上都不会使用到。

  • show-file-list: 是否显示已上传文件列表

  • drag: 是否启用拖拽上传

  • accept: 接受上传的文件类型

  • on-preview: 点击文件列表中已上传文件时的钩子

  • on-remove: 文件列表移除文件时的钩子

  • on-success: 文件上传成功时的钩子

  • on-error: 文件上传失败时的钩子

  • on-progress: 文件上传时的钩子

  • on-change: 文件状态改变时的钩子,添加,上传成功和失败都会被调用

  • on-exceed: 当超出限制时执行的钩子

  • before-upload: 文件上传之前的钩子,参数为上传的文件, 若返回

    1. false
    或者返回
    1. Promise
    且被 reject,则停止上传。
  • before-remove: 删除文件之前的钩子,参数为上传的文件和文件列表, 若返回

    1. false
    或者返回
    1. Promise
    且被 reject,则停止删除。
  • file-list/v-model:file-list: 默认上传文件

  • list-type: 文件列表的类型,'text' | 'picture' | 'picture-card'。

  • auto-upload: 是否自动上传文件

  • http-request: 覆盖默认的 Xhr 行为,允许自行实现上传文件的请求

  • disabled: 是否禁用上传

  • limit: 允许上传文件的最大数量

方法

  • abort: 取消上传请求

  • submit: 手动上传文件列表

  • clearFiles: 清空已上传的文件列表(该方法不支持在

    1. before-upload
    中调用)
  • handleStart: 手动选择文件

  • handleRemove: 手动移除文件。

    1. file
    1. rawFile
    已被合并。

上传图片的实现

上传图片的时候我们一般都会重写http请求,不使用默认的action去请求,因此action我们一般都会设置成‘#’。

  1. <template>
  2. <div>
  3. <el-upload
  4. action="#"
  5. :headers="headers"
  6. :list-type="listType"
  7. :http-request="uploadAction"
  8. :on-exceed="handleExceed"
  9. :on-remove="handleRemove"
  10. :before-upload="beforeUpload"
  11. :on-success="uploadSuccess"
  12. :on-error="uploadError"
  13. :on-progress="uploadProgress"
  14. :file-list="fileListCopy.data"
  15. ref="upload"
  16. :multiple="true"
  17. :limit='limit'
  18. :disabled="disabled"
  19. :data="paramData"
  20. >
  21. <el-icon><Plus /></el-icon>
  22. <template #file="{ file }">
  23. <div>
  24. <img :src="file.url" alt="" />
  25. <span class="el-upload-list__item-actions">
  26. <span
  27. class="el-upload-list__item-preview"
  28. @click="handlePictureCardPreview(file)"
  29. >
  30. <el-icon><zoom-in /></el-icon>
  31. </span>
  32. <span
  33. class="el-upload-list__item-delete"
  34. @click="handleRemove(file)"
  35. >
  36. <el-icon><Delete /></el-icon>
  37. </span>
  38. </span>
  39. </div>
  40. </template>
  41. </el-upload>
  42. <el-dialog v-model="previewVisible">
  43. <img w-full :src="dialogImageUrl" alt="Preview Image" />
  44. </el-dialog>
  45. </div>
  46. </template>
  47. <script>
  48. export default {
  49. name: 'uploadImg'
  50. }
  51. </script>
  52. <script setup>
  53. import { Delete, Plus, ZoomIn } from '@element-plus/icons-vue';
  54. import { reactive, ref, defineProps, defineEmits, computed, getCurrentInstance } from 'vue';
  55. import { ElMessage } from 'element-plus';
  56. const props = defineProps({
  57. // 允许上传文件件的最大数量
  58. limit:{
  59. type:Number
  60. },
  61. // 是否禁用上传
  62. disabled:{
  63. type:Boolean,
  64. default:false
  65. },
  66. // 文件列表类型
  67. listType:{
  68. type:String,
  69. default:'picture-card'
  70. },
  71. // 上传时携带的额外参数
  72. paramData: {
  73. type:String
  74. }
  75. });
  76. const emits = defineEmits([]);
  77. const cns = getCurrentInstance();
  78. const globObj = cns.appContext.config.globalProperties;
  79. const previewVisible = ref(false);
  80. const dialogImageUrl = ref('');
  81. const fileListCopy = reactive({
  82. data: []
  83. });
  84. const onece = ref(false);
  85. const myChangeFile = ref('');
  86. const changeFileIndex = ref(-1);
  87. const uploadImgArr = reactive({
  88. data: []
  89. });
  90. const headers = reactive({});
  91. // 预览大图
  92. const handlePictureCardPreview = (uploadFile) => {
  93. dialogImageUrl.value = uploadFile.url;
  94. previewVisible.value = true;
  95. };
  96. // 移除图片
  97. const handleRemove = (file, fileList) => {
  98. console.log('handleRemove', handleRemove);
  99. console.log('file', file);
  100. console.log('fileList', fileList);
  101. fileListCopy.data = fileListCopy.data.filter(v => v.uid !== file.uid);
  102. };
  103. // 文件上传数量限制
  104. const handleExceed = (files, fileList) => {
  105. if (props.limit) {
  106. ElMessage.error(`只能上传${props.limit}张图片`);
  107. }
  108. console.log('handleExceed', handleExceed);
  109. console.log('files', files);
  110. console.log('fileList', fileList);
  111. };
  112. // 上传请求
  113. const uploadAction = (option) => {
  114. let formData = new FormData();
  115. const url = '';
  116. globObj.$axios({
  117. url: url,
  118. method: 'post',
  119. transformRequest: [function(data, headers) {
  120. // 去除post请求默认的Content-Type
  121. delete headers['Content-Type']
  122. return data
  123. }],
  124. data: formData,
  125. timeout: 300000
  126. }).then(res => {
  127. ElMessage.success('资产添加成功');
  128. }).catch((err) => {
  129. console.log(err);
  130. });
  131. }
  132. // 格式大小的限制
  133. const beforeUpload = (file) => {
  134. let isJPG = false,
  135. fileType = file.type.split('/')[0];
  136. if(file.type === "image/jpeg" || file.type === "image/png") {
  137. isJPG = true;
  138. } else {
  139. isJPG = false;
  140. }
  141. const isLt2M = file.size / 1024 / 1024;
  142. if (fileType != 'image' || isLt2M > 2) {
  143. ElMessage.error("请上传2M以内的图片文件!");
  144. return false
  145. }
  146. return true;
  147. };
  148. // 文件上传成功时的钩子
  149. const uploadSuccess = (response, file, fileList) => {
  150. // 上传成功之后后台返回的数据
  151. console.log('uploadSuccess', uploadSuccess);
  152. };
  153. const uploadProgress = (e, file, fileList) => {
  154. console.log('uploadProgress', uploadProgress)
  155. };
  156. const uploadError = (err, file, fileList) => {
  157. console.log('uploadError', uploadError);
  158. };
  159. </script>

存在的坑

一般上传文件的话请求头中的Content-Type: multipart/form-data;我们的需求中还需要设置文件的随机数,因此请求头需要是这样的Content-Type: multipart/form-data; boundary=----WebKitFormBoundarypzSlbADtTRuFx5FC。

下面是我遇到的问题。

问题1

设置了Content-Type: multipart/form-data;此时请求一直没有随机数boundary=----WebKitFormBoundarypzSlbADtTRuFx5FC。

如果设置了全局的content-type,会发现上传接口设置multipart/form-data是不起作用的,因为没有Boundary,所以上传必定失败,服务器500。

然后尝试手动添加Boundary,这次错误变400了

问题2

后来通过查询资料,说不用设置Content-Type: multipart/form-data;只要参数是formData形式,浏览器就会自动将请求头的Content-Type转成Content-Type: multipart/form-data; boundary=----WebKitFormBoundarypzSlbADtTRuFx5FC。

但是我不设置的话就是默认的application/json。

于是查阅资料发现axios的transformRequest属性可以在向服务器发送请求数据之前修改请求数据,因为我们的请求在默认的post请求方式时Content-Type的值是application/json,需要去掉默认的值,这样浏览器就可以自动添加了。

  1. globObj.$axios({
  2. url: url,
  3. method: 'post',
  4. transformRequest: [function(data, headers) {
  5. // 去除post请求默认的Content-Type
  6. delete headers['Content-Type']
  7. return data
  8. }],
  9. data: formData,
  10. timeout: 300000
  11. }).then(res => {
  12. ElMessage.success('资产添加成功');
  13. }).catch((err) => {
  14. console.log(err);
  15. });

问题3

如果还要传其他的参数,其他的参数必须也要append进去,否则可能会报参数错误。

  1. const formData = new FormData();
  2. formData.append('file', file);
  3. // 其他参数
  4. formData.append('mailSys', mailSys);

以上就是vue3如何使用el-upload上传文件的详细内容,更多关于vue3如何使用el-upload上传文件的资料请关注九品源码其它相关文章!