android Retrofit 2.0

最新推荐文章于 2024-05-12 23:55:08 发布
最新推荐文章于 2024-05-12 23:55:08 发布
阅读量420 收藏
点赞数
分类专栏： Android
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/chunxiaqiudong5/article/details/54587986
版权

一、介绍

主流网络请求库

Android-Async-Http：https://github.com/loopj/android-async-http

Volley ：https://github.com/stormzhang/AndroidVolley

OkHttp：https://github.com/square/okhttp

Retrofit：https://github.com/square/retrofit

 

比较：

 

 

 

二、GET方式请求网络


1、导如到项目

    implementation 'com.squareup.okhttp3:okhttp:3.10.0'
    implementation 'com.squareup.retrofit2:retrofit:2.0.2'
    implementation  'com.squareup.retrofit2:converter-gson:2.0.2'

2、添加网络访问权限

<uses-permission android:name="android.permission.INTERNET"/>

 

3、自定义用来接收服务器返回数据的Bean

package com.lht.liuhaitao;

public class UserBean {
    private String status;
    private Content content;
    private static class Content{
        private int id;
        private String name;
        private int age;

        public int getId() {
            return id;
        }

        public void setId(int id) {
            this.id = id;
        }

        public String getName() {
            return name;
        }

        public void setName(String name) {
            this.name = name;
        }

        public int getAge() {
            return age;
        }

        public void setAge(int age) {
            this.age = age;
        }

        @Override
        public String toString() {
            return "Content{" +
                    "id=" + id +
                    ", name='" + name + '\'' +
                    ", age=" + age +
                    '}';
        }
    }

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        this.status = status;
    }

    public Content getContent() {
        return content;
    }

    public void setContent(Content content) {
        this.content = content;
    }

    @Override
    public String toString() {
        return "UserBean{" +
                "status='" + status + '\'' +
                ", content=" + content +
                '}';
    }
}

4、定义接口

package com.lht.liuhaitao;

import retrofit2.Call;
import retrofit2.http.GET;

public interface IGetRequest {

    @GET("/test.php?id=1")
    Call<UserBean> getCall();
    // 注解里传入 网络请求 的部分URL地址
    // Retrofit把网络请求的URL分成了两部分：一部分放在Retrofit对象里，另一部分放在网络请求接口里
    // 如果接口里的url是一个完整的网址，那么放在Retrofit对象里的URL可以忽略
    // getCall()是接受网络请求数据的方法
}

5、处理返回数据

   @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        but=findViewById(R.id.but_ok);
        imageView=findViewById(R.id.pothoImg);
        but.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                request();
            }
        });
    }

    private void request(){
        Retrofit retrofit=new Retrofit.Builder()
                .baseUrl("http://xxx.xxx.xxx.xxx/") 设置 网络请求 Url
                .addConverterFactory(GsonConverterFactory.create())//设置使用Gson解析(记得加入依赖)
                .build();
        //创建 网络请求接口 的实例
        IGetRequest request=retrofit.create(IGetRequest.class);
        // //对 发送请求 进行封装
        Call<UserBean> call=request.getCall();
        //发送网络请求(异步)
        call.enqueue(new Callback<UserBean>() {
            @Override
            public void onResponse(Call<UserBean> call, Response<UserBean> response) {
                UserBean userBean=response.body();
                Log.e(TAG, "onResponse: "+userBean);
            }

            @Override
            public void onFailure(Call<UserBean> call, Throwable t) {
                Log.e(TAG, "onFailure: "+t.getMessage() );
            }
        });
    }

 

三、POST方式网络请求

1、定义接口

public interface IPostRequest {

    @POST("test.php")
    @FormUrlEncoded
    Call<UserBean> getCall(@Field("id") String targetSentence);
    //采用@Post表示Post方法进行请求（传入部分url地址）
    // 采用@FormUrlEncoded注解的原因:API规定采用请求格式x-www-form-urlencoded,即表单形式
    // 需要配合@Field 向服务器提交需要的字段,服务器端用POST可以接收id的值
}

2、定义bean

package com.lht.liuhaitao;

public class UserBean {
    private String status;
    private Content content;
    private static class Content{
        private int id;
        private String name;
        private int age;

        public int getId() {
            return id;
        }

        public void setId(int id) {
            this.id = id;
        }

        public String getName() {
            return name;
        }

        public void setName(String name) {
            this.name = name;
        }

        public int getAge() {
            return age;
        }

        public void setAge(int age) {
            this.age = age;
        }

        @Override
        public String toString() {
            return "Content{" +
                    "id=" + id +
                    ", name='" + name + '\'' +
                    ", age=" + age +
                    '}';
        }
    }

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        this.status = status;
    }

    public Content getContent() {
        return content;
    }

    public void setContent(Content content) {
        this.content = content;
    }

    @Override
    public String toString() {
        return "UserBean{" +
                "status='" + status + '\'' +
                ", content=" + content +
                '}';
    }
}

3、

   private void request(){
        Retrofit retrofit=new Retrofit.Builder()
                .baseUrl("http://xxx.xxx.xxx.xxx/") 设置 网络请求 Url
                .addConverterFactory(GsonConverterFactory.create())//设置使用Gson解析(记得加入依赖)
                .build();
        //创建 网络请求接口 的实例
        IPostRequest request=retrofit.create(IPostRequest.class);
        // //对 发送请求 进行封装
        Call<UserBean> call=request.getCall("hello");
        //发送网络请求(异步)
        call.enqueue(new Callback<UserBean>() {
            @Override
            public void onResponse(Call<UserBean> call, Response<UserBean> response) {
                UserBean userBean=response.body();
                Log.e(TAG, "onResponse: "+userBean);
            }

            @Override
            public void onFailure(Call<UserBean> call, Throwable t) {
                Log.e(TAG, "onFailure: "+t.getMessage() );
            }
        });
    }

 

三、常用得到参数

1、注解类型

 

2、注解说明

（1）第一类：网络请求方法

详细说明： 
a. @GET、@POST、@PUT、@DELETE、@HEAD 
以上方法分别对应 HTTP中的网络请求方式

网络请求的完整 Url =在创建Retrofit实例时通过.baseUrl()设置 +网络请求接口的注解设置（下面称 “path“ ）

建议采用第三种方式来配置，并尽量使用同一种路径形式。

@HTTP

  • 作用：替换@GET、@POST、@PUT、@DELETE、@HEAD注解的作用 及 更多功能拓展
  • 具体使用：通过属性method、path、hasBody进行设置
public interface GetRequest_Interface {
    /**
     * method：网络请求的方法（区分大小写）
     * path：网络请求地址路径
     * hasBody：是否有请求体
     */
    @HTTP(method = "GET", path = "blog/{id}", hasBody = false)
    Call<ResponseBody> getCall(@Path("id") int id);
    // {id} 表示是一个变量
    // method 的值 retrofit 不会做处理，所以要自行保证准确
}

 

3、标记

@FormUrlEncoded：

  • 作用：表示发送form-encoded的数据

每个键值对需要用@Filed来注解键名，随后的对象需要提供值。

b. @Multipart

  •  
  • 作用：表示发送form-encoded的数据（适用于 有文件 上传的场景） 

每个键值对需要用@Part来注解键名，随后的对象需要提供值。 
具体使用如下： 
GetRequest_Interface

public interface GetRequest_Interface {
        /**
         *表明是一个表单格式的请求（Content-Type:application/x-www-form-urlencoded）
         * <code>Field("username")</code> 表示将后面的 <code>String name</code> 中name的取值作为 username 的值
         */
        @POST("/form")
        @FormUrlEncoded
        Call<ResponseBody> testFormUrlEncoded1(@Field("username") String name, @Field("age") int age);

        /**
         * {@link Part} 后面支持三种类型，{@link RequestBody}、{@link okhttp3.MultipartBody.Part} 、任意类型
         * 除 {@link okhttp3.MultipartBody.Part} 以外，其它类型都必须带上表单字段({@link okhttp3.MultipartBody.Part} 中已经包含了表单字段的信息)，
         */
        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload1(@Part("name") RequestBody name, @Part("age") RequestBody age, @Part MultipartBody.Part file);

}

// 具体使用
       GetRequest_Interface service = retrofit.create(GetRequest_Interface.class);
        // @FormUrlEncoded 
        Call<ResponseBody> call1 = service.testFormUrlEncoded1("Carson", 24);

        //  @Multipart
        RequestBody name = RequestBody.create(textType, "Carson");
        RequestBody age = RequestBody.create(textType, "24");

        MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", "test.txt", file);
        Call<ResponseBody> call3 = service.testFileUpload1(name, age, filePart);

 

4、网络请求参数

 

a. @Header & @Headers

  • 作用：添加请求头 &添加不固定的请求头
  • // @Header
@GET("user")
Call<User> getUser(@Header("Authorization") String authorization)

// @Headers
@Headers("Authorization: authorization")
@GET("user")
Call<User> getUser()

// 以上的效果是一致的。
// 区别在于使用场景和使用方式
// 1. 使用场景：@Header用于添加不固定的请求头，@Headers用于添加固定的请求头
// 2. 使用方式：@Header作用于方法的参数；@Headers作用于方法

    b. @Body

  • 作用：以 Post方式 传递 自定义数据类型 给服务器
  • 特别注意：如果提交的是一个Map，那么作用相当于 @Field 

不过Map要经过 FormBody.Builder 类处理成为符合 Okhttp 格式的表单，如：

FormBody.Builder builder = new FormBody.Builder();
builder.add("key","value");

c. @Field & @FieldMap

  • 作用：发送 Post请求 时提交请求的表单字段
  • 具体使用：与 @FormUrlEncoded 注解配合使用
public interface GetRequest_Interface {
        /**
         *表明是一个表单格式的请求（Content-Type:application/x-www-form-urlencoded）
         * <code>Field("username")</code> 表示将后面的 <code>String name</code> 中name的取值作为 username 的值
         */
        @POST("/form")
        @FormUrlEncoded
        Call<ResponseBody> testFormUrlEncoded1(@Field("username") String name, @Field("age") int age);

/**
         * Map的key作为表单的键
         */
        @POST("/form")
        @FormUrlEncoded
        Call<ResponseBody> testFormUrlEncoded2(@FieldMap Map<String, Object> map);

}

// 具体使用
         // @Field
        Call<ResponseBody> call1 = service.testFormUrlEncoded1("Carson", 24);

        // @FieldMap
        // 实现的效果与上面相同，但要传入Map
        Map<String, Object> map = new HashMap<>();
        map.put("username", "Carson");
        map.put("age", 24);
        Call<ResponseBody> call2 = service.testFormUrlEncoded2(map);

d. @Part & @PartMap

  • 作用：发送 Post请求 时提交请求的表单字段

    与@Field的区别：功能相同，但携带的参数类型更加丰富，包括数据流，所以适用于 有文件上传 的场景

  • 具体使用：与 @Multipart 注解配合使用

public interface GetRequest_Interface {

          /**
         * {@link Part} 后面支持三种类型，{@link RequestBody}、{@link okhttp3.MultipartBody.Part} 、任意类型
         * 除 {@link okhttp3.MultipartBody.Part} 以外，其它类型都必须带上表单字段({@link okhttp3.MultipartBody.Part} 中已经包含了表单字段的信息)，
         */
        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload1(@Part("name") RequestBody name, @Part("age") RequestBody age, @Part MultipartBody.Part file);

        /**
         * PartMap 注解支持一个Map作为参数，支持 {@link RequestBody } 类型，
         * 如果有其它的类型，会被{@link retrofit2.Converter}转换，如后面会介绍的 使用{@link com.google.gson.Gson} 的 {@link retrofit2.converter.gson.GsonRequestBodyConverter}
         * 所以{@link MultipartBody.Part} 就不适用了,所以文件只能用<b> @Part MultipartBody.Part </b>
         */
        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload2(@PartMap Map<String, RequestBody> args, @Part MultipartBody.Part file);

        @POST("/form")
        @Multipart
        Call<ResponseBody> testFileUpload3(@PartMap Map<String, RequestBody> args);
}

// 具体使用
 MediaType textType = MediaType.parse("text/plain");
        RequestBody name = RequestBody.create(textType, "Carson");
        RequestBody age = RequestBody.create(textType, "24");
        RequestBody file = RequestBody.create(MediaType.parse("application/octet-stream"), "这里是模拟文件的内容");

        // @Part
        MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", "test.txt", file);
        Call<ResponseBody> call3 = service.testFileUpload1(name, age, filePart);
        ResponseBodyPrinter.printResponseBody(call3);

        // @PartMap
        // 实现和上面同样的效果
        Map<String, RequestBody> fileUpload2Args = new HashMap<>();
        fileUpload2Args.put("name", name);
        fileUpload2Args.put("age", age);
        //这里并不会被当成文件，因为没有文件名(包含在Content-Disposition请求头中)，但上面的 filePart 有
        //fileUpload2Args.put("file", file);
        Call<ResponseBody> call4 = service.testFileUpload2(fileUpload2Args, filePart); //单独处理文件
        ResponseBodyPrinter.printResponseBody(call4);
}

e. @Query和@QueryMap

  • 具体使用：配置时只需要在接口方法中增加一个参数即可：

   @GET("/")    
   Call<String> cate(@Query("cate") String cate);
}

// 其使用方式同 @Field与@FieldMap，这里不作过多描述

f. @Path

  • 作用：URL地址的缺省值
  • 具体使用：
public interface GetRequest_Interface {

        @GET("users/{user}/repos")
        Call<ResponseBody>  getBlog（@Path("user") String user ）;
        // 访问的API是：https://api.github.com/users/{user}/repos
        // 在发起请求时， {user} 会被替换为方法的第一个参数 user（被@Path注解作用）
    }

g. @Url

  • 作用：直接传入一个请求的 URL变量 用于URL设置
  • 具体使用：
public interface GetRequest_Interface {

        @GET
        Call<ResponseBody> testUrlAndQuery(@Url String url, @Query("showAll") boolean showAll);
       // 当有URL注解时，@GET传入的URL就可以省略
       // 当GET、POST...HTTP等方法中没有设置Url时，则必须使用 {@link Url}提供

}

汇总

 

四、 Retrofit 的拓展使用

Retrofit的使用场景非常丰富，如支持RxJava和Prototocobuff
具体设置也非常简单 & 方便：
<-- 主要在创建Retrofit对象中设置 -->

Retrofit retrofit = new Retrofit.Builder()
  .baseUrl(""http://fanyi.youdao.com/"")
  .addConverterFactory(ProtoConverterFactory.create()) // 支持Prototocobuff解析
  .addConverterFactory(GsonConverterFactory.create()) // 支持Gson解析
  .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 支持RxJava
  .build();

 

很棒  https://blog.csdn.net/carson_ho/article/details/73732076

快乐de馒头
关注
专栏目录
jQuery cdn加速
洪君的博客
12-29 2450
jquery-1.11.0.min.js cdn jQuery <script src="http://libs.baidu.com/jquery/2.0.0/jquery.min.js"></script> 百度CDN 支持版本：2.0.3, 2.0.2, 2.0.1, 2.0.0,1.11.1, 1.10.2, 1.10.1, 1.10.0, 1.9.1, 1.9.0, 1.8.3, 1.8.2, 1.8.1, 1.8.0, 1.7.2, 1.7.1, 1.7.0.
JQueryCDN
MengSs23的博客
02-13 8037
Jquery CDN 如果您不希望下载并存放 jQuery，那么也可以通过 CDN（内容分发网络） 引用它。 Staticfile CDN、百度、又拍云、新浪、谷歌和微软的服务器都存有 jQuery 。 如果你的站点用户是国内的，建议使用百度、又拍云、新浪等国内CDN地址，如果你站点用户是国外的可以使用谷歌和微软。 如需从 Staticfile CDN、又拍云、新浪、谷歌或微软引用 jQuery，请使用以下代码之一： Staticfile CDN: <head> <script .
jQuery引入及下载方法
AZURE060606的博客
02-27 2004
欢迎进入jQuery世界</p>""<p>欢迎进入jQuery世界
哪些是流行的jQuery CDN？
RJ_0517b的博客
11-26 594
有3个流行的jQuery CDN：谷歌，微软、jQuery。
介绍几种利用 CDN在线导入jQuery的方法
亡月杂货铺
11-12 9038
1. 新浪CDN（个人推荐） 一直都比较好使 &lt;script src="http://lib.sinaapp.com/js/jquery/2.0.2/jquery-2.0.2.min.js"&gt; &lt;/script&gt; 2.Baidu CDN： 有时候不好使 &lt;head&gt; &lt;script src="http://libs.baidu.com/jquer...
Android Retrofit 2.0框架上传图片解决方案
01-04
本文为大家分享了 Android Retrofit 2.0框架上传图片解决方案，具体内容如下 1.单张图片的上传 /** * 上传一张图片 * @param description * @param imgs * @return */ @Multipart @POST(/upload) Call...
Android中Retrofit2.0的使用Demo
04-02
在Android应用开发中，网络请求是必不可少的一部分，而Retrofit2.0则是一个非常流行的、由Square公司开发的网络请求库。它通过简洁的接口设计，使得网络调用变得直观且易于管理。在这个Demo中，开发者展示了如何集成...
Retrofit2.0 Demo
04-23
在Android开发中，Retrofit2.0是一款非常流行的网络请求库，它由Square公司开发，设计简洁、易于使用，能够方便地将网络接口转换为Java接口。本项目"Retrofit2.0 Demo"是一个实际应用示例，结合了Okhttp作为网络底层...
Android使用Retrofit2.0技术仿微信发说说
08-31
首先，要集成Retrofit2.0到Android项目中，你需要在build.gradle文件中添加依赖项，并同步项目。Retrofit2.0提供了基于注解的API，使得接口定义清晰，易于理解和使用。通过创建一个Retrofit实例，你可以配置基础URL...
速盾：jquery是用cdn快，还是保存本地快？
最新发布
zhuguowang01的博客
05-12 504
当我们使用CDN加载jQuery时，浏览器会先从离用户最近的CDN服务器获取资源，而不是从我们自己的服务器获取。这样做的好处是，CDN服务器通常具有更快的响应速度，这可以加快资源加载的速度。其次，如果我们的网站在国内，而CDN服务器在国外，那么访问CDN服务器会受到网络延迟的影响，从而影响了网页的加载速度。另外一个使用CDN的好处是，当用户访问不同的网站时，可能多个网站都使用了相同的CDN，这样在访问不同网站时，浏览器已经缓存了CDN资源，所以不需要再次下载，从而提升了网页的加载速度。
JQuery之CDN
lamwolf的博客
01-05 2041
众所周知，JQUERY是对Javascript的封装。而我们在网页中添加JQUERY时，除了可以从jquery.com下载jQuery库，这种方式虽然是比较好，但是有一种更好的方法，那就是CDN，什么是CDN呢？CDN称内容分发网络。这是什么意思呢？其实是在各大有名公司的服务器内都有jQuery，我们只要引用他们的网址即可。 Staticfile CDN、百度、又拍云、新浪、谷歌和微软...
速盾：jquery可以用cdn加速吗？
zhuguowang01的博客
04-16 428
通过使用CDN，可以将jQuery的文件缓存在全球各地的服务器上，无论用户从哪个地方访问网站，都可以很快地获取到jQuery的文件，从而提高网站的加载速度。CDN（Content Delivery Network）是一种优化网络传输的技术，通过将网站的相关静态资源缓存到全球各地的服务器节点上，可以加速网站的访问速度。首先，CDN的工作原理是将网站的静态资源缓存到离用户最近的服务器节点上。当有大量用户同时访问网站时，CDN可以根据用户的地理位置和当前服务器的负载情况，将请求分发到最适合的服务器上。
jQuery CDN
aoer4943的博客
10-29 275
jQuery CDN MS&Baidu PS：jQuery-2.0 以上版本不再支持IE 6/7/8 REF: https://www.sojson.com/jquery/down.html 经多次测试，建议使用百度的CDN引用地址，官网的地址有可能造成部分地区打开略有延迟 Baidu Version 2.1.4 2.1.1 2.0.0 1.11.3 1.11.1 1.1...
如何从CDN加载jQuery
RJ_0517b的博客
11-11 582
从jQuery站点加载jQuery Framework的代码（EdgeCast CDN） <script type="text/javascript" src="http://code.jquery.com/jquery-3.6.0.min.js"> </script>
jquery的CDN
diancui3160的博客
07-24 151
1.菜鸟教程CDN <head> <script src="http://cdn.static.runoob.com/libs/jquery/1.10.2/jquery.min.js"> </script> </head> 2.百度CDN <head> <script src="https://a...
jquery cdn
IT民工的博客
08-12 1604
Jquery是个非常流行的JS前端框架，在很多网站都能看到它的身影。很多网站都喜欢采用一些Jquery CDN加速服务，这样网站加载jquery会更快。之前火端网络的一些网站都是使用Google的jquery CDN，如：http://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js ，但是由于最近Google打不开，这些CDN地址也无
通过 CDN 引入 jQuery 的几种方式
热门推荐
大三了啊
07-14 1万+
大家好我是冈坂日川，今天由于某些原因，本来要继续学习 vuejs 开发，结果只能卡壳，倒回来学习 jQuery 和 ajax，所以教一下各位小白，如何使用 cdn 引入 jQuery 。 使用 CDN 引入 jQuery 的几种方式 1. 百度 CDN <head> <script src="https://apps.bdimg.com/libs/jquery/2.1.4/jquery.min.js"></script> </head> 1. G.
JQuery CDN
MakChiKin
07-04 2769
下载：https://code.jquery.com/ 1.X:兼容IE678,使用最为广泛，官网只做BUG维护，功能不再新增。因此一般项目来说，使用1.X版本就可以了，最终版本：1.12.4 2.X不兼容ie678，很少有人使用，官方只做BUG维护，功能不再新增。如果不考虑兼容低版本的浏览器可以使用2.x，最终版本：2.2.4 3.X不兼容ie678，只支持最新的浏...
JQuery CDN大全
hld_hepeng的专栏
07-05 9284
使用CDN的好处很明显，就是速度快，比如Google提供的CDN，在全球有无数节点，比我们自己的服务器一般要快很多，另外用这些CDN我们就不用在保存一份文件了，还可以永远使用最新的版本。这里列举了几家稳定的，速度快的CDN供大家选择。 1. Google CDN http://ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js G
Android Retrofit2.0 实现微信风格说说上传
本文将详细介绍如何在Android应用中利用Retrofit2.0技术来实现一个类似微信的发说说功能，包括拍照、图库选择以及多图片上传。首先，Retrofit2.0是基于Java的网络请求库，它简化了与RESTful API的交互，使开发者能够...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值