AngularJSを使用してASP.NET Web APIメソッドからファイルをダウンロードする


132

私の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;
}

1
ファイルタイプは何ですか?画像のみ?
Rashmin Javiya 14年

@RashminJaviyaは、.jpg、.doc、.xlsx、.docx、.txt、または.pdfです。
whereDragonsDwell 14年

どの.Netフレームワークを使用していますか?
Rashmin Javiya 14年

@RashminJaviya .NET 4.5
whereDragonsDwell

1
@Kurkulaコントローラーからではなく、System.IO.Fileのファイルを使用する必要があります
Javysk

回答:


242

ajaxを使用してバイナリファイルをダウンロードするためのサポートは素晴らしいものではありません。ワーキングドラフトとしてまだ開発中です。

簡単なダウンロード方法:

以下のコードを使用するだけで、ブラウザーに要求されたファイルをダウンロードさせることができます。これはすべてのブラウザーでサポートされており、明らかに同じようにWebApi要求をトリガーします。

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

Ajaxバイナリダウンロード方法:

一部のブラウザーではajaxを使用してバイナリファイルをダウンロードできます。以下は、Chrome、Internet Explorer、FireFox、Safariの最新のフレーバーで動作する実装です。

これは、arraybufferJavaScript 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私はあなたの方法を使用しましたが、それは機能しますが、ブラウザはファイルをPDFではなくHTMLタイプとして保存します。content-typeをapplication / pdfに設定し、Chromeで開発者ツールをチェックインすると、応答のタイプがapplication / pdfに設定されますが、ファイルを保存すると、htmlとして表示され、動作します。ファイルを開くと、 PDFとして開かれましたが、ブラウザ内にあり、私のブラウザのデフォルトのアイコンがあります。何がいけないのか知っていますか?
Bartosz Bialecki 14

1
:-(申し訳ありません。それを見逃してしまいました。ところで、これは非常にうまく機能しています。filesaver.jsよりも優れています
Jeeva Jsb

1
この方法でMicrosoft実行可能ファイルをダウンロードしようとすると、実際のファイルサイズの約1.5倍のblobサイズが返されます。ダウンロードされるファイルのblobのサイズが正しくありません。なぜこれが起こっているのかについて何か考えはありますか?フィドラーを見ると、応答のサイズは正しいですが、コンテンツをblobに変換すると、どういうわけか増加します。
user3517454

1
最後に問題を見つけました...サーバーコードを投稿から取得に変更しましたが、$ http.getのパラメーターは変更していませんでした。したがって、2番目ではなく3番目の引数として渡されていたため、応答タイプがarraybufferとして設定されることはありませんでした。
user3517454

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で使用されていました

Web 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);
  };

Angular Service

'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をどのように使用しましたか?どのように実装しましたか?
アランダニング2015年

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がダウンロードされ(注意:バックエンドはPDFをBase64エンコードで配信する必要があります!)、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();

Firefoxでattrメソッドが機能しない場合javaScript setAttributeメソッドを使用することもできます


var blob = new Blob([atob(response.payload)]、{"data": "attachment / csv; charset = utf-8;"}); saveAs(blob、 'filename');
PPB

PPBに感謝します。あなたのソリューションはatobを除いて私にとってはうまくいきました。それは私には必要ありませんでした。
Larry Flewwelling 2016年

0

WEBApiから返されたデータのパラメーターと、ダウンロードしようとしているファイルのファイル名を取り込むshowfile関数を実装できます。私が行ったのは、ユーザーのブラウザーを識別し、ブラウザーに基づいてファイルのレンダリングを処理する別のブラウザーサービスを作成することでした。たとえば、ターゲットブラウザーがiPadのクロムである場合、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
スコット、それらのアイテムを捕まえてくれてありがとう。リファクタリングして説明を追加しました。
Erkin Djindjiev

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();

    }

-1

あなたのコンポーネント、すなわち角度のjsコード:

function getthefile (){
window.location.href='http://localhost:1036/CourseRegConfirm/getfile';
};
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.