REST Webサービスからクライアントにファイルを送信する正しい方法は何ですか?


103

RESTサービスの開発を始めたばかりですが、RESTサービスからクライアントにファイルを送信するという難しい状況に遭遇しました。これまでのところ、単純なデータ型(文字列、整数など)を送信する方法のコツをつかんでいますが、ファイル形式が多すぎてどこから始めればよいかわからないため、ファイルの送信は別の問題です。私のRESTサービスはJavaで作成されており、Jerseyを使用しています。すべてのデータをJSON形式で送信しています。

私はbase64エンコーディングについて読みましたが、一部の人々はそれが良いテクニックであると言い、他の人はファイルサイズの問題が原因ではないと言っています。正しい方法は何ですか?これが私のプロジェクトの単純なリソースクラスの外観です。

import java.sql.SQLException;
import java.util.List;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Request;
import javax.ws.rs.core.UriInfo;

import com.mx.ipn.escom.testerRest.dao.TemaDao;
import com.mx.ipn.escom.testerRest.modelo.Tema;

@Path("/temas")
public class TemaResource {

    @GET
    @Produces({MediaType.APPLICATION_JSON})
    public List<Tema> getTemas() throws SQLException{

        TemaDao temaDao = new TemaDao();        
        List<Tema> temas=temaDao.getTemas();
        temaDao.terminarSesion();

        return temas;
    }
}

ファイルを送信するためのコードは次のようになると思います:

import java.sql.SQLException;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;

@Path("/resourceFiles")
public class FileResource {

    @GET
    @Produces({application/x-octet-stream})
    public File getFiles() throws SQLException{ //I'm not really sure what kind of data type I should return

        // Code for encoding the file or just send it in a data stream, I really don't know what should be done here

        return file;
    }
}

どのような注釈を使用すればよいですか?一部の人がを@GET使用することを推奨しているのを見ました@Produces({application/x-octet-stream})が、それは正しい方法ですか?送信するファイルは特定のファイルであるため、クライアントがファイルを参照する必要はありません。ファイルを送信する方法を誰かに教えてもらえますか?JSONオブジェクトとして送信するには、base64を使用してエンコードする必要がありますか?それともJSONオブジェクトとして送信するためにエンコーディングは必要ありませんか?あなたが与えるかもしれないあらゆる助けをありがとう。


java.io.Fileサーバー上に実際の(またはファイルパス)がありますか、それともデータベース、Webサービス、メソッド呼び出しなどのその他のソースからデータが返されていInputStreamますか?
Philipp Reichart、2012

回答:


138

バイナリデータをbase64でエンコードしてJSONでラップすることはお勧めしません。応答のサイズが不必要に大きくなり、処理が遅くなります。

GETと(JAX-RS APIの一部であり、Jerseyにロックされない)application/octect-streamのファクトリメソッドの1つを使用して、ファイルデータを提供するだけjavax.ws.rs.core.Responseです。

@GET
@Produces(MediaType.APPLICATION_OCTET_STREAM)
public Response getFile() {
  File file = ... // Initialize this to the File path you want to serve.
  return Response.ok(file, MediaType.APPLICATION_OCTET_STREAM)
      .header("Content-Disposition", "attachment; filename=\"" + file.getName() + "\"" ) //optional
      .build();
}

実際のFileオブジェクトがない場合でもInputStreamResponse.ok(entity, mediaType)はそれを処理できるはずです。


おかげで、これはうまくいきましたが、フォルダ構造全体を使いたい場合はどうなりますか?私はこのようなことを考えていました また、クライアントでさまざまなファイルを受信するので、HttpResponseのエンティティ応答をどのように処理すればよいですか?
ウリエル

4
from ZipOutputStreamを返すことと一緒に見てください。これにより、ほとんどのクライアントが簡単に読み取ることができる、よく知られたマルチファイル形式を取得できます。圧縮は、データに意味がある場合にのみ使用してください。JPEGなどの事前圧縮されたファイルには使用できません。クライアント側では、応答を解析する必要があります。StreamingOutputgetFile()ZipInputStream
Philipp Reichart、2012

1
このかもしれないのヘルプ: stackoverflow.com/questions/10100936/...
バジルDsouza

ファイルのバイナリデータと共に応答のファイルのメタデータを追加する方法はありますか?
abhig 2014年

応答にはいつでもヘッダーを追加できます。それでも十分でない場合は、オクテットストリームにエンコードする必要があります。つまり、メタデータと必要なファイルの両方を含むコンテナ形式を提供します。
Philipp Reichart、2014年

6

ダウンロードするファイルを返したい場合、特にファイルのアップロード/ダウンロードの一部のjavascriptライブラリと統合したい場合は、次のコードで処理できます。

@GET
@Path("/{key}")
public Response download(@PathParam("key") String key,
                         @Context HttpServletResponse response) throws IOException {
    try {
        //Get your File or Object from wherever you want...
            //you can use the key parameter to indentify your file
            //otherwise it can be removed
        //let's say your file is called "object"
        response.setContentLength((int) object.getContentLength());
        response.setHeader("Content-Disposition", "attachment; filename="
                + object.getName());
        ServletOutputStream outStream = response.getOutputStream();
        byte[] bbuf = new byte[(int) object.getContentLength() + 1024];
        DataInputStream in = new DataInputStream(
                object.getDataInputStream());
        int length = 0;
        while ((in != null) && ((length = in.read(bbuf)) != -1)) {
            outStream.write(bbuf, 0, length);
        }
        in.close();
        outStream.flush();
    } catch (S3ServiceException e) {
        e.printStackTrace();
    } catch (ServiceException e) {
        e.printStackTrace();
    }
    return Response.ok().build();
}

3

マシンアドレスをlocalhostからクライアントが接続するIPアドレスに変更して、下記のサービスを呼び出します。

REST Webサービスを呼び出すクライアント:

package in.india.client.downloadfiledemo;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;

import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response.Status;

import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.ClientHandlerException;
import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.client.UniformInterfaceException;
import com.sun.jersey.api.client.WebResource;
import com.sun.jersey.multipart.BodyPart;
import com.sun.jersey.multipart.MultiPart;

public class DownloadFileClient {

    private static final String BASE_URI = "http://localhost:8080/DownloadFileDemo/services/downloadfile";

    public DownloadFileClient() {

        try {
            Client client = Client.create();
            WebResource objWebResource = client.resource(BASE_URI);
            ClientResponse response = objWebResource.path("/")
                    .type(MediaType.TEXT_HTML).get(ClientResponse.class);

            System.out.println("response : " + response);
            if (response.getStatus() == Status.OK.getStatusCode()
                    && response.hasEntity()) {
                MultiPart objMultiPart = response.getEntity(MultiPart.class);
                java.util.List<BodyPart> listBodyPart = objMultiPart
                        .getBodyParts();
                BodyPart filenameBodyPart = listBodyPart.get(0);
                BodyPart fileLengthBodyPart = listBodyPart.get(1);
                BodyPart fileBodyPart = listBodyPart.get(2);

                String filename = filenameBodyPart.getEntityAs(String.class);
                String fileLength = fileLengthBodyPart
                        .getEntityAs(String.class);
                File streamedFile = fileBodyPart.getEntityAs(File.class);

                BufferedInputStream objBufferedInputStream = new BufferedInputStream(
                        new FileInputStream(streamedFile));

                byte[] bytes = new byte[objBufferedInputStream.available()];

                objBufferedInputStream.read(bytes);

                String outFileName = "D:/"
                        + filename;
                System.out.println("File name is : " + filename
                        + " and length is : " + fileLength);
                FileOutputStream objFileOutputStream = new FileOutputStream(
                        outFileName);
                objFileOutputStream.write(bytes);
                objFileOutputStream.close();
                objBufferedInputStream.close();
                File receivedFile = new File(outFileName);
                System.out.print("Is the file size is same? :\t");
                System.out.println(Long.parseLong(fileLength) == receivedFile
                        .length());
            }
        } catch (UniformInterfaceException e) {
            e.printStackTrace();
        } catch (ClientHandlerException e) {
            e.printStackTrace();
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }

    }

    public static void main(String... args) {
        new DownloadFileClient();
    }
}

応答クライアントへのサービス:

package in.india.service.downloadfiledemo;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import com.sun.jersey.multipart.MultiPart;

@Path("downloadfile")
@Produces("multipart/mixed")
public class DownloadFileResource {

    @GET
    public Response getFile() {

        java.io.File objFile = new java.io.File(
                "D:/DanGilbert_2004-480p-en.mp4");
        MultiPart objMultiPart = new MultiPart();
        objMultiPart.type(new MediaType("multipart", "mixed"));
        objMultiPart
                .bodyPart(objFile.getName(), new MediaType("text", "plain"));
        objMultiPart.bodyPart("" + objFile.length(), new MediaType("text",
                "plain"));
        objMultiPart.bodyPart(objFile, new MediaType("multipart", "mixed"));

        return Response.ok(objMultiPart).build();

    }
}

JARが必要:

jersey-bundle-1.14.jar
jersey-multipart-1.14.jar
mimepull.jar

WEB.XML:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    id="WebApp_ID" version="2.5">
    <display-name>DownloadFileDemo</display-name>
    <servlet>
        <display-name>JAX-RS REST Servlet</display-name>
        <servlet-name>JAX-RS REST Servlet</servlet-name>
        <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
        <init-param>
             <param-name>com.sun.jersey.config.property.packages</param-name> 
             <param-value>in.india.service.downloadfiledemo</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>JAX-RS REST Servlet</servlet-name>
        <url-pattern>/services/*</url-pattern>
    </servlet-mapping>
    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

-2

JSONを使用しているので、ネットワーク経由で送信する前にBase64エンコードします。

ファイルが大きい場合は、BSON、またはバイナリ転送に適しているその他の形式を確認してください。

また、base64でエンコードする前に、ファイルが適切に圧縮されている場合は、zip圧縮することもできます。


全体のファイルサイズの理由で送信する前にそれらを圧縮することを計画していましたが、base64でエンコードする場合、@Produces注釈には何を含める必要がありますか?
ウリエル

何を入力するかに関係なく、JSON仕様に従ってapplication / json。(ietf.org/rfc/rfc4627.txt?number=4627)base64でエンコードされたファイルはJSONタグ内にある必要があることに注意してください
LarsK

3
バイナリデータをbase64でエンコードし、それをJSONでラップしてもメリットはありません。応答のサイズが不必要に大きくなり、処理が遅くなります。
Philipp Reichart、2012
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.