Android消息红点计数模型库

2016-12-05 本文已影响913人此屁天下之绝响

最近在写一个社交APP的时候，在控制消息计数，及界面红点显示时总会或多或少有延迟或计数偏差，网上大多是对界面绘制的探讨，而在处理数据处理上相对较少，因此，我琢磨着能写一个快捷方便，且只需要配置一次，之后均自动更新数字，显示、隐藏的库。于是有了它 —— SuperBadge (全局角标数据模型管理库)

demo

模型思路

通过树形结构将数字和红点进行分层管理，只关联父级和子级数据，原则上不越级干扰其他控件，如图例1所示

图例1

根节点 也可理解为顶级节点，是所有子级节点最终的交汇点，其特点为：没有关联的上级节点（父节点），有关联的下级节点（节点A、节点B、节点C），不能进行增加数字和减少数字操作，能进行已读操作【调用read()方法】；
节点A、节点B、节点C 为普通节点，其特点为：有关联的上级节点（根节点），有关联的下级节点（节点1.2.3.4.5.6），不能进行增加数字和减少数字操作，能进行已读操作
节点1.2.3.4.5.6 最下级节点，红点数字的直接数据源。其特点为：有关联的上级节点（节点A、节点B、节点C），没有关联的下级节点，能进行增加数字和减少数字操作，能进行已读操作

举个栗子
主界面有【消息】【好友】【我的】三个模块，那么这三个模块均为独立的[根节点],以消息为例。【消息】节点下面绑定了好友会话A[节点A]、好友会话B[节点B]、好友会话C[节点C]，每个好友会话下面分别绑定语音消息[节点1.3.5] 、文本消息[节点2.4.6]，如图例2所示

图例2.png

这样的设计方式我们能实现那些功能？
如果我们要在主界面标记为读取所有，那么调用【消息】的 read()方法即可，其下所有节点数字均会设置为0（不显示）；同理，如果我们要读取好友会话A，那么调用好友会话A的 read()；语音消息和文本消息数字均会被设置为0，而【消息】节点会减去好友会话A的数字，通过这种方式，我们在对任意一个层级做出数据更新的时候，其上下级都会联动。

为什么不允许非最下级节点之外的节点进行增减操作？
也可以理解为为什么我只允许在直接关联数据的节点上进行增减操作，其原因很容易理解，假设好友会话A发来一条好友文本消息，如果我们直接对好友会话A节点进行+1的操作，因为SuperBadge不干涉业务逻辑，所以我们的下级节点将无法判断新+1的消息是语音消息+1还是文本消息+1，从而导致对整个数据模型的破坏。同理，我们也不能对【消息】节点采取添加方法，SuperBadge将无法知道新的会话是来自好友会话A、B、C其中的哪一个。

同时，为了保证在配置后能全局自动化，我们希望开发者在初始化和绑定好控件之后，可以完全忘记数字的概念，也无需关心增减的状态，而只有读和未读的两种状态 (但即使如此，为了满足一些特定需求，我们依旧提供了增减方法，但只适用于最下级节点调用)

功能分析：自动管理更新全局角标

首先我们需要【BadgeManger】角标绘制管理者在相应控件上绘制角标，比如右上角画一个圆，圆里面有相应的数字；
然后需要一个【SuperBadgeHelper】角标助手记录这个控件信息的对象，并加入全局数据模型队列，在每次刷新界面的时候获取控件角标信息（如有）并显示。
与之相关联的的控件相互绑定，创建树形数据模型。通过【SuperBadgeDater】角标数据管理 - 储存和获取数据，在某个控件发生数据变化的时候对与之相关联的控件做出联动。

通过上面的分析，代码一共由三部分组成

BadgeManger 角标绘制管理者 - 用于在View上绘制角标

因为本文重点是讨论数据模型，所以角标绘制代码借鉴于他人,在此先不多作分析，有兴趣可跳转BadgeView查看。

SuperBadgeHelper 角标助手 - 核心类，处理全局消息计数模型

私有构造方法

/** 
  * @param context 当前Avtivity 
  * @param view    绑定角标view
  * @param tag     全局的唯一标记 
  * @param num     角标数字
  * @param show    是否显示数字
  * @return SuperBadgeHelper */
private SuperBadgeHelper(Activity context, View view, String tag, int num, boolean show) {
  if (SuperBadgeDater.getInstance().getBadge(context,tag) != null) {
      throw new IllegalArgumentException(tag + "标记已经被其他控件注册");
  }
  if (context == null) {
      throw new NullPointerException("context not is null ");
  }
  if (num < 0) {
      throw new IllegalArgumentException("初始化角标数字不能小于0");
  }
  if (tag == null) {
      throw new IllegalArgumentException("tag 不能为空");
  }
  
  this.tag = tag;
  this.view = view;  
  this.num = num;
  this.context = context;
  this.show = show;
  //创建BadgeManger 为控件绘制角标
  badge = new BadgeManger(context);
  badge.setTargetView(view);
  paterAddNum(num);// 添加数字

}

初始化SuperBadgeHelper

public static SuperBadgeHelper init(Activity context, View view, String tag) {
  return init(context, view, tag, 0, true);
}

public static SuperBadgeHelper init(Activity context, View view, String tag, int num) {
  return init(context, view, tag, num, true);
}

public static SuperBadgeHelper init(Activity context, View view, String tag, boolean show) {
  return init(context, view, tag, 0, show);
}

/**
 * @param context 当前Avtivity
 * @param view    绑定角标view
 * @param tag     用于绑定的唯一标记
 * @param num     角标数字
 * @param show    是否显示数字
 * @return SuperBadgeHelper
 */
public static SuperBadgeHelper init(Activity context, View view, String tag, int num, boolean show) {
    //从数据模型里查找是否已有标记为 [tag] 的控件
    SuperBadgeHelper superBadge = SuperBadgeDater.getInstance().getBadge(context,tag);
    if (superBadge != null) { //如有，替换view
        superBadge.setView(view);
        superBadge.setContext(context);
        superBadge.setShowBadge(show);
        superBadge.getBadge().setTargetView(view);
        if (superBadge.isShow()) {  
            superBadge.getBadge().setBadgeCount(superBadge.getNum());
        }
        return superBadge;
    } else {//如没有，新建SuperBadgeHelper 
        return new SuperBadgeHelper(context, view, tag, num, show);
    }
}

绑定关联控件

绑定关联控件是整个数据模型里面最关键的一步，通过下级控件A调用 bindView()方法来与其他控件B保持关系，如果A发生了变化，那么B也会发生相应的变化。

1.提供了两种绑定方法

/**
 * 根据父级控件根据全局唯一标签将他绑定到本级控件
 *
 * @param tag 父级控件的Tag
 */
public void bindView(String tag) {

    for (SuperBadgeHelper pater : paterBadge) {
        if (pater.getTag().equals(tag)) {
            //  throw new IllegalArgumentException("不能重复添加相同控件");
            return;
        }
    }
    SuperBadgeHelper paterBadgeHelper = SuperBadgeDater.getInstance().getBadge(context,tag);
    if (paterBadgeHelper != null) {
        paterBadge.add(paterBadgeHelper); //添加本级父控件
        paterBadgeHelper.addChild(this);//添加到父级子控件
    } else {
        throw new NullPointerException("没有找到标记为[" + tag + "]的控件");
    }
}

 //第二种是根据SuperBadgeHelper（实质上还是根据标签绑定）

public void bindView(SuperBadgeHelper pater) {   
        bindView(pater.getTag());
}

设置为已读

/**
* 读取所有消息，清空数字为0（隐藏角标）
*/
SuperBadgeHelper.read()

增减数字方法

我们希望开发者在初始化和绑定好控件之后，可以完全忘记数字的概念，也无需关心增减的状态，而只有读和未读的两种状态。
！只有最下级节点可以调用

  //减少数字
   SuperBadgeHelper.lessNum(int i)
  //增加数字
   SuperBadgeHelper.addNum(int i)

其他方法请阅读源码

SuperBadgeDater 角标数据管理 - 储存和获取数据

代码很简单，就全部贴上来了，暂时只用Map进行储存，其他储存方式正在设计中

public class SuperBadgeDater implements Serializable {

    private static final SuperBadgeDater Instance = new SuperBadgeDater();

    Map<String, SuperBadgeHelper> map = new HashMap<>();

    private SuperBadgeDater() {

    }
    public static SuperBadgeDater getInstance() {
        return Instance;
    }

    public void addBadge(SuperBadgeHelper superBadge) {
        map.put(superBadge.getTag(), superBadge);
    }
    public SuperBadgeHelper getBadge(String tag) {
        return map.get(tag);
    }
}

使用 SuperBadge

添加依赖

添加在到APP的gradle里

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

添加到项目 gradle的dependency里

dependencies {
    compile 'com.github.chendongde310:SuperBadge:latest.release'
}

最新版本请跳转至我的Github 查看

如何使用

step1 初始化控件

     /**
       * 
       * @param context Activity
       * @param view 绑定角标view
       * @param tag 用于绑定的唯一标记
       * @param num 角标数字
       * @param show 是否显示数字
       * @return SuperBadgeHelper
       */
  SuperBadgeHelper.init(Activity context, View view, String tag, int num,boolean show)

step2 绑定上级控件

  /**
    * 根据父级控件tag绑定父级控件
    * @param tag  父级控件的Tag
    */
    SuperBadgeHelper.bindView(String tag)
    //or
    SuperBadgeHelper.bindView(mSuperBadgeHelper)

step3 设置已读

  /**
  * 读取所有消息，清空数字为0（不显示）
  */
  SuperBadgeHelper.read()

other method

   //增加数字 - 必须为根节点控件 
   addNum(int i)
   //减少数字 - 必须为根节点控件 
   lessNum(int i)
   //是否显示角标
   setShowBadge(boolean b)
   //设置角标半径
   setDipRadius(int dipRadius)
   //设置角标颜色
   setBadgeColor(int badgeColor)

TODO 即将完成

提供自定义绘制方法
（已完成）小红点（不显示具体数字，半径小的红点提示）
read()方法异步（网络、数据库读写）请求失败后的处理
增加将节点标记为未读状态功能（+1s）
桌面（APP图标）角标显示

采用此消息计数模型，配置好后能让开发者最大化的不去关注数字的更新和界面刷新操作，专注于业务逻辑开发。此库可以不必担心界面和控件创建销毁所造成的内存泄漏等问题，如果此库对你有帮助，请花几秒的时间给我一个star，您的支持是对我最大鼓励！

文末提供Demo下载.

我的Githu地址 - http://github.com/chendongde310

如果此库对你有帮助，请花几秒的时间给我一个star，您的支持是对我最大鼓励！如有任何关于此库的问题和疑问，请在下方留言评论或提交issues,感谢阅读

Android消息红点计数模型库

模型思路

功能分析：自动管理更新全局角标

BadgeManger 角标绘制管理者 - 用于在View上绘制角标

SuperBadgeHelper 角标助手 - 核心类，处理全局消息计数模型

私有构造方法

初始化SuperBadgeHelper

绑定关联控件

设置为已读

增减数字方法

其他方法请阅读源码