AndroidQ SystemUI之插件化基本用法实例

上一篇文章AndroidQ SystemUI之插件化机制Plugin以SystemUI启动时加载的一个插件化接口分析了插件化的基本原理，这篇来看看插件的用法：
回顾上一篇文章，SystemUI启动加载了一个插件接口OverlayPlugin，

Dependency.get(PluginManager.class).addPluginListener(
                new PluginListener<OverlayPlugin>() {
                    private ArraySet<OverlayPlugin> mOverlays = new ArraySet<>();

                    @Override
                    public void onPluginConnected(OverlayPlugin plugin, Context pluginContext) {
                        mainHandler.post(new Runnable() {
                            @Override
                            public void run() {
                                StatusBar statusBar = getComponent(StatusBar.class);
                                if (statusBar != null) {
                                    plugin.setup(statusBar.getStatusBarWindow(),
                                            statusBar.getNavigationBarView(), new Callback(plugin));
                                }
                            }
                        });
                    }

                    @Override
                    public void onPluginDisconnected(OverlayPlugin plugin) {
                        ...
                    }

                   ...
                }, OverlayPlugin.class, true /* Allow multiple plugins */);

我们来看一个实现了OverlayPlugin接口，进而修改statusbar和navigationbar的例子，这是google提供的一个例子，我们学习了此例子就可以举一反三写其他插件了
首先写一个类SampleOverlayPlugin，实现OverlayPlugin接口

@Requires(target = OverlayPlugin.class, version = OverlayPlugin.VERSION)
public class SampleOverlayPlugin implements OverlayPlugin {
    private static final String TAG = "djtang";
    private Context mPluginContext;

    private View mStatusBarView;
    private View mNavBarView;
    private boolean mInputSetup;
    private boolean mCollapseDesired;
    private float mStatusBarHeight;

    @Override
    public void onCreate(Context sysuiContext, Context pluginContext) {
        Log.d(TAG, "onCreate");
        mPluginContext = pluginContext;
    }

    @Override
    public void onDestroy() {
        if (mInputSetup) {
            mStatusBarView.getViewTreeObserver().removeOnComputeInternalInsetsListener(
                    onComputeInternalInsetsListener);
        }
        Log.d(TAG, "onDestroy");
        if (mStatusBarView != null) {
            mStatusBarView.post(
                    () -> ((ViewGroup) mStatusBarView.getParent()).removeView(mStatusBarView));
        }
        if (mNavBarView != null) {
            mNavBarView.post(() -> ((ViewGroup) mNavBarView.getParent()).removeView(mNavBarView));
        }
    }

    @Override
    public void setup(View statusBar, View navBar) {
        Log.d(TAG, "Setup");

        int id = mPluginContext.getResources().getIdentifier("status_bar_height", "dimen",
                "android");
        mStatusBarHeight = mPluginContext.getResources().getDimension(id);
        if (statusBar instanceof ViewGroup) {
            mStatusBarView = LayoutInflater.from(mPluginContext)
                    .inflate(R.layout.colored_overlay, (ViewGroup) statusBar, false);
            ((ViewGroup) statusBar).addView(mStatusBarView);
        }
        if (navBar instanceof ViewGroup) {
            mNavBarView = LayoutInflater.from(mPluginContext)
                    .inflate(R.layout.colored_overlay, (ViewGroup) navBar, false);
            ((ViewGroup) navBar).addView(mNavBarView);
        }
    }

   ...
}

SampleOverlayPlugin需要实现OverlayPlugin接口中的方法，
onCreate和onDestroy我们在上一篇文章分析过，在PluginManagerImpl注册的广播中会调到PluginInstanceManager发送handler消息QUERY_ALL，收到消息后会调用handleQueryPlugins方法，此方法中会通过类加载器加载具体的插件也就是我们这里的SampleOverlayPlugin，然后发送handler消息PLUGIN_CONNECTED，收到消息后调用onCreate方法，接着调用注册的回调方法
onPluginConnected

		case PLUGIN_CONNECTED:
                    .....
                    info.mPlugin.onCreate(mContext, 
                    mListener.onPluginConnected(info.mPlugin, info.mPluginContext);
                    break;

我们回到上面添加插件接口的方法，看下回调onPluginConnected中做了什么事：

@Override
     public void onPluginConnected(OverlayPlugin plugin, Context pluginContext) {
                        mainHandler.post(new Runnable() {
                            @Override
                            public void run() {
                                StatusBar statusBar = getComponent(StatusBar.class);
                                if (statusBar != null) {
                                    plugin.setup(statusBar.getStatusBarWindow(),
                                            statusBar.getNavigationBarView(), new Callback(plugin));
                                }
                            }
                        });
                    }

很清楚了，调用了插件的setup方法，并且将statusBar和NavigationBar传了进去，所以SampleOverlayPlugin实现了OverlayPlugin接口后就能够在它自己的setup方法中拿到SystemUI的statusBar和NavigationBar，也就可以做一些事情了,

 @Override
    public void setup(View statusBar, View navBar) {
        int id = mPluginContext.getResources().getIdentifier("status_bar_height", "dimen",
                "android");
        mStatusBarHeight = mPluginContext.getResources().getDimension(id);
        if (statusBar instanceof ViewGroup) {
            mStatusBarView = LayoutInflater.from(mPluginContext)
                    .inflate(R.layout.colored_overlay, (ViewGroup) statusBar, false);
            ((ViewGroup) statusBar).addView(mStatusBarView);
        }
        if (navBar instanceof ViewGroup) {
            mNavBarView = LayoutInflater.from(mPluginContext)
                    .inflate(R.layout.colored_overlay, (ViewGroup) navBar, false);
            ((ViewGroup) navBar).addView(mNavBarView);
        }
    }

这里的代码很简单，就是向statusBar和NavigationBar的ViewGroup中添加了一个colored_overlay的布局，里面包含一个自定义View，仅仅设置了一个颜色

<com.android.systemui.plugin.testoverlayplugin.CustomView
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:background="#80ff0000" />

public class CustomView extends View {

    private static final String TAG = "CustomView";

    public CustomView(Context context, @Nullable AttributeSet attrs) {
        super(context, attrs);
        Log.d(TAG, "new instance");
    }

    @Override
    protected void onAttachedToWindow() {
        super.onAttachedToWindow();
        Log.d(TAG, "onAttachedToWindow");
    }

    @Override
    protected void onDetachedFromWindow() {
        super.onDetachedFromWindow();
        Log.d(TAG, "onDetachedFromWindow");
    }
}

最后在手机上运行的效果图就是这样，可以看到，系统的statusbar和navigationbar中已经包含了我们添加的view

需要注意的是SampleOverlayPlugin必须在AndroidManifest.xml中定义为service
，并且它的action必须是OverlayPlugin通过注解ProvidesInterface暴露出来

<uses-permission android:name="com.android.systemui.permission.PLUGIN" />
<service android:name=".SampleOverlayPlugin"
            android:label="@string/plugin_label">
            <intent-filter>
                <action android:name="com.android.systemui.action.PLUGIN_OVERLAY" />
            </intent-filter>
        </service>

最后给出案例的完整目录结构：

另外SystemUI的插件写完编译成功之后需要push到手机才能生效

除了上述的OverlayPlugin可以修改系统statusbar和navigationbar之外，SystemUI还提供了许多修改其他控件的插件接口，如下官方文档描述：
/frameworks/base/packages/SystemUI/docs/plugin_hooks.md

### Action: com.android.systemui.action.PLUGIN_NAV_GESTURE
Expected interface: [NavGesture](/packages/SystemUI/plugin/src/com/android/systemui/plugins/statusbar/phone/NavGesture.java)

Use: Allows touch events from the nav bar to be intercepted and used for other gestures.

### Action: com.android.systemui.action.PLUGIN_LOCKSCREEN_RIGHT_BUTTON
Expected interface: [IntentButtonProvider](/packages/SystemUI/plugin/src/com/android/systemui/plugins/IntentButtonProvider.java)

Use: Allows a plugin to specify the icon for the bottom right lock screen button, and the intent that gets launched when it is activated.

### Action: com.android.systemui.action.PLUGIN_LOCKSCREEN_LEFT_BUTTON
Expected interface: [IntentButtonProvider](/packages/SystemUI/plugin/src/com/android/systemui/plugins/IntentButtonProvider.java)

Use: Allows a plugin to specify the icon for the bottom left lock screen button, and the intent that gets launched when it is activated.

### Action: com.android.systemui.action.PLUGIN_GLOBAL_ACTIONS
Expected interface: [GlobalActions](/packages/SystemUI/plugin/src/com/android/systemui/plugins/GlobalActions.java)
	....
	...