Android 网络开源库-Retrofit(二) 单文件上传、下载及下载进度监听

1.写在前面的话

首先说明,我还没太搞懂retrofit,目前,这篇博客只能给出这几个内容。

  • 文件上传
  • 文件下载
  • 文件下载的进度监听

还有这两点没弄好,

  • 多文件一次上传 (批量上传)
  • 文件上传进度监听

当前使用版本

compile 'com.squareup.retrofit2:retrofit:2.0.2'

2. 文件上传

2.1 api 接口编写

public interface uploadfileApi {
    @Multipart
    @POST("/fileabout.php")
    Call upload(@Part("fileName") String des,
                        @Part("file\"; filename=\"1.txt") RequestBody file);
}
  • @Part("fileDes") String des 可以加一些描述信息(可以不加)
  • @Part("file"; filename="1.txt") 格式不变,只需将1.text 对应的替换为你想在服务器生成的文件名称
  • 如果想传多个文件,多次请求,当然,也可以像表单一样(还没弄好)

当然,上面这种办法的灵活性差了点,我们可以选择下面这种写法

public interface uploadfileApi {
    @Multipart
    @POST("/fileabout.php")
    Call upload_2(@PartMap Map params);
}

2.2 上传文件

第一种api接口对应的代码

Retrofit retrofit= new Retrofit.Builder()
                        .addConverterFactory(GsonConverterFactory.create())
                        .baseUrl("http://192.168.56.1")
                        .build();
uploadfileApi service =retrofit.create(uploadfileApi.class);
File file = new File(Environment.getExternalStorageDirectory() + "/" + "1.txt");
RequestBody requestBody = RequestBody.create(MediaType.parse("multipart/form-data"),file);
Call model = service.upload("this is txt",requestBody);
model.enqueue(new Callback() {
    @Override
    public void onResponse(Call call, Response response) {
         Log.e(TAG, "onResponse: " + response.body().toString() );
       }
    @Override
    public void onFailure(Call call, Throwable t) {

                    }
});
  • baseurl 为你的服务器地址,(我这里在局域网)
  • file 文件为你手机中某个存在的文件

第二中API,我们只需要将相应第一种中的参数用map存起来,不多说了。

2.3 服务器接受文件

服务器接受文件的代码就简单多了,我这里以php为例

//var_dump($_POST);
//var_dump($_FILES);
$myfile = fopen("testfile.txt", "w");
fwrite($myfile, $_FILES["file"]["tmp_name"]."\n"
."D:\WWW"."\".$_FILES["file"]["name"]);
move_uploaded_file($_FILES["file"]["tmp_name"], "D:\WWW"."\".$_FILES["file"]["name"]);

> 上面这个代码就是将文件的文件名写入到textfile.txt文件中,并且将文件写在当前d:\www\目录下,文件名就是上传的文件名。
结果如下如:
![这里写图片描述](http://upload-images.jianshu.io/upload_images/1622644-a07ca9595c31c20c?imageMogr2/auto-orient/strip)

### 3. 文件下载及速度监听
Retrofit并没有给我们提供文件下载进度的相关信息,但是,我们还是可以从一些渠道知道如何监听下载进度,在OKHTTP的官方demo里面有一个Progress.java的文件,从名字上就知道与进度有关。[github地址](https://github.com/square/okhttp/blob/master/samples/guide/src/main/java/okhttp3/recipes/Progress.java)

#### 3.1 改造改造ResponseBody
okhttp3默认的responsebody是不能满足我们的要求的,(不能知道进度的相关信息),我们需要作出改造,首先需要个接口,监听进度信息。其次,好吧,我承认这是废话,我们只需要把Progress.java中我们需要的拿出来就好。
##### 3.1.1 interface

public interface ProgressListener {
/**
* @param progress 已经下载或上传字节数
* @param total 总字节数
* @param done 是否完成
*/
void onProgress(long progress, long total, boolean done);
}

##### 3.1.2 ProgressResponseBody

public class ProgressResponseBody extends ResponseBody {

private final ResponseBody responseBody;
private final ProgressListener listener;
private BufferedSource bufferedSource;

public ProgressResponseBody(ResponseBody responseBody,ProgressListener listener){
    this.responseBody = responseBody;
    this.listener = listener;
}
@Override
public MediaType contentType() {
    return responseBody.contentType();
}

@Override
public long contentLength() {
    return responseBody.contentLength();
}

@Override
public BufferedSource source() {
    if (null == bufferedSource){
        bufferedSource = Okio.buffer(source(responseBody.source()));
    }
    return bufferedSource;
}

private Source source(Source source) {
    return new ForwardingSource(source) {
        long totalBytesRead = 0L;

        @Override
        public long read(Buffer sink, long byteCount) throws IOException {
            long bytesRead = super.read(sink, byteCount);
            totalBytesRead += bytesRead != -1 ? bytesRead : 0;
            listener.onProgress(totalBytesRead, responseBody.contentLength(), bytesRead == -1);
            return bytesRead;
        }
    };
}

}

恩,就是这些东西,别为我okio的相关知识,我也正在学呢。这个文件就是ophttp3的官方demo里面的东西。
#### 3.2 使用自己的okhttpclient
我们需要通过OkHttpClient的拦截器去拦截Response,并将我们的ProgressReponseBody设置进去,这样才能监听进度。那么,我们怎么讲client设置进去呢。通过观察Retrofit的结构发现,Builder下面有client()方法可以设置,好,那么我们通过Retrofit.Builder来创建(这样我们可以配置了)。
![这里写图片描述](http://upload-images.jianshu.io/upload_images/1622644-550943bdced92e72?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
相关代码如下

Retrofit.Builder builder = new Retrofit.Builder()
.baseUrl("http://192.168.56.1");
OkHttpClient client = new OkHttpClient.Builder()
.addNetworkInterceptor(new Interceptor() {
@Override
public okhttp3.Response intercept(Chain chain) throws IOException {
okhttp3.Response orginalResponse = chain.proceed(chain.request());

                    return orginalResponse.newBuilder()
                            .body(new ProgressResponseBody(orginalResponse.body(), new ProgressListener() {
                                @Override
                                public void onProgress(long progress, long total, boolean done) {
                                    Log.e(TAG, Looper.myLooper()+"");
                                    Log.e(TAG, "onProgress: " + "total ---->" + total + "done ---->" + progress );
                                }
                            }))
                            .build();
                }
            })
            .build();
    DownLoadApi api = builder.client(client)
            .build().create(DownLoadApi.class);
** 注意进度的监听发生在子线程中,要切记**

#### 3.3 将response写入到文件里
写入的操作就简单了,代码如下,没什么好说的。

Call call = api.getFile("image_text.png");
call.enqueue(new Callback() {
@Override
public void onResponse(Call call, Response response) {
try {
InputStream is = response.body().byteStream();
File file = new File(Environment.getExternalStorageDirectory(), "text_img.png");
FileOutputStream fos = new FileOutputStream(file);
BufferedInputStream bis = new BufferedInputStream(is);
byte[] buffer = new byte[1024];
int len;
while ((len = bis.read(buffer)) != -1) {
fos.write(buffer, 0, len);
fos.flush();
}
fos.close();
bis.close();
is.close();
} catch (IOException e) {
e.printStackTrace();
}
Log.e(TAG,"success");
}

        @Override
        public void onFailure(Call call, Throwable t) {

        }
    });
** 注意image_text.png是我事先将这张图片放入到相应路径下面的,如图,要确定能访问到才行 **
![这里写图片描述](http://upload-images.jianshu.io/upload_images/1622644-1ca99b3b49abcb4f?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
#### 3.4 最后结果展示
![这里写图片描述](http://upload-images.jianshu.io/upload_images/1622644-1103ecc834be2c8f?imageMogr2/auto-orient/strip)

### 4. 总结
retrofit的功能强大,灵活性强,但是这就意味着使用起来稍微麻烦一点(至少我是这样认为的),但是,retrofit依赖于okhttp,okhttp是有demo供我们学习的,so,学习demo去吧,[链接地址](https://github.com/square/okhttp/tree/master/samples)

你可能感兴趣的:(Android 网络开源库-Retrofit(二) 单文件上传、下载及下载进度监听)