Skip to content

getActivity/EasyWindow

BranchesTags

Repository files navigation

悬浮窗框架

本框架意在解决一些悬浮窗的需求，如果是普通的 Toast 封装推荐使用 Toaster

集成步骤

  • 如果你的项目 Gradle 配置是在 7.0 以下，需要在 build.gradle 文件中加入
allprojects {
    repositories {
        // JitPack 远程仓库：https://jitpack.io
        maven { url 'https://jitpack.io' }
    }
}
  • 如果你的 Gradle 配置是 7.0 及以上，则需要在 settings.gradle 文件中加入
dependencyResolutionManagement {
    repositories {
        // JitPack 远程仓库：https://jitpack.io
        maven { url 'https://jitpack.io' }
    }
}
  • 配置完远程仓库后，在项目 app 模块下的 build.gradle 文件中加入远程依赖
android {
    // 支持 JDK 1.8
    compileOptions {
        targetCompatibility JavaVersion.VERSION_1_8
        sourceCompatibility JavaVersion.VERSION_1_8
    }
}

dependencies {
    // 悬浮窗框架：https://github.com/getActivity/EasyWindow
    implementation 'com.github.getActivity:EasyWindow:12.0'
}

AndroidX 兼容

  • 如果项目是基于 AndroidX 包，请在项目 gradle.properties 文件中加入
# 表示将第三方库迁移到 AndroidX
android.enableJetifier = true

使用案例

  • Java 用法
// 传入 Activity 对象表示设置成局部的，不需要有悬浮窗权限
// 传入 Application 对象表示设置成全局的，但需要有悬浮窗权限
EasyWindow.with(this)
        .setContentView(R.layout.toast_hint)
        // 设置成可拖拽的
        //.setWindowDraggableRule()
        // 设置显示时长
        .setWindowDuration(1000)
        // 设置动画样式
        //.setAnimStyle(android.R.style.Animation_Translucent)
        // 设置外层是否能被触摸
        //.setOutsideTouchable(false)
        // 设置窗口背景阴影强度
        //.setBackgroundDimAmount(0.5f)
        .setImageDrawableByImageView(android.R.id.icon, R.mipmap.ic_dialog_tip_finish)
        .setTextByTextView(android.R.id.message, "点我消失")
        .setOnClickListenerByView(android.R.id.message, new OnWindowViewClickListener<TextView>() {

            @Override
            public void onClick(@NonNull EasyWindow<?> easyWindow, @NonNull TextView view) {
                // 有两种方式取消弹窗：
                // 1. easyWindow.cancel：顾名思义，取消显示
                // 2. easyWindow.recycle：在取消显示的基础上，加上了回收
                // 这两种区别在于，cancel 之后还能 show，但是 recycle 之后不能再 show
                // 通常情况下，如果你创建的 EasyWindow 对象在 cancel 之后永远不会再显示，取消弹窗建议直接用 recycle 方法，否则用 cancel 方法
                easyWindow.recycle();
                // 跳转到某个Activity
                // easyWindow.startActivity(intent);
            }
        })
        .show();
  • Kotlin 用法（二选一）
EasyWindow.with(activity).apply {
    setContentView(R.layout.toast_hint)
    // 设置成可拖拽的
    //setWindowDraggableRule()
    // 设置显示时长
    setWindowDuration(1000)
    // 设置动画样式
    //setAnimStyle(android.R.style.Animation_Translucent)
    // 设置外层是否能被触摸
    //setOutsideTouchable(false)
    // 设置窗口背景阴影强度
    //setBackgroundDimAmount(0.5f)
    setImageDrawableByImageView(android.R.id.icon, R.mipmap.ic_dialog_tip_finish)
    setTextByTextView(android.R.id.message, "点我消失")
    setOnClickListenerByView(android.R.id.message, OnWindowViewClickListener<TextView?> { easyWindow: EasyWindow<*>, view: TextView ->
        // 有两种方式取消弹窗：
        // 1. easyWindow.cancel：顾名思义，取消显示
        // 2. easyWindow.recycle：在取消显示的基础上，加上了回收
        // 这两种区别在于，cancel 之后还能 show，但是 recycle 之后不能再 show
        // 通常情况下，如果你创建的 EasyWindow 对象在 cancel 之后永远不会再显示，取消弹窗建议直接用 recycle 方法，否则用 cancel 方法
        easyWindow.recycle()
        // 跳转到某个Activity
        // easyWindow.startActivity(intent)
    })
}.show()
EasyWindow.with(activity)
        .setContentView(R.layout.toast_hint)
        // 设置成可拖拽的
        //.setWindowDraggableRule()
        // 设置显示时长
        .setWindowDuration(1000)
        // 设置动画样式
        //.setAnimStyle(android.R.style.Animation_Translucent)
        // 设置外层是否能被触摸
        //.setOutsideTouchable(false)
        // 设置窗口背景阴影强度
        //.setBackgroundDimAmount(0.5f)
        .setImageDrawableByImageView(android.R.id.icon, R.mipmap.ic_dialog_tip_finish)
        .setTextByTextView(android.R.id.message, "点我消失")
        .setOnClickListenerByView(android.R.id.message, OnWindowViewClickListener<TextView?> { easyWindow: EasyWindow<*>, view: TextView ->
            // 有两种方式取消弹窗：
            // 1. easyWindow.cancel：顾名思义，取消显示
            // 2. easyWindow.recycle：在取消显示的基础上，加上了回收
            // 这两种区别在于，cancel 之后还能 show，但是 recycle 之后不能再 show
            // 通常情况下，如果你创建的 EasyWindow 对象在 cancel 之后永远不会再显示，取消弹窗建议直接用 recycle 方法，否则用 cancel 方法
            easyWindow.recycle()
            // 跳转到某个Activity
            // easyWindow.startActivity(intent)
        })
        .show()

没有悬浮窗权限如何全局显示？

  • 没有悬浮窗权限是不能全局显示在其他应用上的，但是全局显示在自己的应用上是可以实现的

  • 但是当前 Activity 创建的悬浮窗只能在当前 Activity 上面显示，如果想在所有的 Activity 都显示需要做特殊处理

  • 我们可以通过 Application 来监听所有 Activity 的生命周期方法，然后在每个 Activity.onCreate 时创建悬浮窗

public final class WindowLifecycleControl implements Application.ActivityLifecycleCallbacks {

    static void with(Application application) {
        application.registerActivityLifecycleCallbacks(new FloatingLifecycle());
    }

    @Override
    public void onActivityCreated(Activity activity, Bundle savedInstanceState) {
        EasyWindow.with(activity)
                .setView(R.layout.xxx)
                .show();
    }

    @Override
    public void onActivityStarted(Activity activity) {}

    @Override
    public void onActivityResumed(Activity activity) {}

    @Override
    public void onActivityPaused(Activity activity) {}

    @Override
    public void onActivityStopped(Activity activity) {}

    @Override
    public void onActivitySaveInstanceState(Activity activity, Bundle outState) {}

    @Override
    public void onActivityDestroyed(Activity activity) {}
}

LeakCanary 一直报内存泄漏怎么办？

  • 这个问题是 EasyWindow 取消显示之后，没有回收资源才会出现的，目前比较好的解决方案是增加一个取消监听，然后在里面调用 recycle 方法即可
EasyWindow.with(this)
        .setOnWindowLifecycleCallback(new OnWindowLifecycleCallback() {

            @Override
            public void onWindowCancel(@NonNull EasyWindow<?> easyWindow) {
                // 在窗口消失的时候回收资源，避免 LeakCanary 一直报内存泄漏
                easyWindow.recycle();
            }
        })
        .show();

  • 到这里你可能会有一个疑惑，这样的代码为什么框架不内部进行处理？而是交给外层开发者去处理，这难道不是脱裤子放屁？在这里我觉得有必要解释一下，原因有以下两点：

    1. 不是框架不会处理，而是不能处理，因为窗口取消的时候，直接帮你回收窗口资源，如果你在外层持有了 easyWindow 对象，并且调用了相关的方法，会导致不会奏效，例如你取消窗口只是暂时的，等下还要恢复显示，你如果复用了 easyWindow 对象并且调用了 easyWindow.show 方法后窗口是不会显示，这是因为你前面调用了 easyWindow.recycle，窗口所有的资源已经被回收了，不能再次展示了，你调用了也是无效，至于要不要在窗口取消的会调用中调用回收窗口资源的办法，这个要取决你在外层有没有复用 easyWindow 对象去做什么事，如果没有就可以放心大胆调用 easyWindow.recycle，如果有的话，则不行。

    2. 框架内部其实有做对窗口资源回收的动作，框架内部会通过 registerActivityLifecycleCallbacks 监听 Activity 生命周期，发现有 Activity 销毁后，会查找这个上下文相关的窗口对象，然后进行调用 easyWindow.recycle 对窗口资源进行回收，那这样为什么 LeakCanary 还会报内存泄漏？这是因为 LeakCanary 在 Activity 还没有结束的时候就急不可耐地去检查对象是否出现了内存泄漏，所以才出现了这个问题，作为框架作者我表示很受伤，至于处理方案你其实可以参考一下第一点。

框架的 API 介绍

  • 对象方法
// 显示悬浮窗
easyWindow.show();
// 将悬浮窗显示在指定 View 的旁边
easyWindow.showAsDropDown(@NonNull View anchorView, int showGravity, int xOff, int yOff);
// 取消显示悬浮窗
easyWindow.cancel();
// 取消显示并回收悬浮窗
easyWindow.recycle();
// 更新悬浮窗（在更新了悬浮窗参数才需要调用）
easyWindow.update();
// 延迟更新悬浮窗（可在子线程中调用，不怕频繁调用）
easyWindow.postUpdate();
// 当前悬浮窗是否正在显示
easyWindow.isShowing();

// 设置窗口生命周期回调监听
easyWindow.setOnWindowLifecycleCallback(@Nullable OnWindowLifecycleCallback callback);
// 设置悬浮窗拖拽规则（框架内部提供了两种拖拽规则，MovingWindowDraggableRule 和 SpringBackWindowDraggableRule ）
easyWindow.setWindowDraggableRule(@Nullable AbstractWindowDraggableRule draggableRule);
// 设置悬浮窗拖拽规则（可能为空）
easyWindow.getWindowDraggableRule();

// 设置悬浮窗内容布局
easyWindow.setContentView(@LayoutRes int layoutId);
easyWindow.setContentView(@LayoutRes int layoutId, @Nullable OnWindowLayoutInflateListener listener);
easyWindow.setContentView(@NonNull View view);
// 获取内容布局（可能为空）
easyWindow.getContentView();
// 限定悬浮窗显示时长
easyWindow.setWindowDuration(@IntRange(from = 0) int delayMillis);
// 设置悬浮窗 tag
easyWindow.setTag(@Nullable String tag);
// 获取悬浮窗 tag
easyWindow.getTag();
// 设置悬浮窗宽度
easyWindow.setWidth(int width);
// 设置悬浮窗高度
easyWindow.setHeight(int height);

// 设置悬浮窗显示的重心
easyWindow.setGravity(int gravity);
// 设置水平偏移量
easyWindow.setXOffset(int px);
// 设置垂直偏移量
easyWindow.setYOffset(int px);

// 设置悬浮窗外层是否可触摸
easyWindow.setOutsideTouchable(boolean touchable);
// 设置悬浮窗背景阴影强度
easyWindow.setBackgroundDimAmount(@FloatRange(from = 0.0, to = 1.0) float amount);

// 添加窗口标记
easyWindow.addWindowFlags(int flags);
// 移除窗口标记
easyWindow.removeWindowFlags(int flags);
// 设置窗口标记
easyWindow.setWindowFlags(int flags);
// 是否存在某个窗口标记
easyWindow.hasWindowFlags(int flags);
// 设置悬浮窗的显示类型
easyWindow.setWindowType(int type);

// 设置悬浮窗动画样式
easyWindow.setAnimStyle(int id);
// 设置悬浮窗软键盘模式
easyWindow.setSoftInputMode(int softInputMode);
// 设置悬浮窗 Token
easyWindow.setWindowToken(@Nullable IBinder token);

// 设置悬浮窗透明度
easyWindow.setWindowAlpha(@FloatRange(from = 0.0, to = 1.0) float alpha);
// 设置容器和窗口小部件之间的垂直边距
easyWindow.setVerticalMargin(float verticalMargin);
// 设置容器和窗口小部件之间的水平边距
easyWindow.setHorizontalMargin(float horizontalMargin);
// 设置位图格式
easyWindow.setBitmapFormat(int format);
// 设置状态栏的可见性
easyWindow.setSystemUiVisibility(int systemUiVisibility);
// 设置垂直权重
easyWindow.setVerticalWeight(float verticalWeight);
// 设置挖孔屏下的显示模式
easyWindow.setLayoutInDisplayCutoutMode(int layoutInDisplayCutoutMode);
// 设置悬浮窗在哪个显示屏上显示
easyWindow.setPreferredDisplayModeId(int preferredDisplayModeId);
// 设置悬浮窗标题
easyWindow.setWindowTitle(@Nullable CharSequence title);
// 设置屏幕的亮度
easyWindow.setScreenBrightness(@FloatRange(from = -1.0, to = 1.0) float screenBrightness);
// 设置键盘背光的亮度
easyWindow.setButtonBrightness(@FloatRange(from = -1.0, to = 1.0) float buttonBrightness);
// 设置悬浮窗的刷新率
easyWindow.setPreferredRefreshRate(float preferredRefreshRate);
// 设置悬浮窗的颜色模式
easyWindow.setColorMode(int colorMode);
// 设置悬浮窗背后的高斯模糊半径大小（Android 12 及以上才支持）
easyWindow.setBlurBehindRadius(@IntRange(from = 0) int blurBehindRadius);
// 设置悬浮窗屏幕方向
easyWindow.setScreenOrientation(int screenOrientation);

// 设置悬浮窗可见性
easyWindow.setWindowVisibility(int visibility);
// 获取悬浮窗可见性
easyWindow.getWindowVisibility();
// 设置悬浮窗根布局（一般情况下推荐使用 {@link #setContentView} 方法来填充布局）
easyWindow.setWindowRootLayout(@NonNull ViewGroup viewGroup);
// 重新设置 WindowManager 参数集
easyWindow.setWindowParams(@NonNull WindowManager.LayoutParams params);
// 重新设置 WindowManager 对象
easyWindow.setWindowManager(@NonNull WindowManager windowManager);

// 获取当前窗口内容宽度
easyWindow.getWindowContentWidth();
// 获取当前窗口内容高度
easyWindow.getWindowContentHeight();

// 设置可见性状态给 View
easyWindow.setVisibilityByView(@IdRes int viewId, int visibility);
// 设置背景 Drawable 给 View
easyWindow.setBackgroundDrawableByView(@IdRes int viewId, @DrawableRes int drawableId);
easyWindow.setBackgroundDrawableByView(@IdRes int viewId, @Nullable Drawable drawable);
// 设置文本给 TextView
easyWindow.setTextByTextView(@IdRes int viewId, @StringRes int stringId);
easyWindow.setTextByTextView(@IdRes int viewId, @Nullable CharSequence text);
// 设置字体颜色给 TextView
easyWindow.setTextColorByTextView(@IdRes int viewId, @ColorInt int colorValue);
// 设置字体大小给 TextView
easyWindow.setTextSizeByTextView(@IdRes int viewId, float textSize);
easyWindow.setTextSizeByTextView(@IdRes int viewId, int unit, float textSize);
// 设置提示文本给 TextView
easyWindow.setHintTextByTextView(@IdRes int viewId, @StringRes int stringId);
easyWindow.setHintTextByTextView(@IdRes int viewId, @Nullable CharSequence text);
// 设置提示文本颜色给 TextView
easyWindow.setHintTextColorByTextView(@IdRes int viewId, @ColorInt int colorValue);
// 设置图片 Drawable 给 ImageView
easyWindow.setImageDrawableByImageView(@IdRes int viewId, @DrawableRes int drawableId);
easyWindow.setImageDrawableByImageView(@IdRes int viewId, @Nullable Drawable drawable);

// 跳转 Activity
easyWindow.startActivity(@Nullable Class<? extends Activity> clazz);
easyWindow.startActivity(@Nullable Intent intent);

// 延迟执行任务
easyWindow.post(Runnable runnable);
// 延迟一段时间执行任务
easyWindow.postDelayed(@NonNull Runnable runnable, long delayMillis);
// 在指定的时间执行任务
easyWindow.postAtTime(@NonNull Runnable runnable, long uptimeMillis);
// 移除指定的任务
easyWindow.removeRunnable(@NonNull Runnable runnable);
// 移除所有的任务
easyWindow.removeAllRunnable();
  • 静态方法
// 取消所有正在显示的悬浮窗
EasyWindow.cancelAllWindow();
// 取消特定类名的悬浮窗
EasyWindow.cancelWindowByClass(@Nullable Class<? extends EasyWindow<?>> clazz);
// 取消特定标记的悬浮窗
EasyWindow.cancelWindowByTag(@Nullable String tag);

// 显示所有已取消但未回收的悬浮窗
EasyWindow.showAllWindow();
// 显示特定类名已取消但未回收的悬浮窗
EasyWindow.showWindowByClass(@Nullable Class<? extends EasyWindow<?>> clazz);
// 显示特定标记已取消但未回收的悬浮窗
EasyWindow.showWindowByTag(@Nullable String tag);

// 回收所有正在显示的悬浮窗
EasyWindow.recycleAllWindow();
// 回收特定类名的悬浮窗
EasyWindow.recycleWindowByClass(@Nullable Class<? extends EasyWindow<?>> clazz);
// 回收特定标记的悬浮窗
EasyWindow.recycleWindowByTag(@Nullable String tag);

// 判断当前是否有悬浮窗正在显示
EasyWindow.existAnyWindowShowing();
// 判断当前是否有特定类名的悬浮窗正在显示
EasyWindow.existWindowShowingByClass(@Nullable Class<? extends EasyWindow<?>> clazz);
// 判断当前是否有特定标记的悬浮窗正在显示
EasyWindow.existWindowShowingByTag(@Nullable String tag);

// 获取所有的悬浮窗
EasyWindow.getAllWindowInstance();
// 获取特定类名的悬浮窗
EasyWindow.getWindowInstanceByClass(@Nullable Class<? extends EasyWindow<?>> clazz);
// 获取特定标记的悬浮窗
EasyWindow.getWindowInstanceByTag(@Nullable String tag);

作者的其他开源项目

微信公众号：Android轮子哥

Android 技术 Q 群：10047167

如果您觉得我的开源库帮你节省了大量的开发时间，请扫描下方的二维码随意打赏，要是能打赏个 10.24 🐵就太👍了。您的支持将鼓励我继续创作:octocat:（点击查看捐赠列表）

License

Copyright 2019 Huang JinQun

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
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.

About

Android 悬浮窗框架，好用不解释

Topics

android floating dialog popup toast window-manager android-toast windowmanager float floating-window popupwindow xtoast toastutils floatwindow easyfloat

Resources

Readme

License

Apache-2.0 license
Activity

Stars

1.5k stars

Watchers

16 watching

Forks

168 forks
Report repository

Releases 33

v12.0 Latest
May 10, 2025
+ 32 releases

Sponsor this project

Packages

No packages published

Contributors 2

  •  
  •  

Languages