使用OkHttp3以Multipart/Form-Data方式上傳文件方式

更新時(shí)間：2024年10月23日 16:13:08 作者：莫翊痕

在開(kāi)發(fā)過(guò)程中,使用multipart/form-data進(jìn)行圖片上傳是一個(gè)常見(jiàn)的需求,本文通過(guò)一個(gè)實(shí)際案例,講解了如何在項(xiàng)目中添加OkHttp3庫(kù)依賴(lài),并使用multipart/form-data進(jìn)行圖片上傳,首先,介紹了ContentType的概念和常見(jiàn)類(lèi)型

準(zhǔn)備工作

首先，確保項(xiàng)目已經(jīng)添加了OkHttp3庫(kù)的依賴(lài)：

implementation 'com.squareup.okhttp3:okhttp:4.9.0'

ContentType概述

ContentType，也稱(chēng)為媒體類(lèi)型或MIME類(lèi)型，用于描述網(wǎng)絡(luò)請(qǐng)求和響應(yīng)中的內(nèi)容類(lèi)型。

以下是一些常見(jiàn)的ContentType：

text/plain：普通文本
text/html：HTML文檔
application/json：JSON數(shù)據(jù)
application/xml：XML數(shù)據(jù)
image/jpeg：JPEG圖片
image/png：PNG圖片
multipart/form-data：用于文件上傳

本文主要關(guān)注multipart/form-data，因?yàn)樗ǔＳ糜诒韱翁峤?，特別是包含文件上傳的表單。

步驟

1.創(chuàng)建MediaType

MediaType mediaType = MediaType.parse("image/jpeg");

MediaType用于描述文件類(lèi)型，這里我們上傳的是JPEG格式的圖片。

2.創(chuàng)建RequestBody

RequestBody fileBody = RequestBody.create(mediaType, photoFile);

RequestBody用于封裝待上傳的文件數(shù)據(jù)。

3.創(chuàng)建MultipartBody

RequestBody requestBody = new MultipartBody.Builder()
        .setType(MultipartBody.FORM)
        .addFormDataPart("file", photoFile.getName(), fileBody)
        .build();

MultipartBody用于構(gòu)建多部分表單請(qǐng)求，這里添加了文件部分。

4.添加請(qǐng)求頭

我也不知道他為什么要把參數(shù)放在url里面…

Request request = new Request.Builder()
        .url("http://xx.xx.x.xx:xxxxx/fileUploadAndDownload/upload?detailNo=1234&noSave=0")
        .addHeader("X-Token", token)
        .post(requestBody)
        .build();

這里我們添加了自定義的請(qǐng)求頭X-Token。

5.發(fā)送請(qǐng)求

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

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        if (!response.isSuccessful()) {
            throw new IOException("Unexpected code " + response);
        }
        System.out.println(response.body().string());
    }
});

通過(guò)OkHttpClient發(fā)送請(qǐng)求，并處理響應(yīng)。

完整代碼

使用OkHttp3以multipart/form-data方式上傳圖片的示例代碼。

import okhttp3.*;

import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.Set;

public class UploadImage {

    private static final String TAG = "UploadImage";

    public static void main(String[] args) {
        // 創(chuàng)建MediaType
        MediaType mediaType = MediaType.parse("image/jpeg");
        
        // 圖片文件路徑
        File photoFile = new File("path/to/your/photo.jpg");

        // 創(chuàng)建RequestBody
        RequestBody fileBody = RequestBody.create(mediaType, photoFile);
        
        // 創(chuàng)建MultipartBody
        RequestBody requestBody = new MultipartBody.Builder()
                .setType(MultipartBody.FORM)
                .addFormDataPart("file", photoFile.getName(), fileBody)
                .build();

        // 獲取自定義請(qǐng)求頭
        Map<String, String> headers = EasyConfig.getInstance().getHeaders();
        String token = headers.get("X-Token");
        Set<String> keySet = headers.keySet();
        for (String key : keySet) {
            Log.i(TAG, "uploadImage: " + headers.get(key));
        }

        // 創(chuàng)建Request
        Request request = new Request.Builder()
                .url("http://192.168.6.162:8888/fileUploadAndDownload/upload?detailNo=1234&noSave=0")
                .addHeader("X-Token", token)
                .post(requestBody)
                .build();

        // 創(chuàng)建OkHttpClient
        OkHttpClient client = new OkHttpClient();

        // 發(fā)送請(qǐng)求
        client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                e.printStackTrace();
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                if (!response.isSuccessful()) {
                    throw new IOException("Unexpected code " + response);
                }
                // 處理響應(yīng)
                System.out.println(response.body().string());
            }
        });
    }
}

我這邊使用的是EasyHttp庫(kù)，multipart/form-data不知道怎么設(shè)置，導(dǎo)致EasyHttp上傳不了圖片。

所以才用原生的api先學(xué)習(xí)，這邊也貼一下EasyHttp使用multipart/form-data上傳圖片。

 		// 創(chuàng)建RequestBody，指定媒體類(lèi)型和文件
        RequestBody fileRequestBody = RequestBody.create(MediaType.parse("image/jpeg"), photoFile);
        // 創(chuàng)建MultipartBody.Part，指定字段名和RequestBody
        MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", photoFile.getName(), fileRequestBody);
        // 構(gòu)建MultipartBody
        MultipartBody requestBody = new MultipartBody.Builder()
                .setType(MultipartBody.FORM)
                .addPart(filePart)
                .build();
        EasyHttp.post(this)
                .api(new UploadApi())
                .body(requestBody)
                .request(new OnUpdateListener<Void>() {
                    @Override
                    public void onUpdateProgressChange(int progress) {
                        Log.i(TAG, "onUpdateProgressChange: "+progress);
                    }

                    @Override
                    public void onUpdateSuccess(Void result) {
                        Log.i(TAG, "onUpdateSuccess:");
                    }

                    @Override
                    public void onUpdateFail(Throwable throwable) {
                        Log.i(TAG, "onUpdateFail:");
                    }
                });