[关闭]
@pockry 2017-01-19T06:09:26.000000Z 字数 5184 阅读 1197

Android蓝牙BLE集成多设备最佳实践

章星星


背景

公司开发了一款健康类APP,用户可以通过APP连接外部蓝牙BLE设备采集血糖,血压,体重等多个常见健康类指标。因此APP需要同时集成多款设备(多个品牌的血糖仪,血压计,体脂秤等)。每个厂家的设备对接协议是不同的,甚至连同一个设备的不同版本,协议都会有差距。在一个APP中跟多个设备对接,甚至在同一个界面中需要处理多个设备,界面跟协议混在一起,成为一个比较头疼的问题。本文对如何在APP中支持多设备集成,并且在需要对接新设备的时候,容易扩展现有代码提供了一个比较好的实践思路。

原有实现

原来在界面Activity类中,集成多个设备时候的代码通常如下所示(为了达到说明目的,代码做了很多简化,实际情况中设备对接的协议代码逻辑要复杂的多):

  1. private DeviceType mConnectedDeviceType; //连接设备类型
  2. /**
  3. * 处理集成设备发过来的数据
  4. * @param uuid
  5. * @param data
  6. */
  7. private void processDeviceData(UUID uuid,byte[] data){
  8. //首先判断当前连接设备类型,再分别处理
  9. if (mConnectedDeviceType == DeviceType.A){
  10. //如果当前连接设备类型为A, 根据本地硬编码的协议处理A类设备
  11. processDeviceA(UUID uuid,byte[] data);
  12. }else if (mConnectedDeviceType == DeviceType.B){
  13. //如果当前连接设备类型为B, 处理B类设备
  14. processDeviceB(UUID uuid,byte[] data);
  15. }else if (mConnectedDeviceType == DeviceType.C){
  16. //如果当前连接设备类型为C, 处理C类设备
  17. processDeviceC(UUID uuid,byte[] data);
  18. }
  19. ...
  20. }
  21. /**
  22. * 处理A类设备的协议交互代码
  23. * @param uuid
  24. * @param data
  25. */
  26. private void processDeviceA(UUID uuid,byte[] data){
  27. int step = parseCmdA(uuid, data);
  28. if (step == 0x1){
  29. showResultA(data); //显示测量结果
  30. }else if (step == 0x2){
  31. writeCmd("cmd2a"); //向连接设备下发数据
  32. }else if (step == 0x3){
  33. writeCmd("cmd3a");
  34. }
  35. }
  36. /**
  37. * 处理B类设备的协议交互代码
  38. * @param uuid
  39. * @param data
  40. */
  41. private void processDeviceB(UUID uuid,byte[] data){
  42. int step = parseCmdB(uuid, data);
  43. if (step == 0x1){
  44. showResultB(data); //显示测量结果
  45. }else if (step == 0x2){
  46. writeCmd("cmd2b"); //向连接设备下发数据
  47. }else if (step == 0x3){
  48. writeCmd("cmd3b");
  49. }
  50. }
  51. /**
  52. * 处理C类设备的协议交互代码
  53. * @param uuid
  54. * @param data
  55. */
  56. private void processDeviceC(UUID uuid,byte[] data){
  57. int step = parseCmdC(uuid, data);
  58. if (step == 0x1){
  59. writeCmd("cmd2c"); //向连接设备下发数据
  60. }else if (step == 0x2){
  61. showResultC(data); //显示测量结果
  62. }else if (step == 0x3){
  63. writeCmd("cmd3c");
  64. }
  65. }

如何解决

以上代码可以看出界面跟设备协议是强耦合在一起的。如果需要集成更多的设备那怎么办?原有的类代码势必变得更复杂,难以维护。因此我们需要把设备间的协议交互逻辑与界面进行解耦,以保持单一职责的设计原则:界面只进行步骤和测量结果的更新展示,交互逻辑可以放到其他类中。在这个地方我们可以使用Adapter作为设备适配器,把设备间的交互封装到Adapter里面去,集成不同设备的时候调用不同的Adapter处理即可。

我们如何设计Adapter呢?虽然每个设备的交互协议不一样,但是其中一些操作却是共性的,比如一开始总是要连接设备,连接成功后设置指定UUID的notification或者indication,然后向外部设备写入数据(下发指令),或者等待外部设备数据变化上报,交互完成后再断开设备。

因此我们可以把这些共性操作抽象成DeviceAdapter接口。DeviceAdatper接口主要包含上述的常用操作:

  1. UUID[] notificationUUIDs() //设置notification的UUID
  2. UUID[] indicatorUUIDs() //设置indicator的UUID
  3. void connectThenStart(BleDevice bleDevice) //连接设备并进行协议交互
  4. void disconnect() //断开设备
  5. void writeCharacteristic(UUID uuid, byte[] data) //向指定UUID的Characteristic写入数据
  6. void readCharacteristic(UUID uuid) //从指定UUID的Characteristic中读取数据
  7. void executeCmd(int cmd) throws EasyBleException //执行命令接口
  8. void processData(UUID uuid, byte[] data) //解析外部设备发过来的数据

经过进一步的调研我们发现,设备的连接,断开连接,设置notification/indication,写入数据,读取数据,这些操作本身都是完全一样的,不同的是我们对协议数据本身的解析。所以这些操作我们可以用一个默认的抽象类DefaultAdapter来实现,DefaultAdapter实现DeviceAdapter接口,把对数据解析的功能延迟到子类去进行。针对A设备创建DeviceAdapterA继承于DefaultAdapter,B设备创建DeviceAdapterB继承于DefaultAdapter,不同的设备用不同的Adapter去处理。

如图所示:



Drawing


解耦关键

Adapter设计完成后,那调用模块(Client)又是如何知道针对A设备,用DeviceAdapterA处理;针对B设备用DeviceAdapterB处理的呢?

我们需要做到两点:

  1. Adapter需要告诉客户:它能处理哪些设备。
  2. 需要把adapter管理起来,连接设备后需要能找到相匹配的adapter去处理设备。

解决第1点很简单,我们只需要在DeviceAdapter增加一个方法用来标识它能处理哪些设备,方法如下:

  1. String[] supportedNames() //返回的String数组代表它能处理的设备名组合

第2点解决起来要复杂些,我们需要增加一个管理类BleCenterManager(门面模式),BleCenterManager的主要职责为:管理维护adapter,并对不同设备找到相匹配的adapter进行处理,主要包含如下方法:

  1. public void startScan() //开始蓝牙扫描
  2. public void stopScan() //停止蓝牙扫描
  3. public void connectThenStart(BleDevice device) //连接并处理设备
  4. public void addDeviceAdapterFactory(DeviceAdapter.Factory factory) //增加Adapter相应的Factory

Adapter创建

在深入讲解BleCenterManager之前,我们可以先谈谈adapter的创建。adapter主要由客户代码根据交互协议创建,初始化的过程可能各不相同。因此BleCenterManager最好不直接创建adapter,委托相应的Factory进行,也就是通常所说的工厂方法模式。客户提供adapter的时候,需提供与之对应的Factory,BleCenterManager负责管理这些factories,创建adapter的时候只需要调用factory.buildDeviceAdapter()方法即可。Factory针对抽象编程,设计为抽象类,核心代码如下:

  1. abstract class Factory{
  2. protected BleCenterManager mBleCenterManager;
  3. public Factory(BleCenterManager bleCenterManager) {
  4. mBleCenterManager = bleCenterManager;
  5. }
  6. public abstract DeviceAdapter buildDeviceAdapter();
  7. @Override
  8. public String toString() {
  9. return "Factory{}"+getClass().getName();
  10. }
  11. }

Factory与adapter之间关系如下:



Drawing


查找Adapter进行处理

Adapter和Factory设计完后,通过bleCenterManager.addDeviceAdapterFactory()方法添加到BleCenterManager内部的factory列表,添加factory的同时,factory创建对应的adapter并加入到adapter列表。添加完之后,BleCenterManager是如何找到device相匹配的adapter进行处理的呢?答案很简单,逐一遍历adapter列表,查找adapter的supportedNames()方法返回的String列表是否包含设备名。查找到第一个就返回,如果列表遍历后查找不到就抛出异常。核心代码如下:

查找Adapter

  1. private DeviceAdapter findAppropriateDeviceAdapter(BleDevice bleDevice) throws EasyBleException {
  2. //先判断factory是否为空
  3. if (mDeviceAdapterFactories == null || mDeviceAdapterFactories.isEmpty()){
  4. throw new EasyBleException("Device adapter factories empty!");
  5. }
  6. //遍历adapter列表
  7. for (DeviceAdapter adapter:mDeviceAdapters){
  8. String[] nameList = adapter.supportedNames();
  9. if (nameList != null && nameList.length > 0){
  10. for (String name:nameList){
  11. //查找到名字符合的就返回
  12. if (bleDevice.getDeviceName().equalsIgnoreCase(name)){
  13. return adapter;
  14. }
  15. }
  16. }
  17. String[] nameRegExpList = adapter.supportedNameRegExps();
  18. if (nameRegExpList != null && nameRegExpList.length >0){
  19. for (String nameRegExp:nameRegExpList){
  20. if (Pattern.matches(nameRegExp,bleDevice.getDeviceName())){
  21. return adapter;
  22. }
  23. }
  24. }
  25. }
  26. throw new EasyBleUnsupportedDeviceException(bleDevice);
  27. }

查找到adapter后,调用adapter.connectThenStart()方法进行后续协议交互处理。

看完Adapter这部分,很多人都会觉得有些熟悉,这个设计跟Retrofit的CallAdapter很类似。对的,好的设计都是相通的,只是换了个形式,都是常用设计模式:适配器,工厂,单例等的组合。

结束语

通过Adapter与BleCenterManager的结合实现了协议逻辑与APP界面的解耦。上文中的代码只是基本核心示例代码,完整代码已经开源到Github:https://github.com/nziyouren/EasyBle ,欢迎大家contribute。目前库还处于初级阶段,后续逐步会加一些功能,比如从网络加载adapter,如何在APP不升级版本的情况下,动态扩展集成能力。

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注