使用AngularJS从ASP.NET Web API方法下载文件


132

在我的Angular JS项目中,我有一个<a>锚标记,单击该锚标记会生成一个HTTPGET会对返回文件的WebAPI方法请求。

现在,我希望一旦请求成功就将文件下载给用户。我怎么做?

锚标记:

<a href="#" ng-click="getthefile()">Download img</a>

AngularJS:

$scope.getthefile = function () {        
    $http({
        method: 'GET',
        cache: false,
        url: $scope.appPath + 'CourseRegConfirm/getfile',            
        headers: {
            'Content-Type': 'application/json; charset=utf-8'
        }
    }).success(function (data, status) {
        console.log(data); // Displays text data if the file is a text file, binary if it's an image            
        // What should I write here to download the file I receive from the WebAPI method?
    }).error(function (data, status) {
        // ...
    });
}

我的WebAPI方法:

[Authorize]
[Route("getfile")]
public HttpResponseMessage GetTestFile()
{
    HttpResponseMessage result = null;
    var localFilePath = HttpContext.Current.Server.MapPath("~/timetable.jpg");

    if (!File.Exists(localFilePath))
    {
        result = Request.CreateResponse(HttpStatusCode.Gone);
    }
    else
    {
        // Serve the file to the client
        result = Request.CreateResponse(HttpStatusCode.OK);
        result.Content = new StreamContent(new FileStream(localFilePath, FileMode.Open, FileAccess.Read));
        result.Content.Headers.ContentDisposition = new System.Net.Http.Headers.ContentDispositionHeaderValue("attachment");
        result.Content.Headers.ContentDisposition.FileName = "SampleImg";                
    }

    return result;
}

1
文件类型是什么?仅图像?
Rashmin Javiya 2014年

@RashminJaviya可以是.jpg,.doc,.xlsx,.docx,.txt或.pdf。
DragonsDwell 2014年

您正在使用哪个.Net框架?
Rashmin Javiya 2014年

@RashminJaviya .net 4.5
DragonsDwell 2014年

1
@Kurkula,您应该使用System.IO.File的文件,而不是来自控制器的文件
Javysk

Answers:


242

使用ajax来下载二进制文件的支持不是很好,它仍在作为工作草案进行开发

简单的下载方法:

您可以使用以下代码简单地让浏览器下载所请求的文件,并且所有浏览器都支持此功能,并且显然会触发WebApi请求。

$scope.downloadFile = function(downloadPath) { 
    window.open(downloadPath, '_blank', '');  
}

Ajax二进制下载方法:

使用ajax下载二进制文件可以在某些浏览器中完成,下面是一个可以在最新版本的Chrome,Internet Explorer,FireFox和Safari中运行的实现。

它使用arraybuffer响应类型,然后将其转换为JavaScript blob,然后使用saveBlob方法 -尽管当前仅在Internet Explorer中存在-或转换为由浏览器打开的Blob数据URL,从而触发如果支持在浏览器中查看MIME类型,则为下载对话框。

Internet Explorer 11支持(已修复)

注意:Internet Explorer 11不喜欢使用msSaveBlob已别名的功能-也许是安全功能,但更可能是漏洞,因此使用var saveBlob = navigator.msSaveBlob || navigator.webkitSaveBlob ... etc.确定可用的saveBlob支持会导致异常。因此,为什么下面的代码现在分别进行测试navigator.msSaveBlob。谢谢?微软

// Based on an implementation here: web.student.tuwien.ac.at/~e0427417/jsdownload.html
$scope.downloadFile = function(httpPath) {
    // Use an arraybuffer
    $http.get(httpPath, { responseType: 'arraybuffer' })
    .success( function(data, status, headers) {

        var octetStreamMime = 'application/octet-stream';
        var success = false;

        // Get the headers
        headers = headers();

        // Get the filename from the x-filename header or default to "download.bin"
        var filename = headers['x-filename'] || 'download.bin';

        // Determine the content type from the header or default to "application/octet-stream"
        var contentType = headers['content-type'] || octetStreamMime;

        try
        {
            // Try using msSaveBlob if supported
            console.log("Trying saveBlob method ...");
            var blob = new Blob([data], { type: contentType });
            if(navigator.msSaveBlob)
                navigator.msSaveBlob(blob, filename);
            else {
                // Try using other saveBlob implementations, if available
                var saveBlob = navigator.webkitSaveBlob || navigator.mozSaveBlob || navigator.saveBlob;
                if(saveBlob === undefined) throw "Not supported";
                saveBlob(blob, filename);
            }
            console.log("saveBlob succeeded");
            success = true;
        } catch(ex)
        {
            console.log("saveBlob method failed with the following exception:");
            console.log(ex);
        }

        if(!success)
        {
            // Get the blob url creator
            var urlCreator = window.URL || window.webkitURL || window.mozURL || window.msURL;
            if(urlCreator)
            {
                // Try to use a download link
                var link = document.createElement('a');
                if('download' in link)
                {
                    // Try to simulate a click
                    try
                    {
                        // Prepare a blob URL
                        console.log("Trying download link method with simulated click ...");
                        var blob = new Blob([data], { type: contentType });
                        var url = urlCreator.createObjectURL(blob);
                        link.setAttribute('href', url);

                        // Set the download attribute (Supported in Chrome 14+ / Firefox 20+)
                        link.setAttribute("download", filename);

                        // Simulate clicking the download link
                        var event = document.createEvent('MouseEvents');
                        event.initMouseEvent('click', true, true, window, 1, 0, 0, 0, 0, false, false, false, false, 0, null);
                        link.dispatchEvent(event);
                        console.log("Download link method with simulated click succeeded");
                        success = true;

                    } catch(ex) {
                        console.log("Download link method with simulated click failed with the following exception:");
                        console.log(ex);
                    }
                }

                if(!success)
                {
                    // Fallback to window.location method
                    try
                    {
                        // Prepare a blob URL
                        // Use application/octet-stream when using window.location to force download
                        console.log("Trying download link method with window.location ...");
                        var blob = new Blob([data], { type: octetStreamMime });
                        var url = urlCreator.createObjectURL(blob);
                        window.location = url;
                        console.log("Download link method with window.location succeeded");
                        success = true;
                    } catch(ex) {
                        console.log("Download link method with window.location failed with the following exception:");
                        console.log(ex);
                    }
                }

            }
        }

        if(!success)
        {
            // Fallback to window.open method
            console.log("No methods worked for saving the arraybuffer, using last resort window.open");
            window.open(httpPath, '_blank', '');
        }
    })
    .error(function(data, status) {
        console.log("Request failed with status: " + status);

        // Optionally write the error out to scope
        $scope.errorDetails = "Request failed with status: " + status;
    });
};

用法:

var downloadPath = "/files/instructions.pdf";
$scope.downloadFile(downloadPath);

笔记:

您应该修改WebApi方法以返回以下标头:

  • 我已使用x-filename标题发送文件名。为了方便起见,这是一个自定义标头,但是您可以content-disposition使用正则表达式从标头中提取文件名。

  • 您还应该content-type为响应设置mime标头,以便浏览器知道数据格式。

我希望这有帮助。


嗨,@ Scott,我使用了您的方法,它可以工作,但是浏览器将文件另存为html类型而不是pdf类型。我将content-type设置为application / pdf,当我在chrome中签入开发人员工具时,响应的类型设置为application / pdf,但是当我将文件保存为html时,它起作用了,当我打开文件时,它是以pdf格式打开,但在浏览器中打开,并且我的浏览器具有默认图标。你知道我会怎么做吗?
Bartosz Bialecki 2014年

1
:-(对不起。我错过了看。顺便说一句,它的效果很好。甚至比filesaver.js更好
Jeeva Jsb

1
当我尝试通过这种方法下载Microsoft可执行文件时,我得到的blob大小约为实际文件大小的1.5倍。下载的文件的Blob大小不正确。关于为什么会发生这种情况的任何想法?根据提琴手的观察,响应的大小是正确的,但是将内容转换为斑点会以某种方式增加斑点。
user3517454'1

1
终于找出了问题所在...我已将服务器代码从发布更改为获取,但没有更改$ http.get的参数。因此,从未将响应类型设置为arraybuffer,因为它是作为第三个参数而不是第二个参数传递的。
user3517454 2016年

1
@RobertGoldwein可以执行此操作,但可以假设的是,如果您正在使用angularjs应用程序,则希望用户保留在该应用程序中,该位置将保持下载开始后的状态和使用该功能的能力。如果直接导航到下载,则不能保证应用程序将保持活动状态,因为浏览器可能无法按照我们期望的方式处理下载。想象一下服务器是500s还是404s请求。用户现在退出了Angular应用程序。建议使用在新窗口中打开链接的最简单window.open建议。
斯科特,

10

C#WebApi PDF下载全部与Angular JS身份验证一起使用

Web Api控制器

[HttpGet]
    [Authorize]
    [Route("OpenFile/{QRFileId}")]
    public HttpResponseMessage OpenFile(int QRFileId)
    {
        QRFileRepository _repo = new QRFileRepository();
        var QRFile = _repo.GetQRFileById(QRFileId);
        if (QRFile == null)
            return new HttpResponseMessage(HttpStatusCode.BadRequest);
        string path = ConfigurationManager.AppSettings["QRFolder"] + + QRFile.QRId + @"\" + QRFile.FileName;
        if (!File.Exists(path))
            return new HttpResponseMessage(HttpStatusCode.BadRequest);

        HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.OK);
        //response.Content = new StreamContent(new FileStream(localFilePath, FileMode.Open, FileAccess.Read));
        Byte[] bytes = File.ReadAllBytes(path);
        //String file = Convert.ToBase64String(bytes);
        response.Content = new ByteArrayContent(bytes);
        response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment");
        response.Content.Headers.ContentType = new MediaTypeHeaderValue("application/pdf");
        response.Content.Headers.ContentDisposition.FileName = QRFile.FileName;

        return response;
    }

Angular JS服务

this.getPDF = function (apiUrl) {
            var headers = {};
            headers.Authorization = 'Bearer ' + sessionStorage.tokenKey;
            var deferred = $q.defer();
            $http.get(
                hostApiUrl + apiUrl,
                {
                    responseType: 'arraybuffer',
                    headers: headers
                })
            .success(function (result, status, headers) {
                deferred.resolve(result);;
            })
             .error(function (data, status) {
                 console.log("Request failed with status: " + status);
             });
            return deferred.promise;
        }

        this.getPDF2 = function (apiUrl) {
            var promise = $http({
                method: 'GET',
                url: hostApiUrl + apiUrl,
                headers: { 'Authorization': 'Bearer ' + sessionStorage.tokenKey },
                responseType: 'arraybuffer'
            });
            promise.success(function (data) {
                return data;
            }).error(function (data, status) {
                console.log("Request failed with status: " + status);
            });
            return promise;
        }

任一个都可以

Angular JS Controller调用服务

vm.open3 = function () {
        var downloadedData = crudService.getPDF('ClientQRDetails/openfile/29');
        downloadedData.then(function (result) {
            var file = new Blob([result], { type: 'application/pdf;base64' });
            var fileURL = window.URL.createObjectURL(file);
            var seconds = new Date().getTime() / 1000;
            var fileName = "cert" + parseInt(seconds) + ".pdf";
            var a = document.createElement("a");
            document.body.appendChild(a);
            a.style = "display: none";
            a.href = fileURL;
            a.download = fileName;
            a.click();
        });
    };

最后是HTML页面

<a class="btn btn-primary" ng-click="vm.open3()">FILE Http with crud service (3 getPDF)</a>

只需共享代码即可将其重构,现在希望它能对某人有所帮助,因为我花了一些时间才能使其正常工作。


上面的代码适用于ios以外的所有系统,因此,如果您需要在iOS上使用此代码,请执行以下步骤。步骤1检查ios stackoverflow.com/questions/9038625/detect-if-device-is-ios 步骤2(如果ios)使用此代码stackoverflow.com/questions/24485077/…–
tfa


6

对我而言,Web API是Rails和客户端Angular,与RestangularFileSaver.js一起使用

网络API

module Api
  module V1
    class DownloadsController < BaseController

      def show
        @download = Download.find(params[:id])
        send_data @download.blob_data
      end
    end
  end
end

的HTML

 <a ng-click="download('foo')">download presentation</a>

角度控制器

 $scope.download = function(type) {
    return Download.get(type);
  };

角度服务

'use strict';

app.service('Download', function Download(Restangular) {

  this.get = function(id) {
    return Restangular.one('api/v1/downloads', id).withHttpConfig({responseType: 'arraybuffer'}).get().then(function(data){
      console.log(data)
      var blob = new Blob([data], {
        type: "application/pdf"
      });
      //saveAs provided by FileSaver.js
      saveAs(blob, id + '.pdf');
    })
  }
});

您如何与此一起使用Filesaver.js?您是如何实现的?
艾伦·邓宁

2

我们还必须开发一种解决方案,甚至可以与需要身份验证的API配合使用(请参阅本文

概括地说,使用AngularJS的方法如下:

步骤1:建立专用指令

// jQuery needed, uses Bootstrap classes, adjust the path of templateUrl
app.directive('pdfDownload', function() {
return {
    restrict: 'E',
    templateUrl: '/path/to/pdfDownload.tpl.html',
    scope: true,
    link: function(scope, element, attr) {
        var anchor = element.children()[0];

        // When the download starts, disable the link
        scope.$on('download-start', function() {
            $(anchor).attr('disabled', 'disabled');
        });

        // When the download finishes, attach the data to the link. Enable the link and change its appearance.
        scope.$on('downloaded', function(event, data) {
            $(anchor).attr({
                href: 'data:application/pdf;base64,' + data,
                download: attr.filename
            })
                .removeAttr('disabled')
                .text('Save')
                .removeClass('btn-primary')
                .addClass('btn-success');

            // Also overwrite the download pdf function to do nothing.
            scope.downloadPdf = function() {
            };
        });
    },
    controller: ['$scope', '$attrs', '$http', function($scope, $attrs, $http) {
        $scope.downloadPdf = function() {
            $scope.$emit('download-start');
            $http.get($attrs.url).then(function(response) {
                $scope.$emit('downloaded', response.data);
            });
        };
    }] 
});

步骤2:建立范本

<a href="" class="btn btn-primary" ng-click="downloadPdf()">Download</a>

步骤3:使用

<pdf-download url="/some/path/to/a.pdf" filename="my-awesome-pdf"></pdf-download>

这将呈现一个蓝色按钮。单击后,将下载PDF(警告:后端必须以Base64编码提供PDF!)并放入href中。该按钮变为绿色,并将文本切换为“ 保存”。用户可以再次单击,然后将看到my-awesome.pdf文件的标准下载文件对话框。


1

将文件作为base64字符串发送。

 var element = angular.element('<a/>');
                         element.attr({
                             href: 'data:attachment/csv;charset=utf-8,' + encodeURI(atob(response.payload)),
                             target: '_blank',
                             download: fname
                         })[0].click();

如果attr方法在Firefox中不起作用,您还可以使用javaScript setAttribute方法


var blob = new Blob([atob(response.payload)],{“ data”:“ attachment / csv; charset = utf-8;”}); saveAs(blob,'文件名');
PPB 2015年

谢谢PPB,除了atob以外,您的解决方案对我有用。这对我来说不是必需的。
Larry Flewwelling

0

您可以实现一个showfile函数,该函数接受WEBApi返回的数据的参数以及您要下载的文件的文件名。我所做的就是创建一个单独的浏览器服务,该服务标识用户的浏览器,然后根据浏览器处理文件的呈现。例如,如果目标浏览器是ipad上的Chrome浏览器,则必须使用javascripts FileReader对象。

FileService.showFile = function (data, fileName) {
    var blob = new Blob([data], { type: 'application/pdf' });

    if (BrowserService.isIE()) {
        window.navigator.msSaveOrOpenBlob(blob, fileName);
    }
    else if (BrowserService.isChromeIos()) {
        loadFileBlobFileReader(window, blob, fileName);
    }
    else if (BrowserService.isIOS() || BrowserService.isAndroid()) {
        var url = URL.createObjectURL(blob);
        window.location.href = url;
        window.document.title = fileName;
    } else {
        var url = URL.createObjectURL(blob);
        loadReportBrowser(url, window,fileName);
    }
}


function loadFileBrowser(url, window, fileName) {
    var iframe = window.document.createElement('iframe');
    iframe.src = url
    iframe.width = '100%';
    iframe.height = '100%';
    iframe.style.border = 'none';
    window.document.title = fileName;
    window.document.body.appendChild(iframe)
    window.document.body.style.margin = 0;
}

function loadFileBlobFileReader(window, blob,fileName) {
    var reader = new FileReader();
    reader.onload = function (e) {
        var bdata = btoa(reader.result);
        var datauri = 'data:application/pdf;base64,' + bdata;
        window.location.href = datauri;
        window.document.title = fileName;
    }
    reader.readAsBinaryString(blob);
}

1
谢谢Scott赶上这些物品。我已经重构并添加了解释。
Erkin Djindjiev '16

0

我经历了一系列解决方案,这对我来说非常有用。

以我为例,我需要发送带有一些凭证的发帖请求。小开销是在脚本内添加jquery。但是值得。

var printPDF = function () {
        //prevent double sending
        var sendz = {};
        sendz.action = "Print";
        sendz.url = "api/Print";
        jQuery('<form action="' + sendz.url + '" method="POST">' +
            '<input type="hidden" name="action" value="Print" />'+
            '<input type="hidden" name="userID" value="'+$scope.user.userID+'" />'+
            '<input type="hidden" name="ApiKey" value="' + $scope.user.ApiKey+'" />'+
            '</form>').appendTo('body').submit().remove();

    }

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.