web-dev-qa-db-ja.com

JERSEYを使用してバイナリストリームを入出力しますか？

私はジャージーを使用して、主にJSONエンコードデータを取得して提供するRESTful APIを実装しています。しかし、次のことを達成する必要がある状況がいくつかあります。

  • PDF、XLS、Zip、またはその他のバイナリファイルなどのダウンロード可能なドキュメントをエクスポートします。
  • JSONやアップロードされたXLSファイルなどのマルチパートデータを取得する

このWebサービスへのAJAX呼び出しを作成する単一ページのJQueryベースのWebクライアントがあります。現時点では、フォームの送信は行わず、GETとPOST（JSONオブジェクトを使用）を使用します。フォームポストを利用してデータと添付のバイナリファイルを送信する必要がありますか、それともJSONとバイナリファイルを使用してマルチパートリクエストを作成できますか？

現在、私のアプリケーションのサービスレイヤーは、PDFファイルを生成するときにByteArrayOutputStreamを作成します。 Jerseyを介してこのストリームをクライアントに出力する最良の方法は何ですか？ MessageBodyWriterを作成しましたが、Jerseyリソースからそれを使用する方法がわかりません。それは正しいアプローチですか？

私はジャージーに含まれているサンプルを調べてきましたが、これらのいずれかを行う方法を示すものはまだ見つかりませんでした。問題があれば、JacksonでJerseyを使用してObject-> JSONをXMLステップなしで実行しており、実際にはJAX-RSを使用していません。

javajerseyjax-rs
109
Tauren

StreamingOutputオブジェクトを拡張することにより、ZipファイルまたはPDFファイルを取得できました。以下にサンプルコードを示します。

@Path("PDF-file.pdf/")
@GET
@Produces({"application/pdf"})
public StreamingOutput getPDF() throws Exception {
    return new StreamingOutput() {
        public void write(OutputStream output) throws IOException, WebApplicationException {
            try {
                PDFGenerator generator = new PDFGenerator(getEntity());
                generator.generatePDF(output);
            } catch (Exception e) {
                throw new WebApplicationException(e);
            }
        }
    };
}

PDFGeneratorクラス（PDFを作成するための独自のクラス）は、writeメソッドから出力ストリームを取得し、新しく作成された出力ストリームの代わりにそれに書き込みます。

それが最善の方法かどうかはわかりませんが、うまくいきます。

108
MikeTheReader

私はrtfファイルを返さなければならず、これは私のために働いた。

// create a byte array of the file in correct format
byte[] docStream = createDoc(fragments); 

return Response
            .ok(docStream, MediaType.APPLICATION_OCTET_STREAM)
            .header("content-disposition","attachment; filename = doc.rtf")
            .build();
29
Abhishek Rakshit

このコードを使用して、添付ファイルとしてジャージでExcel（xlsx）ファイル（Apache Poi）をエクスポートします。

@GET
@Path("/{id}/contributions/Excel")
@Produces("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
public Response exportExcel(@PathParam("id") Long id)  throws Exception  {

    Resource resource = new ClassPathResource("/xls/template.xlsx");

    final InputStream inp = resource.getInputStream();
    final Workbook wb = WorkbookFactory.create(inp);
    Sheet sheet = wb.getSheetAt(0);

    Row row = CellUtil.getRow(7, sheet);
    Cell cell = CellUtil.getCell(row, 0);
    cell.setCellValue("TITRE TEST");

    [...]

    StreamingOutput stream = new StreamingOutput() {
        public void write(OutputStream output) throws IOException, WebApplicationException {
            try {
                wb.write(output);
            } catch (Exception e) {
                throw new WebApplicationException(e);
            }
        }
    };


    return Response.ok(stream).header("content-disposition","attachment; filename = export.xlsx").build();

}
22
Grégory

別の例を示します。 ByteArrayOutputStreamを介してQRCodeをPNGとして作成しています。リソースはResponseオブジェクトを返し、ストリームのデータはエンティティです。

応答コードの処理を説明するために、キャッシュヘッダーの処理（If-modified-since、If-none-matchesなど）を追加しました。

@Path("{externalId}.png")
@GET
@Produces({"image/png"})
public Response getAsImage(@PathParam("externalId") String externalId, 
        @Context Request request) throws WebApplicationException {

    ByteArrayOutputStream stream = new ByteArrayOutputStream();
    // do something with externalId, maybe retrieve an object from the
    // db, then calculate data, size, expirationTimestamp, etc

    try {
        // create a QRCode as PNG from data     
        BitMatrix bitMatrix = new QRCodeWriter().encode(
                data, 
                BarcodeFormat.QR_CODE, 
                size, 
                size
        );
        MatrixToImageWriter.writeToStream(bitMatrix, "png", stream);

    } catch (Exception e) {
        // ExceptionMapper will return HTTP 500 
        throw new WebApplicationException("Something went wrong …")
    }

    CacheControl cc = new CacheControl();
    cc.setNoTransform(true);
    cc.setMustRevalidate(false);
    cc.setNoCache(false);
    cc.setMaxAge(3600);

    EntityTag etag = new EntityTag(HelperBean.md5(data));

    Response.ResponseBuilder responseBuilder = request.evaluatePreconditions(
            updateTimestamp,
            etag
    );
    if (responseBuilder != null) {
        // Preconditions are not met, returning HTTP 304 'not-modified'
        return responseBuilder
                .cacheControl(cc)
                .build();
    }

    Response response = Response
            .ok()
            .cacheControl(cc)
            .tag(etag)
            .lastModified(updateTimestamp)
            .expires(expirationTimestamp)
            .type("image/png")
            .entity(stream.toByteArray())
            .build();
    return response;
}

stream.toByteArray()がノーメモリノーである場合に私をbeatめないでください:)それは私の<1KB PNGファイルで動作します...

15
Hank

私は、ジャージー1.17サービスを次のように作成しています。

FileStreamingOutput

public class FileStreamingOutput implements StreamingOutput {

    private File file;

    public FileStreamingOutput(File file) {
        this.file = file;
    }

    @Override
    public void write(OutputStream output)
            throws IOException, WebApplicationException {
        FileInputStream input = new FileInputStream(file);
        try {
            int bytes;
            while ((bytes = input.read()) != -1) {
                output.write(bytes);
            }
        } catch (Exception e) {
            throw new WebApplicationException(e);
        } finally {
            if (output != null) output.close();
            if (input != null) input.close();
        }
    }

}

GET

@GET
@Produces("application/pdf")
public StreamingOutput getPdf(@QueryParam(value="name") String pdfFileName) {
    if (pdfFileName == null)
        throw new WebApplicationException(Response.Status.BAD_REQUEST);
    if (!pdfFileName.endsWith(".pdf")) pdfFileName = pdfFileName + ".pdf";

    File pdf = new File(Settings.basePath, pdfFileName);
    if (!pdf.exists())
        throw new WebApplicationException(Response.Status.NOT_FOUND);

    return new FileStreamingOutput(pdf);
}

そして、あなたがそれを必要とするならば、クライアント：

Client

private WebResource resource;

public InputStream getPDFStream(String filename) throws IOException {
    ClientResponse response = resource.path("pdf").queryParam("name", filename)
        .type("application/pdf").get(ClientResponse.class);
    return response.getEntityInputStream();
}
14
Daniel Szalay

この例は、残りのリソースを介してJBossでログファイルを公開する方法を示しています。 getメソッドはStreamingOutputインターフェイスを使用してログファイルのコンテンツをストリーミングします。

@Path("/logs/")
@RequestScoped
public class LogResource {

private static final Logger logger = Logger.getLogger(LogResource.class.getName());
@Context
private UriInfo uriInfo;
private static final String LOG_PATH = "jboss.server.log.dir";

public void pipe(InputStream is, OutputStream os) throws IOException {
    int n;
    byte[] buffer = new byte[1024];
    while ((n = is.read(buffer)) > -1) {
        os.write(buffer, 0, n);   // Don't allow any extra bytes to creep in, final write
    }
    os.close();
}

@GET
@Path("{logFile}")
@Produces("text/plain")
public Response getLogFile(@PathParam("logFile") String logFile) throws URISyntaxException {
    String logDirPath = System.getProperty(LOG_PATH);
    try {
        File f = new File(logDirPath + "/" + logFile);
        final FileInputStream fStream = new FileInputStream(f);
        StreamingOutput stream = new StreamingOutput() {
            @Override
            public void write(OutputStream output) throws IOException, WebApplicationException {
                try {
                    pipe(fStream, output);
                } catch (Exception e) {
                    throw new WebApplicationException(e);
                }
            }
        };
        return Response.ok(stream).build();
    } catch (Exception e) {
        return Response.status(Response.Status.CONFLICT).build();
    }
}

@POST
@Path("{logFile}")
public Response flushLogFile(@PathParam("logFile") String logFile) throws URISyntaxException {
    String logDirPath = System.getProperty(LOG_PATH);
    try {
        File file = new File(logDirPath + "/" + logFile);
        PrintWriter writer = new PrintWriter(file);
        writer.print("");
        writer.close();
        return Response.ok().build();
    } catch (Exception e) {
        return Response.status(Response.Status.CONFLICT).build();
    }
}

}

7
Jaime Casero

Jersey 2.16ファイルのダウンロードは非常に簡単です。

以下は、Zipファイルの例です

@GET
@Path("zipFile")
@Produces("application/Zip")
public Response getFile() {
    File f = new File(Zip_FILE_PATH);

    if (!f.exists()) {
        throw new WebApplicationException(404);
    }

    return Response.ok(f)
            .header("Content-Disposition",
                    "attachment; filename=server.Zip").build();
}
6
orangegiraffa

私は次のことが私にとって役立つことを発見し、あなたまたは他の誰かに役立つ場合に備えて共有したいと思いました。存在しないMediaType.PDF_TYPEのようなものが必要でしたが、このコードは同じことを行います。

DefaultMediaTypePredictor.CommonMediaTypes.
        getMediaTypeFromFileName("anything.pdf")

http://jersey.Java.net/nonav/apidocs/1.1.0-ea/contribs/jersey-multipart/com/Sun/jersey/multipart/file/DefaultMediaTypePredictor.CommonMediaTypes.html を参照してください

私の場合、PDFドキュメントを別のサイトに投稿していました。

FormDataMultiPart p = new FormDataMultiPart();
p.bodyPart(new FormDataBodyPart(FormDataContentDisposition
        .name("fieldKey").fileName("document.pdf").build(),
        new File("path/to/document.pdf"),
        DefaultMediaTypePredictor.CommonMediaTypes
                .getMediaTypeFromFileName("document.pdf")));

次に、pが2番目のパラメーターとしてpost（）に渡されます。

このリンクは、このコードスニペットをまとめるのに役立ちました： http://jersey.576304.n2.nabble.com/Multipart-Post-td4252846.html

5
Dovev Hefetz

Url： http://example.com/rest/muqsith/get-file?filePath=C ：\ Users\I066807\Desktop\test.xml

@GET
@Produces({ MediaType.APPLICATION_OCTET_STREAM })
@Path("/get-file")
public Response getFile(@Context HttpServletRequest request){
   String filePath = request.getParameter("filePath");
   if(filePath != null && !"".equals(filePath)){
        File file = new File(filePath);
        StreamingOutput stream = null;
        try {
        final InputStream in = new FileInputStream(file);
        stream = new StreamingOutput() {
            public void write(OutputStream out) throws IOException, WebApplicationException {
                try {
                    int read = 0;
                        byte[] bytes = new byte[1024];

                        while ((read = in.read(bytes)) != -1) {
                            out.write(bytes, 0, read);
                        }
                } catch (Exception e) {
                    throw new WebApplicationException(e);
                }
            }
        };
    } catch (FileNotFoundException e) {
        e.printStackTrace();
    }
        return Response.ok(stream).header("content-disposition","attachment; filename = "+file.getName()).build();
        }
    return Response.ok("file path null").build();
}
4
Muqsith

RESTサービスにファイルをアップロードできる別のサンプルコード、RESTサービスはファイルを圧縮し、クライアントはサーバーからZipファイルをダウンロードします。これは、ジャージーを使用してバイナリ入出力ストリームを使用する良い例です。

https://stackoverflow.com/a/32253028/15789

この答えは私が別のスレッドに投稿しました。お役に立てれば。

1
RuntimeException