使用requestPinAppWidget()添加Widget时如何启动配置Activity

问题背景 #

我的Widget依赖配置Activity来选择Widget类型：通过系统启动器添加Widget时，配置Activity会正常启动，完成初始化后Widget正常显示；但调用requestPinAppWidget()接口添加Widget时，Widget直接被添加到桌面，配置Activity并未启动，导致Widget无内容。

修改步骤与代码实现 #

1. 调整requestPinAppWidget()调用逻辑 #

调用时需要传入包含触发配置标识的Bundle，同时调整回调Intent以接收新生成的Widget ID：

ComponentName mmwidgetProvider = new ComponentName(MainActivity.this, mm_WidgetAppWidgetProvider.class);
if (mAppWidgetManager.isRequestPinAppWidgetSupported()) {
    // 创建用于触发配置Activity的Bundle（无需手动填充ID，系统会自动处理）
    Bundle extras = new Bundle();

    // 定义回调广播Intent，用于接收系统返回的新Widget ID
    Intent pinCallbackIntent = new Intent(MainActivity.this, WidgetPinBroadcastReceiver.class);
    PendingIntent pendingIntent = PendingIntent.getBroadcast(
            MainActivity.this,
            0,
            pinCallbackIntent,
            PendingIntent.FLAG_IMMUTABLE | PendingIntent.FLAG_UPDATE_CURRENT
    );

    // 传入extras参数，触发系统启动配置Activity
    mAppWidgetManager.requestPinAppWidget(mmwidgetProvider, extras, pendingIntent);
}

2. 实现广播接收器处理回调 #

创建广播接收器，在Widget成功添加后启动配置Activity：

public class WidgetPinBroadcastReceiver extends BroadcastReceiver {
    @Override
    public void onReceive(Context context, Intent intent) {
        // 获取系统返回的新Widget ID
        int appWidgetId = intent.getIntExtra(
                AppWidgetManager.EXTRA_APPWIDGET_ID,
                AppWidgetManager.INVALID_APPWIDGET_ID
        );

        if (appWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID) {
            // 启动配置Activity并传入Widget ID
            Intent configIntent = new Intent(context, YourWidgetConfigActivity.class);
            configIntent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId);
            configIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
            context.startActivity(configIntent);
        }
    }
}

3. 注册广播接收器 #

在AndroidManifest.xml中注册上述广播接收器：

<receiver android:name=".WidgetPinBroadcastReceiver">
    <intent-filter>
        <!-- 可自定义Action，或保持默认接收系统广播 -->
    </intent-filter>
</receiver>

4. 确保配置Activity完成后正确更新Widget #

在配置Activity的提交逻辑中，完成配置后更新Widget并返回结果给系统：

// 获取传入的Widget ID
int appWidgetId = getIntent().getIntExtra(
        AppWidgetManager.EXTRA_APPWIDGET_ID,
        AppWidgetManager.INVALID_APPWIDGET_ID
);

if (appWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID) {
    // 执行你的配置逻辑（比如保存用户选择的Widget类型）
    String selectedType = "xxx"; // 示例：用户选择的类型
    
    // 更新Widget视图
    AppWidgetManager appWidgetManager = AppWidgetManager.getInstance(this);
    RemoteViews remoteViews = new RemoteViews(getPackageName(), R.layout.your_widget_layout);
    // 根据配置设置视图内容，比如remoteViews.setTextViewText(R.id.widget_title, selectedType);
    
    appWidgetManager.updateAppWidget(appWidgetId, remoteViews);

    // 返回结果给系统，标记配置完成
    Intent resultIntent = new Intent();
    resultIntent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId);
    setResult(RESULT_OK, resultIntent);
    finish();
}

关键说明 #

• 必须传递非空的extras参数给requestPinAppWidget()，系统才会识别到Widget需要启动配置Activity（前提是你的Widget已在Manifest中声明了配置Activity）。
• 广播接收器的核心作用是获取系统生成的新Widget ID，并传递给配置Activity进行初始化。
• 配置Activity完成后必须返回RESULT_OK结果，确保系统确认配置流程完成，Widget正常工作。

内容的提问来源于stack exchange，提问作者shane