Android app内角标解决方案 BadgeUtil

前言

在我们的app中可能会遇到各种各样的需求,其中一个还算是比较常见的需求就是给一个需要通知的地方加上角标。

在最近正好需要做这么个东西,所以我本着人人为我我为人人的思想把我的思路拿出来跟大家分享

思路

在自己实现角标功能之前也有同事集成过其他的第三方角标库,但是大部分三方的角标库对我的项目来说并不适用。因为目前大部分的三方角标解决方案都是使用别人写好的View,大部分是实现的FrameLayout。然而当你需要在底部的tab上来实现该功能时就会出现问题,比如说你用的RadioGroup + RadioButton组合来实现的Tab那么你必须将你的tab方案改成LinearLayout + FrameLayout来实现。这样的话可能又会对你的程序结构产生影响,比如你的程序构架与底部的结构有关。。。那么使用起来将会非常麻烦...既然这样.......那不如自己来造个轮子。

如何在使用角标的情况下来保持良好的可拓展性呢?如果费很大劲将工程改成适应某个View的样子,那么一旦项目经理要改需求。。。那心中肯定是一万头草泥马奔腾而过啊。

接下来说说我的实现方案吧

我的实现方案是通过使用时进行自定义View,并重写相应的绘制方法。这听上去比较复杂,但是其实很简单,因为所有的 View实现方法几乎都一样,所以使用起来并不复杂。而且保留了良好的可拓展性,也不破坏原有的程序结构。 详细的使用方法见下一节

预览

Paste_Image.png

gif图片加载比较慢


GIF_20170820_111700.gif

使用方法

  • 1.新建一个自定义View类,并继承你想继承的类,比如RadioButton
  • 2.实现BadgeUtil.Badge 接口并重写接口中的方法
  • 3.实例化一个BadgeUtil.BadgeDrawer 实例并调用实例的draw(canvas)方法。具体的调用分2种情况:

1)当继承的View类仅仅是普通的View,那么需要在onDraw(canvas)方法中来调用draw(canvas);
2)当继承的View类是ViewGroup时,那么需要在dispatchDraw(canvas)方法中来调用draw(canvas);

示例代码如下:

//普通View,比如RadioButton
public class BadgeRadioButton extends AppCompatRadioButton implements BadgeUtil.Badge {
   ......
   private BadgeUtil.BadgeDrawer drawer;

   @Override
   protected void onDraw(Canvas canvas) {
      super.onDraw(canvas);
      if (drawer == null){
          drawer = drawer();
       }
       drawer.draw(canvas);
   }

   @Override
   public BadgeUtil.BadgeDrawer drawer() {
       if (drawer == null) drawer = new BadgeUtil.BadgeDrawer(this);
       return drawer;
   }
   ......
}

//ViewGroup,比如FrameLayout
public class BadgeFrameLayout extends FrameLayout implements BadgeUtil.Badge {
   ......
   private BadgeUtil.BadgeDrawer drawer;

   @Override
   protected void dispatchDraw(Canvas canvas) {
      super.dispatchDraw(canvas);
      if (drawer == null){
          drawer = drawer();
       }
       drawer.draw(canvas);
   }

   @Override
   public BadgeUtil.BadgeDrawer drawer() {
       if (drawer == null) drawer = new BadgeUtil.BadgeDrawer(this);
       return drawer;
   }
   ......
}
  • 4.将xml文件中的View替换成新自定义的BadgeView

以BadgeRadioButton 为例

示例代码如下:

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
   android:orientation="vertical"
   android:layout_width="match_parent"
   android:layout_height="match_parent">

   <FrameLayout
     android:id="@+id/layout_container"
      android:layout_width="match_parent"
      android:layout_height="0dp"
       android:layout_weight="1">

      <TextView
          android:layout_width="wrap_content"
          android:layout_height="wrap_content" 
          android:layout_gravity="center_horizontal"
          android:layout_marginTop="24dp"
          android:textSize="14sp"
          android:lineSpacingMultiplier="1.2"
         android:textColor="#333333"
         android:text="click single view to update themselves \nand click UpdateNumbers button to update all"/>

     <Button
         android:id="@+id/btn_update"
         android:layout_width="wrap_content"
         android:layout_height="40dp"
        android:layout_gravity="center_horizontal|bottom"
         android:layout_marginBottom="60dp"
         android:text="updateNumbers"
         android:paddingLeft="8dp"
         android:paddingRight="8dp"
         android:background="@color/colorPrimary"
         android:textColor="#ffffff"/>

    <com.leobai.library.view.BadgeFrameLayout
        android:id="@+id/frame_badge"
         android:layout_width="wrap_content"
        android:layout_height="wrap_content"
       android:layout_gravity="center">
       <LinearLayout
           android:layout_width="wrap_content"
           android:layout_height="wrap_content"
           android:orientation="vertical"
           android:gravity="center">
          <ImageView
               android:layout_width="wrap_content"
              android:layout_height="wrap_content"
              android:src="@mipmap/ic_launcher_round"/>

               <TextView
                   android:layout_width="wrap_content"
                   android:layout_height="wrap_content"
                   android:text="Frame"
                   android:textColor="#333333"
                   android:layout_marginTop="4dp"
                   />
           </LinearLayout>

       </com.leobai.library.view.BadgeFrameLayout>
   </FrameLayout>

   <RadioGroup
       android:layout_width="match_parent"
       android:layout_height="wrap_content"
       android:orientation="horizontal">
       <com.leobai.library.view.BadgeRadioButton
           android:id="@+id/tab0"
           android:layout_width="0dp"
           android:layout_weight="1"
           android:layout_height="wrap_content"
           android:text="Tab0"
           android:drawableTop="@mipmap/ic_launcher"
           android:button="@null"
           android:gravity="center"/>
       <com.leobai.library.view.BadgeRadioButton
           android:id="@+id/tab1"
           android:layout_width="0dp"
           android:layout_weight="1"
           android:layout_height="wrap_content"
           android:text="Tab1"
           android:drawableTop="@mipmap/ic_launcher"
           android:button="@null"
           android:gravity="center"/>
       <com.leobai.library.view.BadgeRadioButton
           android:id="@+id/tab2"
           android:layout_width="0dp"
           android:layout_weight="1"
           android:layout_height="wrap_content"
           android:text="Tab2"
           android:drawableTop="@mipmap/ic_launcher"
           android:button="@null"
           android:gravity="center"/>
       <com.leobai.library.view.BadgeRadioButton
           android:id="@+id/tab3"
           android:layout_width="0dp"
           android:layout_weight="1"
           android:layout_height="wrap_content"
           android:text="Tab3"
           android:drawableTop="@mipmap/ic_launcher"
           android:button="@null"
           android:gravity="center"/>

   </RadioGroup>

</LinearLayout>
  • 5.调用Badge 的update(number)方法进行更新,或者如果你需要一个统一的管理工具的话可以使用Notifier类:创建一个新的notifer实例,并且把要更新的Badge注册到notifier实例上去并且给Badge设置唯一Id。这时你可以将所有的Badge进行统一升级。
    示例代码:
//对单个Badge进行更新
    private View.OnClickListener badgeOnClickListener = new View.OnClickListener() {
        @Override
        public void onClick(View v) {
            if (v instanceof BadgeUtil.Badge){
                ((BadgeUtil.Badge) v).update((int) (Math.random() * 200));
            }
        }
    };

    //注册Badge到Notifier对象
    private void registerBadges(){
        badgeNotifier = new BadgeUtil.Notifier();
        badgeNotifier.register(tab0);
        badgeNotifier.register(tab1);
        badgeNotifier.register(tab2);
        badgeNotifier.register(tab3);
        badgeNotifier.register(frameBadge);
        tab0.setBadgeId("tab0");
        tab1.setBadgeId("tab1");
        tab2.setBadgeId("tab2");
        tab3.setBadgeId("tab3");
        frameBadge.setBadgeId("frame");
    }

  //使用Notifier对已注册的Badge进行升级
  private View.OnClickListener updateAllOnClickListener = new View.OnClickListener() {
        @Override
        public void onClick(View v) {
            List<BadgeUtil.BadgeNumber> list = new ArrayList<>();

            list.add(new BadgeUtil.BadgeNumber((int) (Math.random() * 200),"tab0"));
            list.add(new BadgeUtil.BadgeNumber((int) (Math.random() * 200),"tab1"));
            list.add(new BadgeUtil.BadgeNumber((int) (Math.random() * 200),"tab2"));
            list.add(new BadgeUtil.BadgeNumber((int) (Math.random() * 200),"tab3"));
            list.add(new BadgeUtil.BadgeNumber((int) (Math.random() * 200),"frame"));

            badgeNotifier.notifyUpdate(list);
        }
    };
  • 6.至此你的自定义角标控件以及使用已基本完成了。是不是看起来比较复杂。

    不过其实我已经替你做好了。我已经替你自定义好了一个BadgeRadioButtonBadgeFrameLayout类,分别对应一个View和ViewGroup类,所以你在使用时可以直接将需要的类复制一份,比如我想要自定义ImageView类型的Badge,你可以将BadgeRadioButton类复制成BadgeImageView,你现在需要做的只是将BadgeImageView的父类从RadioButton改成ImageView就可以了,除非你需要自己定义新的样式,那么类里面的任何代码都不需要改动你就完成了一个新的自定义BadgeImageView,对于ViewGroup来说也是如此。是不是很简单?

List或者Grid中的使用

由于List比较特殊,限于ListView或者RecyclerView的机制,我们不可以单独去对一个item进行更新,所以我们需要一些更进一步的拓展

我在这里提供一种解决方案,让adapter实现BadgeUtil.UpdateAble接口,具体请看代码示例:

public class BadgeGridAdapter extends RecyclerView.Adapter<ViewHolder> implements BadgeUtil.UpdateAble{
    //store your badges to a list on ViewHolder's instantiation.
    List<Badges> badges = new ArrayList<>();

    //override method void updateBadge(List<BadgeNumber> badgeNumbers)
    public void updateBadge(List<BadgeNumber> badgeNumbers){
        //update your badges by ids.
        ...
        ...
    }

    public void onBindViewHolder(ViewHolder holder,int position){
        //update your badge's unique id.
        holder.badge.setId("your unique id,you may store it in Java bean object.");
        ...
    }
}

当然了还有其他的方法来解决这个问题,比如将通知数量信息放在JavaBeen实体类中,在onBindViewHolder中直接更新Badge,这时当你需要更新Badge数量时你需要更新实体类的内容。
其实也还有很多其他方法来做这件事,我在这里不再一一列举,具体选择哪种方式还得看具体项目需求。

结语

总体来说这种方案还是比较方便拓展的,不会遇到使用一种view时一旦改需求非常难办的情况。

博主也是个菜鸟,水平不足,所以有不足之处希望大家可以指出

我已经将完整的代码发布到了Github,如果有需要的同学可以自己移步到github去取,如果大家觉得对自己有用可以star或者fork一下,博主在这里提前谢过大家了:

https://github.com/wjdforever/BadgeUtil

本篇内容为作者原创,转载请注明出处。


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容