.NET開発者のためのブログメディア
ASP.NETでファイルのダウンロード機能を実装する方法
ASP.NETとは、C#やVB.NETで開発できるWebアプリケーションのフレームワークです。Webアプリを作成する際に、よく使う機能にファイルのダウンロードがあります。サーバサイドで実装して、ユーザーが使うクライアントに出力するので、少し難しく感じるかもしれませんが、サーバサイドで、HttpResponseを使うとこの機能は比較的簡単に実装できます。ここではこのダウンロードをする方法について解説していきます。
- SE
- ASP.NETを利用して、Webアプリを開発中です。仕様書にファイルのダウンロードをするように明記されているのですが、どうやってコーディングを行えば良いのでしょうか？
- PM
- ファイルのダウンロードを行う場合には、HttpResponseを使って実装します。簡単なサンプルプログラムを提供しますので、確認してみましょう。
実行環境
・Visual Studio Community 2017
目次
ASP.NETを使ってファイルダウンロードを実装する
それでは早速ですが、ASP.NETを活用してのファイルのダウンロードを行う方法を、サンプルプログラムをもとに解説していきます。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="WebForm1.aspx.cs" Inherits="WebApplication21.WebForm1" %>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title></title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:Button ID="btnDownload" runat="server" Text="ダウンロード" OnClick="btnDownload_Click"/>
</div>
</form>
</body>
</html>
|
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
using System;
namespace WebApplication21
{
public partial class WebForm1 : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
}
public void btnDownload_Click(object sender, EventArgs e)
{
var filename = @"test.txt";
Response.Clear();
Response.ContentType = "text/plain";
Response.HeaderEncoding = System.Text.Encoding.UTF8;
Response.ContentEncoding = System.Text.Encoding.UTF8;
Response.AddHeader("Content-Disposition", "attachment;filename=" + Server.UrlEncode(filename));
Response.End();
}
}
}
|
実行結果
◆ダウンロードボタンを押下する
◆ダウンロード成功
上記のプログラミングで大事なポイントは、Content-Typeに何を指定するかです。今回はテキストファイルを出力するためのContent-Typeとしてtext/plainを指定しました。他のファイルを出力するためのContent-Typeも多数そろえられていますので、ここでは代表的なContent-Typeの種類を確認しておきましょう。
■Content-Typeの種類
| Content-Type | 出力ファイル様式 |
|---|---|
| text/plain | テキストファイル |
| text/csv | CSVファイル |
| text/html | HTMLファイル |
| application/octet-stream | EXEファイルなどの実行ファイル |
| application/pdf | PDFファイル |
| application/vnd.ms-excel | EXCELファイル 拡張子が.xlsのもの |
| application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | EXCELファイル 拡張子が.xlsxのもの |
| image/jpeg | JPEGファイル |
| image/bmp | Bitmapファイル |
| application/zip | Zipファイル |
ファイル名が文字化けする際の対策
ダウンロードする際に、ファイル名に日本語を使用すると、文字化けや意図しないファイル名が表示されることがあります。
Webアプリケーションからクライアントサイドへの応答返信時、Content-Disposition ヘッダに、”attachment; filename=xxx” というコーディングを行うと、クライアントサイドへのファイルのダウンロード処理が行われます。
ダウンロードを行うファイル名は、このヘッダの filename=xxx に設定しますが、xxxの箇所に日本語のようなマルチバイトの文字列を指定すると、文字化けが発生する恐れがあります。
これを回避させるためには、 ヘッダを常に UTF-8 で送信するようにしましょう。ファイル名を Server.UrlEncode()で囲むことで解決できます。しかし、使用しているブラウザによっては、解決できない場合もありますので、注意が必要です。
- SE
- ファイル名を指定する際には、UTF-8で送信することを心がけます。ファイルのダウンロード処理が実装できれば、作業の幅も広がりそうです。自分でもコーディングしてみます！
- PM
- Webアプリケーションを開発するならば、ファイルのアップロードとダウンロードは行えるようにしておきたいところです。早く自分でも実装できるように、積極的にコーディング方法は覚えていきましょう！
ファイルのダウンロード機能の実装は共通モジュールで
ASP.NETでファイルのダウンロードを行う方法は、今回解説したやり方をマスターできれば、他でも応用できます。サーバサイドで、このファイルダウンロード処理を共通モジュール化しておけば、どこからでも呼び出すことができ、1箇所の実装で済むはずです。
ダウンロード機能などは、プロジェクトではじめに共通化する箇所でありますので、早めに実装方法は理解し、プロジェクトメンバー全員が使えるダウンロード機能を実装していきましょう。
Search キーワード検索
Popular 人気の記事
-
【VB.NET入門】DataGridViewの使い方まとめ
公開: 更新:
reccomended おすすめ記事
-
【.NETが統合】.NET 5の概要と今後のリリース予定
公開: 更新:
Categories 連載一覧
Tags タグ一覧
Jobs 新着案件
-
開発エンジニア/東京都品川区/【WEB面談可】/在宅ワーク
月給29万～30万円東京都品川区(大崎駅) -
遠隔テストサービス機能改修/JavaScript/東京都港区/【WEB面談可】/テレワーク
月給45万～60万円東京都港区(六本木駅) -
病院内システムの不具合対応、保守/東京都豊島区/【WEB面談可】/テレワーク
月給30万～30万円東京都豊島区(池袋駅) -
開発/JavaScript/東京都豊島区/【WEB面談可】/テレワーク
月給50万～50万円東京都豊島区(大塚駅) -
債権債務システム追加開発/東京都文京区/【WEB面談可】/在宅勤務
月給62万～67万円東京都文京区(後楽園駅)