鸿洋推荐：实际生产中的-Android-SDK开发总结（一）(3)

最新推荐文章于 2024-06-23 12:08:07 发布

好像要长脑子了1

最新推荐文章于 2024-06-23 12:08:07 发布

阅读量941

点赞数 18

分类专栏：程序员文章标签： android

本文链接：https://blog.csdn.net/2301_79600088/article/details/138730917

版权

程序员专栏收录该内容

269 篇文章 0 订阅

订阅专栏

SDK全称 Software Development Kit，广义上的SDK 是为特定的软件包、软件框架、硬件平台、操作系统等建立应用程序时所使用的开发工具的集合；狭义上的 SDK 则是基于系统基础组件进行二次开发封装的、独立的、能够完成特定功能并返回相关数据的一组工具的集合。

说人话，SDK一般就是我们常见的jar包、so库、aar包，大到一套JDK，小到只有一个方法的jar包，都可以称之为SDK。SDK的本质是一系列方法、逻辑的集合，对资源与API封装后的产物。

2.2、SDK的场景

SDK的定义我们了解了，那么SDK在行业内的场景有哪些呢？SDK广泛存在于2B产品中（此处禁止联想…）。

如推送SDK，支付SDK，地图SDK、OCR-SDK、人脸识别SDK、游戏SDK等等。标准化的、可复用的SDK产品，广泛提高了中小型公司开发APP的效率。

三、SDK接口设计

设计一个SDK，有两个明确的原则贯穿始终：

一是：最小可用性原则，即用最少的代码，如无必要勿增实体；
二是：最少依赖性原则，即用最低限度的外部依赖，如无必要勿增依赖。

首先我们需要明确一下这个SDK的职责与边界，定义与宿主App的交互参数。即SDK接收什么？输出什么？

举个例子：

关键要点：

出入参都有一个token，用于本次调用的关联与凭证。
前端SDK设计入参时，应当尽量减少前端参数交互，相关参数尽量在获取token时传入后端服务，以此保持SDK接口调用的简洁性与调用的灵活性。

3.1、出入参设计

大多数情况下，出入参需要交互多个字段。那么就产生了数据组装的问题。

因此，必须设计一个便捷、清晰的数据结构。

SDK出入参本质上是交互一组键值对（Key-Value），因此可以考虑的方式有：

3.1.1、传递一个Map

生成一个Map，并设置对应的Key-Value。可行，但缺点是暴露了过多生成参数的细节与内部逻辑，Map的生成与KEY的设置相对不可控，也埋下了数据不一致的隐患。

Tips：采用HashMap实例在activity间传输时，需要使用bundle.putSerializable(KEY_REQ, value);

3.1.2、传递一个String

生成一个JSON格式的字符串，跟Map方案的缺点类似，组装过程中还容易产生JSON格式问题。

3.1.3、传递一个自定义实体类

通过SDK模块内置专用实体类的实例，动态设置相关参数，交互类的实例。该放方案简单易用，屏蔽了生成与设置的细节，直接通过简单的set方法接口为其赋值，并且可以在赋值时进行数据校验、限定。

入参构建示例：

//构建请求实体
final ReqContent req = new ReqContent();
req.setToken(“a_valid_token”);
req.setSignature(“a_valid_signature”);

返参获取示例：

//获取返回实体
ResultContent result = getResult(intent);
int code = result.getCode();
String message = result.getMessage();
String token = result.getToken();

Tips1：采用自定义实体类作为出入参在activity间传输时，无法直接传递实体，需要经过序列化。有两种方法可以实现

1、实体类需要实现 JDK下的Serializable接口，通过bundle传输：

bundle.putSerializable(KEY_REQ, req);

2、实体类需要实现 Android SDK下的Parcelable接口，通过bundle传输：bundle.putParcelable(KEY_REQ, req);

Tips2：需要注意的是：Intent 中的 Bundle 是使用 Binder 机制进行数据传送的，有大小限制，所以务必不要进行大数据传输，建议最大不超过500K，越小越好，避免传输图片。（实测不同版本有不同限制，500K不是一个确定的数目，感兴趣的可以自己测试一下）

3.2、调用封装设计

SDK的调用，需遵循简单、封装的原则。

主要有两种类型，一是单纯的、无界面的、不与用户交互的代码逻辑，如常见的加密、摘要生成SDK等等，直接通过一个最简单的方法调用后直接返回即可。

二是复杂的、有界面、直接接触用户的SDK，此类SDK也是本章重点讨论的类型。

背景：SDK内部有一系列承载不同业务逻辑的Activity，第三方通过启动SDK的入口Activity进行SDK调用与业务分发，那么如何做一个优雅的调用封装？

封装前的调用：

//繁琐的调用代码
Bundle bundle = new Bundle();
//这里要暴露或者约定一个静态KEY
bundle.putParcelable(KEY_REQ, request);
Intent intent = new Intent(context, EntryActivity.class);
//屏蔽转场动画，让画面跳转更和谐
intent.setFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
intent.putExtras(bundle);
context.startActivity(intent);

封装后的调用：

//简洁的调用代码
MySDK.launchSdk(context,req);

//将复杂逻辑或细节内置于SDK中，对外提供封装好的静态方法即可
public static void launchSdk(Context context, ReqContent request) {
Bundle bundle = new Bundle();
bundle.putParcelable(KEY_REQ, request);
Intent intent = new Intent(context, EntryActivity.class);
//屏蔽转场动画，让画面跳转更和谐
intent.setFlags(Intent.FLAG_ACTIVITY_NO_ANIMATION);
intent.putExtras(bundle);
context.startActivity(intent);
}

如此一来，不仅简化了调用，还屏蔽了一系列中间过程的模板代码，何乐而不为呢？SDK多写几行代码，可以方便开发者千万家。这里只是简单提供了一个思路，具体流程具体分析，从这里发散开去即可，但是也要避免过度封装，导致扩展、、兼容性的问题。

3.3、数据返回设计

数据返回是SDK设计中不可缺失的一环。遵循的是“调用即响应”的原则，响应具体可以分为返回码、抛异常。切勿设计出无响应、无回调的SDK逻辑。SDK内部流程处理完毕后必须给调用方一个返回，业务才能继续。具体来讲，处理了if，就必须关注else，处理了case，就必须关注default，这也是良好的java编程习惯的一部分。

业务型SDK的数据返回机制需要怎么设计呢？首先我们看下需求背景：

需要在App与SDK的Activity间进行数据传输
调取SDK后，需要执行一段异步逻辑，结束后需及时关闭；
需要在逻辑代码处理过程中随时随地的构造返回参数并返回；
SDK代码需集成于各类第三方App，需要通用的交互机制，避免引起更多兼容问题。

采用startActivityForResult()? 理论可行，但不够灵活，弃用。

采用EventBus ? 避免引入非必须第三方依赖，暂时放弃。

采用BroadcastReceiver？Android 内置的四大组件之一，为组件间交互而生。而且灵活方便，与入参方法呼应，可以从Intent中传输数据。

广播又可以分为全局广播和应用内广播，全局广播可以跨App传递，基于Binder机制，在这个场景下显得过于大材小用。而应用内广播，基于Handler机制，仅限于同一应用内的数据交互，相比于全局广播无需进程间通信，效率更高、也无需担心其他应用接收广播带来的安全性问题。下面来看下应用实例：

发送数据

//SDK内部封装的静态方法，提供给SDK内部模块统一调用
public static void sendResult(String token, int code, String message) {

ResultContent result = new ResultContent();
result.setToken(token);
result.setCode(code);
result.setMessage(message);

Bundle bundle = new Bundle();
bundle.putParcelable(KEY_RESULT, result);

Intent intent = new Intent();
intent.setAction(MY_SDK_RECEIVER_ACTION);
intent.putExtras(bundle);
LocalBroadcastManager.getInstance(MySDK.getContext()).sendBroadcast(intent);
}

接收数据

//SDK内部封装的注册方法，提供给APP模块统一调用
public static void registerReceiver(BroadcastReceiver receiver) {
IntentFilter filter = new IntentFilter();
filter.addAction(MY_SDK_RECEIVER_ACTION);
LocalBroadcastManager.getInstance(getContext()).registerReceiver(receiver, filter);
}

//SDK内部封装的反注册方法，提供给APP模块统一调用，如果在onCreate()方法中注册，则在onDestroy()方法中反注册。
public static void unregisterReceiver(BroadcastReceiver receiver) {
LocalBroadcastManager.getInstance(getContext()).unregisterReceiver(receiver);
}

//APP 中定义的广播接收器，用于接收返回参数
public class MyReceiver extends BroadcastReceiver {
@Override
public void onReceive(Context context, Intent intent) {
ResultContent result = MySDKHelper.getResult(intent);
if (result == null) {
return;
}
int code = result.getCode();
String message = result.getMessage();
String token = result.getToken();
String log = String.format(Locale.CHINA,“返回码: %d 返回信息: %s Token: %s”, code, message, token);
Log.d(TAG, log);
}