二、RESTFUL网路请求框Retrofit

Retrofit是一个高质量高效率的HTTP请求库。Retrofit内部依赖于OkHttp&＃xff0c;它将OKHttp底层的代码和细节都封装了起来&＃xff0c;功能上做了更多的扩展,比如返回结果的自动解析数据模型&＃xff0c;网络引擎的切换&＃xff0c;拦截器…

restFul是符合rest架构风格的网络API接口,完全承认Http是用于标识资源。restFul URL是面向资源的&＃xff0c;可以唯一标识和定位资源。 对于该URL标识的资源做何种操作是由Http方法决定的。

rest请求方法有4种&＃xff0c;包括get,post,put,delete.分别对应获取资源&＃xff0c;添加资源&＃xff0c;更新资源及删除资源.

作者&＃xff1a;埋着头向前走寻找我自己
链接&＃xff1a;https://www.jianshu.com/p/dfe3077ddbcd
来源&＃xff1a;简书
著作权归作者所有。商业转载请联系作者获得授权&＃xff0c;非商业转载请注明出处。

1. 注解

retrofit注解驱动型上层网络请求框架&＃xff0c;使用注解来简化请求&＃xff0c;大体分为以下几类&＃xff1a;

• 用于标注网络请求方式的注解
• 标记网络请求参数的注解
• 用于标记网络请求和响应格式的注解

图片和部分文字转自https://www.songyubao.com/book/primary/network/Retrofit.html

1.1请求方法注解

1.2 请求头注解

既可以标记在方法上面也可以标记在参数里面

1.3请求参数注解

1.4请求和响应格式注解

2 开始使用

step1: 添加依赖

app/build.gradle

implementation &＃39;com.squareup.retrofit2:retrofit:2.3.0&＃39;
implementation &＃39;com.squareup.retrofit2:converter-gson:2.3.0&＃39; //json转换


step2: 初始化

object FirstRetrofit {//OkHttpClient 对象private val okClient:OkHttpClient &＃61; OkHttpClient.Builder() //builder构建者设计模式.connectTimeout(10,TimeUnit.SECONDS) //连接超时时间.readTimeout(10,TimeUnit.SECONDS) //读取超时.writeTimeout(10,TimeUnit.SECONDS) //写超时.addInterceptor(LoggingInterceptor()) //拦截器.build()//初始化private val retrofit:Retrofit &＃61; Retrofit.Builder().client(okClient) //配置OkHttp网络请求框架的对象.baseUrl("http://123.56.232.18:8080/serverdemo/") //网络请求的域名.addConverterFactory(GsonConverterFactory.create()) //数据转换适配器.build()//发起网络请求//public T create(final Class service) java类型fun <T> create(clazz: Class<T>):T{return retrofit.create(clazz)}
}//网络请求接口
interface ApiService{//&＃64;Query 的 encoded发起网络请求是要不要对接口进行编码(防止中文乱码)//&＃64;Query(value &＃61; "userId", encoded &＃61; true) 是用来修饰 userId:String&＃64;GET(value &＃61; "user/query")fun queryUser(&＃64;Query(value &＃61; "userId", encoded &＃61; true) userId:String):Call<UserResponse>
}


step3:调用

异步用enqueue()&＃xff0c;同步用execute()

val apiService &＃61; FirstRetrofit.create(ApiService::class.java)apiService.queryUser("1600933269").enqueue(object :Callback<UserResponse>{override fun onResponse(call: Call<UserResponse>, response: Response<UserResponse>) {Log.e("Retrofit",response.body()?.toString()?:"response is null")}override fun onFailure(call: Call<UserResponse>, t: Throwable) {Log.e("Retrofit",t.message?:"unknown reason")}})


Tips:

onResponse 和 onFailure 的回调都是在主线程里面
可以直接操控UI控件

请求方法定义

//网络请求接口
interface ApiService{//&＃64;Query 的 encoded发起网络请求是要不要对接口进行编码(防止中文乱码)//&＃64;Query(value &＃61; "userId", encoded &＃61; true) 是用来修饰 userId:String&＃64;GET(value &＃61; "user/query")fun queryUser(&＃64;Query(value &＃61; "userId", encoded &＃61; true) userId:String):Call<UserResponse>//使用&＃64;Headers添加多个请求头&＃64;Headers("User-Agent:android", "apikey:123456789")&＃64;GET(value &＃61; "user/query")fun queryUser1(&＃64;Query(value &＃61; "userId" , encoded &＃61; true) userId: String):Call<UserResponse>//多个参数的情况下可以使用&＃64;QueryMap&＃xff0c;但只能用在GET请求上&＃64;GET(value &＃61; "user/query")fun queryUser2(&＃64;QueryMap(encoded &＃61; true) queryMap: Map<String?, String?>):Call<UserResponse>/*** 很多情况下&＃xff0c;我们需要上传json格式的数据。当我们注册新用户的时候&＃xff0c;因为用户注册时的数据相对较多* 并可能以后会变化&＃xff0c;这时候&＃xff0c;服务端可能要求我们上传json格式的数据。此时就要&＃64;Body注解来实现。* 直接传入实体,它会自行转化成Json, &＃64;Body只能用在POST请求上** 字符串提交*/&＃64;POST("user/update")fun userUpdate(&＃64;Body post: User):Call<UserResponse>/*** 表单提交&＃xff08;键值对提交&＃xff09;* 多用于post请求中表单字段,Filed和FieldMap需要FormUrlEncoded结合使用*/&＃64;POST()&＃64;FormUrlEncodedfun executePost(&＃64;FieldMap map:Map<String , User>):Call<UserResponse>/*** 表单上传文件&＃xff08;键值对提交、同时上传文件&＃xff09;*/&＃64;Multipart&＃64;FormUrlEncoded&＃64;POST("upload/upload")fun register(&＃64;Field("openId") openId:String,&＃64;PartMap map:Map<String? , MultipartBody.Part>):Call<UserResponse>}