114

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

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

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

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

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

4

10 に答える 10

110

オブジェクトを拡張することで、ZIPファイルまたはPDFファイルを取得することができましたStreamingOutput。サンプルコードは次のとおりです。

@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メソッドから出力ストリームを取得し、新しく作成された出力ストリームの代わりにそれに書き込みます。

それが最善の方法かどうかはわかりませんが、機能します。

于 2010-08-17T14:48:04.080 に答える
30

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();
于 2010-10-22T22:34:26.390 に答える
23

このコードを使用して、添付ファイルとしてジャージの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();

}
于 2012-04-02T10:59:09.023 に答える
16

別の例を次に示します。を介して QRCode を PNG として作成してい ByteArrayOutputStreamます。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():)私の1KB未満のPNGファイルで動作します...

于 2012-09-24T21:27:00.380 に答える
14

私は次の方法でJersey 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();
}
于 2013-10-31T09:05:23.853 に答える
7

この例は、残りのリソースを介して 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();
    }
}

}

于 2013-07-10T16:38:40.877 に答える
7

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();
}
于 2015-02-12T14:12:33.460 に答える
5

以下は私にとって役に立ちました。あなたや他の誰かに役立つ場合に備えて共有したいと思います. 存在しない 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 が post() の 2 番目のパラメーターとして渡されます。

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

于 2012-01-10T13:14:12.913 に答える
4

これは私の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();
}
于 2013-05-16T06:49:51.053 に答える