ウェブサーバーがクライアントからのHTTPリクエストを受け取り、そのリクエストに対応するHttpServletRequestオブジェクトとHttpServletResponseオブジェクトを作成します。HttpServletRequestはクライアントのリクエストパラメータを取得するために使用し、HttpServletResponseはクライアントに情報を送信するために使用します。

レスポンス関連のメソッド

ブラウザにレスポンスを送信するためのメソッド:

ServletOutputStream getOutputStream() throws IOException;
PrintWriter getWriter() throws IOException;

ブラウザにレスポンスヘッダーを送信するためのメソッド:

void setCharacterEncoding(String charset);
void setContentLength(int len);
void setContentLengthLong(long len);
void setContentType(String type);
void setDateHeader(String name, long date);
void addDateHeader(String name, long date);
void setHeader(String name, String value);
void addHeader(String name, String value);
void setIntHeader(String name, int value);
void addIntHeader(String name, int value);

ステータスコードを設定するためのメソッド:

void setStatus(int sc);

ステータスコード

int SC_CONTINUE = 100;
int SC_SWITCHING_PROTOCOLS = 101;
int SC_OK = 200;
int SC_CREATED = 201;
int SC_ACCEPTED = 202;
int SC_NON_AUTHORITATIVE_INFORMATION = 203;
int SC_NO_CONTENT = 204;
int SC_RESET_CONTENT = 205;
int SC_PARTIAL_CONTENT = 206;
int SC_MULTIPLE_CHOICES = 300;
int SC_MOVED_PERMANENTLY = 301;
int SC_MOVED_TEMPORARILY = 302;
int SC_FOUND = 302;
int SC_SEE_OTHER = 303;
int SC_NOT_MODIFIED = 304;
int SC_USE_PROXY = 305;
int SC_TEMPORARY_REDIRECT = 307;
int SC_BAD_REQUEST = 400;
int SC_UNAUTHORIZED = 401;
int SC_PAYMENT_REQUIRED = 402;
int SC_FORBIDDEN = 403;
int SC_NOT_FOUND = 404;
int SC_METHOD_NOT_ALLOWED = 405;
int SC_NOT_ACCEPTABLE = 406;
int SC_PROXY_AUTHENTICATION_REQUIRED = 407;
int SC_REQUEST_TIMEOUT = 408;
int SC_CONFLICT = 409;
int SC_GONE = 410;
int SC_LENGTH_REQUIRED = 411;
int SC_PRECONDITION_FAILED = 412;
int SC_REQUEST_ENTITY_TOO_LARGE = 413;
int SC_REQUEST_URI_TOO_LONG = 414;
int SC_UNSUPPORTED_MEDIA_TYPE = 415;
int SC_REQUESTED_RANGE_NOT_SATISFIABLE = 416;
int SC_EXPECTATION_FAILED = 417;
int SC_INTERNAL_SERVER_ERROR = 500;
int SC_NOT_IMPLEMENTED = 501;
int SC_BAD_GATEWAY = 502;
int SC_SERVICE_UNAVAILABLE = 503;
int SC_GATEWAY_TIMEOUT = 504;
int SC_HTTP_VERSION_NOT_SUPPORTED = 505;

一般的な用途

• ブラウザにメッセージを出力する
• ファイルをダウンロードする
  • ダウンロードするファイルのパスを取得する
  • ダウンロードするファイル名を決定する
  • ブラウザがファイルをダウンロードできるようにヘッダーを設定する
  • ファイルの入力ストリームを取得する
  • バッファを作成する
  • OutputStreamオブジェクトを取得する
  • ファイルの入力ストリームをバッファに書き込む
  • OutputStreamを使用してバッファ内のデータをクライアントに送信する

ファイルダウンロードの実装

Mavenのmaven-archetype-webテンプレートを使用して新しいMavenモジュールを作成します。

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee
                      https://jakarta.ee/xml/ns/jakartaee/web-app_5_0.xsd"
         version="5.0"
         metadata-complete="true">
    <servlet>
        <servlet-name>download</servlet-name>
        <servlet-class>com.example.servlet.FileDownloader</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>download</servlet-name>
        <url-pattern>/download</url-pattern>
    </servlet-mapping>
</web-app>

FileDownloader.java

package com.example.servlet;

import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URLEncoder;

public class FileDownloader extends HttpServlet {
    private static final long serialVersionUID = 1L;

    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String filePath = "x:xxx\\JavaWeb-Study\\03-Download\\target\\classes\\サンプル画像.jpg";
        System.out.println("ダウンロードするファイルのパス: " + filePath);
        String fileName = filePath.substring(filePath.lastIndexOf("\\") + 1);
        System.out.println("ファイル名: " + fileName);
        response.setHeader("Content-disposition", "attachment; filename=" + URLEncoder.encode(fileName, "UTF-8"));
        FileInputStream fileInputStream = new FileInputStream(filePath);
        int bufferSize = 1024;
        byte[] buffer = new byte[bufferSize];
        ServletOutputStream outputStream = response.getOutputStream();
        int bytesRead;
        while ((bytesRead = fileInputStream.read(buffer)) != -1) {
            outputStream.write(buffer, 0, bytesRead);
        }
        fileInputStream.close();
        outputStream.close();
    }

    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doGet(request, response);
    }
}