实现微信小程序内嵌H5中的下载功能

项目场景如下

开发框架是uniapp,使用uniapp脚手架搭建,最终打包成H5部署在服务器上。
微信小程序的主体内容使用了<web-view>标签将H5的页面内容展示,H5中有页面存放了下载的路径。点击下载按钮下载文件,或者预览文件让用户手动保存。

难点

如果是pc端,下载用一个<a>标签就很容易,但是在小程序里的<web-view>标签中是行不通的。此外,小程序里的<web-view>与小程序的通行方式主要用postMessage,但是触发条件非常苛刻,参照微信的官方文档,只在小程序后退,组件销毁,还有分享时才会触发postMessage并一次性把值全部带出来,使用起来非常不变,对于小程序实际内容主体是<web-view>内嵌的spa的H5页面的情况下,销毁组件会带来很多麻烦,因此最后放弃了这个方案。

我的方法

首先必不可少的是安装jweixin-module模块

npm i jweixin-module

在main.js中将依赖绑定

import wx from  "jweixin-module"
Vue.prototype.$wx = wx 

H5对应页面点击下载时
假设你的文件路径是
https://sample.com/apiName.do?fileToken=ABCDEFG&fileName=HIJKLMN.png
这里有需要注意的3点
1是?会被微信小程序解析,所以需要替换成&,等传入微信再去拼接
2是fileName与fileToken,假设链接里有这些额外的参数,那这些参数因为很可能组成内容比较复杂,会有特殊字符,所以需要转义,然后在微信小程序的看情况有需要的话就解析回去。这里使用encodeURIComponent与decodeURIComponent去处理可能存在特殊字符的字段。
3是我的实际场景里,获取服务器的图片需要鉴权,所以我会额外带一个cookie,也使用&拼接在链接后。

let fileToken = "ABCDEFG"
let fileName = "HIJKLMN.png"
this.$wx.miniProgram.navigateTo({
  url:"/pages/upload/page?link=https://sample.com/apiName.do&fileToken="+encodeURIComponent(fileToken) + "&fileName=" + encodeURIComponent(fileName)
})

小程序里,对应的/pages/upload/page页面

onLoad: function(options) {
    let that = this;
    wx.setStorageSync('uploadData', options)//保存传入的参数
//option为一个对象,内容就是{ link,fileToken,fileName,cookie等之前使用&拼上的数据}
    let pages = getCurrentPages();
    let previousPage = pages[pages.length - 2]; //上一个页面
    previousPage.setData({
      isDownLoadPageBack: true  //在上一个页面设置标记,用来判断
    })
    wx.navigateBack({
      delta: 1
    })
  },

返回到之前有web-view 的页面

data: {
    isDownLoadPageBack: false,
  },
onShow: function() {
    wx.hideHomeButton();
    if (this.data.isDownLoadPageBack) {
      this.getDownLoadFile() //具体的微信下载文件的方法
    }
//每次onShow执行完,还有上面的下载方法执行完后要把这个标记重置为false,这样不同情况触发的onShow才能区分是否是下载文件页面回来的。可能写的重复但是多写几次比较放心
    this.setData({
      isDownLoadPageBack: false
    })
  },

下载方法

getDownLoadFile: function() {
    wx.showLoading({
      title: '下载中', //提示文字
      mask: true, //是否显示透明蒙层,防止触摸穿透,默认:false  
    })
    let that = this;
    let options = wx.getStorageSync('uploadData')
    let timeStamp = (Date.parse(new Date())) / 1000; //定义了时间戳拼接在文件名前防止名字重复
//这里是判断文件类型,是否是图片,后面用来判断并使用不同的展示方式
//写的很菜,凑合看下就行
    let originFileName = decodeURIComponent(options.fileName)
    let originFileNameSplit  = originFileName.split('.')
    let fileNameType = originFileNameSplit[originFileNameSplit.length - 1]
    let imageType = ['gif', 'png', 'jpg', 'tif', 'bmp', 'webp', 'jpeg', 'JPG', ]
    let myCookie = decodeURIComponent(options.cookie)
    const downloadTask = wx.downloadFile({ //微信下载文件方法
    //这里拼接成需要的格式
      url: options.link + '?fileToken=' + options.fileToken + '&&fileName=' + options.fileName,
      header: {
        'cookie': myCookie
      },
      success(res) {
        wx.getFileSystemManager().saveFile({ //微信保存文件,这个存储有点复杂
          // 临时存储路径,先有临时存储路径方可使用wx官方的存储本地路径( wx.env.USER_DATA_PATH )
          tempFilePath: res.tempFilePath,
          //定义本地的存储路径及名称
          filePath: wx.env.USER_DATA_PATH + '/' + timeStamp + originFileName,
          success(res) {
            const savedFilePath = res.savedFilePath;
            wx.hideLoading()
            if (imageType.includes(fileNameType)) {
              wx.previewImage({
                urls: [savedFilePath],
              })
            } else {
              wx.openDocument({ //微信打开文件
                filePath: savedFilePath,
                showMenu: true,
                success: function(res) {
                  that.setData({
                    waitWord: '返回请点击左上角',
                    isDownLoadPageBack: false
                  });
                },
                fail: function(err) {
                  console.log(res)
                  wx.showToast({
                    title: '预览失败',
                    icon: 'error',
                    duration: 1500
                  })
                  that.setData({
                    waitWord: '文件预览失败,请稍后重试',
                    isDownLoadPageBack: false
                  });
                }
              });
            }

          },
          fail(err) {
            wx.showToast({
              title: '预览失败',
              icon: 'error',
              duration: 1500
            })
            that.setData({
              waitWord: '文件预览失败,请稍后重试',
              isDownLoadPageBack: false
            });
          }
        })

      },
      fail(err) {
        wx.hideLoading()
        wx.showToast({
          title: '下载失败',
          icon: 'error',
          duration: 1500
        })
        console.log(err)
        that.setData({
          waitWord: '文件下载失败,请稍后重试',
          isDownLoadPageBack: false
        });
      }
    })
    downloadTask.onProgressUpdate((res) => {
      console.log('下载进度', res.progress)
      console.log('已经下载的数据长度', res.totalBytesWritten)
      console.log('预期需要下载的数据总长度', res.totalBytesExpectedToWrite)
    })
  }

总结

大致过程就这样。缺点是点击下载时页面会一闪而过空白的微信页面再回来。如果有其他的更友好的实现方式也请不吝赐教。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容