codeなにがし::Java(Servlet)でファイルダウンロード

Java(Servlet)でファイルダウンロード: 台北猫々

ソースコードID：　473
登録日時：　2008/03/17 21:12
最終更新日時：　2008/10/22 20:30
アクセス数：　7143
タグ：　 java ファイルダウンロード content-disposition attachment servlet

0 users

説明

サーバにあるファイルをクライアント（ブラウザ）にダウンロードするメソッドです。"Content-Disposition: attachment"により、ブラウザ側ではダウンロードダイアログが表示され、「開く」か「保存」するかをユーザが選択することができます。

※クライアントから、ダウンロード要求があった場合にサーバ側で行う処理です。

【変更履歴】
2008.03.19 例外処理追加等

ソースコード

履歴表示コピペ用

import java.io.File;
import java.io.IOException;
import java.io.FileInputStream;
import java.io.BufferedOutputStream;
import java.io.BufferedInputStream;
import java.net.HttpURLConnection;
import java.net.SocketException;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class DownloadFile extends HttpServlet {

    public void service(HttpServletRequest request, HttpServletResponse res)
            throws ServletException, IOException {
        
        File file = new File("c:\\sample.pdf");
        BufferedInputStream in = null;
        BufferedOutputStream out = null;
        try {
            //HTTPヘッダの出力
            res.setContentType("application/octet-stream");
            res.setHeader("Content-disposition", "attachment; filename=\"" + file.getName() + "\"");
            res.setContentLength((int)file.length());
            res.setHeader("Expires", "0");
            res.setHeader("Cache-Control", "must-revalidate, post-check=0,pre-check=0");
            res.setHeader("Pragma", "private");

            in = new BufferedInputStream(new FileInputStream(file));
            out = new BufferedOutputStream(res.getOutputStream());
            
            byte buf[]=new byte[1024];
            int len;
            while((len=in.read(buf))!=-1){
                out.write(buf,0,len);
            }
        } catch (SocketException e) {
            //●ダウンロード処理中にダウンロードダイアログの「キャンセル」が
            //クリックされた場合の例外。
            //●ただし、ダウンロードダイアログが表示されているバックグラウンドで
            //ブラウザへのダウンロードが行われていることに留意すること。
            //●つまり小さいファイルでは、ダイアログが表示される時には、ダウンロード
            //処理は完了し、サーブレットは終了してしまっており、SocketExceptionの
            //も発生しないということです。
        } catch (Exception e) {
            //ファイルダウンロード用のHTTPヘッダをリセットします。
            res.reset();
            res.sendError(HttpURLConnection.HTTP_INTERNAL_ERROR , e.toString());
        } finally {
            if (in != null) {
                in.close();
            }
            if (out != null) {
                out.flush();
                out.close();
            }
        }
        return;
    }
}

1：ゲスト (通りすがり)
2008/03/18 13:00

Javaのダウンロード処理を書くのであれば、以下の説明も欲しいかな。。。

発生する例外種別として、
・IOException
・FileNotFoundException
・SocketException
などなど、、、色々ありますよね？
また、よく見るケースとしては、
----抜粋開始
while((len=in.read(buf))!=-1){
out.write(buf,0,len);
}
----抜粋終了
の部分が
----NGCode
while((len=in.read(buf)) > -1){
out.write(buf,0,len);
}
----NGCode
となっていたりするケースも見られます。
とか、、、ノウハウならそこまで欲しいかも

2：台北猫々
2008/03/18 18:52

う～ん。例外処理はノウハウとして欲しいところですよね～（ちょっと、はしょっちゃいました（＾＾；）

ところで、アップしているソースで考慮すべき例外としては、
・IOException
・FileNotFoundException
の２つですよね？（異常系の組み方によっては、IllegalStateExceptionが発生するかなと思いますが）
・SocketException
は、IOExceptionにマッピングされてしまうのでは？

それと、
----NGCode
while((len=in.read(buf)) > -1){
out.write(buf,0,len);
}
----NGCode
という判定方法については問題無いような気がするのですが、具体的にどのようにNGなのかご教示いただけませんか？

3：ゲスト (１です。)
2008/03/19 16:39

回答のみ
> ・SocketException
> は、IOExceptionにマッピングされてしまうのでは？
拾い方によりけりです。
FileのIO例外とResponseのSocket例外は両方共にIOExceptionで拾えますが、ユーザがダウンロードの途中キャンセル等を拾うケースではSocket例外で拾うほうが正確になります。
ユーザキャンセル等は例外をキャッチはしてもプログラムとしての異常には落とすと変ですよね？

----NGCode
while((len=in.read(buf)) > -1){
out.write(buf,0,len);
}
----NGCode
に関しては誤記です。
失礼いたしました。「動作」としては正常に動くけど「論理的」な意味合いでのNGでしかないですね^^;

----NGCode
while((len=in.read(buf)) > 0){
out.write(buf,0,len);
}
----NGCode
としたつもりが[0]が[-1]のままになってしまいました。
> while((len=in.read(buf)) > 0){
の部分で、0の場合まだデータが残っていることを示すため、、、のつもりだったのですが、誤記してしまいました。

4：台北猫々
2008/03/19 22:54

>ユーザがダウンロードの途中キャンセル等を拾うケースではSocket
>例外で拾うほうが正確になります。
なるほどです。

＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃
＃↓以下は、この記事の読み手に、ダウンロードのクライアントユ
＃ーザのキャンセルをサーバ側で「常に」検知できるという誤解を
＃与えないために書いています。
＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃
ただ、サーバ→ブラウザのダウンロード処理は、ダウンロードダイアログ表示のバックグラウンドで行われているため、ユーザキャンセルをいつもSocket例外で拾えるわけではないという、条件付きですね。
（例えば、サイズの小さいファイルでは、ダイアログが表示される時には、ダウンロード処理は完了し、サーブレットは終了してしまっており、SocketExceptionも発生しない）。
＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃＃

＞失礼いたしました。「動作」としては正常に動くけど「論理的」
＞な意味合いでのNGでしかないですね^^;
なんとなく、そんな気もしていたのですが、念のためお聞きしてしまいました（＾＾）

5：ゲスト (1です。)
2008/03/23 04:17

蛇足なんだろうなというのはイヤというほど解かっていますし、しつこくて申し訳ないですが、乗りかかった船なのでついでです。
ノウハウに補足します。

> byte buf[]=new byte[1024];
の[1024]はパフォーマンスを見たものです。
よく知られてるチューニングだと、サーバ上のファイルIOに時間がかかる場合(Webサーバとは別のハードのファイルにアクセスする等)これはwhileの周期よりバッファ読み込みが遅くなるケースです。このチューニングは主にバッファの読み込みサイズとwhile文を遅延させることで行います。

以下のメソッドを確認すると、
http://sdc.sun.co.jp/java/docs/j2se/1.4/ja/docs/ja/api/ja...(byte[],%20int,%20int)
----抜粋
できるだけ多くのバイト数を読み込もうとします。
----終了
とあるため、そのときの「できるだけ」が0byteである場合無駄にwhile文がCPU時間をとりCPUフル現象が発生します。
原因がIO時間によるのであれば、スリープをはさむことで解決します。
また、メモリ容量が少ない環境(昨今そんなことは少ないでしょうけど)では、例えば元のファイルのサイズを拾ってきてbyte配列のサイズにしてしまうと、そのファイルが大きい場合、かなり無駄なメモリ空間を取ってしまうというケースも過去に見たことがあります。(私が見たケースは極端で1.5Gのファイルでした。そんなファイルのダウンロードなんてWebでしないで欲しいものですが。。。)なので、固定サイズで発行してあることそのものにも意味があります。

6：ゲスト (ヒロ)
2008/10/22 19:50

attachment部分をinlineに変更して、ファイルをダウンロードし別ウィンドウで開くようにしましたが、ウィンドウが元ウィンドウの裏側に表示されてしまうことがあります。
ダウンロードして、開くウィンドウが常に最上位になるようにするには、どうすれば良いでしょうか？
ちなみに、ダウンロードするファイルはPDFで、AcrobatReaderにて開いています。