修复 Toast 在关闭通知栏权限后无法在后台显示的问题

新增支持 ActivityToast 设置显示动画和显示时长

Author: getActivity

README.md

@@ -4,9 +4,11 @@
 
 * 博客地址：[只需体验三分钟，你就会跟我一样，爱上这款 Toast](https://www.jianshu.com/p/9b174ee2c571)
 
-* 已投入公司项目多时，没有任何毛病，可胜任任何需求，[点击此处下载Demo](ToastUtils.apk)
+* 可以扫码下载 Demo 进行演示或者测试，如果扫码下载不了的，[点击此处可直接下载](https://github.com/getActivity/ToastUtils/releases/download/10.0/ToastUtils.apk)
 
-![](ToastUtils.jpg)
+![](picture/demo_code.png)
+
+![](picture/demo_page.jpg)
 
 #### 集成步骤
 
@@ -38,7 +40,7 @@ android {
 
 dependencies {
     // 吐司框架：https://github.com/getActivity/ToastUtils
-    implementation 'com.github.getActivity:ToastUtils:9.6'
+    implementation 'com.github.getActivity:ToastUtils:10.0'
 }
 ```
 
@@ -97,41 +99,67 @@ ToastUtils.setInterceptor(IToastInterceptor interceptor);
 ToastUtils.getInterceptor();
 ```
 
+* 如果你需要对 Toast 的进行定制化，可以使用以下方式
+
+```java
+ToastUtils.init(this, new ToastStrategy() {
+
+    @Override
+    public IToast createToast(Application application) {
+        IToast toast = super.createToast(application);
+        if (toast instanceof ActivityToast) {
+            ActivityToast activityToast = ((ActivityToast) toast);
+            // 设置 Toast 动画效果
+            activityToast.setAnimationsId(R.anim.xxx);
+            // 设置短 Toast 的显示时长（默认是 2000 毫秒）
+            activityToast.setShortDuration(1000);
+            // 设置长 Toast 的显示时长（默认是 3500 毫秒）
+            activityToast.setLongDuration(5000);
+        }
+        return toast;
+    }
+});
+```
+
+* 这种方式的缺点是只有应用在前台的情况下才会生效，这是因为前台的 Toast 是用框架实现的，本质上是一个 WindowManager，优点是非常灵活，不受原生 Toast 机制限制，缺点是无法在后台的情况下显示；而后台的 Toast 是用系统来实现的，优点是能在后台的情况下显示，缺点是局限性非常大，无法做太深的定制化；而框架正是利用了两种方式的优缺点进行了互补。
+
 ### 温馨提示：框架意在解决一些常规的 Toast 需求，如果是有一些特殊的定制化需求请配搭 [XToast](https://github.com/getActivity/XToast) 悬浮窗框架使用
 
-### 不同 Toast 框架之间的对比
+#### 不同 Toast 框架之间的对比
 
 |  功能或细节  | [ToastUtils](https://github.com/getActivity/ToastUtils) | [AndroidUtilCode](https://github.com/Blankj/AndroidUtilCode)  | [Toasty](https://github.com/GrenderG/Toasty) |
 | :----: | :------: |  :-----: |  :-----: |
-|    对应版本  |  9.6 |  1.30.6  |  1.5.0  |
+|    对应版本  |  10.0 |  1.30.6  |  1.5.0  |
 |    issues 数   |  [![](https://img.shields.io/github/issues/getActivity/ToastUtils.svg)](https://github.com/getActivity/ToastUtils/issues)  |  [![](https://img.shields.io/github/issues/Blankj/AndroidUtilCode.svg)](https://github.com/Blankj/AndroidUtilCode/issues)  |  [![](https://img.shields.io/github/issues/GrenderG/Toasty.svg)](https://github.com/GrenderG/Toasty/issues)  |
-|                  **aar 包大小**                 | 22 KB | 500 KB | 50 KB |
+|                  **aar 包大小**                 | 26 KB | 500 KB | 50 KB |
 |                  **调用代码定位**                |  ✅  |  ❌  |  ❌  |
 |                支持在子线程中调用显示              |  ✅  |  ✅  |  ❌  |
 |           支持全局设置统一 Toast 样式              |  ✅  |  ❌  |  ❌  |
 |        处理 Toast 在 Android 7.1 崩溃的问题       |  ✅  |  ✅  |  ❌  |
-|      兼容通知栏权限关闭后 Toast 显示不出来的问题      |  ✅  |  ✅  |  ❌  |
-| 适配 Android 11 不能在后台显示自定义样式 Toast 的问题 |  ✅  |  ❌  |  ❌  |
+|      兼容通知栏权限关闭后 Toast 显示不出来的问题      |  ✅  |  ❌  |  ❌  |
+|     适配 Android 11 不能在后台显示 Toast 的问题        |  ✅  |  ❌  |  ❌  |
 
 #### 调用代码定位功能介绍
 
-* 框架会在日志打印中输出在 Toast 调用的代码位置，这样开发者可以直接通过点击 Log 来定位是在哪个类哪行代码调用的，这样可以极大提升我们排查问题的效率，特别是 Toast 的内容是由后台返回的情况下，我相信没有一个人会拒绝这样的功能。
+* 框架会在日志打印中输出在 Toast 调用的代码位置，这样开发者可以直接通过点击 Log 来定位是在哪个类哪行代码调用的，这样可以极大提升我们排查问题的效率，特别是 Toast 的内容是由后台返回的情况下，我相信没有任何一个人会拒绝这样的功能。
 
-![](RequestCode.jpg)
+![](picture/logcat_code.jpg)
 
 #### Toast 在 Android 7.1 崩溃的问题介绍
 
-* 这个问题是由于 Android 7.1 加入 WindowToken 校验机制导致的，而这个 WindowToken 是 NotificationManagerService 生成的，这个 WindowToken 是存在一定时效性的，而当应用的主线程被阻塞时，WindowManager 在 addView 时会对 WindowToken 进行校验，但是 WindowToken 已经过期了，这个时候 addView 的时候就会抛出异常。
+* 这个问题是由于 Android 7.1 加入 WindowToken 校验机制导致的，而这个 WindowToken 是 NotificationManagerService 生成的，这个 WindowToken 是存在一定时效性的，而当应用的主线程被阻塞时，WindowManager 在 addView 时会对 WindowToken 进行校验，但是 WindowToken 已经过期了，这个时候 addView 就会抛出异常。
 
 * 谷歌在 Android 8.0 就修复了这个问题，修复方式十分简单粗暴，就是直接捕获这个异常，而框架的修复思路跟谷歌类似，只不过修复方式不太一样，因为框架无法直接修改系统源码，所以是直接通过 Hook 的方式对异常进行捕获，大家如果对修复过程感兴趣可以看一下我写的这篇文章[Toast 在 Android 7.1 崩溃排查及修复](https://www.jianshu.com/p/437f473017d6)。
 
 #### 通知栏权限关闭后 Toast 显示不出来的问题介绍
 
-* 这个问题的出现是因为原生 Toast 的显示要通过 NMS（NotificationManagerService） 才会 addView 到 Window 上面，而在 NMS 中有一个 `static final boolean ENABLE_BLOCKED_TOASTS = true` 的字段，当这个常量值为 true 时，会触发 NMS 对应用通知栏权限的检查，如果没有通知栏权限，那么这个 Toast 将会被 NMS 所拦截，并输出 `Suppressing toast from package` 日志信息，而小米手机没有这个问题是因为它是将 `ENABLE_BLOCKED_TOASTS` 字段值修改成 `false`，所以就不会触发对通知栏权限的检查，另外我为什么会知道有这个事情？因为我曾经和一名 MIUI 工程师一起确认过这个事情，不过值得一提的是，这个问题在 Android 9.0 的版本已经修复了。
+* [Toast通知栏权限填坑指南](https://www.jianshu.com/p/1d64a5ccbc7c)
+
+* 这个问题的出现是因为原生 Toast 的显示要通过 NMS（NotificationManagerService） 才会 addView 到 Window 上面，而在 NMS 中有一个 `static final boolean ENABLE_BLOCKED_TOASTS = true` 的字段，当这个常量值为 true 时，会触发 NMS 对应用通知栏权限的检查，如果没有通知栏权限，那么这个 Toast 将会被 NMS 所拦截，并输出 `Suppressing toast from package` 日志信息，而小米手机没有这个问题是因为它是将 `ENABLE_BLOCKED_TOASTS` 字段值修改成 `false`，所以就不会触发对通知栏权限的检查，另外我为什么会知道有这个事情？因为我曾经和一名 MIUI 工程师一起确认过这个事情。
 
-* 框架处理这个问题的方式很简单，是在显示 Toast 的时候判断是否有通知栏权限，如果有则显示系统的 Toast，如果没有则使用 WindowManager 来代替显示，大家如果对修复过程感兴趣可以看一下我写的这篇文章[Toast通知栏权限填坑指南](https://www.jianshu.com/p/1d64a5ccbc7c)。
+* 框架处理这个问题的方式有两种，先判断当前应用是否处于前台状态，如果是则使用自定义的 WindowManager 代替 Toast 来显示，如果当前应用处于后台状态，则会通过 Hook Toast 中的 INotificationManager 接口，将 enqueueToast 方法传递的包名参数修改成 `android` 来欺骗 NotificationManagerService，因为 NotificationManagerService 已经将 `android` 包名的应用纳入白名单，会自动放行，需要注意的是，这种方式在 Android 10 上面已经失效了，已经被系统纳入反射黑名单，但是好消息是，通过查看和对比 NotificationManagerService 源码发现，这个问题已经在 Android 10.0 的版本上面被修复了，所以框架只在 Android 9.0 及以下版本并且在关闭了通知栏权限的情况下才去 Hook INotificationManager，这样就能比较完美地解决这一问题，另外我还找到了官方关于这块的代码提交记录：[Always allow toasts from foreground apps](https://cs.android.com/android/_/android/platform/frameworks/base/+/58b2453ed69197d765c7254241d9966ee49a3efb)，大家可以感兴趣可以看看。
 
-#### Android 11 不能在后台显示自定义样式 Toast 的问题介绍
+#### Android 11 不能在后台显示 Toast 的问题介绍
 
 * 当我们将 targetSdkVersion 改成 30 及以上的版本时，会发现一个问题，如果应用处于后台进程的情况下，而恰好我们的应用 Toast 样式是经过定制的，那么在这些情况下调用 Toast 的 show 方法会惊奇的发现，Toast 没有显示出来，请注意这个问题不是 Bug，而是 Android 11 禁止了这种行为，在 [Toast 官方文档](https://developer.android.google.cn/reference/android/widget/Toast#setView(android.view.View)) 中也有注明，不建议对 Toast 的样式做定制化，并且还对 `Toast.setView` 方法进行了标记过时处理。
 
@@ -165,8 +193,6 @@ ToastUtils.getInterceptor();
 Toast\.makeText\([^,]+,\s*(.+{1}),\s*[^,]+\)\.show\(\)
 ```
 
----
-
 ```text
 ToastUtils.show($1)
 ```
@@ -177,8 +203,6 @@ ToastUtils.show($1)
 import android.widget.Toast
 ```
 
----
-
 ```text
 import com.hjq.toast.ToastUtils
 ```
@@ -238,4 +262,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-```
+```

ToastUtils.apk

@@ -1,14 +1,14 @@
 apply plugin: 'com.android.application'
 
 android {
-    compileSdkVersion 30
+    compileSdkVersion 31
 
     defaultConfig {
         applicationId "com.hjq.toast.demo"
         minSdkVersion 16
-        targetSdkVersion 30
-        versionCode 96
-        versionName "9.6"
+        targetSdkVersion 31
+        versionCode 1000
+        versionName "10.0"
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
     }
 
@@ -59,9 +59,6 @@ dependencies {
     // Material 库：https://github.com/material-components/material-components-android
     implementation 'com.google.android.material:material:1.4.0'
 
-    // 权限请求框架：https://github.com/getActivity/XXPermissions
-    implementation 'com.github.getActivity:XXPermissions:12.3'
-
     // 标题栏框架：https://github.com/getActivity/TitleBar
     implementation 'com.github.getActivity:TitleBar:9.2'
 

app/build.gradle

@@ -13,9 +13,8 @@
 
         <activity
             android:name=".ToastActivity"
-            android:configChanges="orientation|screenSize|keyboardHidden"
-            android:launchMode="singleTop"
-            android:screenOrientation="portrait">
+            android:exported="true">
+
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
                 <action android:name="android.intent.action.VIEW" />

app/src/main/AndroidManifest.xml

@@ -10,8 +10,6 @@
 import androidx.appcompat.app.AppCompatActivity;
 
 import com.google.android.material.snackbar.Snackbar;
-import com.hjq.permissions.Permission;
-import com.hjq.permissions.XXPermissions;
 import com.hjq.toast.ToastUtils;
 import com.hjq.toast.style.BlackToastStyle;
 import com.hjq.toast.style.WhiteToastStyle;
@@ -63,45 +61,33 @@ public void show5(View v) {
     }
 
     public void show6(View v) {
-        if (XXPermissions.isGranted(this, Permission.NOTIFICATION_SERVICE)) {
+        Snackbar.make(getWindow().getDecorView(), "正在准备跳转到手机桌面，请系好安全带", Snackbar.LENGTH_SHORT).show();
 
-            Snackbar.make(getWindow().getDecorView(), "正在准备跳转到手机桌面，请注意有极少数机型无法在后台显示 Toast", Snackbar.LENGTH_SHORT).show();
-
-            v.postDelayed(new Runnable() {
-                @Override
-                public void run() {
-                    Intent intent = new Intent(Intent.ACTION_MAIN);
-                    intent.addCategory(Intent.CATEGORY_HOME);
-                    startActivity(intent);
-                }
-            }, 2000);
-
-            v.postDelayed(new Runnable() {
-                @Override
-                public void run() {
-                    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
-                        ToastUtils.show("我是在后台显示的 Toast（Android 11 及以上在后台显示 Toast 只能使用系统样式）");
-                    } else {
-                        ToastUtils.show("我是在后台显示的 Toast");
-                    }
-                }
-            }, 3000);
-
-        } else {
+        v.postDelayed(new Runnable() {
+            @Override
+            public void run() {
+                Intent intent = new Intent(Intent.ACTION_MAIN);
+                intent.addCategory(Intent.CATEGORY_HOME);
+                startActivity(intent);
+            }
+        }, 2000);
 
-            ToastUtils.show("在后台显示 Toast 需要先获取通知栏权限");
-            v.postDelayed(new Runnable() {
-                @Override
-                public void run() {
-                    XXPermissions.startPermissionActivity(ToastActivity.this, Permission.NOTIFICATION_SERVICE);
+        v.postDelayed(new Runnable() {
+            @Override
+            public void run() {
+                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {
+                    ToastUtils.show("我是在后台显示的 Toast（Android 11 及以上在后台显示 Toast 只能使用系统样式）");
+                } else {
+                    ToastUtils.show("我是在后台显示的 Toast");
                 }
-            }, 2000);
-        }
+            }
+        }, 3000);
     }
 
     public void show7(View v) {
-        new XToast<>(ToastActivity.this)
+        new XToast<>(this)
                 .setDuration(1000)
+                // 将 ToastUtils 中的 View 转移给 XToast 来显示
                 .setContentView(ToastUtils.getStyle().createView(getApplication()))
                 .setAnimStyle(android.R.style.Animation_Translucent)
                 .setText(android.R.id.message, "就问你溜不溜")

app/src/main/java/com/hjq/toast/demo/ToastActivity.java

@@ -3,7 +3,7 @@
 buildscript {
     repositories {
         // 阿里云云效仓库：https://maven.aliyun.com/mvn/guide
-        maven { url 'https://maven.aliyun.com/repository/jcenter' }
+        maven { url 'https://maven.aliyun.com/repository/public' }
         maven { url 'https://maven.aliyun.com/repository/google' }
         // 华为开源镜像：https://mirrors.huaweicloud.com/
         maven { url 'https://repo.huaweicloud.com/repository/maven/' }
@@ -21,7 +21,7 @@ buildscript {
 
 allprojects {
     repositories {
-        maven { url 'https://maven.aliyun.com/repository/jcenter' }
+        maven { url 'https://maven.aliyun.com/repository/public' }
         maven { url 'https://maven.aliyun.com/repository/google' }
         maven { url 'https://repo.huaweicloud.com/repository/maven/' }
         maven { url 'https://jitpack.io' }

build.gradle

@@ -1,12 +1,12 @@
 apply plugin: 'com.android.library'
 
 android {
-    compileSdkVersion 30
+    compileSdkVersion 31
 
     defaultConfig {
         minSdkVersion 14
-        versionCode 96
-        versionName "9.6"
+        versionCode 1000
+        versionName "10.0"
     }
 
     // 使用 JDK 1.8

library/build.gradle

@@ -12,7 +12,7 @@
  *    time   : 2018/11/02
  *    desc   : 自定义 Toast（用于解决关闭通知栏权限之后不能弹吐司的问题和 Android 11 不能自定义吐司样式的问题）
  */
-public final class ActivityToast implements IToast {
+public class ActivityToast implements IToast {
 
     /** Toast 实现类 */
     private final ToastImpl mToastImpl;
@@ -33,6 +33,12 @@ public final class ActivityToast implements IToast {
     private float mHorizontalMargin;
     /** 垂直间距 */
     private float mVerticalMargin;
+    /** Toast 动画 */
+    private int mAnimations = android.R.style.Animation_Toast;
+    /** 短吐司显示的时长 */
+    private int mShortDuration = 2000;
+    /** 长吐司显示的时长 */
+    private int mLongDuration = 3500;
 
     public ActivityToast(Activity activity) {
         mToastImpl = new ToastImpl(activity, this);
@@ -128,4 +134,28 @@ public float getHorizontalMargin() {
     public float getVerticalMargin() {
         return mVerticalMargin;
     }
+
+    public void setAnimationsId(int animationsId) {
+        mAnimations = animationsId;
+    }
+
+    public int getAnimationsId() {
+        return mAnimations;
+    }
+
+    public void setShortDuration(int duration) {
+        mShortDuration = duration;
+    }
+
+    public int getShortDuration() {
+        return mShortDuration;
+    }
+
+    public void setLongDuration(int duration) {
+        mLongDuration = duration;
+    }
+
+    public int getLongDuration() {
+        return mLongDuration;
+    }
 }

library/src/main/java/com/hjq/toast/ActivityToast.java

@@ -0,0 +1,37 @@
+package com.hjq.toast;
+
+import java.lang.reflect.InvocationHandler;
+import java.lang.reflect.Method;
+
+/**
+ *    author : Android 轮子哥
+ *    github : https://github.com/getActivity/ToastUtils
+ *    time   : 2021/11/13
+ *    desc   : 通知服务代理代理对象
+ */
+final class NotificationServiceProxy implements InvocationHandler {
+
+    /** 被代理的对象 */
+    private final Object mSource;
+
+    public NotificationServiceProxy(Object source) {
+        mSource = source;
+    }
+
+    @Override
+    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
+        switch (method.getName()) {
+            case "enqueueToast":
+            case "enqueueToastEx":
+            case "cancelToast":
+                // 将包名修改成系统包名，这样就可以绕过系统的拦截
+                // 部分华为机将 enqueueToast 修改成了 enqueueToastEx
+                args[0] = "android";
+                break;
+            default:
+                break;
+        }
+        // 使用动态代理
+        return method.invoke(mSource, args);
+    }
+}