Android为应用添加角标（Badge）

标签：String EXTRA 角标 intent context INTENT Android Badge

1.需求简介

角标是什么意思呢？

看下图即可明了：

Android为应用添加角标（Badge）_github

可以看到图中的乐购这个app右上角的红色的圆圈，里面有10这个数字的，就是一种角标。

角标，英语是badge，也就是“徽章，像章，奖章；象征，标记”的意思。

一般来说，应用的角标是用来标记有多少条提醒（Notification）没读（unread），一旦点击提示进应用阅读了，角标也会消失。

2. Android角标起源

角标原本是苹果的iOS中的东西，Android原生并不支持角标，因为Google的意思是让大家用Notification（提示栏）即可，角标实在大有让处女座“跳崖”的风险。幸好我不是...

最近公司的项目中，客户的一个新需求是在我们的加密信息应用上加上角标功能，因为我们的合作伙伴是三星（可以参看我的这篇文章：程序员在法国 | 我被法国国防部盯上了!），因此我就去网上找相关资料。

找的时候，才知道上面所说的Android原生不支持角标一事。不过无妨，厉害的Android第三方厂商可以通过在自定义的Launcher（启动器）中操作来实现添加角标。

我在第一时间当然是去找三星的移动设备如何添加角标，不过却有幸找到了Github上的比较普适的项目。

把我导向Github的自然是Stack Overflow，而把我导向Stack Overflow的就是Google，因此我会说：

为什么程序员一定要会用Google和Stack Overflow？。

3. 不错的Github项目

一般来说，现在被引用最多的Android添加和去除角标的Github项目是这位中国人写的：

https://github.com/leolin310148/ShortcutBadger

这个项目挺不错，虽然更新不是特别勤快，但最近一次更新是在2016年10月31日，也就是两个月前，还可以接受。

《Android群英传》和《Android群英传：神兵利器》的作者徐宜生也在自己的Github上建了一个项目：

https://github.com/xuyisheng/ShortcutHelper ，挺有意思，里面还有号称“疯狂模式”的为所有在手机桌面上的应用加上99的角标数的功能，当然了，去除的代码也有，不然处女座岂不是要晕了～

添加角标的原理就是发送一个Broadcast（广播），在广播的Intent中指定需要被添加角标的应用的packageName（包名），className（类名），count（角标数目）。当然了，不同厂商的手机的角标操作的Intent的action是不一样的。

因此，我们如果要给自己的手机里的应用添加角标，只需要简单的利用上面两个项目中的代码即可，一般不需要把全部项目搬过来。当然了，如果你要适配所有手机，那么可以全盘引用项目。

比如我要给三星的手机的应用添加角标，那么我只需要做以下的几步即可：

在AndroidManifest.xml中添加读取和写入角标的权限：

<uses-permission android:name="com.sec.android.provider.badge.permission.READ" /><uses-permission android:name="com.sec.android.provider.badge.permission.WRITE" />

自己写一个类，随便取名字，比如叫做 BadgeUtils，在类中添加如下内容：

public class BadgeUtils {
  private static final String INTENT_ACTION = "android.intent.action.BADGE_COUNT_UPDATE";
  private static final String INTENT_EXTRA_BADGE_COUNT = "badge_count";
  private static final String INTENT_EXTRA_PACKAGENAME = "badge_count_package_name";
  private static final String INTENT_EXTRA_ACTIVITY_NAME = "badge_count_class_name";

  public static void setBadgeCount(Context context, ComponentName componentName, int badgeCount) {
    Intent intent = new Intent(INTENT_ACTION);     
    intent.putExtra(INTENT_EXTRA_BADGE_COUNT, badgeCount);    
    intent.putExtra(INTENT_EXTRA_PACKAGENAME, componentName.getPackageName());    
    intent.putExtra(INTENT_EXTRA_ACTIVITY_NAME, componentName.getClassName());
    context.sendBroadcast(intent);  
  }
}

使用上面的代码时，只需要传入三个参数，也就是：

Context ：应用的Context。简单。

ComponentName ：组件名，略有点麻烦。可以这样来获取（applicationContext就是应用的Context）：

applicationContext.getPackageManager()
.getLaunchIntentForPackage(applicationContext.getPackageName())
.getComponent()

badgeCount ：角标的数目，例如10。简单。

当然了，如果你不想要传入三个参数这么麻烦，你也可以再写一个方法getLauncherClassName，就只需要传入两个参数即可。BadgeUtils中的代码变为：

public class BadgeUtils {
  private static final String INTENT_ACTION = "android.intent.action.BADGE_COUNT_UPDATE";
  private static final String INTENT_EXTRA_BADGE_COUNT = "badge_count";
  private static final String INTENT_EXTRA_PACKAGENAME = "badge_count_package_name";
  private static final String INTENT_EXTRA_ACTIVITY_NAME = "badge_count_class_name";

  public static void setBadgeCount(Context context, int badgeCount) {
    String launcherClassName = getLauncherClassName(context);
    if (launcherClassName == null) {
      return;
    }

    Intent intent = new Intent(INTENT_ACTION);     
    intent.putExtra(INTENT_EXTRA_BADGE_COUNT, badgeCount);    
    intent.putExtra(INTENT_EXTRA_PACKAGENAME, context.getPackageName());    
    intent.putExtra(INTENT_EXTRA_ACTIVITY_NAME, launcherClassName);

    context.sendBroadcast(intent);  
  }

  private static String getLauncherClassName(Context context) {
    PackageManager pm = context.getPackageManager();

    Intent intent = new Intent(Intent.ACTION_MAIN); 
    intent.addCategory(Intent.CATEGORY_LAUNCHER);

    List<ResolveInfo> resolveInfos = pm.queryIntentActivities(intent, 0);
    for (ResolveInfo resolveInfo : resolveInfos) {
      String pkgName = resolveInfo.activityInfo.applicationInfo.packageName;
      if (pkgName.equalsIgnoreCase(context.getPackageName())) {
        String className = resolveInfo.activityInfo.name;
        return className;
      }
    }
    return null; 
  }
}

使用时传入两个参数即可：

Context ：应用的Context。

badgeCount ：角标的数目，例如10。

4. 清除角标

要清除应用的角标就很简单了，给badgeCount传入0即可。

BadgeUtils.setBadgeCount(context,       
context.getPackageManager()               
.getLaunchIntentForPackage(context.getPackageName())                
.getComponent(),        
0);

或者

BadgeUtils.setBadgeCount(context, 0);

5. 小问题纠错

上面的 https://github.com/leolin310148/ShortcutBadger 这个项目中，基本已经包含了大多数可以定制角标的Android生产厂商的添加角标的代码实现，不过它也提到：

三星和LG（这两个难兄难弟）的代码有很多类似，连角标处理的广播的Intent中的action也是一样的，都是：

"android.intent.action.BADGE_COUNT_UPDATE"

但是作者在三星和LG的两个角标操作实现类中写了注释：

// Deprecated, Samsung devices will use DefaultBadger

// Deprecated, LG devices will use DefaultBadger

意思是“三星和LG的实现代码已经Deprecated（失效了），请用DefaultBadger类”。

因此，这两个需要用 https://github.com/leolin310148/ShortcutBadger/blob/master/ShortcutBadger/src/main/java/me/leolin/shortcutbadger/impl/DefaultBadger.java 中的实现：

private static final String INTENT_ACTION = "android.intent.action.BADGE_COUNT_UPDATE";
private static final String INTENT_EXTRA_BADGE_COUNT = "badge_count";
private static final String INTENT_EXTRA_PACKAGENAME = "badge_count_package_name";
private static final String INTENT_EXTRA_ACTIVITY_NAME = "badge_count_class_name";

@Override
public void executeBadge(Context context, ComponentName componentName, int badgeCount) throws ShortcutBadgeException {
  Intent intent = new Intent(INTENT_ACTION);
  intent.putExtra(INTENT_EXTRA_BADGE_COUNT, badgeCount);
  intent.putExtra(INTENT_EXTRA_PACKAGENAME, componentName.getPackageName());
  intent.putExtra(INTENT_EXTRA_ACTIVITY_NAME, componentName.getClassName());

  if (BroadcastHelper.canResolveBroadcast(context, intent)) {
    context.sendBroadcast(intent);
  } else {
    throw new ShortcutBadgeException("unable to resolve intent: " + intent.toString());
  }
}

不过上面的代码有一个小问题，就是那句

if (BroadcastHelper.canResolveBroadcast(context, intent)) {

在有些设备（比如Samsung Galaxy S5）上会抛出异常（Exception），找不到处理"android.intent.action.BADGE_COUNT_UPDATE"这个Intent的BroadcastReceiver，很奇怪。

但有些设备（比如Samsung Galaxy A5）上又运行正常，没有抛出异常。

解决办法是去除这一个检测，把

if (BroadcastHelper.canResolveBroadcast(context, intent)) {
  context.sendBroadcast(intent);
} else {
  throw new ShortcutBadgeException("unable to resolve intent: " + intent.toString());
}

替换为简单的