Android 小门径 SDK 集成历程

集成准备 获得SDK

请磋议使命主谈主员获得小门径对应的Android版块的SDK

首先集成

本文档适用于Android Studio用具

导入SDK 加入AAR

解压SDK压缩包,将aar 放入工程主module的libs目次下。

修改建立

在款式主module的build.gradle中添加依赖。

SDK接入 启动化

举止含义

SDK的启动化和回调。

参数诠释:

属性 类型 诠释 是否为空 activity Activity activity对象 弗成为空 miniAppIdAlias String 小门径识别码 弗成为空 iMiniAppCallback IMiniAppCallback SDK提供给接入方的接口回调 弗成为空

诠释：对于线程的问题诠释 接入方调用SDK提供的举止，皆需要在UI线程。 SDK提供的回调皆在UI线程。

具体解决

翔实的解决细节，请参考SDK提供的Sample工程。

底下对回调中出现的举止按序进行翔实的诠释

自界说小门径顶部导航栏样子

启动化建立类MiniAppInitConfig

摘记先容

小门径启动化建立类MiniAppInitConfig, 可通过Builder构建者模式创建，提供的功能如下。

1、自界说小门径顶部导航栏样子 (如:确立导航栏高度)

2、确立小门径默许Icon

3、确立小门径加载页GIF图片

自界说顶部导航栏样子 API

API - navigationBarBackgroundColor

确立顶部导航栏配景相貌。默许相貌值为#3b3f42

接口界说

参数诠释

color：相貌值，为Int类型，驻扎:非资源ID, resource ID可通过getResources().getColor(R.color.xxx)函数飘荡

示例代码

API - navigationBarHeight

确立顶部导航栏高度。默许值46dp

接口界说

参数诠释

unit：尺寸单元，如px、dp等，通过原生类android.util.TypedValue可确立不同的高度单元，如确立dp则为TypedValue.COMPLEX_UNIT_DIP navigationBarHeight：高度值大小, 为Int类型，单元为第一个参数unit的值，高度值必须大于0，不然显现高度为默许值大小

示例代码

API - navigationBarTitleName

确立顶部导航栏标落款称。该Title称号也可通过jsbridge调用SDK磋议API进举止态确立，若H5界面动态确立该Title称号，则此处确立将被袒护

接口界说

参数诠释

titleName：标落款, 为String字符串类型

示例代码

API - navigationBarTitleTextColor

确立顶部导航栏标题字体相貌。默许相貌值为#FFFFFF

接口界说

参数诠释

color：相貌值，为Int类型，驻扎:非资源ID, resource ID可通过getResources().getColor(R.color.xxx)函数飘荡

示例代码

API - navigationBarTitleTextSize

确立顶部导航栏标题字体大小。默许值为18sp

接口界说

参数诠释

unit：尺寸单元，如px、dp等，通过原生类android.util.TypedValue可确立不同的高度单元，如确立dp则为TypedValue.COMPLEX_UNIT_DIP textSize：笔墨字体大小，值为float类型，传入的值必须大于0，不然显现为默许字体大小18sp

示例代码

API - navigationBarMoreImage

确立顶部导航栏右侧 “更多” 按钮图片，默许为". . ."，三个白色小点按钮。

接口界说

参数诠释

三个重载函数,分离复古以resourceId、以drawable对象、以bitmap对象的姿色确立，征战者调用其中一种方式确立即可

示例代码

以resourceId的方式确立为例

API - navigationBarCloseImage

app开发

确立顶部导航栏右侧 “关闭” 按钮图片，默许为"X"型图片

接口界说

参数诠释

三个重载函数,分离复古以resourceId、以drawable对象、以bitmap对象的姿色确立，征战者调用其中一种方式确立即可

示例代码

以resourceId的方式确立为例

确立小门径默许Icon API

API - miniAppDefaultIcon

确立小门径默许Icon，用于在"对于小门径"页面，当收集加载小门径Icon出错时显现

接口界说

参数诠释

三个重载函数,分离复古以resourceId、以drawable对象、以bitmap对象的姿色确立，征战者调用其中一种方式确立即可

示例代码

以resourceId的方式确立为例

确立小门径加载页gif图片 API

API - setLoadingGifImage

确立小门径加载页gif图片，收集加载HTML未得胜前，将显现加载页，教唆用户正在加载，不自界说gif图片，则使用SDK默许的gif图片

接口界说

参数诠释

resourceId: gif图片的资源id,若只念念改造图片宽高，使用SDK默许gif资源,resourceId值则填入MiniAppInitConfig.DEFAULT_LOADING_RESOURCES即可 widthUnit：尺寸单元，青海app开发如px、dp等，通过原生类android.util.TypedValue可确立不同的宽度单元，如确立dp则为TypedValue.COMPLEX_UNIT_DIP heightUnit：尺寸单元，如px、dp等，通过原生类android.util.TypedValue可确立不同的高度单元，如确立dp则为TypedValue.COMPLEX_UNIT_DIP imageWidth: 确立gif图片的宽度, 为Int类型,单元取决于widthUnit的值 imageHeight: 确立gif图片的高度,为Int类型，单元取决于imageHeight的值

示例代码

以dp为尺寸单元确立为例

创建MiniAppInitConfig对象示例代码

驻扎：若未启动化该Config对象，简略个别建立未确立，则会使用SDK内默许建立

获得小门径建立信息

诠释：SDK苦求接入方从收集上获允洽前小门径的建立信息，接入方苦求罢了后，将复返数据奉告SDK 这个在回调中的 setMiniAppConfig举止中触发。

底下对setMiniAppConfig举止进行翔实诠释：

举止含义

SDK苦求接入方从收集上获允洽前小门径的建立信息，接入方苦求罢了后，将复返数据奉告SDK(包括得胜，失败)

参数诠释

属性 类型 诠释 localMiniAppVersion String 腹地数据库中刻下小门径的版块，用于收集苦求中苦求版块参数 configCallback IMiniAppConfigCallback SDK提供给接入方实在立建立数据的接口援用

具体解决

接入方获允洽前的小门径建立信息 苦求参数有两个 1. code:刻下小门径的识别码 2. version:刻下小门径的版块，值为回调中的参数localMiniAppVersion. 具体收集接口的翔实诠释，请稽查 小门径劳动端文档

当建立接口苦求完成后，进行如下的调遣，将苦求成果奉告SDK

下载小门径离线包

诠释：SDK陈述接入方下载离线包，并将下载后的成果奉告SDK 在回调中的 setOfflinePackagePath举止中触发

底下对setOfflinePackagePath举止进行翔实诠释： 1.举止含义

SDK陈述接入方下载离线包，并将下载后的成果奉告SDK

参数诠释

属性 类型 诠释 appId String 小门径id fullDownloadUrl String 小门径全量离线包下载地址url offlinePackageStorageDirectory String 下载完成后离线包的存储目次 offlinePackageName String 下载后离线包需要重定名的名字 downloadCallback IMiniAppOfflinePackageDownloadCallback SDK提供给接入方的下载完成接口援用

具体解决

1.接入方使用fullDownloadUrl进行离线包下载 2.下载得胜后，将离线包再行定名为 offlinePackageName，将其保存在offlinePackageStorageDirectory这个旅途下 3.下载得胜调用 downloadCallback.setOfflinePackagePath(offlinePackagePath+"/"+offlinePackageName);举止 4.下载失败后调用 downloadCallback.downloadError(errorMsg)，其中errorMsg为下载失败的原因

小门径苦求登录

诠释：SDK苦求接入方进行登录，然后将成果告诉SDK 这个会在回调中的 requestLogin举止中触发。

底下对requestLogin举止进行翔实诠释 举止含义

SDK苦求接入方进行登录，然后将成果告诉SDK

参数诠释

属性 类型 诠释 appId String 小门径id loginCallback IMiniAppLoginCallback SDK提供给接入方的登录完成后回调的接口援用

具体解决

登录得胜:

登录失败

小门径苦求接口转发

诠释：小门径内收集苦求的转发,请进行收集苦求,并将成果告诉SDK 这个在回调中的 requestNetWork举止中触发。

举止含义

小门径内收集苦求的转发,请进行收集苦求,并将成果告诉SDK

参数诠释

属性 类型 诠释 appId String 小门径id accessName String 拼接URL时使用 forwardCallback IMiniAppNetWorkForwardCallback SDK提供给接入方的接口转发完成后回调的接口援用

具体解决

苦求URL的无缺方法为:

举例: 转发接口的 host如下:

苦求转发的forwardInfoJsonString字段值如下:

forwardInfoJsonString的方法参数诠释

forwardInfoJsonString为一个Json方法的字符串. 举例:

字段含义诠释

属性 类型 默许值 必填 诠释 最低版块 url string 是 征战者劳动器接口地址 　 data string/object 否 苦求的参数 　 method string POST 否 HTTP 苦求举止 　 dataType string json 否 复返的数据方法 　 responseType string text 否 反馈的数据类型 　 encrypted boolean/string false 否 是否加密 　 cipherFlag string 否 加密方式 　

method 参数的正当值

值 诠释 最低版块 GET HTTP 苦求 GET 　 POST HTTP 苦求 POST 　

dataType 参数的正当值

小门径sdk无用温雅，前端解决

值 诠释 最低版块 json 复返的数据为 JSON，复返后会对复返的数据进行一次 JSON.parse 　 其他 不对复返的本色进行 JSON.parse 　

responseType 参数的正当值

值 诠释 最低版块 text 反馈的数据为文本 　

encrypted 参数的正当值

值 诠释 最低版块 false简略空 不加密 　 true 加密 　

cipherFlag 参数的正当值

encrypted为false或空时不传该字段

值 诠释 最低版块 002 登陆后来往使用的加密 　 005 登陆前来往使用的加密 　

success 回调参数:

属性 类型 诠释 最低版块 data string/Object/Arraybuffer 征战者劳动器复返的数据 　 statusCode number 征战者劳动器复返的 HTTP 气象码 　 header Object 征战者劳动器复返的 HTTP Response Header 　

fail 回调参数：

属性 类型 诠释 最低版块 error Object 征战者劳动器复返的乌有信息，包括code乌有码， msg乌有信息字段 　

那么转发苦求的无缺的URL如下:

小门径乌有回调

诠释：小门径SDK长入的乌有回调,包括接入方传入的参数不对法,包括SDK里面的十分. 这个在回调中的 miniAppError举止中触发

底下对miniAppError举止进行翔实诠释： 举止含义

小门径SDK长入的乌有回调,包括接入方传入的参数不对法,包括SDK里面的十分

参数诠释

error_code:乌有码 error_msg:乌有信息

具体解决

乌有码诠释

乌有码 诠释 100 建立接口授递的map==null 101 建立接口复返数据乌有 102 建立接口复返Json数据十分! response==null 103 小门径建立Json中 miniAppId is empty 104 小门径建立Json中 miniAppVersion is empty 105 小门径建立Json中 fullDownloadUrl is empty 106 小门径建立Json中 fullMd5 is empty 107 小门径建立Json中 loadType is empty 108 小门径建立Json中 urlPrefix is empty 109 小门径建立Json中 sdkMinVer is empty 110 小门径建立Json中 sdkMinVer 不是一个数字 111 小门径建立Json中 accessName is empty 112 小门径建立Json中 miniAppIdAlias is empty 200 刻下SDK不复古该小门径,请升级SDK版块 201 客户端获得Config信息失败 300 客户端下载离线包失败 301 客户端传递的小门径离线包存储地址为空 302 小门径离线包不存在 303 小门径离线包,压缩文献md5值和建立接口中复返的不一致 304 小门径解压目次中莫得文献 305 小门径解压失败 306 解压文献中包含违章字符 400 加载的文献中出现了sha1不一致的情况 小门径人命周期

诠释：小门径SDK对外提供人命周期的两个回调。分离是首先加载和关闭。 分离对应着回调中的 miniPageOnStart举止和miniPageOnDestroy举止

底下分离对这两个举止进行翔实的诠释

回调中的miniPageOnStart举止

举止含义

小门径界面首先加载的回调.

第21分钟，亚马尔禁区前沿轰出世界波破门。

21:18 奖号全部产生，本期奖号：红球05 09 14 21 22 26，蓝球12。

参数诠释

属性 类型 诠释 appId String 小门径id

具体解决

不错阐述我方的业务,进行统计等等解决.

回调中miniPageOnDestroy举止

举止含义

小门径界面关闭的回调.

参数诠释

属性 类型 诠释 appId String 小门径id

具体解决

不错阐述我方的业务,进行统计等等解决.

小门径日记截止

SDK提供了Log日记开关的举止MiniAppLog.setDebug()

SDK里面的日记，默许是开着的，提议在release模式下关闭日记。

小门径版块

SDK提供获允洽前的版块号APP开发公司，浅近调试。