Javaを使用してmultipart / form-data POSTリクエストを作成するにはどうすればよいですか?


96

Apache Commons HttpClientのバージョン3.xの時代には、multipart / form-data POSTリクエストを行うことが可能でした(2004年の例)。残念ながら、これはもはや可能ではありません HttpClientのバージョン4.0では

コアアクティビティ「HTTP」の場合、マルチパートはやや範囲外です。スコープ内にある他のプロジェクトによって管理されているマルチパートコードを使用したいのですが、私は知りません。数年前にマルチパートコードをcommons-codecに移行しようとしましたが、私はそこから離陸しませんでした。Olegは最近、マルチパート解析コードがあり、マルチパートフォーマットコードに興味があるかもしれない別のプロジェクトに言及しました。その現状はわかりません。(http://www.nabble.com/multipart-form-data-in-4.0-td14224819.html

multipart / form-data POSTリクエストを実行できるHTTPクライアントを作成できるJavaライブラリを知っている人はいますか?

背景:Zoho WriterのリモートAPIを使用したいと思います


回答:


151

マルチパートファイルをポストするためにHttpClient 4.xを使用します。

更新HttpClient 4.3以降、一部のクラスが非推奨になりました。新しいAPIのコードは次のとおりです。

CloseableHttpClient httpClient = HttpClients.createDefault();
HttpPost uploadFile = new HttpPost("...");
MultipartEntityBuilder builder = MultipartEntityBuilder.create();
builder.addTextBody("field1", "yes", ContentType.TEXT_PLAIN);

// This attaches the file to the POST:
File f = new File("[/path/to/upload]");
builder.addBinaryBody(
    "file",
    new FileInputStream(f),
    ContentType.APPLICATION_OCTET_STREAM,
    f.getName()
);

HttpEntity multipart = builder.build();
uploadFile.setEntity(multipart);
CloseableHttpResponse response = httpClient.execute(uploadFile);
HttpEntity responseEntity = response.getEntity();

以下は、廃止されたHttpClient 4.0 API使用した元のコードスニペットです。

HttpClient httpclient = new DefaultHttpClient();
HttpPost httppost = new HttpPost(url);

FileBody bin = new FileBody(new File(fileName));
StringBody comment = new StringBody("Filename: " + fileName);

MultipartEntity reqEntity = new MultipartEntity();
reqEntity.addPart("bin", bin);
reqEntity.addPart("comment", comment);
httppost.setEntity(reqEntity);

HttpResponse response = httpclient.execute(httppost);
HttpEntity resEntity = response.getEntity();

62
ああ、マルチパートのものがorg.apache.httpcomponents-httpmime-4.0に移動しました!どこかに言及することができます:/

小さなファイルでは正常に機能するが、大きなファイルでは機能しない更新されたコードを試してみました。この質問について
AabinGunz '19

こんにちはZZさん、コードに上記の変更を加えましたが、今、新しい問題に直面しています。RESTエンドポイントがリクエストを受け入れていません。次のパラメーターを想定しています:〜@ PathVariable final String id、@RequestParam( "image")final MultipartFile image、@RequestParam( "l")final String l、@RequestParam( "lo")final String lo、@RequestParam( " bac ")final String bac、@RequestParam(" cac ")final String cac、@RequestParam(" m ")final String m ...以前は、リクエストは受け入れられていました。しかし、今私は500エラーを取得しています。なぜこれが起こっているのでしょうか?
ローガン、

コード例がもはや水平スクロールしないように回答を編集しました---自分の作業でそれを使用しようとすると、スクロールによって重要な最終パラメーターが見落とされました。
G.シルビーデイヴィス

更新された回答<dependency> <groupId> org.apache.httpcomponents </ groupId> <artifactId> httpclient </ artifactId> <version> 4.3.6 </ version> </ dependency> <!-のMaven依存関係は次のとおりです!mvnrepository.com/artifact/org.apache.httpcomponents/httpmime- > <dependency> < groupId > org.apache.httpcomponents </ groupId> <artifactId> httpmime </ artifactId> <version> 4.3.6 </ version> < / dependency>
Wazime 2017年

39

これらは私が持っているMavenの依存関係です。

Javaコード:

HttpClient httpclient = new DefaultHttpClient();
HttpPost httpPost = new HttpPost(url);

FileBody uploadFilePart = new FileBody(uploadFile);
MultipartEntity reqEntity = new MultipartEntity();
reqEntity.addPart("upload-file", uploadFilePart);
httpPost.setEntity(reqEntity);

HttpResponse response = httpclient.execute(httpPost);

pom.xmlのMaven依存関係:

<dependency>
  <groupId>org.apache.httpcomponents</groupId>
  <artifactId>httpclient</artifactId>
  <version>4.0.1</version>
  <scope>compile</scope>
</dependency>
<dependency>
  <groupId>org.apache.httpcomponents</groupId>
  <artifactId>httpmime</artifactId>
  <version>4.0.1</version>
  <scope>compile</scope>
</dependency>

1
HttpEntityクラスには、少なくとも4.2ではhttpcoreも必要です
alalonde

18

JARのサイズが重要な場合(アプレットの場合など)、HttpClientの代わりにjava.net.HttpURLConnectionを使用してhttpmimeを直接使用することもできます。

httpclient-4.2.4:      423KB
httpmime-4.2.4:         26KB
httpcore-4.2.4:        222KB
commons-codec-1.6:     228KB
commons-logging-1.1.1:  60KB
Sum:                   959KB

httpmime-4.2.4:         26KB
httpcore-4.2.4:        222KB
Sum:                   248KB

コード:

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setDoOutput(true);
connection.setRequestMethod("POST");

FileBody fileBody = new FileBody(new File(fileName));
MultipartEntity multipartEntity = new MultipartEntity(HttpMultipartMode.STRICT);
multipartEntity.addPart("file", fileBody);

connection.setRequestProperty("Content-Type", multipartEntity.getContentType().getValue());
OutputStream out = connection.getOutputStream();
try {
    multipartEntity.writeTo(out);
} finally {
    out.close();
}
int status = connection.getResponseCode();
...

pom.xmlの依存関係:

<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpmime</artifactId>
    <version>4.2.4</version>
</dependency>

これがどこから来たかFileBody?apace.httpcomponentsを使用しない(簡単な)方法はありますか?
Jr.

6

このコードを使用して、マルチパートのポストを使用して画像やその他のファイルをサーバーにアップロードします。

import java.io.File;
import java.io.IOException;
import java.io.UnsupportedEncodingException;

import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.HttpClient;
import org.apache.http.client.ResponseHandler;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.mime.MultipartEntity;
import org.apache.http.entity.mime.content.FileBody;
import org.apache.http.entity.mime.content.StringBody;
import org.apache.http.impl.client.BasicResponseHandler;
import org.apache.http.impl.client.DefaultHttpClient;

public class SimplePostRequestTest {

    public static void main(String[] args) throws UnsupportedEncodingException, IOException {
        HttpClient httpclient = new DefaultHttpClient();
        HttpPost httppost = new HttpPost("http://192.168.0.102/uploadtest/upload_photo");

        try {
            FileBody bin = new FileBody(new File("/home/ubuntu/cd.png"));
            StringBody id = new StringBody("3");
            MultipartEntity reqEntity = new MultipartEntity();
            reqEntity.addPart("upload_image", bin);
            reqEntity.addPart("id", id);
            reqEntity.addPart("image_title", new StringBody("CoolPic"));

            httppost.setEntity(reqEntity);
            System.out.println("Requesting : " + httppost.getRequestLine());
            ResponseHandler<String> responseHandler = new BasicResponseHandler();
            String responseBody = httpclient.execute(httppost, responseHandler);
            System.out.println("responseBody : " + responseBody);

        } catch (ClientProtocolException e) {

        } finally {
            httpclient.getConnectionManager().shutdown();
        }
    }

}

アップロードするには以下のファイルが必要です。

ライブラリがある httpclient-4.1.2.jar, httpcore-4.1.2.jar, httpmime-4.1.2.jar, httpclient-cache-4.1.2.jar, commons-codec.jarcommons-logging-1.1.1.jar、クラスパスにあるように。


4

HTTPクライアント上に構築されたREST Assuredを使用することもできます。とても簡単です:

given().multiPart(new File("/somedir/file.bin")).when().post("/fileUpload");

「ファイル」と呼ばれるコントロール名を想定します。あなたが別のコントロール名を持っているなら、あなたはそれを指定する必要がありますmultiPart("controlName", new File("/somedir/file.bin"))、参照github.com/rest-assured/rest-assured/wiki/...
asmaier

REST Assuredには優れたAPIがあり、多くの機能をサポートしています。それを使用することは喜びです。ただし、公平を期すために、ウォームアップの手順によっては、最初の呼び出しでパフォーマンスが低下する可能性があることに言及する価値があります。あなたはすなわち、ここで、インターネット上でより多くの情報を見つけることがsqa.stackexchange.com/questions/39532/...
user1053510

REST Assuredは素晴らしいライブラリですが、Web APIテスト用に設計されているため、実稼働コードでHTTP呼び出しを行うのに適切なツールではないと思います。もちろん、同じ基盤となるライブラリを利用しています。
Ranil Wijeyratne

3

これは、ライブラリを必要としないソリューションです。

このルーチンは、ディレクトリ内のすべてのファイルd:/data/mpf10urlToConnect


String boundary = Long.toHexString(System.currentTimeMillis());
URLConnection connection = new URL(urlToConnect).openConnection();
connection.setDoOutput(true);
connection.setRequestProperty("Content-Type", "multipart/form-data; boundary=" + boundary);
PrintWriter writer = null;
try {
    writer = new PrintWriter(new OutputStreamWriter(connection.getOutputStream(), "UTF-8"));
    File dir = new File("d:/data/mpf10");
    for (File file : dir.listFiles()) {
        if (file.isDirectory()) {
            continue;
        }
        writer.println("--" + boundary);
        writer.println("Content-Disposition: form-data; name=\"" + file.getName() + "\"; filename=\"" + file.getName() + "\"");
        writer.println("Content-Type: text/plain; charset=UTF-8");
        writer.println();
        BufferedReader reader = null;
        try {
            reader = new BufferedReader(new InputStreamReader(new FileInputStream(file), "UTF-8"));
            for (String line; (line = reader.readLine()) != null;) {
                writer.println(line);
            }
        } finally {
            if (reader != null) {
                reader.close();
            }
        }
    }
    writer.println("--" + boundary + "--");
} finally {
    if (writer != null) writer.close();
}
// Connection is lazily executed whenever you request any status.
int responseCode = ((HttpURLConnection) connection).getResponseCode();
// Handle response

2

httpcomponents-client-4.0.1私のために働いた。ただし、外部jar apache-mime4j-0.6.jarorg.apache.james.mime4j) を追加する必要がありました。追加しreqEntity.addPart("bin", bin);ないとコンパイルできません。今それは魅​​力のように働いています。


2

私が見つかりました。このサンプルを Apacheの中にクイックスタートガイド。バージョン4.5用です。

/**
 * Example how to use multipart/form encoded POST request.
 */
public class ClientMultipartFormPost {

    public static void main(String[] args) throws Exception {
        if (args.length != 1)  {
            System.out.println("File path not given");
            System.exit(1);
        }
        CloseableHttpClient httpclient = HttpClients.createDefault();
        try {
            HttpPost httppost = new HttpPost("http://localhost:8080" +
                    "/servlets-examples/servlet/RequestInfoExample");

            FileBody bin = new FileBody(new File(args[0]));
            StringBody comment = new StringBody("A binary file of some kind", ContentType.TEXT_PLAIN);

            HttpEntity reqEntity = MultipartEntityBuilder.create()
                    .addPart("bin", bin)
                    .addPart("comment", comment)
                    .build();


            httppost.setEntity(reqEntity);

            System.out.println("executing request " + httppost.getRequestLine());
            CloseableHttpResponse response = httpclient.execute(httppost);
            try {
                System.out.println("----------------------------------------");
                System.out.println(response.getStatusLine());
                HttpEntity resEntity = response.getEntity();
                if (resEntity != null) {
                    System.out.println("Response content length: " + resEntity.getContentLength());
                }
                EntityUtils.consume(resEntity);
            } finally {
                response.close();
            }
        } finally {
            httpclient.close();
        }
    }
}

0

jdkの外部の外部依存関係やライブラリを使用せずに、multipart-form submitの純粋なJava実装があります。https://github.com/atulsm/https-multipart-purejava/blob/master/src/main/java/com/atul/MultipartPure.javaを参照してください

private static String body = "{\"key1\":\"val1\", \"key2\":\"val2\"}";
private static String subdata1 = "@@ -2,3 +2,4 @@\r\n";
private static String subdata2 = "<data>subdata2</data>";

public static void main(String[] args) throws Exception{        
    String url = "https://" + ip + ":" + port + "/dataupload";
    String token = "Basic "+ Base64.getEncoder().encodeToString((userName+":"+password).getBytes());

    MultipartBuilder multipart = new MultipartBuilder(url,token);       
    multipart.addFormField("entity", "main", "application/json",body);
    multipart.addFormField("attachment", "subdata1", "application/octet-stream",subdata1);
    multipart.addFormField("attachment", "subdata2", "application/octet-stream",subdata2);        
    List<String> response = multipart.finish();         
    for (String line : response) {
        System.out.println(line);
    }
}

0

私のコードはmultipartFileをサーバーに投稿します。

  public static HttpResponse doPost(
    String host,
    String path,
    String method,
    MultipartFile multipartFile
  ) throws IOException
  {

    HttpClient httpClient = wrapClient(host);
    HttpPost httpPost = new HttpPost(buildUrl(host, path));

    if (multipartFile != null) {

      HttpEntity httpEntity;

      ContentBody contentBody;
      contentBody = new ByteArrayBody(multipartFile.getBytes(), multipartFile.getOriginalFilename());
      httpEntity = MultipartEntityBuilder.create()
                                         .addPart("nameOfMultipartFile", contentBody)
                                         .build();

      httpPost.setEntity(httpEntity);

    }
    return httpClient.execute(httpPost);
  }
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.