使用OkHttp进行文件上传

Question

我正在完成一个使用okhttp与web服务进行通信的项目。

对于常规的GET和POST请求一切都很顺利，但我无法正确上传文件。

okhttp文档在这些方面非常缺乏，而我在这里或其他任何地方找到的所有内容似乎都不能在我的情况下工作。

这应该很简单：我必须同时发送文件和一些字符串值。但是我无法弄清楚如何做到这一点。

根据我找到的一些示例，我首先尝试了以下操作：

RequestBody requestBody = new MultipartBuilder().type(MultipartBuilder.FORM)
    .addFormDataPart("group", getGroup())
    .addFormDataPart("type", getType())
    .addFormDataPart("entity", Integer.toString(getEntity()))
    .addFormDataPart("reference", Integer.toString(getReference()))
    .addPart(Headers.of("Content-Disposition", "form-data; name=\"task_file\""), RequestBody.create(MediaType.parse("image/png"), getFile()))
    .build();

我收到了“400错误请求”的提示。

于是我尝试了 okhttp 的示例代码：

RequestBody requestBody = new MultipartBuilder().type(MultipartBuilder.FORM)
    .addPart(Headers.of("Content-Disposition", "form-data; name=\"group\""), RequestBody.create(null, getGroup()))
    .addPart(Headers.of("Content-Disposition", "form-data; name=\"type\""), RequestBody.create(null, getType()))
    .addPart(Headers.of("Content-Disposition", "form-data; name=\"entity\""), RequestBody.create(null, Integer.toString(getEntity())))
    .addPart(Headers.of("Content-Disposition", "form-data; name=\"reference\""), RequestBody.create(null, Integer.toString(getReference())))
    .addPart(Headers.of("Content-Disposition", "form-data; name=\"task_file\""), RequestBody.create(MediaType.parse("image/png"), getFile()))
    .build();

同样的结果。

不知道还有什么尝试或者调试这个问题时需要查看什么。

使用以下代码完成请求：

// adds the required authentication token
Request request = new Request.Builder().url(getURL()).addHeader("X-Auth-Token", getUser().getToken().toString()).post(requestBody).build();
Response response = client.newCall(request).execute();

但我相信问题在于我构建请求体的方式。

我做错了什么？

编辑：顺便说一下，“getFile()”返回一个文件对象。其余参数都是字符串和整数。

- diogo.abdalla

Answer 1

我在最初发帖后不久就找到了自己问题的答案。

我会将它保留在这里，因为鉴于 okhttp 的上传示例非常少，它可能对其他人有用：

RequestBody requestBody = new MultipartBuilder().type(MultipartBuilder.FORM)
        .addFormDataPart("group", getGroup())
        .addFormDataPart("type", getType())
        .addFormDataPart("entity", Integer.toString(getEntity()))
        .addFormDataPart("reference", Integer.toString(getReference()))
        .addFormDataPart("task_file", "file.png", RequestBody.create(MediaType.parse("image/png"), getFile()))
                                                .build();

使用“addPart”与“Headers.of”等在示例中没有必要，addFormDataPart就可以胜任。

至于文件字段本身，它需要3个参数：名称、文件名和文件主体。仅此而已。

- diogo.abdalla

---

我遇到了同样的问题...不知道为什么食谱建议使用"addPart"和"Headers.of"。 - J28

getFile() 函数是做什么的？它是用于图像路径的吗？ - Jaimin Modi

@JaiminModi RequestBody.create(MEDIA_TYPE_PNG, sourceFile) 中的 sourceFile 是文件对象。 - Pratik Butani

好的，这意味着我可以传递存储在SD卡中的图像路径，还是必须传递位图？ - Jaimin Modi

请注意，类MultipartBuilder已经不存在了。 - zygimantus

Answer 2

我刚刚将addPart更改为addFormDataPart，最终使用以下代码解决了我的问题：

  /**
     * Upload Image
     *
     * @param memberId
     * @param sourceImageFile
     * @return
     */
    public static JSONObject uploadImage(String memberId, String sourceImageFile) {

        try {
            File sourceFile = new File(sourceImageFile);

            Log.d(TAG, "File...::::" + sourceFile + " : " + sourceFile.exists());

            final MediaType MEDIA_TYPE_PNG = MediaType.parse("image/png");

            RequestBody requestBody = new MultipartBuilder()
                    .type(MultipartBuilder.FORM)
                    .addFormDataPart("member_id", memberId)
                    .addFormDataPart("file", "profile.png", RequestBody.create(MEDIA_TYPE_PNG, sourceFile))
                    .build();

            Request request = new Request.Builder()
                    .url(URL_UPLOAD_IMAGE)
                    .post(requestBody)
                    .build();

            OkHttpClient client = new OkHttpClient();
            Response response = client.newCall(request).execute();
            return new JSONObject(response.body().string());

        } catch (UnknownHostException | UnsupportedEncodingException e) {
            Log.e(TAG, "Error: " + e.getLocalizedMessage());
        } catch (Exception e) {
            Log.e(TAG, "Other Error: " + e.getLocalizedMessage());
        }
        return null;
    }

- Pratik Butani

---

如果您正在使用PHP，您能提供服务器端代码吗？ - Rookie

什么是MultipartBuilder？Shubhank说它是OkHttp的一部分，但当我将其引入我的项目时，它无法解析并给出错误。 - Jumong

Answer 3

以下是使用okhttp3上传文件的方法。

      try {

          UpdateInformation("yourEmailAddress", filePath, sourceFile);

          } catch (IOException e) {
                        e.printStackTrace();
         }

    private void UploadInformation(String email, final String _filePath, final File file) throws IOException {


        runOnUiThread(new Runnable() {
            @Override
            public void run() {


            //show progress bar here

            }
        });


        OkHttpClient client = new OkHttpClient.Builder()
                .connectTimeout(60, TimeUnit.SECONDS)
                .writeTimeout(60, TimeUnit.SECONDS)
                .readTimeout(60, TimeUnit.SECONDS)
                .build();





        String mime = getMimeType(_filePath);


        RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
                .addFormDataPart("file", file.getName(),
                        RequestBody.create(MediaType.parse(mime), file))
                .addFormDataPart("email", email)
                .build();





        okhttp3.Request request = new okhttp3.Request.Builder()
                .url("yourEndPointURL")
                .post(body)
                .addHeader("authorization", "yourEndPointToken")
                .addHeader("content-type", "application/json")
                .build();



        client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                call.cancel();


                runOnUiThread(new Runnable() {
                    @Override
                    public void run() {

                    //hide progress bar here

                    }
                });

            }

            @Override
            public void onResponse(Call call, okhttp3.Response response) throws IOException {


                try {

                    final String myResponse = response.body().string();


                    runOnUiThread(new Runnable() {
                        @Override
                        public void run() {

                    //hide progress bar here

                    //Cont from here
                    //Handle yourEndPoint Response.



                        }
                    });


                } catch (Exception e) {
                    e.printStackTrace();
                }


            }



        });
    }


private String getMimeType(String path) {
        FileNameMap fileNameMap = URLConnection.getFileNameMap();
        String contentTypeFor = fileNameMap.getContentTypeFor(path);
        if (contentTypeFor == null)
        {
            contentTypeFor = "application/octet-stream";
        }
        return contentTypeFor;
    }

希望这能有所帮助。

- Oyewo Remi