okhttp常规用法和上传文件(multipart/form-data的学习)

本文详细介绍了使用OkHttp进行文件上传的方法,包括Multipart/form-data格式的理解与应用,以及如何封装OkHttp进行异步上传并回调结果。

okhttp常规用法

try {
            OkHttpClient client=new OkHttpClient();
            
            /**
             * 上传文件格式
             */
            /*RequestBody fileBody = RequestBody.create(MediaType.parse("image/png"), file);//将file转换成RequestBody文件
            RequestBody requestBody=new MultipartBody.Builder()
                    .addFormDataPart("name","filename",filebody)
                    .addFormDataPart("name","value")
                    .build();*/
            
            RequestBody requestBody=new FormBody.Builder()
                    .add("name","value")
                    .build();
            Request request=new Request.Builder()
                    .url("url")
                    .post(requestBody)
                    .build();
            Response response=client.newCall(request).execute();
            String responseBody=response.body().string();
            
        } catch (IOException e) {
            e.printStackTrace();
        }

封装okhttp,使其运行在子线程(因为网络操作耗时,会引起主线程堵塞)并且回调函数

public class OkhttpUtil {
    public static void senfOkhttpRequest(String address, okhttp3.Callback callback){
        OkHttpClient client=new OkHttpClient();
        Request request=new Request.Builder()
                .url(address)
                .post(requestBody)
                .build();
        client.newCall(request).enqueue(callback);
    }
}

在引用的时候如下

OkhttpUtil.senfOkhttpRequest(address, new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {

            }

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

            }
        });

--------------------------------------------------------------------------------------------------------------------------------------------------

在app 中,最基本的设置用户头像,需要进行头像的图片上传,那就会使用到 post 进行上传文件的操作。必然要了解下 Multipart/form-data 的含义。以前在写这部分代码的时候,不理解Headers.of(xxx)什么意思,而且 里面填写的格式又有什么要求代表了什么意思 等。

这里写图片描述

看到上面的api 的说明文档更是头大,所以需要了解下 Multipart/form-data

1.Multipart/form-data 解释

  • 1.1 什么是 Multipart/form-data: 
    Multipart/form-data是上传文件的一种方式,是浏览器用表单上传文件的方式

  • 1.2 Multipart/form-data 上传步骤: 
    首先,客户端和服务器建立连接(TCP协议)。 
    第二,客户端可以向服务器端发送数据。因为上传文件实质上也是向服务器端发送请求。 
    第三,客户端按照符合“multipart/form-data”的格式向服务器端发送数据。(这一点非常重要)。

  • 1.3 Multipart/form-data 上传格式的说明:

因为在进行上传文件的操作的时候,有些公共的api 会要求header 的上传格式 ,所以需要具体了解下相关格式的含义,以便更加精确的了解。下面是摘录的一段(http://blog.youkuaiyun.com/xiaojianpitt/article/details/6856536

这里是相关请求头的信息:

POST /t2/upload.do HTTP/1.1 
User-Agent: SOHUWapRebot 
Accept-Language: zh-cn,zh;q=0.5 
Accept-Charset: GBK,utf-8;q=0.7,*;q=0.7 
Connection: keep-alive 
Content-Length: 60408 
Content-Type:multipart/form-data; boundary=ZnGpDtePMx0KrHh_G0X99Yef9r8JZsRJSXC 
Host: w.sohu.com

–ZnGpDtePMx0KrHh_G0X99Yef9r8JZsRJSXC 
Content-Disposition: form-data;name=”desc” 
Content-Type: text/plain; charset=UTF-8 
Content-Transfer-Encoding: 8bit

[……][……][……][……]……………………… 
–ZnGpDtePMx0KrHh_G0X99Yef9r8JZsRJSXC 
Content-Disposition: form-data;name=”pic”; filename=”photo.jpg” 
Content-Type: application/octet-stream 
Content-Transfer-Encoding: binary

[图片二进制数据] 
–ZnGpDtePMx0KrHh_G0X99Yef9r8JZsRJSXC–

我们来分析下数据,第一个空行之前自然还是HTTP header,之后则是Entity,而此时的Entity也比之前要复杂一些。根据RFC 1867定义,我们需要选择一段数据作为“分割边界”( boundary属性),这个“边界数据”不能在内容其他地方出现,一般来说使用一段从概率上说“几乎不可能”的数据即可。 不同浏览器的实现不同,例如火狐某次post的 boundary=—————————32404670520626 , opera为boundary=———-E4SgDZXhJMgNE8jpwNdOAX ,每次post浏览器都会生成一个随机的30-40位长度的随机字符串,浏览器一般不会遍历这次post的所有数据找到一个不可能出现在数据中的字符串,这样代价太大了。一般都是随机生成,如果你遇见boundary值和post的内容一样,那样的话这次上传肯定失败,不过我建议你去买彩票,你太幸运了。Rfc1867这样说明{A boundary is selected that does not occur in any of the data. (This selection is sometimes done probabilisticly.)}。

选择了这个边界之后,浏览器便把它放在Content-Type 里面传递给服务器,服务器根据此边界解析数据。下面的数据便根据boundary划分段,每一段便是一项数据。(每个field被分成小部分,而且包含一个value是”form-data”的”Content-Disposition”的头部;一个”name”属性对应field的ID,等等,文件的话包括一个filename) 
IE和Chrome在filename的选择策略上有所不同,前者是文件的完整路径,而后者则仅仅是文件名。 
数据内容以两条横线结尾,并同样以一个换行结束。在网络协议中一般都以连续的CR、LF(即\r、\n,或0x0D、Ox0A)字符作为换行,这与Windows的标准一致。如果您使用其他操作系统,则需要考虑它们的换行符。 
另外Content-length 指的是所用数据的长度。

2.okhttp post 上传图片文件

public class UploadHelper extends Presenter {

    public static final String TAG = "UploadHelper";
    private static final MediaType MEDIA_TYPE_PNG = MediaType.parse("image/png");
    private final OkHttpClient client = new OkHttpClient();

    public String upload(String imageType,String userPhone,File file) throws NetworkException{

        RequestBody fileBody = RequestBody.create(MediaType.parse("image/png"), file);

        RequestBody requestBody = new MultipartBody.Builder()
                .setType(MultipartBody.FORM)
///                .addPart(
//                        Headers.of("Content-Disposition", "form-data; name=\"file\"; filename=\"" + fileName + "\""),
//                        RequestBody.create(MEDIA_TYPE_PNG, file))
//                .addPart(
//                        Headers.of("Content-Disposition", "form-data; name=\"imagetype\""),
//                        RequestBody.create(null, imageType))
//                .addPart(
//                        Headers.of("Content-Disposition", "form-data; name=\"userphone\""),
//                        RequestBody.create(null, userPhone))

                .addFormDataPart("file", "head_image", fileBody)
                .addFormDataPart("imagetype", imageType)
                .addFormDataPart("userphone", userPhone)
                .build();

        Request request = new Request.Builder()
                .url("http://xxxxx")
                .post(requestBody)
                .build();

        Response response;
        try {
            response = client.newCall(request).execute();
            String jsonString = response.body().string();
            Log.d(TAG," upload jsonString ="+jsonString);

            if(!response.isSuccessful()){
                throw new NetworkException("upload error code "+response);
            }else{
                JSONObject jsonObject = new JSONObject(jsonString);
                int errorCode = jsonObject.getInt("errorCode");
                if(errorCode == 0){
                    Log.d(TAG," upload data ="+jsonObject.getString("data"));
                    return jsonObject.getString("data");
                }else {
                    throw new NetworkException("upload error code "+errorCode+",errorInfo="+jsonObject.getString("errorInfo"));
                }
            }

        } catch (IOException e) {
            Log.d(TAG,"upload IOException ",e);
        }catch (JSONException e){
            Log.d(TAG,"upload JSONException ",e);
        }
        return null;
    }
   
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58

addPart 就是发送头部的具体内容了,其中 addFormDataPart 封装了部分内容,本质上 和

.addPart( 
Headers.of(“Content-Disposition”, “form-data; name=\”token\”“), 
RequestBody.create(null, uploadToken))

道理是一样的,只是内部进行了自己的封装。下面是相关的源代码

这里写图片描述

3.相关的参考的博客

http://blog.youkuaiyun.com/xiaojianpitt/article/details/6856536

http://blog.youkuaiyun.com/lmj623565791/article/details/23781773

http://blog.youkuaiyun.com/lmj623565791/article/details/47911083


<think> 我们正在讨论的是使用OkHttp进行multipart/form-data格式的文件上传。根据引用[1][3],我们可以使用OkHttpMultipartBody来构建请求体,然后发起POST请求。 引用[1]提供了一个示例方法,它使用MultipartBody.Builder来构建请求体,其中添加了文件部分。引用[3]指出MultipartBody是RequestBody的一个子类,专门用于multipart/form-data类型的请求。 下面我们将详细说明如何使用OkHttp实现multipart/form-data文件上传: 步骤: 1. 创建OkHttpClient实例。 2. 构建MultipartBody请求体,设置类型为MultipartBody.FORM(即multipart/form-data)。 3. 使用addFormDataPart方法添加表单字段,对于文件字段,需要指定字段名、文件文件体(通过RequestBody.create创建)。 4. 构建Request对象,设置URL请求方法为POST,并将前面构建的MultipartBody作为请求体。 5. 使用OkHttpClient发送请求并处理响应。 注意:在OkHttp 3.x及更高版本中,RequestBody.create方法的使用有所变化。在较新的版本(如OkHttp4)中,create方法已经被标记为过时,推荐使用RequestBody.create(File, MediaType)的重载形式或者使用Companion方式。 下面是一个更新后的示例代码(兼容新旧版本): </think> ### 使用 OkHttp 实现 multipart/form-data 文件上传 使用 OkHttp 进行 `multipart/form-data` 格式的文件上传需要以下步骤(以 Android 开发为例): #### 核心实现代码 ```java public static String uploadFile(String url, File file) throws IOException { OkHttpClient client = new OkHttpClient(); // 1. 构建 multipart/form-data 请求体 RequestBody requestBody = new MultipartBody.Builder() .setType(MultipartBody.FORM) // 设置表单类型[^2] .addFormDataPart( "file", // 表单字段名(与服务器一致) file.getName(), // 文件名 RequestBody.create( // 创建文件请求体 MediaType.parse("application/octet-stream"), file ) ) .build(); // 完成构建[^1] // 2. 创建请求对象 Request request = new Request.Builder() .url(url) .post(requestBody) // 设置POST方法请求体 .build(); // 3. 执行同步请求 try (Response response = client.newCall(request).execute()) { if (!response.isSuccessful()) { throw new IOException("上传失败,状态码: " + response.code()); } return response.body().string(); // 返回服务器响应 } } ``` #### 关键说明 1. **请求体构建**: - `MultipartBody.Builder` 用于构建多部分表单数据[^3] - `addFormDataPart()` 添加文件字段,参数依次为: - 字段名称(服务器端接收参数名,如 `file`) - 文件名(可选) - 文件内容请求体(通过 `RequestBody.create()` 创建) 2. **媒体类型选择**: - 通用二进制文件:`application/octet-stream` - 图片文件:`image/jpeg`/`image/png` - 文本文件:`text/plain` 3. **添加额外参数**: 在文件字段前后可添加普通表单字段: ```java .addFormDataPart("token", "user123") // 文本参数 .addFormDataPart("type", "avatar") // 文本参数 ``` #### 完整调用示例 ```java // 实际使用 File imageFile = new File("/sdcard/avatar.jpg"); try { String response = uploadFile( "https://api.example.com/upload", imageFile ); Log.d("UPLOAD", "服务器返回:" + response); } catch (IOException e) { e.printStackTrace(); } ``` #### 注意事项 1. **异步执行**:实际开发中建议使用 `enqueue()` 异步调用避免阻塞主线程 2. **权限声明**: ```xml <!-- AndroidManifest.xml 添加网络权限 --> <uses-permission android:name="android.permission.INTERNET"/> ``` 3. **大文件处理**:超过 10MB 文件需添加进度监听 4. **服务器兼容**:字段名 `file` 需与服务器接收参数名一致
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值