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

IT技术 c# javascript html angularjs asp.net-web-api
2021-01-21 21:11:31

在我的 Angular JS 项目中,我有一个<a>锚标记,单击该标记时会GET向返回文件的 WebAPI 方法发出 HTTP请求。

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

锚标签:

<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;
}
6个回答

对使用 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 标头,以便浏览器知道数据格式。

我希望这有帮助。

:-(抱歉。我没看到。顺便说一句,这很好用。甚至比 filesaver.js 还要好
2021-03-12 21:11:31
@RobertGoldwein 您可以这样做,但假设您使用的是 angularjs 应用程序,您希望用户保留在应用程序中,在该应用程序中保持下载开始后使用该功能的状态和能力。如果您直接导航到下载,则无法保证应用程序将保持活动状态,因为浏览器可能无法按照我们预期的方式处理下载。想象一下,如果服务器 500s 或 404s 的请求。用户现在离开了 Angular 应用程序。建议使用在新窗口中打开链接的最简单window.open建议。
2021-03-19 21:11:31
终于找到问题了...我已经将服务器代码从帖子更改为get,但我没有更改$http.get的参数。所以响应类型从未被设置为数组缓冲区,因为它是作为第三个参数而不是第二个参数传入的。
2021-03-31 21:11:31
当我尝试通过这种方法下载 Microsoft 可执行文件时,我得到的 blob 大小大约是实际文件大小的 1.5 倍。下载的文件的 blob 大小不正确。关于为什么会发生这种情况的任何想法?基于查看 fiddler,响应的大小是正确的,但将内容转换为 blob 会以某种方式增加它。
2021-04-06 21:11:31
嗨@Scott 我使用了你的方法并且它有效,但浏览器将文件保存为 html 类型而不是 pdf。我将内容类型设置为 application/pdf,当我在 chrome 中检查开发人员工具时,响应类型设置为 application/pdf 但是当我保存文件时,它显示为 html,它可以工作,当我打开它时,文件是以 pdf 格式打开,但在浏览器中打开,并且我的浏览器具有默认图标。你知道我会做错什么吗?
2021-04-08 21:11:31

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 Step 2(如果 ios)使用这个stackoverflow.com/questions/24485077/...
2021-03-29 21:11:31

对我来说,Web API 是 Rails,客户端 Angular 与RestangularFileSaver.js 一起使用

网页接口

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 的?你是如何实施的?
2021-04-08 21:11:31

我们还必须开发一个解决方案,它甚至可以与需要身份验证的 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。该按钮变为绿色并将文本切换为Save用户可以再次单击,将看到文件my-awesome.pdf的标准下载文件对话框

将您的文件作为 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 方法

谢谢PPB,除了atob,您的解决方案对我有用。这对我来说不是必需的。
2021-03-22 21:11:31
var blob = new Blob([atob(response.payload)], { "data":"attachment/csv;charset=utf-8;" }); saveAs(blob, '文件名');
2021-03-25 21:11:31