a标签下载

  1. <body>
  2. <button onclick="downloadEvt('http://192.168.66.183:13666/download?name=HAP.pdf')">a标签下载</button>
  3. <script>
  4. function downloadEvt(url, fileName = '未知文件') {
  5. const el = document.createElement('a');
  6. el.style.display = 'none';
  7. el.setAttribute('target', '_blank');
  8. /**
  9. * download的属性是HTML5新增的属性
  10. * href属性的地址必须是非跨域的地址,如果引用的是第三方的网站或者说是前后端分离的项目(调用后台的接口),这时download就会不起作用。
  11. * 此时,如果是下载浏览器无法解析的文件,例如.exe,.xlsx..那么浏览器会自动下载,但是如果使用浏览器可以解析的文件,比如.txt,.png,.pdf....浏览器就会采取预览模式
  12. * 所以,对于.txt,.png,.pdf等的预览功能我们就可以直接不设置download属性(前提是后端响应头的Content-Type: application/octet-stream,如果为application/pdf浏览器则会判断文件为 pdf ,自动执行预览的策略)
  13. */
  14. fileName && el.setAttribute('download', fileName);
  15. el.href = url;
  16. console.log(el);
  17. document.body.appendChild(el);
  18. el.click();
  19. document.body.removeChild(el);
  20. }
  21. </script>
  22. </body>

优点

  • 可以下载txt、png、pdf等类型文件
  • download的属性是HTML5新增的属性
    href属性的地址必须是非跨域的地址,如果引用的是第三方的网站或者说是前后端分离的项目(调用后台的接口),这时download就会不起作用。 此时,如果是下载浏览器无法解析的文件,例如.exe,.xlsx..那么浏览器会自动下载,但是如果使用浏览器可以解析的文件,比如.txt,.png,.pdf….浏览器就会采取预览模式;所以,对于.txt,.png,.pdf等的预览功能我们就可以直接不设置download属性(前提是后端响应头的Content-Type: application/octet-stream,如果为application/pdf浏览器则会判断文件为 pdf ,自动执行预览的策略)

缺点

  • a标签只能做get请求,所有url有长度限制
  • 无法获取下载进度
  • 无法在header中携带token做鉴权操作
  • 跨域限制
  • 无法判断接口是否返回成功
  • IE兼容问题

    form标签下载

    1. <body>
    2. <button onclick="inputDownloadEvt('get', 'http://192.168.66.183:13666/download', 'name', 'HAP.pdf')">form标签下载</button>
    3. <script>
    4. /**
    5. * @param {String} method - 请求方法get/post
    6. * @param {String} url
    7. * @param {String} paramsKey - 请求参数名
    8. * @param {String} paramsValue - 请求参数值
    9. */
    10. function inputDownloadEvt(method, url, paramsKey, paramsValue) {
    11. const form = document.createElement('form');
    12. form.style.display = 'none';
    13. form.setAttribute('target', '_blank');
    14. form.setAttribute('method', method);
    15. form.setAttribute('action', url);
    16. const input = document.createElement('input');
    17. input.setAttribute('type','hidden');
    18. // 对于get请求 最终会拼成http://192.168.66.183:13666/download?name=HAP.pdf
    19. input.setAttribute('name', paramsKey);
    20. input.setAttribute('value', paramsValue);
    21. form.appendChild(input);
    22. document.body.appendChild(form);
    23. form.submit();
    24. document.body.removeChild(form);
    25. }
    26. </script>
    27. </body>

    优点

  • 兼容性好,不会出现URL长度限制问题

  • form标签get和post都可以

缺点

  • 无法获取下载进度
  • 无法在header中携带token做鉴权操作
  • 无法直接下载浏览器可直接预览的文件类型(txt、png、pdf会直接预览)
  • 无法判断接口是否返回成功

    window.open下载

    1. <body>
    2. <button onclick="downloadEvt('http://192.168.66.183:13666/download?name=HAP.pdf')">window.open下载</button>
    3. <script>
    4. function downloadEvt(url) {
    5. window.open(url, '_self');
    6. }
    7. </script>
    8. </body>

    优点

  • 简单方便直接

缺点

  • 会出现URL长度限制问题
  • 需要注意url编码问题
  • 无法获取下载进度
  • 无法在header中携带token做鉴权操作
  • 无法直接下载浏览器可直接预览的文件类型(txt、png、pdf会直接预览)
  • 无法判断接口是否返回成功

    iframe下载

    1. <body>
    2. <button onclick="downloadEvt('http://192.168.66.183:13666/download?name=HAP.pdf')">iframe下载</button>
    3. <script>
    4. // 批量下载时,动态创建a标签,会始终只下载一个文件,改为动态创建iframe标签
    5. function downloadEvt(url) {
    6. const iframe = document.createElement('iframe');
    7. iframe.style.display = 'none';
    8. iframe.src = url;
    9. document.body.appendChild(iframe);
    10. setTimeout(() => {
    11. document.body.removeChild(iframe);
    12. }, 200);
    13. }
    14. </script>
    15. </body>

    优点

  • 可以下载txt、png、pdf等类型文件

缺点

  • 无法获取下载进度
  • 无法在header中携带token做鉴权操作
  • 无法判断接口是否返回成功
  • 兼容、性能差

    location.href下载

    1. <body>
    2. <button onclick="downloadEvt('http://192.168.66.183:13666/download?name=HAP.pdf')">location.href下载</button>
    3. <script>
    4. function downloadEvt(url) {
    5. window.location.href = url;
    6. }
    7. </script>
    8. </body>

    优点

  • 简单方便直接

  • 可以下载大文件(G以上)

缺点

  • 会出现URL长度限制问题
  • 需要注意url编码问题
  • 无法获取下载进度
  • 无法在header中携带token做鉴权操作
  • 无法直接下载浏览器可直接预览的文件类型(txt、png、pdf会直接预览)
  • 无法判断接口是否返回成功

    ajax下载(Blob - 利用Blob对象生成Blob URL)

    如果后端需要做token验证,那么a、form、iframe、window.open、location.href都无法在header中携带token,这时候可以使用ajax来实现。

    1. <body>
    2. <button onclick="downLoadAjaxEvt('get', 'http://192.168.66.183:13666/download?name=HAP.pdf')">ajax下载</button>
    3. <script>
    4. function downloadEvt(url, fileName = '未知文件') {
    5. const el = document.createElement('a');
    6. el.style.display = 'none';
    7. el.setAttribute('target', '_blank');
    8. /**
    9. * download的属性是HTML5新增的属性
    10. * href属性的地址必须是非跨域的地址,如果引用的是第三方的网站或者说是前后端分离的项目(调用后台的接口),这时download就会不起作用。
    11. * 此时,如果是下载浏览器无法解析的文件,例如.exe,.xlsx..那么浏览器会自动下载,但是如果使用浏览器可以解析的文件,比如.txt,.png,.pdf....浏览器就会采取预览模式
    12. * 所以,对于.txt,.png,.pdf等的预览功能我们就可以直接不设置download属性(前提是后端响应头的Content-Type: application/octet-stream,如果为application/pdf浏览器则会判断文件为 pdf ,自动执行预览的策略)
    13. */
    14. fileName && el.setAttribute('download', fileName);
    15. el.href = url;
    16. console.log(el);
    17. document.body.appendChild(el);
    18. el.click();
    19. document.body.removeChild(el);
    20. };
    21. // 根据header里的contenteType转换请求参数
    22. function transformRequestData(contentType, requestData) {
    23. requestData = requestData || {};
    24. if (contentType.includes('application/x-www-form-urlencoded')) {
    25. // formData格式:key1=value1&key2=value2,方式二:qs.stringify(requestData, {arrayFormat: 'brackets'}) -- {arrayFormat: 'brackets'}是对于数组参数的处理
    26. let str = '';
    27. for (const key in requestData) {
    28. if (Object.prototype.hasOwnProperty.call(requestData, key)) {
    29. str += `${key}=${requestData[key]}&`;
    30. }
    31. }
    32. return encodeURI(str.slice(0, str.length - 1));
    33. } else if (contentType.includes('multipart/form-data')) {
    34. const formData = new FormData();
    35. for (const key in requestData) {
    36. const files = requestData[key];
    37. // 判断是否是文件流
    38. const isFile = files ? files.constructor === FileList || (files.constructor === Array && files[0].constructor === File) : false;
    39. if (isFile) {
    40. for (let i = 0; i < files.length; i++) {
    41. formData.append(key, files[i]);
    42. }
    43. } else {
    44. formData.append(key, files);
    45. }
    46. }
    47. return formData;
    48. }
    49. // json字符串{key: value}
    50. return Object.keys(requestData).length ? JSON.stringify(requestData) : '';
    51. }
    52. /**
    53. * ajax实现文件下载、获取文件下载进度
    54. * @param {String} method - 请求方法get/post
    55. * @param {String} url
    56. * @param {Object} [params] - 请求参数,{name: '文件下载'}
    57. * @param {Object} [config] - 方法配置
    58. */
    59. function downLoadAjaxEvt(method = 'get', url, params, config) {
    60. const _method = method.toUpperCase();
    61. const _config = Object.assign({
    62. contentType: _method === 'GET' ? 'application/x-www-form-urlencoded' : 'application/json', // 请求头类型
    63. fileName: '未知文件', // 下载文件名(必填,若为空,下载下来都是txt格式)
    64. async: true, // 请求是否异步-true异步、false同步
    65. token: 'token' // 用户token
    66. }, config);
    67. const queryParams = transformRequestData(_config.contentType, params);
    68. const _url = `${url}${_method === 'GET' && queryParams ? '?' + queryParams : ''}`;
    69. const ajax = new XMLHttpRequest();
    70. ajax.open(_method, _url, _config.async);
    71. ajax.setRequestHeader('Authorization', _config.token);
    72. ajax.setRequestHeader('Content-Type', _config.contentType);
    73. // responseType若不设置,会导致下载的文件可能打不开
    74. ajax.responseType = 'blob';
    75. // 获取文件下载进度
    76. ajax.addEventListener('progress', (progress) => {
    77. const percentage = ((progress.loaded / progress.total) * 100).toFixed(2);
    78. const msg = `下载进度 ${percentage}%...`;
    79. console.log(msg);
    80. });
    81. ajax.onload = function () {
    82. if (this.status === 200 || this.status === 304) {
    83. // 通过FileReader去判断接口返回是json还是文件流
    84. const fileReader = new FileReader();
    85. fileReader.onloadend = (e) => {
    86. if (this.getResponseHeader('content-type').includes('application/json')) {
    87. const result = JSON.parse(fileReader.result || '{message: 服务器出现问题,请联系管理员}');
    88. alert(result.message);
    89. } else {
    90. // 两种解码方式,区别自行百度: decodeURIComponent/decodeURI(主要获取后缀名,否则低版本浏览器会一律识别为txt,导致下载下来的都是txt)
    91. const _fileName = decodeURIComponent((this.getResponseHeader('content-disposition') || '; filename="未知文件"').split(';')[1].trim().slice(9));
    92. /**
    93. * Blob.type一个字符串,表明该 Blob 对象所包含数据的 MIME 类型。如果类型未知,则该值为空字符串。
    94. * 对于pdf:type为application/pdf 同时 a标签 不设置download属性, 可以直接预览
    95. */
    96. const blob = new Blob([this.response]);
    97. const href = URL.createObjectURL(blob);
    98. downloadEvt(href, _fileName);
    99. // 释放一个之前已经存在的、通过调用 URL.createObjectURL() 创建的 URL 对象
    100. URL.revokeObjectURL(href);
    101. }
    102. };
    103. // 调用readAsText读取文件,少了readAsText将不会触发onloadend事件
    104. fileReader.readAsText(this.response);
    105. } else {
    106. alert('服务器出现问题,请联系管理员');
    107. }
    108. };
    109. // send(string): string:仅用于 POST 请求
    110. ajax.send(queryParams);
    111. }
    112. </script>
    113. </body>
  • responseType
    responseType若不设置,会导致下载的文件可能打不开ajax.responseType = ‘blob’;

  • new FileReader()
    1.文件下载的接口存在返回失败的情况(例如:服务器连接不上、接口报错等),对于下载失败的情况我们需要在页面上弹出失败提示,而不是将失败信息写进文件里等用户打开,这时候可以使用FileReader去根据响应头里的content-type判断接口是否返回成功;
    2.如果content-type返回application/json表示文件流返回失败,此时直接在页面上弹出失败信息(图6-1);如果是其他格式就认为文件流已经返回。

image.pngthis.getResponseHeader(‘content-disposition’)
后端返回的文件名称,主要获取后缀名,否则某些浏览器会一律识别为txt,导致下载下来的都是txt
image.pngnew Blob([this.response], {type: ‘文件类型’})Application Type 对照表
1.Blob.type一个字符串,表明该 Blob 对象所包含数据的 MIME 类型。如果类型未知,则该值为空字符串;
2.对于pdf:type为application/pdf 同时 a标签 不设置download属性(图6-3), 可以直接预览
image.png
axios中其实已经提供了获取文件上传和下载进度的事件,这里我使用的是原生ajax(axios雷同,只需要修改请求方法)。
image.png
优点

  • 可以下载txt、png、pdf等类型文件
  • 可以在header中携带token做鉴权操作
  • 可以获取文件下载进度
  • 可以判断接口是否返回成功

缺点

  • 兼容性问题,IE10以下不可用,注意Safari浏览器,官网给出
    Safari has a serious issue with blobs that are of the type application/octet-stream
  • 将后端返回的文件流全部获取后才会下载

    ajax下载(Data URL - base64编码后的url)

    1. <body>
    2. <button onclick="downLoadAjaxEvt('get', 'http://192.168.66.183:13666/download?name=HAP.pdf')">ajax下载(base64)</button>
    3. <script>
    4. function downloadEvt(url, fileName = '未知文件') {
    5. const el = document.createElement('a');
    6. el.style.display = 'none';
    7. el.setAttribute('target', '_blank');
    8. /**
    9. * download的属性是HTML5新增的属性
    10. * href属性的地址必须是非跨域的地址,如果引用的是第三方的网站或者说是前后端分离的项目(调用后台的接口),这时download就会不起作用。
    11. * 此时,如果是下载浏览器无法解析的文件,例如.exe,.xlsx..那么浏览器会自动下载,但是如果使用浏览器可以解析的文件,比如.txt,.png,.pdf....浏览器就会采取预览模式
    12. * 所以,对于.txt,.png,.pdf等的预览功能我们就可以直接不设置download属性(前提是后端响应头的Content-Type: application/octet-stream,如果为application/pdf浏览器则会判断文件为 pdf ,自动执行预览的策略)
    13. */
    14. fileName && el.setAttribute('download', fileName);
    15. el.href = url;
    16. console.log(el);
    17. document.body.appendChild(el);
    18. el.click();
    19. document.body.removeChild(el);
    20. };
    21. // 根据header里的contenteType转换请求参数
    22. function transformRequestData(contentType, requestData) {
    23. requestData = requestData || {};
    24. if (contentType.includes('application/x-www-form-urlencoded')) {
    25. // formData格式:key1=value1&key2=value2,方式二:qs.stringify(requestData, {arrayFormat: 'brackets'}) -- {arrayFormat: 'brackets'}是对于数组参数的处理
    26. let str = '';
    27. for (const key in requestData) {
    28. if (Object.prototype.hasOwnProperty.call(requestData, key)) {
    29. str += `${key}=${requestData[key]}&`;
    30. }
    31. }
    32. return encodeURI(str.slice(0, str.length - 1));
    33. } else if (contentType.includes('multipart/form-data')) {
    34. const formData = new FormData();
    35. for (const key in requestData) {
    36. const files = requestData[key];
    37. // 判断是否是文件流
    38. const isFile = files ? files.constructor === FileList || (files.constructor === Array && files[0].constructor === File) : false;
    39. if (isFile) {
    40. for (let i = 0; i < files.length; i++) {
    41. formData.append(key, files[i]);
    42. }
    43. } else {
    44. formData.append(key, files);
    45. }
    46. }
    47. return formData;
    48. }
    49. // json字符串{key: value}
    50. return Object.keys(requestData).length ? JSON.stringify(requestData) : '';
    51. }
    52. /**
    53. * ajax实现文件下载、获取文件下载进度
    54. * @param {String} method - 请求方法get/post
    55. * @param {String} url
    56. * @param {Object} [params] - 请求参数,{name: '文件下载'}
    57. * @param {Object} [config] - 方法配置
    58. */
    59. function downLoadAjaxEvt(method = 'get', url, params, config) {
    60. const _method = method.toUpperCase();
    61. const _config = Object.assign({
    62. contentType: _method === 'GET' ? 'application/x-www-form-urlencoded' : 'application/json', // 请求头类型
    63. fileName: '未知文件', // 下载文件名(必填,若为空,下载下来都是txt格式)
    64. async: true, // 请求是否异步-true异步、false同步
    65. token: 'token' // 用户token
    66. }, config);
    67. const queryParams = transformRequestData(_config.contentType, params);
    68. const _url = `${url}${_method === 'GET' && queryParams ? '?' + queryParams : ''}`;
    69. const ajax = new XMLHttpRequest();
    70. ajax.open(_method, _url, _config.async);
    71. ajax.setRequestHeader('Authorization', _config.token);
    72. ajax.setRequestHeader('Content-Type', _config.contentType);
    73. // responseType若不设置,会导致下载的文件可能打不开
    74. ajax.responseType = 'blob';
    75. // 获取文件下载进度
    76. ajax.addEventListener('progress', (progress) => {
    77. const percentage = ((progress.loaded / progress.total) * 100).toFixed(2);
    78. const msg = `下载进度 ${percentage}%...`;
    79. console.log(msg);
    80. });
    81. ajax.onload = function () {
    82. if (this.status === 200 || this.status === 304) {
    83. // 通过FileReader去判断接口返回是json还是文件流
    84. const fileReader = new FileReader();
    85. fileReader.readAsDataURL(this.response);
    86. fileReader.onload = () => {
    87. if (this.getResponseHeader('content-type').includes('application/json')) {
    88. alert('服务器出现问题,请联系管理员');
    89. } else {
    90. // 两种解码方式,区别自行百度: decodeURIComponent/decodeURI(主要获取后缀名,否则某些浏览器会一律识别为txt,导致下载下来的都是txt)
    91. const _fileName = decodeURIComponent((this.getResponseHeader('content-disposition') || '; filename="未知文件"').split(';')[1].trim().slice(9));
    92. // 也可以用FileSaver(需提前引入https://github.com/eligrey/FileSaver.js): saveAs(fileReader.result, _fileName);
    93. downloadEvt(fileReader.result, _fileName);
    94. }
    95. }
    96. } else {
    97. alert('服务器出现问题,请联系管理员');
    98. }
    99. };
    100. // send(string): string:仅用于 POST 请求
    101. ajax.send(queryParams);
    102. }
    103. </script>
    104. </body>
  • fileSaver
    网上介绍很多,可以自己百度下

优点

  • 可以下载txt、png、pdf等类型文件
  • 可以在header中携带token做鉴权操作
  • 可以获取文件下载进度
  • 可以判断接口是否返回成功

缺点

  • 兼容性问题,IE10以下不可用
  • 将后端返回的文件流全部获取后才会下载

    大文件下载注意点

    fileSaver
    批量下载时,总量不超过2G可以用下这个,但是每个浏览器允许下载的最大文件不一样~
    image.png
    ajax下载
    如果后端需要对下载接口做token鉴权,此时需要使用ajax获取文件流(第六、七点),可以了解下ajax文件下载原理
    简单来说,文件下载依赖浏览器特性。前端获取到服务器端生成的字节流,此时数据是存在于js的内存中的,是不可以直接保存在本地的,利用Blob对象和window.URL.createObjectURL对象生成一个虚拟的URL地址,然后在利用浏览器的特性进行下载。
    因此对于ajax下载大文件时,会出现浏览器崩溃情况,此时可以考虑使用链接直接下载或使用分片下载
    image.png
    链接下载
    链接下载需要后端一边去下载要打包的文件,一边把打包好的东西写入这个链接。存在的问题是,如果文件很大,那么这个链接需要一直保持,相当于这个接口一直开着没有结束;而且一旦中间出了什么问题,已经下载的东西也全部废了,因此推荐使用分片下载


    vue中实现下载xlsx格式的excel

    ```javascript // 这是axios文件 const VueAxios = { vm: {}, // eslint-disable-next-line no-unused-vars install(Vue, router = {}, instance) {

    1. if (this.installed) {
    2. return;
    3. }
    4. this.installed = true;
    5. if (!instance) {
    6. // eslint-disable-next-line no-console
    7. console.error('You have to install axios');
    8. return;
    9. }
    10. Vue.axios = instance;
    11. Object.defineProperties(Vue.prototype, {
    12. axios: {
    13. get: function get() {
    14. return instance;
    15. }
    16. },
    17. $http: {
    18. get: function get() {
    19. return instance;
    20. }
    21. }
    22. });

    } };

export { VueAxios, // eslint-disable-next-line no-undef //instance as axios }

  1. ```javascript
  2. // 封装一个axios请求方式
  3. import Vue from 'vue'
  4. import axios from 'axios'
  5. import store from '@/store'
  6. import { VueAxios } from './axios'
  7. import { ACCESS_TOKEN } from '@/store/mutation-types'
  8. import {Modal} from 'ant-design-vue'
  9. let apiBaseUrl = window._CONFIG['domianURL']
  10. // 创建 axios 实例
  11. const service = axios.create({
  12. baseURL: apiBaseUrl
  13. // timeout: 9000 // 请求超时时间
  14. })
  15. // 请求头,参数设置
  16. service.interceptors.request.use(config => {
  17. const token = Vue.ls.get(ACCESS_TOKEN)
  18. if (token) {
  19. config.headers['X-Access-Token'] = token
  20. }
  21. if (config.method === 'get') {
  22. if (config.url.indexOf('sys/dict/getDictItems') < 0) {
  23. config.params = {
  24. _t: Date.parse(new Date()) / 1000,
  25. ...config.params
  26. }
  27. }
  28. }
  29. return config
  30. }, (error) => {
  31. return Promise.reject(error)
  32. })
  33. // 接收器,拦截code === 500,踢出并重定向
  34. service.interceptors.response.use(res => {
  35. let data = res.data
  36. if (data.code === 520) {
  37. loginOut()
  38. }
  39. return res.data
  40. }, (err) => {
  41. if (err.response) {
  42. let data = err.response.data
  43. if (data.code === 500 || data.status === 500) {
  44. loginOut()
  45. }
  46. }
  47. })
  48. function loginOut () {
  49. store.dispatch('Logout').then(() => {
  50. })
  51. }
  52. const installer = {
  53. vm: {},
  54. install (Vue, router = {}) {
  55. Vue.use(VueAxios, router, service)
  56. }
  57. }
  58. export {
  59. installer as VueAxios,
  60. service as axios
  61. }
  1. // 在utils文件中封装一个方法 然后导出
  2. import Vue from 'vue'
  3. import { axios } from '@/utils/request'
  4. export function downFile(url,parameter){
  5. return axios({
  6. url: url,
  7. params: parameter,
  8. method:'get' ,
  9. responseType: 'blob'
  10. })
  11. }
  1. handleExportXls (fileName) {
  2. if (!fileName || typeof fileName != 'string') {
  3. fileName = '导出文件'
  4. }
  5. let param = { ...this.queryParam }
  6. if (this.selectedRowKeys && this.selectedRowKeys.length > 0) {
  7. param['selections'] = this.selectedRowKeys.join(',')
  8. }
  9. downFile(this.url.exportXlsUrl, param).then((data) => {
  10. if (!data) {
  11. this.$message.warning('文件下载失败')
  12. return
  13. }
  14. if (typeof window.navigator.msSaveBlob !== 'undefined') {
  15. window.navigator.msSaveBlob(new Blob([data], { type: 'application/vnd.ms-excel' }), fileName + '.xlsx')
  16. } else {
  17. let url = window.URL.createObjectURL(new Blob([data], { type: 'application/vnd.ms-excel' }))
  18. let link = document.createElement('a')
  19. link.style.display = 'none'
  20. link.href = url
  21. link.setAttribute('download', fileName + '.xlsx')
  22. document.body.appendChild(link)
  23. link.click()
  24. document.body.removeChild(link) //下载完成移除元素
  25. window.URL.revokeObjectURL(url) //释放掉blob对象
  26. }
  27. })
  28. },