Retrofit WebService 实践

分类：Android作者：码中之牛

前言

作为 Android 开发，平时和后端聊得最多的除了喝酒就是接口。常用语：Restful 和 WebService，前者现在聊得多，后者以前聊得多。

默认含义分别为：

  • Restful：HTTP 协议 和 JSON 格式
  • WebService：特指 Soap 协议 和 XML 格式

针对基于 HTTP 协议且格式为 JSON 的 Restful 接口，Android 客户端一般采用 Retrofit + Gson/Moshi 的方案解决。

而针对 Soap 协议 和 XML 格式的 Soap WebService ，则少有实践机会。考虑到 Retroift is A type-safe HTTP client for Android and Java. 并且 Soap 协议是基于 XML 且通过 HTTP 协议来交换信息，故解决好 XML 的封装与解析，使用 Retrofit 实现 SOAP 服务调用应该简单。

Restful & WebService

概念

WebService

WebService 是一个平台独立的，低耦合的，自包含的、基于可编程的 WEB 应用程序，可使用开放的 XML（标准通用标记语言下的一个子集）标准来描述、发布、发现、协调和配置这些应用程序，用于开发分布式的交互操作的应用程序[1]。

WebService 三要素：

  • SOAP(Simple Object Access Protocol)：描述传递信息的格式；
  • WSDL(WebServicesDescriptionLanguage)：描述如何访问具体的接口；
  • UDDI(UniversalDescriptionDiscovery andIntegration)：管理，分发，查询 WebService 。

SOAP

SOAP(Simple Object Access Protocol)，即简单对象访问协议，是交换数据的一种协议规范，是一种轻量的、简单的、基于XML（标准通用标记语言下的一个子集）的协议，它被设计成在WEB上交换结构化的和固化的信息。

  • SOAP 指简易对象访问协议
  • SOAP 是一种通信协议
  • SOAP 用于应用程序之间的通信
  • SOAP 是一种用于发送消息的格式
  • SOAP 被设计用来通过因特网进行通信
  • SOAP 独立于平台
  • SOAP 独立于语言
  • SOAP 基于 XML
  • SOAP 很简单并可扩展
  • SOAP 允许您绕过防火墙
  • SOAP 将被作为 W3C 标准来发展[2]

SOAP 消息的基本结构

<?xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">

<soap:Header>
  ...
  ...
</soap:Header>

<soap:Body>
  ...
  ...
  <soap:Fault>
    ...
    ...
  </soap:Fault>
</soap:Body>

</soap:Envelope>

SoapUI

soapUI，是一款开源软件测试工具。

开源软件，是源码可以被公众使用的软件，并且此软件的使用，修改和分发也不受许可证的束缚。

软件测试工具，即是通过一些工具能够使软件的一些简单问题直观的显示在读者的面前的软件工具。它们使测试人员能够更好地找出软件错误的所在。

soapUI是一款开源测试工具，通过soap/http来检查、调用、实现Web Service的功能/负载/符合性测试。该工具既可作为一个单独的测试软件使用，也可利用附件集成到Eclipse，maven2.X，Netbeans 和 intellij 中使用。

WebXml

WEB服务开发、WEBXML是标准商业和免费WEB服务（Web Service）提供商您可以在这里搜索技术问题的答案以及获取最新的发展动态。数据库开发和网站设计开发的解决方案和技术支持WEB服务接入、从事WEB服务设计

实践

通过 Retrofit 调用 Web Xml 网站 的 国内手机号码归属地查询WEB服务。

  • SOAP 协议
  • XML 格式
  • Kotlin + Retrofit + Coroutine

1. 接口分析

Retrofit WebService 实践

MobileCodeWS

Retrofit WebService 实践

SoapUI MobileCodeWS

针对 SOAP 1.1 和 SOAP 1.2 协议，虽然请求报文略有不用，但是请求结果报文相同，SOAP 协议 走 HTTP POST 请求且 Content-Type: text/xml; charset=utf-8。当然，若嫌 SOAP 协议麻烦，可以直接利用参数进行 GET 或者 POST 的请求，省去封装 XML 的麻烦。

Retrofit WebService 实践

HTTP GET and POST

2. 程序设计

2.1 添加依赖

dependencies {
    implementation fileTree(include: ['*.jar'],dir: 'libs')
    implementation 'androidx.appcompat:appcompat:1.4.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.1.1'
    implementation 'com.squareup.okhttp3:okhttp:5.0.0-alpha.2'
    implementation 'com.squareup.okhttp3:logging-interceptor:5.0.0-alpha.2'
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-simplexml:2.3.0'

    implementation 'androidx.navigation:navigation-fragment-ktx:2.3.5'
    implementation 'androidx.navigation:navigation-ui-ktx:2.3.5'

    implementation 'com.github.kirich1409:viewbindingpropertydelegate:1.5.6'
}

2.2 请求接口

  • GET
  • POST
  • POST SOAP 1.1（构建请求对象和响应对象）
  • POST SOAP 1.2（拼接 XML ）
interface MobileCodeApi {

    @Headers("Content-Type: text/xml; charset=utf-8")
    @GET("MobileCodeWS.asmx/getMobileCodeInfo")
    suspend fun mobileCodeInfoByHttpGet(
        @Query("mobileCode") mobileCode: String,@Query("userID") userId: String = ""
    ): ResponseBody

    @POST("MobileCodeWS.asmx/getMobileCodeInfo")
    @FormUrlEncoded
    suspend fun mobileCodeInfoByHttpPost(
        @Field("mobileCode") mobileCode: String,@Field("userID") userId: String = ""
    ): ResponseBody

    @Headers("Content-Type: text/xml;charset=utf-8")
    @POST("MobileCodeWS.asmx")
    suspend fun mobileCodeInfoBySoap11(
        @Body requestEnvelope: MobileCodeRequestEnvelope?
    ): MobileCodeResponseEnvelope

    @Headers("Content-Type: application/soap+xml;charset=utf-8")
    @POST("MobileCodeWS.asmx")
    suspend fun mobileCodeInfoBySoap12(
        @Body requestEnvelope: RequestBody
    ): ResponseBody
}

2.3 请求体设计

“

SOAP 1.1 协议

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://WebXml.com.cn/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:getMobileCodeInfo>
         <!--Optional:-->
         <web:mobileCode></web:mobileCode>
         <!--Optional:-->
         <web:userID></web:userID>
      </web:getMobileCodeInfo>
   </soapenv:Body>
</soapenv:Envelope>

查看请求体 XML 模板，总共 4 层，我们定义 3 个类即可满足。

“

核心为  com.squareup.retrofit2:converter-simplexml:2.3.0 依赖库中的注解。

MobileCodeRequestEnvelope.kt

@Root(name = "soapenv:Envelope")
@NamespaceList(
    Namespace(prefix = "soapenv",reference = "http://schemas.xmlsoap.org/soap/envelope/"),Namespace(prefix = "web",reference = "http://WebXml.com.cn/")
)
class MobileCodeRequestEnvelope {
    @field:Element(name = "soapenv:Body",required = true)
    var body: MobileCodeRequestBody? = null
}

MobileCodeRequestBody.kt

@Root(name = "soapenv:Body")
class MobileCodeRequestBody {
    @field:Element(name = "web:getMobileCodeInfo",required = true)
    var mobileCodeRequestData: MobileCodeRequestData? = null
}

MobileCodeRequestData.kt

@Root(name = "getMobileCodeInfo")
class MobileCodeRequestData {
    @field:Element(name = "web:mobileCode",required = true)
    var mobileCode: String? = null

    @field:Element(name = "web:userID",required = true)
    var userId: String = ""
}

2.4 响应体设计

“

SOAP 1.1 协议

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <getMobileCodeInfoResponse xmlns="http://WebXml.com.cn/">
         <getMobileCodeInfoResult>18507152743：湖北 武汉 湖北联通GSM卡</getMobileCodeInfoResult>
      </getMobileCodeInfoResponse>
   </soap:Body>
</soap:Envelope>

参考请求体，我们定义 3 个类即可满足响应体设计需求。

MobileCodeResponseEnvelope.kt

@Root(name = "soap:Envelope")
@NamespaceList(
    Namespace(prefix = "soap",reference = "http://www.w3.org/2003/05/soap-envelope"),Namespace(prefix = "xsi",reference = "http://www.w3.org/2001/XMLSchema-instance"),Namespace(prefix = "xsd",reference = "http://www.w3.org/2001/XMLSchema")
)
class MobileCodeResponseEnvelope {
    @field:Element(name = "Body")
    var body: MobileCodeResponseBody? = null
}

MobileCodeResponseBody.kt

@Root(name = "Body")
class MobileCodeResponseBody {
    @field:Element(name = "getMobileCodeInfoResponse",required = false)
    var response: MobileCodeInfoResponse? = null
}

MobileCodeResponse.kt

@Root(name = "getMobileCodeInfoResponse",strict = false)
class MobileCodeInfoResponse {
    @field:Element(name = "getMobileCodeInfoResult",required = false)
    var mobileCodeInfoResult: String? = null
}

2.5 Retrofit

object Retrofitance {
    private const val BASE_URL = "http://ws.webxml.com.cn/WebServices/"
    private val strategy: Strategy = AnnotationStrategy()
    private val serializer: Serializer = Persister(strategy)

    private val client = OkHttpClient.Builder()
        .addInterceptor(HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BODY))
        .build()

    private val retrofitance = Retrofit.Builder()
        .client(client)
        .addConverterFactory(SimpleXmlConverterFactory.create(serializer))
        .baseUrl(BASE_URL)
        .build()

    val mobileCodeApi: MobileCodeApi = retrofitance.create(MobileCodeApi::class.java)
}

2.6 请求数据

2.6.1 GET

fun doHttpGet() {
    lifecycleScope.launchWhenCreated {
        val response =
            Retrofitance.mobileCodeApi.mobileCodeInfoByHttpGet(binding.etMobile.text.toString())
        Toast.makeText(context,"请求成功",Toast.LENGTH_SHORT).show()
        val result = response.string()
        binding.tvMobileResult.text = result
    }
}

2.6.2 POST

fun doHttpPost() {
    lifecycleScope.launchWhenCreated {
        val response =
            Retrofitance.mobileCodeApi.mobileCodeInfoByHttpPost(binding.etMobile.text.toString())
        Toast.makeText(context,Toast.LENGTH_SHORT).show()
        val result = response.string()
        binding.tvMobileResult.text = result
    }
}

2.6.3 SOAP 1.1

fun doSoap11() {
    val apiService = Retrofitance.mobileCodeApi
    val requestEnvelope = MobileCodeRequestEnvelope()
    val requestBody = MobileCodeRequestBody()
    val requestData = MobileCodeRequestData()
    requestData.mobileCode = binding.etMobile.text.toString()
    requestBody.mobileCodeRequestData = requestData
    requestEnvelope.body = requestBody
    lifecycleScope.launchWhenCreated {
        val mobileCodeResponseEnvelope = apiService.mobileCodeInfoBySoap11(requestEnvelope)
        Toast.makeText(context,Toast.LENGTH_SHORT).show()
        val result = mobileCodeResponseEnvelope.body?.response?.mobileCodeInfoResult
        binding.tvMobileResult.text = result
    }
}

2.6.3 SOAP 1.2

“

为了区分请求形式，直接采用 XML String 作为 RequestBody，也省事。

fun doSoap12() {
    val xml = """
        <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:web="http://WebXml.com.cn/">
           <soap:Header/>
           <soap:Body>
              <web:getMobileCodeInfo>
                 <web:mobileCode>${binding.etMobile.text}</web:mobileCode>
                 <web:userID></web:userID>
              </web:getMobileCodeInfo>
           </soap:Body>
        </soap:Envelope>
    """.trimIndent()
    lifecycleScope.launchWhenCreated {
        val result =
            Retrofitance.mobileCodeApi.mobileCodeInfoBySoap12(xml.toRequestBody("text/xml".toMediaTypeOrNull()))
        Toast.makeText(context,Toast.LENGTH_SHORT).show()
        binding.tvMobileResult.text = result.string()
    }
}

2.7 效果

Retrofit WebService 实践

3. 源码

https://github.com/onlyloveyd/RetrofitWebService

参考资料

[1]WebService百度百科:  https://baike.baidu.com/item/Web%20Service

[2]什么是 Soap?:  https://www.w3school.com.cn/soap/soap_intro.asp

[3]SoapUI: https://www.soapui.org/

[4]WebXml服务: http://www.webxml.com.cn/

Retrofit WebService 实践

原文地址：https://blog.csdn.net/weixin_61845324

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 dio@foxmail.com 举报，一经查实，本站将立刻删除。

相关推荐

更新Android SDK到3.0版本时，遇到Failed to rename directory E:androidtools to E:androidtempToolPackage.old01问题
更新Android SDK到3.0版本时，遇到Failed to rename directory E:\android\tools to E:\android\temp\ToolPackage.old01问题，导致无法更新，出现该问题的原因是由于3.0版本与较早的sdk版本之间文件结构有冲突，解决
Android 如何解决dialog弹出时无法捕捉Activity的back事件
Android 如何解决dialog弹出时无法捕捉Activity的back事件 在一些情况下，我们需要捕捉back键事件，然后在捕捉到的事件里写入我们需要进行的处理，通常可以采用下面三种办法捕捉到back事件： 1）重写onKeyDown或者onKeyUp方法 2）重写onBackPressed方
Android实现自定义带文字和图片的Button
Android实现自定义带文字和图片的Button 在Android开发中经常会需要用到带文字和图片的button，下面来讲解一下常用的实现办法。一.用系统自带的Button实现 最简单的一种办法就是利用系统自带的Button来实现，这种方式代码量最小。在Button的属性中有一个是drawable
Android中的"Unable to start activity ComponentInfo"或者"Unable to instantiate activity ComponentInfo"的错误
Android中的&quot;Unable to start activity ComponentInfo&quot;的错误 最近在做一款音乐播放器的时候，然后在调试的过程中发现一直报这个错误&quot;Unable to start activity ComponentInfo&quot;，从字面
Android 关于长按back键退出应用程序的实现
Android 关于长按back键退出应用程序的实现最近在做一个Android上的应用，碰到一个问题就是如何实现长按back键退出应用程序。在网上查找了很多资料，发现几乎没有这样的实现，大部分在处理时是双击back键来退出应用程序。参考了一下双击back键退出应用程序的代码，网上主流的一种方法是下面
android 可以精确到秒级的时间选择器
android自带的时间选择器只能精确到分，但是对于某些应用要求选择的时间精确到秒级，此时只有自定义去实现这样的时间选择器了。下面介绍一个可以精确到秒级的时间选择器。 先上效果图： 下面是工程目录： 这个控件我也是用的别人的，好像是一个老外写的，com.wheel中的WheelView是滑动控件的主
Android平台下利用zxing实现二维码开发
Android平台下利用zxing实现二维码开发 现在走在大街小巷都能看到二维码，而且最近由于项目需要，所以研究了下二维码开发的东西，开源的二维码扫描库主要有zxing和zbar，zbar在iPos平台上应用比较成熟，而在Android平台上主流还是用zxing库，因此这里主要讲述如何利用zxing
Android ListView的item背景色设置以及item点击无响应等相关问题
Android ListView的item背景色设置以及item点击无响应等相关问题 在Android开发中，listview控件是非常常用的控件，在大多数情况下，大家都会改掉listview的item默认的外观，下面讲解以下在使用listview时最常见的几个问题。1.如何改变item的背景色和按
如何向Android模拟器中导入含有中文名称的文件
如何向Android模拟器中导入含有中文名称的文件在进行Android开发的时候，如果需要向Android模拟器中导入文件进行测试，通过DDMS下手动导入或者在命令行下通过adb push命令是无法导入含有中文文件名的文件的。后来发现借用其他工具可以向模拟器中导入中文名称的文件，这个工具就是Ultr
Windows 下搭建Android开发环境
Windows 下搭建Android开发环境一．下载并安装JDK版本要求JDK1.6+，下载JDK成功后进行安装，安装好后进行环境变量的配置【我的电脑】-——&gt;【属性】——&gt;【高级】 ——&gt;【环境变量】——&gt;【系统变量】中点击【新建】：变量名：CLASSPATH变量值：……
如何利用PopupWindow实现弹出菜单并解决焦点获取以及与软键盘冲突问题
如何利用PopupWindow实现弹出菜单并解决焦点获取以及与软键盘冲突问题 在android中有时候可能要实现一个底部弹出菜单，此时可以考虑用PopupWindow来实现。下面就来介绍一下如何使用PopupWindow实现一个弹出窗。 主Activity代码：public void onCreat
解决Android中的ERROR: the user data image is used by another emulator. aborting的方法
解决Android中的ERROR: the user data image is used by another emulator. aborting的方法 今天调试代码的时候，突然出现这个错误，折腾了很久没有解决。最后在google上找到了大家给出的两种解决方案，下面给出这两种方法的链接博客：ht
ViewFlipper 简单应用
AdvserView.java package com.earen.viewflipper; import android.content.Context; import android.graphics.Bitmap; import android.graphics.BitmapFactory;
ImageView的scaleType属性 与 adjustViewBounds属性
ImageView的scaleType的属性有好几种，分别是matrix（默认）、center、centerCrop、centerInside、fitCenter、fitEnd、fitStart、fitXY。 |值|说明| |:--:|:--| |center|保持原图的大小，显示在ImageVie
在Android studio 3.2 版项目中使用cmake调用C/C++
文章浏览阅读8.8k次，点赞9次，收藏20次。本文操作环境:win10/Android studio 3.21.环境配置 在SDK Tools里选择 CMAKE/LLDB/NDK点击OK 安装这些插件. 2.创建CMakeLists.txt文件 在Project 目录下,右键app，点击新建File文件,命名为CMakeLists.txt点击OK，创建完毕! 3.配置文件 在CMa..._link c++ project with gradle
Android studio跳转界面
文章浏览阅读1.2w次，点赞15次，收藏69次。实现目的：由mainActivity界面跳转到otherActivity界面1.写好两个layout文件，activity_main.xml和otherxml.xmlactivity_main.xml&lt;?xml version="1.0" encoding="utf-8"?&gt;&lt;RelativeLayout ="http://schemas..._android studio 界面跳转
Android全局代理软件ProxyDroid和TransProxy源码分享
文章浏览阅读3.8w次。前言：最近在找Android上的全局代理软件来用，然后发现了这两款神作，都是外国的软件，而且都是开源的软件，因此把源码下载了下来，给有需要研究代理这方面的童鞋看看。不得不说，国外的开源精神十分浓，大家相互使用当前基础的开源软件，然后组合成一个更大更强的大开源软件。好吧，废话不多说，下面简单介绍一下这两款开源项目。一、ProxyDroid：ProxyDroid功能比较强大，用到的技术也比较多，源码也_proxydroid
Error:(23, 25) 错误: 程序包R不存在
文章浏览阅读2.5w次，点赞17次，收藏6次。创建项目后，运行项目时Gradle Build 窗口却显示错误：程序包R不存在通常情况下是不会出现这个错误的。我是怎么遇到这个错误的呢？第一次创建项目，company Domain我使用的是：aven.com，但是创建过程在卡在了Building 'Calculator' Gradle Project info这个过程中，于是我选择了“Cancel”第二次创建项目，我还是使用相同的项目名称和项目路_r不存在
教你在Android手机上使用全局代理！
文章浏览阅读8.9w次，点赞4次，收藏43次。前言：在Android上使用系统自带的代理，限制灰常大，仅支持系统自带的浏览器。这样像QQ、飞信、微博等这些单独的App都不能使用系统的代理。如何让所有软件都能正常代理呢？ProxyDroid这个软件能帮你解决！使用方法及步骤如下：一、推荐从Google Play下载ProxyDroid，目前最新版本是v2.6.6。二、对ProxyDroid进行配置（基本配置：） （1） Auto S_proxydroid使用教程
【Android 开发入门】Android设备监视器之调试工具DDMS使用初探
文章浏览阅读1.1w次，点赞4次，收藏17次。Android Studio提供了一个很实用的工具Android设备监视器(Android device monitor)，该监视器中最常用的一个工具就是DDMS（Dalvik Debug Monitor Service），是 Android 开发环境中的Dalvik虚拟机调试监控服务。可以进行的操作有：为测试设备截屏，查看特定进程中正在运行的线程以及堆栈信息、Logcat、广播状态信息、模拟电话_安卓摄像头调试工具
pythonJavaScriptjavaHTMLPHPreactjsC#AndroidCSSNode.jssqlrpython-3.xMysqLjQueryc++pandasFlutterangularIOSdjangolinuxswifttypescript路由器JSON路由器设置无线路由器h3c华三华三路由器设置华三路由器电脑软件教程arraysdocker软件图文教程Cvue.jslaravelspring-boot