如何在Activity中正确使用WindowInsetsCompat监听键盘高度变化

问题背景 #

采用Android官方推荐的WindowInsetsCompat监听键盘高度变化，未配置android:windowSoftInputMode="adjustResize"，但出现两个问题：

• 顶部状态栏和底部软键背景变为白色
• 获取的键盘高度值不正确（将红色keyboardView高度设为该值后仍可见）

解决方案 #

一、修复状态栏与底部软键背景变白问题 #

背景异常通常是主题配置错误或Insets处理逻辑不当导致系统栏样式丢失，可通过以下步骤解决：

1. 确保主题配置正确
   在styles.xml中为Activity设置继承自Material系列的主题，并明确系统栏颜色：

<style name="AppTheme" parent="Theme.Material3.DayNight.NoActionBar">
    <!-- 状态栏颜色 -->
    <item name="android:statusBarColor">@color/your_status_bar_color</item>
    <!-- 底部导航栏颜色 -->
    <item name="android:navigationBarColor">@color/your_nav_bar_color</item>
    <!-- 根据状态栏颜色设置内容文字的明暗 -->
    <item name="android:windowLightStatusBar">false</item>
    <item name="android:windowLightNavigationBar">false</item>
</style>

2. 正确处理Insets消费逻辑
   处理键盘Insets时，不要直接消费所有Insets，需保留系统栏Insets的原有处理逻辑，避免覆盖系统默认样式：

ViewCompat.setOnApplyWindowInsetsListener(rootView, (v, insets) -> {
    // 仅处理键盘相关Insets
    Insets keyboardInsets = insets.getInsets(WindowInsetsCompat.Type.ime());
    // 这里写键盘高度的处理逻辑...
    
    // 返回未处理系统栏Insets的结果，让系统继续维护系统栏样式
    return insets;
});

如果需要让布局适配系统栏，应通过设置布局padding实现，而非修改背景：

Insets systemBarsInsets = insets.getInsets(WindowInsetsCompat.Type.systemBars());
v.setPadding(systemBarsInsets.left, systemBarsInsets.top, systemBarsInsets.right, systemBarsInsets.bottom);

二、获取正确的键盘高度 #

键盘高度计算错误的核心是未区分键盘显示状态、未排除系统导航栏高度干扰，可按以下方式修正：

1. 精准计算键盘高度
   通过对比IME Insets与导航栏Insets的差值，判断键盘是否显示，并计算真实高度：

ViewCompat.setOnApplyWindowInsetsListener(rootView, (v, insets) -> {
    WindowInsetsCompat insetsCompat = WindowInsetsCompat.toWindowInsetsCompat(insets);
    // 获取键盘（IME）的Insets
    Insets imeInsets = insetsCompat.getInsets(WindowInsetsCompat.Type.ime());
    // 获取底部导航栏的Insets
    Insets navInsets = insetsCompat.getInsets(WindowInsetsCompat.Type.navigationBars());
    
    // 键盘显示判定：IME底部Insets大于导航栏底部Insets（说明键盘弹出）
    boolean isKeyboardVisible = imeInsets.bottom > navInsets.bottom;
    // 真实键盘高度 = IME底部高度 - 导航栏底部高度
    int keyboardHeight = isKeyboardVisible ? (imeInsets.bottom - navInsets.bottom) : 0;
    
    // 更新keyboardView的高度
    if (keyboardView != null) {
        ViewGroup.LayoutParams params = keyboardView.getLayoutParams();
        params.height = keyboardHeight;
        keyboardView.setLayoutParams(params);
    }
    
    return insetsCompat.toWindowInsets();
});

2. 配置根视图属性
   在activity_main.xml的根布局中开启fitsSystemWindows，确保布局能正确响应WindowInsets变化：

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/root_view"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:fitsSystemWindows="true"
    android:orientation="vertical">
    
    <!-- 其他布局元素 -->
    <View
        android:id="@+id/keyboardView"
        android:layout_width="match_parent"
        android:layout_height="0dp"
        android:background="@color/red"/>
</LinearLayout>

3. 清除干扰配置
   确保未设置其他android:windowSoftInputMode值干扰Insets传递，当前未配置adjustResize的设置保持不变。

内容的提问来源于stack exchange，提问作者Cheok Yan Cheng