工作生活

Kotlin使用Retrofit调用后台接口(以登录为例)

2019-06-29  本文已影响0人  丁功春

1、创建进行网络请求的接口

interface Api {
    @POST("api/login")
    fun login(@Body request: LoginRequest): MyCall<LoginToken>
//返回值是Retrofit网络请求回来json数据,经过Gson转换以后的对象
//@Body会把参数放到请求体中,适用于POST请求。
}

POST注解
Retrofit在创建的时候,有一行代码:

.baseUrl(baseUrl)

这个baseUrl是我们要访问的接口的baseUrl,而我们现在用POST注解的字符串 "api/login"会追加到baseUrl后面,通过去调用这个接口得到返回数据。
2、创建Retrofit对象

class WebService private constructor() {
    companion object {
        var api: Api? = null
            get() {
                if (field == null) {
                    field = createApi(Api.BASE_URL)
                }
                return field
            }

        fun get(): Api {
            return api!!
        }

        private fun createApi(baseUrl: String): Api {
            val retrofit = Retrofit.Builder()
                    .client(createHttpClient())
                    .baseUrl(baseUrl)//设置网络请求的Url地址
                    .addConverterFactory(GsonConverterFactory.create())//设置数据解析器,使得来自接口的json结果会自动解析成定义好了的字段和类型都相符的json对象接受类
                    .addCallAdapterFactory(MyCallAdapterFactory())//想把返回值定义为Observable对象
                    .build()
            // 返回网络请求接口的实例
            return retrofit.create(Api::class.java)
        }
}

这里通过调用 WebService.get()的方式就可以获得Retrofit对象

3、发送网络请求

fun login(userName: String, password: String): LiveData<NetworkResource<LoginToken>> {
        val result = MutableLiveData<NetworkResource<LoginToken>>()//LiveData的子类,可进行setValue、postValue操作
        val request = LoginRequest()
        request.username = userName
        request.pwd = password
        WebService.get().login(request).enqueue(object : ApiCallback<LoginToken> {//创建网络请求接口的实例并对发送请求进行封装,然后enqueue发送网络请求
            //enqueue()非异步方式,会阻塞线程,等待返回结果。
            override fun onSuccess(response: LoginToken) {//成功时返回LoginTakon对象
                App.get().saveUserToken(response.token!!)//这句后面专门讲
                result.postValue(NetworkResource.success(response))//成功后返回的LoginToken的对象respose,放入MutableLiveData对象result中
            }

            override fun onError(error: HError) {
                result.postValue(NetworkResource.error(error, null))
            }
        })
        return result
    }

第三行的LoginRequest类:

class LoginRequest {
    var username: String? = null
    var pwd: String? = null
}

先从WebService那行开始讲,这里对Callback进行了一个封装
ApiCallback:

interface ApiCallback<T> {
    fun onSuccess(response: T)
    fun onError(error: HError)
}

object:Apicallback{.......}是个对象表达式,相当于java里new的一个匿名类
重写Apicallback<LoginToken>里的两个函数

4、LiveData与ViewModel的组合使用

LiveData:数据变化时会收到通知。
ViewModel:管理UI的数据

利用这一点,使UserViewModel的login函数的返回值为LiveData对象,当他的数据变化时,LoginActivity的“观察者”会观测到并触发相应的事件处理。

 if (userViewModel == null) {//为空创建UserViewModel对象,返回值是LiveData<LoginToken>对象
      userViewModel = ViewModelProviders.of(this).get(UserViewModel::class.java)
      //of(this),这里this代表LoginActivity,表示生命周期就以LoginActivity作为参照对象了。
      //get(UserViewModel::class.java),表示与UserViewModel关联
 }
 showLoadingDialog()//显示加载框
 userViewModel!!.login(name, pwd).observe(this, Observer { resource ->
//观测者发现LiveData对象发生变化时
 closeLoadingDialog()//关闭加载框
 if (resource!!.isSuccess) {
    startActivity(MainActivity::class.java)
    App.get().uploadFireBaseMsgToken()
    finish()
 } else {
    val msg = resources.getString(R.string.login_fail)
    Toaster.shortToast(msg!!)
 }

5、回到第3中

override fun onSuccess(response: LoginToken) {//成功时返回LoginTakon对象
      App.get().saveUserToken(response.token!!)
      result.postValue(NetworkResource.success(response))//成功后返回的LoginToken的对象respose,放入MutableLiveData对象result中
 }

App.get().saveUserToken(response.token!!)这行代码一看就知道是客户端存储了一个东西——服务端返回的LoginToken对象第token变量。
这里看一下LoginToken里面有什么

class LoginToken : BaseResponse() {
    var token: String? = null
}

LoginToken继承自BaseResponse,BaseResponse是自己定义的一个类,用于判断是否操作成功,错误类型...
可以看到LoginToken里面定义了一个变量token
那客户端为什么要存储服务端返回的这个token变量呢,这个token变量又是什么?

user_token的职责是保护用户的用户名及密码多次提交,以防密码泄露。
如果接口需要用户登录,其访问流程如下:
1、用户提交“用户名”和“密码”,实现登录
2、登录成功后,服务端返回一个user_token,生成规则参考如下:
user_token = md5('用户的uid' + 'Unix时间戳') = etye0fgkgk4ca2ttdsl0ae9a5dd77471fgf

总结:
服务端生成user_token后,返回给客户端(自己存储),这里的
App.get().saveUserToken(response.token!!)
就是将服务端生成的user_token存储到客户端,客户端每次接口请求时,如果接口需要用户登录才能访问,则需要把 user_id与user_token传回给服务端。

上一篇 下一篇

猜你喜欢

热点阅读