u-upload.vue 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666
  1. <template>
  2. <view class="u-upload" v-if="!disabled">
  3. <view
  4. v-if="showUploadList"
  5. class="u-list-item u-preview-wrap"
  6. v-for="(item, index) in lists"
  7. :key="index"
  8. :style="{
  9. width: $u.addUnit(width),
  10. height: $u.addUnit(height)
  11. }"
  12. >
  13. <view
  14. v-if="deletable"
  15. class="u-delete-icon"
  16. @tap.stop="deleteItem(index)"
  17. :style="{
  18. background: delBgColor
  19. }"
  20. >
  21. <u-icon class="u-icon" :name="delIcon" size="20" :color="delColor"></u-icon>
  22. </view>
  23. <u-line-progress
  24. v-if="showProgress && item.progress > 0 && !item.error"
  25. :show-percent="false"
  26. height="16"
  27. class="u-progress"
  28. :percent="item.progress"
  29. ></u-line-progress>
  30. <view @tap.stop="retry(index)" v-if="item.error" class="u-error-btn">点击重试</view>
  31. <image @tap.stop="doPreviewImage(!item.blob?ip+item.url:item.url, index)" class="u-preview-image" v-if="!item.isImage" :src="!item.blob?ip+item.url:item.url" :mode="imageMode"></image>
  32. </view>
  33. <slot name="file" :file="lists"></slot>
  34. <view style="display: inline-block;" @tap="selectFile" v-if="maxCount > lists.length">
  35. <slot name="addBtn"></slot>
  36. <view
  37. v-if="!customBtn"
  38. class="u-list-item u-add-wrap"
  39. hover-class="u-add-wrap__hover"
  40. hover-stay-time="150"
  41. :style="{
  42. width: $u.addUnit(width),
  43. height: $u.addUnit(height)
  44. }"
  45. >
  46. <u-icon name="plus" class="u-add-btn" size="40"></u-icon>
  47. <view class="u-add-tips">{{ uploadText }}</view>
  48. </view>
  49. </view>
  50. </view>
  51. </template>
  52. <script>
  53. /**
  54. * upload 图片上传
  55. * @description 该组件用于上传图片场景
  56. * @tutorial https://www.uviewui.com/components/upload.html
  57. * @property {String} action 服务器上传地址
  58. * @property {String Number} max-count 最大选择图片的数量(默认99)
  59. * @property {Boolean} custom-btn 如果需要自定义选择图片的按钮,设置为true(默认false)
  60. * @property {Boolean} show-progress 是否显示进度条(默认true)
  61. * @property {Boolean} disabled 是否启用(显示/移仓)组件(默认false)
  62. * @property {String} image-mode 预览图片等显示模式,可选值为uni的image的mode属性值(默认aspectFill)
  63. * @property {String} del-icon 右上角删除图标名称,只能为uView内置图标
  64. * @property {String} del-bg-color 右上角关闭按钮的背景颜色
  65. * @property {String | Number} index 在各个回调事件中的最后一个参数返回,用于区别是哪一个组件的事件
  66. * @property {String} del-color 右上角关闭按钮图标的颜色
  67. * @property {Object} header 上传携带的头信息,对象形式
  68. * @property {Object} form-data 上传额外携带的参数
  69. * @property {String} name 上传文件的字段名,供后端获取使用(默认file)
  70. * @property {Array<String>} size-type original 原图,compressed 压缩图,默认二者都有(默认['original', 'compressed'])
  71. * @property {Array<String>} source-type 选择图片的来源,album-从相册选图,camera-使用相机,默认二者都有(默认['album', 'camera'])
  72. * @property {Boolean} preview-full-image 是否可以通过uni.previewImage预览已选择的图片(默认true)
  73. * @property {Boolean} multiple 是否开启图片多选,部分安卓机型不支持(默认true)
  74. * @property {Boolean} deletable 是否显示删除图片的按钮(默认true)
  75. * @property {String Number} max-size 选择单个文件的最大大小,单位B(byte),默认不限制(默认Number.MAX_VALUE)
  76. * @property {Array<Object>} file-list 默认显示的图片列表,数组元素为对象,必须提供url属性
  77. * @property {Boolean} upload-text 选择图片按钮的提示文字(默认“选择图片”)
  78. * @property {Boolean} auto-upload 选择完图片是否自动上传,见上方说明(默认true)
  79. * @property {Boolean} show-tips 特殊情况下是否自动提示toast,见上方说明(默认true)
  80. * @property {Boolean} show-upload-list 是否显示组件内部的图片预览(默认true)
  81. * @event {Function} on-oversize 图片大小超出最大允许大小
  82. * @event {Function} on-preview 全屏预览图片时触发
  83. * @event {Function} on-remove 移除图片时触发
  84. * @event {Function} on-success 图片上传成功时触发
  85. * @event {Function} on-change 图片上传后,无论成功或者失败都会触发
  86. * @event {Function} on-error 图片上传失败时触发
  87. * @event {Function} on-progress 图片上传过程中的进度变化过程触发
  88. * @event {Function} on-uploaded 所有图片上传完毕触发
  89. * @event {Function} on-choose-complete 每次选择图片后触发,只是让外部可以得知每次选择后,内部的文件列表
  90. * @example <u-upload :action="action" :file-list="fileList" ></u-upload>
  91. */
  92. export default {
  93. name: 'u-upload',
  94. props: {
  95. //是否显示组件自带的图片预览功能
  96. showUploadList: {
  97. type: Boolean,
  98. default: true
  99. },
  100. // 后端地址
  101. action: {
  102. type: String,
  103. default: ''
  104. },
  105. // ip地址
  106. ip: {
  107. type: String,
  108. default: ''
  109. },
  110. // 最大上传数量
  111. maxCount: {
  112. type: [String, Number],
  113. default: 52
  114. },
  115. // 是否显示进度条
  116. showProgress: {
  117. type: Boolean,
  118. default: true
  119. },
  120. // 是否启用
  121. disabled: {
  122. type: Boolean,
  123. default: false
  124. },
  125. // 预览上传的图片时的裁剪模式,和image组件mode属性一致
  126. imageMode: {
  127. type: String,
  128. default: 'aspectFill'
  129. },
  130. // 头部信息
  131. header: {
  132. type: Object,
  133. default() {
  134. return {};
  135. }
  136. },
  137. // 额外携带的参数
  138. formData: {
  139. type: Object,
  140. default() {
  141. return {};
  142. }
  143. },
  144. // 上传的文件字段名
  145. name: {
  146. type: String,
  147. default: 'file'
  148. },
  149. // 所选的图片的尺寸, 可选值为original compressed
  150. sizeType: {
  151. type: Array,
  152. default() {
  153. return ['original', 'compressed'];
  154. }
  155. },
  156. sourceType: {
  157. type: Array,
  158. default() {
  159. return ['album', 'camera'];
  160. }
  161. },
  162. // 是否在点击预览图后展示全屏图片预览
  163. previewFullImage: {
  164. type: Boolean,
  165. default: true
  166. },
  167. // 是否开启图片多选,部分安卓机型不支持
  168. multiple: {
  169. type: Boolean,
  170. default: true
  171. },
  172. // 是否展示删除按钮
  173. deletable: {
  174. type: Boolean,
  175. default: true
  176. },
  177. // 文件大小限制,单位为byte
  178. maxSize: {
  179. type: [String, Number],
  180. default: Number.MAX_VALUE
  181. },
  182. // 显示已上传的文件列表
  183. fileList: {
  184. default() {
  185. return [];
  186. }
  187. },
  188. // 上传区域的提示文字
  189. uploadText: {
  190. type: String,
  191. default: '选择图片'
  192. },
  193. // 是否自动上传
  194. autoUpload: {
  195. type: Boolean,
  196. default: true
  197. },
  198. // 是否显示toast消息提示
  199. showTips: {
  200. type: Boolean,
  201. default: true
  202. },
  203. // 是否通过slot自定义传入选择图标的按钮
  204. customBtn: {
  205. type: Boolean,
  206. default: false
  207. },
  208. // 内部预览图片区域和选择图片按钮的区域宽度
  209. width: {
  210. type: [String, Number],
  211. default: 200
  212. },
  213. // 内部预览图片区域和选择图片按钮的区域高度
  214. height: {
  215. type: [String, Number],
  216. default: 200
  217. },
  218. // 右上角关闭按钮的背景颜色
  219. delBgColor: {
  220. type: String,
  221. default: '#fa3534'
  222. },
  223. // 右上角关闭按钮的叉号图标的颜色
  224. delColor: {
  225. type: String,
  226. default: '#ffffff'
  227. },
  228. // 右上角删除图标名称,只能为uView内置图标
  229. delIcon: {
  230. type: String,
  231. default: 'close'
  232. },
  233. // 如果上传后的返回值为json字符串,是否自动转json
  234. toJson: {
  235. type: Boolean,
  236. default: true
  237. },
  238. // 上传前的钩子,每个文件上传前都会执行
  239. beforeUpload: {
  240. type: Function,
  241. default: null
  242. },
  243. // 移除文件前的钩子
  244. beforeRemove: {
  245. type: Function,
  246. default: null
  247. },
  248. // 允许上传的图片后缀
  249. limitType: {
  250. type: Array,
  251. default() {
  252. return ['png', 'jpg', 'jpeg', 'webp', 'gif'];
  253. }
  254. },
  255. // 在各个回调事件中的最后一个参数返回,用于区别是哪一个组件的事件
  256. index: {
  257. type: [Number, String],
  258. default: ''
  259. }
  260. },
  261. mounted() {},
  262. data() {
  263. return {
  264. lists: [],
  265. isInCount: true,
  266. uploading: false
  267. };
  268. },
  269. watch: {
  270. fileList: {
  271. immediate: true,
  272. handler(val) {
  273. if(typeof val!='string'){
  274. val.map(value => {
  275. // 首先检查内部是否已经添加过这张图片,因为外部绑定了一个对象给fileList的话(对象引用),进行修改外部fileList
  276. // 时,会触发watch,导致重新把原来的图片再次添加到this.lists
  277. // 数组的some方法意思是,只要数组元素有任意一个元素条件符合,就返回true,而另一个数组的every方法的意思是数组所有元素都符合条件才返回true
  278. let tmp = this.lists.some(val => {
  279. return val.url == value;
  280. });
  281. // 如果内部没有这个图片(tmp为false),则添加到内部
  282. !tmp && this.lists.push({blob:false,url: value, error: false, progress: 100 });
  283. });
  284. }
  285. }
  286. },
  287. // 监听lists的变化,发出事件
  288. lists(n) {
  289. this.$emit('on-list-change', n, this.index);
  290. }
  291. },
  292. methods: {
  293. // 清除列表
  294. clear() {
  295. this.lists = [];
  296. },
  297. // 重新上传队列中上传失败的所有文件
  298. reUpload() {
  299. this.uploadFile();
  300. },
  301. // 选择图片
  302. selectFile() {
  303. if (this.disabled) return;
  304. const { name = '', maxCount, multiple, maxSize, sizeType, lists, camera, compressed, maxDuration, sourceType } = this;
  305. let chooseFile = null;
  306. const newMaxCount = maxCount - lists.length;
  307. // 设置为只选择图片的时候使用 chooseImage 来实现
  308. chooseFile = new Promise((resolve, reject) => {
  309. uni.chooseImage({
  310. count: multiple ? (newMaxCount > 9 ? 9 : newMaxCount) : 1,
  311. sourceType: sourceType,
  312. sizeType,
  313. success: resolve,
  314. fail: reject
  315. });
  316. });
  317. chooseFile
  318. .then(res => {
  319. let file = null;
  320. let listOldLength = this.lists.length;
  321. res.tempFiles.map((val, index) => {
  322. // 检查文件后缀是否允许,如果不在this.limitType内,就会返回false
  323. if (!this.checkFileExt(val)) return;
  324. // 如果是非多选,index大于等于1或者超出最大限制数量时,不处理
  325. if (!multiple && index >= 1) return;
  326. if (val.size > maxSize) {
  327. this.$emit('on-oversize', val, this.lists, this.index);
  328. this.showToast('超出允许的文件大小');
  329. } else {
  330. if (maxCount <= lists.length) {
  331. this.$emit('on-exceed', val, this.lists, this.index);
  332. this.showToast('超出最大允许的文件个数');
  333. return;
  334. }
  335. console.log("zxxxx:"+val.path);
  336. lists.push({
  337. blob:true,
  338. url: val.path,
  339. progress: 0,
  340. error: false,
  341. file: val
  342. });
  343. }
  344. });
  345. // 每次图片选择完,抛出一个事件,并将当前内部选择的图片数组抛出去
  346. this.$emit('on-choose-complete', this.lists, this.index);
  347. if (this.autoUpload) this.uploadFile(listOldLength);
  348. })
  349. .catch(error => {
  350. this.$emit('on-choose-fail', error);
  351. });
  352. },
  353. // 提示用户消息
  354. showToast(message, force = false) {
  355. if (this.showTips || force) {
  356. uni.showToast({
  357. title: message,
  358. icon: 'none'
  359. });
  360. }
  361. },
  362. // 该方法供用户通过ref调用,手动上传
  363. upload() {
  364. this.uploadFile();
  365. },
  366. // 对失败的图片重新上传
  367. retry(index) {
  368. this.lists[index].progress = 0;
  369. this.lists[index].error = false;
  370. this.lists[index].response = null;
  371. uni.showLoading({
  372. title: '重新上传'
  373. });
  374. this.uploadFile(index);
  375. },
  376. // 上传图片
  377. async uploadFile(index = 0) {
  378. if (this.disabled) return;
  379. if (this.uploading) return;
  380. // 全部上传完成
  381. if (index >= this.lists.length) {
  382. this.$emit('on-uploaded', this.lists, this.index);
  383. return;
  384. }
  385. // 检查是否是已上传或者正在上传中
  386. if (this.lists[index].progress == 100) {
  387. if (this.autoUpload == false) this.uploadFile(index + 1);
  388. return;
  389. }
  390. // 执行before-upload钩子
  391. if (this.beforeUpload && typeof this.beforeUpload === 'function') {
  392. // 执行回调,同时传入索引和文件列表当作参数
  393. // 在微信,支付宝等环境(H5正常),会导致父组件定义的customBack()函数体中的this变成子组件的this
  394. // 通过bind()方法,绑定父组件的this,让this.customBack()的this为父组件的上下文
  395. // 因为upload组件可能会被嵌套在其他组件内,比如u-form,这时this.$parent其实为u-form的this,
  396. // 非页面的this,所以这里需要往上历遍,一直寻找到最顶端的$parent,这里用了this.$u.$parent.call(this)
  397. // 明白意思即可,无需纠结this.$u.$parent.call(this)的细节
  398. let beforeResponse = this.beforeUpload.bind(this.$u.$parent.call(this))(index, this.lists);
  399. // 判断是否返回了promise
  400. if (!!beforeResponse && typeof beforeResponse.then === 'function') {
  401. await beforeResponse
  402. .then(res => {
  403. // promise返回成功,不进行动作,继续上传
  404. })
  405. .catch(err => {
  406. // 进入catch回调的话,继续下一张
  407. return this.uploadFile(index + 1);
  408. });
  409. } else if (beforeResponse === false) {
  410. // 如果返回false,继续下一张图片的上传
  411. return this.uploadFile(index + 1);
  412. } else {
  413. // 此处为返回"true"的情形,这里不写代码,就跳过此处,继续执行当前的上传逻辑
  414. }
  415. }
  416. // 检查上传地址
  417. if (!this.action) {
  418. this.showToast('请配置上传地址', true);
  419. return;
  420. }
  421. this.lists[index].error = false;
  422. this.uploading = true;
  423. // 创建上传对象
  424. const task = uni.uploadFile({
  425. url: this.action,
  426. filePath: this.lists[index].url,
  427. name: this.name,
  428. formData: this.formData,
  429. header: this.header,
  430. success: res => {
  431. // 判断是否json字符串,将其转为json格式
  432. let data = this.toJson && this.$u.test.jsonString(res.data) ? JSON.parse(res.data) : res.data;
  433. if (data.code === 500) {
  434. console.log('图片上传:' + JSON.stringify(data));
  435. this.uploadError(index, data);
  436. return;
  437. }
  438. // 上传成功
  439. this.lists[index].response = data;
  440. this.lists[index].progress = 100;
  441. this.lists[index].error = false;
  442. this.$emit('on-success', data, index, this.lists, this.index);
  443. },
  444. fail: e => {
  445. this.uploadError(index, e);
  446. },
  447. complete: res => {
  448. uni.hideLoading();
  449. this.uploading = false;
  450. this.uploadFile(index + 1);
  451. this.$emit('on-change', res, index, this.lists, this.index);
  452. }
  453. });
  454. task.onProgressUpdate(res => {
  455. if (res.progress > 0) {
  456. this.lists[index].progress = res.progress;
  457. this.$emit('on-progress', res, index, this.lists, this.index);
  458. }
  459. });
  460. },
  461. // 上传失败
  462. uploadError(index, err) {
  463. this.lists[index].progress = 0;
  464. this.lists[index].error = true;
  465. this.lists[index].response = null;
  466. this.$emit('on-error', err, index, this.lists, this.index);
  467. this.showToast('上传失败,请重试');
  468. },
  469. // 删除一个图片
  470. deleteItem(index) {
  471. uni.showModal({
  472. title: '提示',
  473. content: '您确定要删除此项吗?',
  474. success: async res => {
  475. if (res.confirm) {
  476. // 先检查是否有定义before-remove移除前钩子
  477. // 执行before-remove钩子
  478. if (this.beforeRemove && typeof this.beforeRemove === 'function') {
  479. // 此处钩子执行 原理同before-remove参数,见上方注释
  480. let beforeResponse = this.beforeRemove.bind(this.$u.$parent.call(this))(index, this.lists);
  481. // 判断是否返回了promise
  482. if (!!beforeResponse && typeof beforeResponse.then === 'function') {
  483. await beforeResponse
  484. .then(res => {
  485. // promise返回成功,不进行动作,继续上传
  486. this.handlerDeleteItem(index);
  487. })
  488. .catch(err => {
  489. // 如果进入promise的reject,终止删除操作
  490. this.showToast('已终止移除');
  491. });
  492. } else if (beforeResponse === false) {
  493. // 返回false,终止删除
  494. this.showToast('已终止移除');
  495. } else {
  496. // 如果返回true,执行删除操作
  497. this.handlerDeleteItem(index);
  498. }
  499. } else {
  500. // 如果不存在before-remove钩子,
  501. this.handlerDeleteItem(index);
  502. }
  503. }
  504. }
  505. });
  506. },
  507. // 执行移除图片的动作,上方代码只是判断是否可以移除
  508. handlerDeleteItem(index) {
  509. // 如果文件正在上传中,终止上传任务,进度在0 < progress < 100则意味着正在上传
  510. if (this.lists[index].process < 100 && this.lists[index].process > 0) {
  511. typeof this.lists[index].uploadTask != 'undefined' && this.lists[index].uploadTask.abort();
  512. }
  513. this.lists.splice(index, 1);
  514. this.$forceUpdate();
  515. this.$emit('on-remove', index, this.lists, this.index);
  516. this.showToast('移除成功');
  517. },
  518. // 用户通过ref手动的形式,移除一张图片
  519. remove(index) {
  520. // 判断索引的合法范围
  521. if (index >= 0 && index < this.lists.length) {
  522. this.lists.splice(index, 1);
  523. this.$emit('on-list-change', this.lists, this.index);
  524. }
  525. },
  526. // 预览图片
  527. doPreviewImage(url, index) {
  528. console.log("zx:"+url);
  529. if (!this.previewFullImage) return;
  530. const images = this.lists.map(item => !item.blob?this.ip+item.url:item.url);
  531. uni.previewImage({
  532. urls: images,
  533. current: url,
  534. success: () => {
  535. this.$emit('on-preview', url, this.lists, this.index);
  536. },
  537. fail: () => {
  538. uni.showToast({
  539. title: '预览图片失败',
  540. icon: 'none'
  541. });
  542. }
  543. });
  544. },
  545. // 判断文件后缀是否允许
  546. checkFileExt(file) {
  547. // 检查是否在允许的后缀中
  548. let noArrowExt = false;
  549. // 获取后缀名
  550. let fileExt = '';
  551. const reg = /.+\./;
  552. // 如果是H5,需要从name中判断
  553. // #ifdef H5
  554. fileExt = file.name.replace(reg, '').toLowerCase();
  555. // #endif
  556. // 非H5,需要从path中读取后缀
  557. // #ifndef H5
  558. fileExt = file.path.replace(reg, '').toLowerCase();
  559. // #endif
  560. // 使用数组的some方法,只要符合limitType中的一个,就返回true
  561. noArrowExt = this.limitType.some(ext => {
  562. // 转为小写
  563. return ext.toLowerCase() === fileExt;
  564. });
  565. if (!noArrowExt) this.showToast(`不允许选择${fileExt}格式的文件`);
  566. return noArrowExt;
  567. }
  568. }
  569. };
  570. </script>
  571. <style lang="scss" scoped>
  572. @import '../../libs/css/style.components.scss';
  573. .u-upload {
  574. @include vue-flex;
  575. flex-wrap: wrap;
  576. align-items: center;
  577. }
  578. .u-list-item {
  579. width: 200rpx;
  580. height: 200rpx;
  581. overflow: hidden;
  582. margin: 10rpx;
  583. background: rgb(244, 245, 246);
  584. position: relative;
  585. border-radius: 10rpx;
  586. /* #ifndef APP-NVUE */
  587. display: flex;
  588. /* #endif */
  589. align-items: center;
  590. justify-content: center;
  591. }
  592. .u-preview-wrap {
  593. border: 1px solid rgb(235, 236, 238);
  594. }
  595. .u-add-wrap {
  596. flex-direction: column;
  597. color: $u-content-color;
  598. font-size: 26rpx;
  599. }
  600. .u-add-tips {
  601. margin-top: 20rpx;
  602. line-height: 40rpx;
  603. }
  604. .u-add-wrap__hover {
  605. background-color: rgb(235, 236, 238);
  606. }
  607. .u-preview-image {
  608. display: block;
  609. width: 100%;
  610. height: 100%;
  611. border-radius: 10rpx;
  612. }
  613. .u-delete-icon {
  614. position: absolute;
  615. top: 10rpx;
  616. right: 10rpx;
  617. z-index: 10;
  618. background-color: $u-type-error;
  619. border-radius: 100rpx;
  620. width: 44rpx;
  621. height: 44rpx;
  622. @include vue-flex;
  623. align-items: center;
  624. justify-content: center;
  625. }
  626. .u-icon {
  627. @include vue-flex;
  628. align-items: center;
  629. justify-content: center;
  630. }
  631. .u-progress {
  632. position: absolute;
  633. bottom: 10rpx;
  634. left: 8rpx;
  635. right: 8rpx;
  636. z-index: 9;
  637. width: auto;
  638. }
  639. .u-error-btn {
  640. color: #ffffff;
  641. background-color: $u-type-error;
  642. font-size: 20rpx;
  643. padding: 4px 0;
  644. text-align: center;
  645. position: absolute;
  646. bottom: 0;
  647. left: 0;
  648. right: 0;
  649. z-index: 9;
  650. line-height: 1;
  651. }
  652. </style>