HttpClient 4によるマルチパートアップロード

HttpClient 4を使用したマルチパートアップロード

1. 概要

このチュートリアルでは、a multipart upload operation using HttpClient 4を実行する方法を説明します。

http://echo.200please.comは公開されており、ほとんどの種類のコンテンツを受け入れるため、テストサーバーとして使用します。

より深くlearn other cool things you can do with the HttpClientを掘り下げたい場合は、the main HttpClient tutorialに進んでください。

**2. AddPartメソッドの使用**

まず、MultipartEntityBuilderオブジェクトからadd parts to an Http entityを確認します。これは、POST操作を介してアップロードされます。

これは、フォームを表すHttpEntityにパーツを追加する一般的な方法です。

例2.1 –Uploading a Form with Two Text Parts and a File

File file = new File(textFileName);
HttpPost post = new HttpPost("http://echo.200please.com");
FileBody fileBody = new FileBody(file, ContentType.DEFAULT_BINARY);
StringBody stringBody1 = new StringBody("Message 1", ContentType.MULTIPART_FORM_DATA);
StringBody stringBody2 = new StringBody("Message 2", ContentType.MULTIPART_FORM_DATA);
//
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
builder.addPart("upfile", fileBody);
builder.addPart("text1", stringBody1);
builder.addPart("text2", stringBody2);
HttpEntity entity = builder.build();
//
post.setEntity(entity);
HttpResponse response = client.execute(post);

サーバーが使用するContentType値も指定して、Fileオブジェクトをインスタンス化していることに注意してください。

また、addPartメソッドには2つの引数があり、フォームのkey/valueペアのように機能することに注意してください。これらは、サーバー側が実際にパラメータ名を予期して使用する場合にのみ関係します。それ以外の場合は、単に無視されます。

**3. addBinaryBodyおよびaddTextBodyメソッドの使用**

マルチパートエンティティを作成するより直接的な方法は、addBinaryBodyおよびAddTextBodyメソッドを使用することです。これらのメソッドは、テキスト、ファイル、文字配列、およびInputStreamオブジェクトをアップロードするために機能します。簡単な例でその方法を説明しましょう。

例3.1。 –Uploading Text and a Text File Part

HttpPost post = new HttpPost("http://echo.200please.com");
File file = new File(textFileName);
String message = "This is a multipart post";
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
builder.addBinaryBody("upfile", file, ContentType.DEFAULT_BINARY, textFileName);
builder.addTextBody("text", message, ContentType.DEFAULT_BINARY);
//
HttpEntity entity = builder.build();
post.setEntity(entity);
HttpResponse response = client.execute(post);

ここでは、FileBodyおよびStringBodyオブジェクトは必要ないことに注意してください。

また、ほとんどのサーバーはテキスト本文のContentTypeをチェックしないため、addTextBodyメソッドはContentType値を省略できます。

addBinaryBody APIはContentTypeを受け入れますが、バイナリ本体とファイルを保持するフォームパラメータの名前だけからエンティティを作成することはis also可能です。前のセクションで述べたように、ContentType値が指定されていない場合、一部のサーバーはファイルを認識しません。

次に、zipファイルをInputStream,として追加し、画像ファイルをFileオブジェクトとして追加します。

例3.2 –Uploading a __ Zip File, an Image File, and a Text Part

HttpPost post = new HttpPost("http://echo.200please.com");
InputStream inputStream = new FileInputStream(zipFileName);
File file = new File(imageFileName);
String message = "This is a multipart post";
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
builder.addBinaryBody
  ("upfile", file, ContentType.DEFAULT_BINARY, imageFileName);
builder.addBinaryBody
  ("upstream", inputStream, ContentType.create("application/zip"), zipFileName);
builder.addTextBody("text", message, ContentType.TEXT_PLAIN);
//
HttpEntity entity = builder.build();
post.setEntity(entity);
HttpResponse response = client.execute(post);

上記のzipファイルの例のように、ContentType値はオンザフライで作成できることに注意してください。

最後に、すべてのサーバーがInputStreamの部分を認識するわけではありません。コードの最初の行でインスタンス化したサーバーは、InputStreamsを認識します。

ここで、addBinaryBodyがバイト配列を直接操作している別の例を見てみましょう。

例3.3。 –Uploading a Byte Array and Text

HttpPost post = new HttpPost("http://echo.200please.com");
String message = "This is a multipart post";
byte[] bytes = "binary code".getBytes();
//
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
builder.addBinaryBody("upfile", bytes, ContentType.DEFAULT_BINARY, textFileName);
builder.addTextBody("text", message, ContentType.TEXT_PLAIN);
//
HttpEntity entity = builder.build();
post.setEntity(entity);
HttpResponse response = client.execute(post);

ContentTypeに注意してください–これは現在バイナリデータを指定しています。

4. 結論

この記事では、MultipartEntityBuilderを、マルチパートフォームを作成するための複数のAPIの選択肢を提供する柔軟なオブジェクトとして紹介しました。

例では、HttpClientを使用して、フォームエンティティに類似したa HttpEntityをアップロードする方法も示しています。

これらすべての例とコードスニペットcan be found in our GitHub projectの実装–これはEclipseベースのプロジェクトであるため、そのままインポートして実行するのは簡単です。

TOC