淺談Android客戶端與服務(wù)器的數(shù)據(jù)交互總結(jié)

更新時間：2019年09月01日 15:12:10 作者：小羊子說

這篇文章主要介紹了淺談Android客戶端與服務(wù)器的數(shù)據(jù)交互總結(jié)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

前言：

本文總結(jié)了Android客戶端與服務(wù)器進行交互時，采用RESTful API +Json的交互方式，針對不同的數(shù)據(jù)形式以及不同的解析方法，如有不足之處，歡迎指正。

溫馨提示：本文適合有一定Android開發(fā)經(jīng)驗的人閱讀，如有疑問，歡迎留言討論。

先了解一下相關(guān)的基本概念。

1. Android客戶端與服務(wù)器端通信方式

通信方式主要有HTTP和Socket。

HTTP通信：即使用HTTP協(xié)議進行通信，工作原理是客戶端向服務(wù)器端發(fā)送一條HTTP請求，服務(wù)器收到之后先解析客戶端的請求，之后會返回數(shù)據(jù)給客戶端，然后客戶端再對這些數(shù)據(jù)進行解析和處理。HTTP連接采取的是“請求—響應(yīng)”方式，即在請求時建立連接通道，當客戶端像服務(wù)器端發(fā)送請求時，服務(wù)器端才能向客戶端發(fā)送數(shù)據(jù)。

Socket通信：Socket又稱套接字，在程序內(nèi)部提供了與外界通信的端口，即端口通信。通過建立socket連接，可為通信雙方的數(shù)據(jù)傳輸傳提供通道。Socket的主要特點有數(shù)據(jù)丟失率低，使用簡單且易于移植。Socket類似于peer to peer的連接，一方可隨時向另一方喊話。

小結(jié)：HTTP和Socket都是基于TCP協(xié)議的。使用兩種通信方式的情況是：

1.使用HTTP的情況：雙方不需要時刻保持連接在線，比如客戶端資源的獲取、文件上傳等。

2.使用UDP的情況：大部分即時通訊應(yīng)用(QQ、微信)、聊天室、蘋果APNs等。

2. Android客戶端與服務(wù)器的數(shù)據(jù)交互方式

主要有三種：

數(shù)據(jù)流

從web服務(wù)器響應(yīng)到手機終端的數(shù)據(jù) 一般打包在一個字節(jié)數(shù)組中，這個字節(jié)數(shù)據(jù)中包含了不同的數(shù)據(jù)類型，客端端采取Java數(shù)據(jù)流和過慮流的方式從字節(jié)數(shù)組中取出各種類型的數(shù)據(jù)。

這種交互方式我在學習Android之初用過，實際項目中并沒有發(fā)現(xiàn)哪家公司在用。這種方式了擴展了Android平臺在訪問Web服務(wù)器進行交互時的解析數(shù)據(jù)能力，僅供研究學習。

Webservice的標準數(shù)據(jù)格式。

Protocol Buffers

Protocol Buffers 是一種輕便高效的結(jié)構(gòu)化數(shù)據(jù)存儲格式，支持跨平臺。它很適合做數(shù)據(jù)存儲或 RPC 數(shù)據(jù)交換格式。比 JSON 最大的優(yōu)點就是傳輸?shù)臅r候數(shù)據(jù)體積可以壓縮很小，傳輸效率比較高。本人在這個在項目中沒有用到過。

JSON

JSON(JavaScript Object Notation) 是一種輕量級的數(shù)據(jù)交換格式。易于人閱讀和編寫。同時也易于機器解析和生成。毫無疑問，大家最常用。

本文重點會介紹關(guān)于json數(shù)據(jù)格式的常用格式。

json數(shù)據(jù)格式的采用，根據(jù)業(yè)務(wù)情況，一般是團隊中的共識。技術(shù)的迭代更新，到后期基本都會考慮多個平臺的通用性、可移植性和可讀性。比如我們開發(fā)團隊，有移動端開發(fā)（Android、iOS)、前端開發(fā)（H5開發(fā)）和后臺開發(fā)（golang開發(fā)）。

關(guān)于服務(wù)器的開發(fā)規(guī)范，我們先來了解一下。

服務(wù)器開發(fā)規(guī)范我們采用的是 RESTful，RESTful是目前最流流行的 API設(shè)計規(guī)范，用于web數(shù)據(jù)接口的設(shè)計。

3. 為什么要使⽤RESTful API

⾯面向資源（URI），具有解釋性；
行為（GET / POST / PUT / PATCH / DELETE）與資源（URI）分離，更更加輕量量；
數(shù)據(jù)描述簡單，使⽤用JSON、XML、Protocol Buffers即可全覆蓋，主要使用JSON；

它的核心原則是定義用少量方法就能操作的命名資源。資源和方法可視為API的名詞和動詞。

4. http請求方式

GET ：讀?。≧ead）
POST ：新建（Create）
PUT ：更新（Update），通常是全部更更新
PATCH ：更新（Update），通常是部分更更新
DELETE ：刪除（Delete）

項目搭建之始，客戶端和服務(wù)器一般用 Get 和Post的方式來交互，隨著業(yè)務(wù)的演進和技術(shù)的規(guī)范迭代，到后期我們都得按規(guī)范來。于是我們采用了上述幾種方式來設(shè)計服務(wù)器接口，相應(yīng)地，移動端的請求方式也得與之對應(yīng)。

至此，不在贅述RESTful API的設(shè)計規(guī)范，可自行百度了解更多。

5. Json交互數(shù)據(jù)類型實際中的運用

接口的數(shù)據(jù)一般都采用JSON格式進行傳輸，不過，需要注意的是，JSON的值只有六種數(shù)據(jù)類型：

Number：整數(shù)或浮點數(shù)
String：字符串
Boolean：true 或 false
Array：數(shù)組包含在方括號[]中
Object：對象包含在大括號{}中
Null：空類型

傳輸?shù)臄?shù)據(jù)類型不能超過這六種數(shù)據(jù)類型,不能用Date數(shù)據(jù)類型，不同的解析庫解析方式不同，可能會導(dǎo)致異常，如果遇到日期的數(shù)據(jù)，最好的方式就是使用毫秒數(shù)表示日期。

5.1 String的數(shù)據(jù)類型

使用場景：如用戶退出登錄時，只需要得到返回狀態(tài)和提示信息即可，不需要返回任何數(shù)據(jù)。

 {
   "code": 1000,
   "message": "成功"
  }

數(shù)據(jù)解析工具類：

abstract class BaseStringCallback: BaseCallback() {

  override fun onSuccess(data: String) {
    val responseData = JSONObject(data)
    val code = responseData.getInt("code")
    val message = responseData.getString("message")

    if (code == 1000) {
      success(message)
    } else {
      //其他狀態(tài)
    }
  }

  abstract fun success(msg: String)
}

調(diào)用時（偽代碼）：

LogoutApi.execute(object : BaseStringCallback() {
          override fun success(msg: String) {
   //處理數(shù)據(jù)
          }）

5.2 Object數(shù)據(jù)類型

識別標示為：{}

使用場景：如獲取當前用戶信息，返回owner實體類，這個類我們可以直接用Gson的工具類轉(zhuǎn)換為owner實體類。

{
   "code": 1000,
   "message": "成功",
   "resp": {
    "owner": {
     "id": 58180,
     "name": "張三",
     "idCert": "",
     "certType": 1,
     "modifier": "jun5753",
     "updateTime": 1567127656436
    },
   }
  }

Json數(shù)據(jù)轉(zhuǎn)換為實體類工具類：

abstract class BaseObjectCallback<T>(private val clazz: Class<T>) : BaseCallback() {

  override fun onSuccess(data: String) {
    val responseData = JSONObject(data)
    val code = responseData.getInt("code")
    val message = responseData.getString("message")

    if (code == 1000) {
      val disposable = Observable.just(responseData)
          .map { it.getJSONObject("resp").toString() }
          .map { JsonUtil.parseObject(it, clazz)!! }
          .applyScheduler()
          .subscribe(
              {
                success(it)
              },
              {
                //異常時處理
              })
     
    } else {
     //其他狀態(tài)時處理
    }
  }

  abstract fun success(data: T)
}

調(diào)用時（偽代碼）：

LaunchApi.getOwerInfo.execute(object : BaseObjectCallback<OwnerEntity>(OwnerEntity::class.java) {  
   override fun success(data: OwnerEntity) { 
     //處理數(shù)據(jù)  
   })

5.3. Array數(shù)據(jù)類型

識別標示為：[]

使用場景：如獲取聯(lián)系人列表，返回的數(shù)據(jù)是contact列表，如 ArrayList<contact >。

{
   "code": 1000,
   "message": "成功",
   "resp": {
    "contact": [
     {
      "id": 5819,
      "name": "來啦",
      "phone": "",
      "address": "哈哈哈",
      "province": "湖南省",
      "city": "長沙市",
      "area": "芙蓉區(qū)",
      "modifier": "jun5753",
      "isOwner": 0,
      "updateTime": 1566461377761
     },
     {
      "id": 5835,
      "name": "小六",
      "phone": "13908258239",
      "address": "天安門",
      "province": "北京市",
      "city": "北京市",
      "area": "東城區(qū)",
      "modifier": "jun5753",
      "isOwner": 0,
      "updateTime": 1567150580553
     }
    ]
   }
  }

Json數(shù)據(jù)轉(zhuǎn)換為實體類列表工具類：

abstract class BaseArrayCallback<T>(private val clazz: Class<T>) :BaseCallback() {

  override fun onSuccess(data: String) {
    val responseData = JSONObject(data)
    val code = responseData.getInt("code")
    val message = responseData.getString("message")

    if (code == 1000) {
      val disposable = Observable.just(responseData)
          .map { it.getJSONArray("resp").toString() }
          .map { JsonUtil.parseArray(it, clazz)!! }
          .applyScheduler()
          .subscribe(
              {
                success(it)
              },
              {
                //異常時處理
              })
    } else {
  //其他狀態(tài)時處理
    }
  }
  abstract fun success(data: ArrayList<T>)
}

調(diào)用時(偽代碼):

LaunchApi.getContactList.execute(object : BaseArrayCallback<ContactEntity>(ContactEntity::class.java) {  
   override fun success(data: ArrayList<ContactEntity>) { 
     //處理數(shù)據(jù)  
   })

5.4 復(fù)雜數(shù)據(jù)格式

使用場景：如用戶的篩選數(shù)據(jù)需要上傳到服務(wù)器,每次進入篩選界面時先從服務(wù)器獲取最新數(shù)據(jù)信息。

返回的篩選json數(shù)據(jù)如下所示：

{
   "code": 1000,
   "message": "成功",
   "resp": {
    "filterdata": [
     321,
     671
    ],
    
   }

此時的數(shù)據(jù) 不同于上面提到的幾種Json數(shù)據(jù)類型,返回的列表中數(shù)據(jù)沒有key,只有value值。并不是以鍵值對(key-value)返回的。

解析方法：

聲明實體類

class FilterEntity {

  /** 篩選的數(shù)據(jù)：解析數(shù)組對象 為Int 型數(shù)據(jù) ArrayList<Int> */ 
  var filterdata = ArrayList<Int>()
}

調(diào)用方法（偽代碼）：

HomeApi.getFilterData()
        .execute(object : CJJObjectCallback<FilterEntity>(FilterEntity::class.java) {
          override fun success(data: FilterEntity) {
          //處理數(shù)據(jù)
          }
        })

當用戶選擇篩選數(shù)據(jù)后，需要上傳到服務(wù)器,偽代碼如下：

//上傳json示例為：[0,1,2,3,4]
val filterList = ArrayList<Int>()
//添加int數(shù)據(jù)
 filterList.add(321)
 filterList.add(671)
val jsonData = JsonUtil.toJson(filterList)
//上傳服務(wù)器
 HttpTool.put(FILTER_DATA).param("data", jsonData)

//Gson轉(zhuǎn)換方法
 fun toJson(object: Any): String {
    var str = ""
    try {
      str = gson.toJson(object)
    } catch (e: Exception) {
    
    }
    return str
  }

更多地，如果想要上傳多種數(shù)據(jù)類型，如key-value形式的數(shù)據(jù)到服務(wù)器，偽代碼如下：

//json數(shù)據(jù)示例：{"group":[22,23,24],"brand":[1,2,3,4]}

// 客戶分組篩選
val customerGroupJsonArray = ArrayList<Int>()

 val map = ArrayMap<String, ArrayList<Int>>()
  customerGroupList.forEach {
    customerGroupJsonArray.add(it.id)
   }
  map["group"] = customerGroupJsonArray

  // 品牌篩選
  val vehicleBrandJsonArray = ArrayList<Int>()
  vehicleBrandList.forEach {
    vehicleBrandJsonArray.add(it.brandId)
  }
  map["brand"] = vehicleBrandJsonArray

 //將map類型的數(shù)據(jù)轉(zhuǎn)換為json數(shù)據(jù)
  val jsonData = JsonUtil.toJson(map)

 //上傳服務(wù)器
  HttpTool.put(FILTER_DATA).param("data", jsonData)

6.總結(jié)

本文總結(jié)了Android與服務(wù)器的交互方式和數(shù)據(jù)類型，并總結(jié)了在實際項目的簡單運用，數(shù)據(jù)格式的運用場景遠不止上面提到的幾種場景，后期會持續(xù)完善，如有不足之處，歡迎指出。

參考資料：

1.Android手機訪問服務(wù)器的一種數(shù)據(jù)交互方法

2.App架構(gòu)設(shè)計經(jīng)驗談:接口的設(shè)計

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: