如何获取MediaBrowserServiceCompat子类服务的实例并调用其方法？

Hey there! The issue you're running into is that MediaBrowserServiceCompat has a slightly different binding flow compared to regular Android Services—since it's built specifically for media browsing, we need to adjust our approach to call custom methods like doMagic() while still respecting its core functionality. Let's break down two solid solutions:

方法一：区分绑定类型，兼容普通绑定与媒体浏览 #

First off, your current onBind() method is overriding the default behavior that MediaBrowserServiceCompat uses for media client connections. We need to modify it to return your custom Binder only for your own binding requests, and let the superclass handle media browser connections. Here's how:

1. 更新你的Service代码 #

class MyService extends MediaBrowserServiceCompat {
    // 定义一个自定义Action，用来标识我们的普通绑定请求
    public static final String ACTION_CUSTOM_BIND = "com.your.app.package.ACTION_CUSTOM_BIND";

    class MyBinder extends Binder {
        public MyService getServiceInstance() {
            return MyService.this;
        }
    }
    private final MyBinder localBinder = new MyBinder();

    @Override
    public IBinder onBind(Intent intent) {
        // 检查Intent的Action：如果是我们自定义的绑定请求，返回自己的Binder
        if (ACTION_CUSTOM_BIND.equals(intent.getAction())) {
            return localBinder;
        }
        // 否则交给父类处理媒体浏览器的绑定逻辑
        return super.onBind(intent);
    }

    public void doMagic() {
        // 你的自定义逻辑，比如打印日志或者执行媒体操作
        Log.d("MyService", "Whoa, magic just happened! 🎩");
    }

    // 必须实现的MediaBrowserServiceCompat抽象方法
    @Override
    public BrowserRoot onGetRoot(String clientPackageName, int clientUid, Bundle rootHints) {
        // 根据你的需求配置访问权限，这里允许所有客户端访问根目录
        return new BrowserRoot("media_root", null);
    }

    @Override
    public void onLoadChildren(String parentId, Result<List<MediaBrowser.MediaItem>> result) {
        // 这里实现加载媒体内容的逻辑，暂时返回空列表即可
        result.sendResult(new ArrayList<>());
    }
}

2. 在Activity中绑定并调用方法 #

In your Activity, we'll use a standard ServiceConnection to bind to the service using our custom Action, then grab the service instance to call doMagic():

public class MainActivity extends AppCompatActivity {
    private MyService myServiceInstance;
    private boolean isServiceBound = false;

    private final ServiceConnection serviceConnection = new ServiceConnection() {
        @Override
        public void onServiceConnected(ComponentName name, IBinder service) {
            // 转换为我们的自定义Binder，获取服务实例
            MyService.MyBinder binder = (MyService.MyBinder) service;
            myServiceInstance = binder.getServiceInstance();
            isServiceBound = true;

            // 现在可以直接调用doMagic()啦！
            myServiceInstance.doMagic();
        }

        @Override
        public void onServiceDisconnected(ComponentName name) {
            myServiceInstance = null;
            isServiceBound = false;
        }
    };

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // 构建绑定Intent，指定我们的自定义Action
        Intent bindIntent = new Intent(this, MyService.class);
        bindIntent.setAction(MyService.ACTION_CUSTOM_BIND);
        // 绑定服务，自动创建实例如果还没启动
        bindService(bindIntent, serviceConnection, Context.BIND_AUTO_CREATE);
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        // 记得解绑服务，避免内存泄漏
        if (isServiceBound) {
            unbindService(serviceConnection);
            isServiceBound = false;
        }
    }
}

方法二：遵循Media框架规范，用MediaBrowser获取服务实例 #

If you want to stick closer to the media framework's intended design (especially if you're using media browsing features alongside custom methods), you can use MediaBrowser to connect to the service and then use a callback to get the service instance:

1. 在Service中添加回调接口 #

class MyService extends MediaBrowserServiceCompat {
    private MediaSessionCompat mediaSession;
    private ServiceReadyCallback readyCallback;

    // 定义回调接口，通知Activity服务已就绪
    public interface ServiceReadyCallback {
        void onServiceReady(MyService service);
    }

    public void setServiceReadyCallback(ServiceReadyCallback callback) {
        this.readyCallback = callback;
        // 如果服务已经创建，立即通知
        if (mediaSession != null) {
            callback.onServiceReady(this);
        }
    }

    @Override
    public void onCreate() {
        super.onCreate();
        mediaSession = new MediaSessionCompat(this, "MyMediaSession");
        setSessionToken(mediaSession.getSessionToken());
        
        // 如果回调已设置，通知服务就绪
        if (readyCallback != null) {
            readyCallback.onServiceReady(this);
        }
    }

    public void doMagic() {
        Log.d("MyService", "Magic via MediaBrowser! 🎉");
    }

    // 实现MediaBrowserServiceCompat的抽象方法
    @Override
    public BrowserRoot onGetRoot(String clientPackageName, int clientUid, Bundle rootHints) {
        return new BrowserRoot("media_root", null);
    }

    @Override
    public void onLoadChildren(String parentId, Result<List<MediaBrowser.MediaItem>> result) {
        result.sendResult(new ArrayList<>());
    }
}

2. 在Activity中用MediaBrowser连接并调用方法 #

public class MainActivity extends AppCompatActivity {
    private MediaBrowser mediaBrowser;
    private MyService myServiceInstance;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // 初始化MediaBrowser，设置连接回调
        mediaBrowser = new MediaBrowser(
            this,
            new ComponentName(this, MyService.class),
            mediaBrowserConnectionCallback,
            null
        );
        mediaBrowser.connect();
    }

    private final MediaBrowser.ConnectionCallback mediaBrowserConnectionCallback = new MediaBrowser.ConnectionCallback() {
        @Override
        public void onConnected() {
            super.onConnected();
            // 服务已连接，设置回调获取实例
            ((MyService) getApplicationContext().getSystemService(MyService.class))
                .setServiceReadyCallback(new MyService.ServiceReadyCallback() {
                    @Override
                    public void onServiceReady(MyService service) {
                        myServiceInstance = service;
                        myServiceInstance.doMagic();
                    }
                });
        }
    };

    @Override
    protected void onDestroy() {
        super.onDestroy();
        // 断开MediaBrowser连接
        if (mediaBrowser != null && mediaBrowser.isConnected()) {
            mediaBrowser.disconnect();
        }
    }
}

最后别忘了在Manifest中注册Service #

Make sure your Service is properly registered in AndroidManifest.xml, including both the media service action and your custom bind action:

<service
    android:name=".MyService"
    android:exported="true">
    <intent-filter>
        <!-- 媒体浏览器服务必须的Action -->
        <action android:name="android.media.browse.MediaBrowserService" />
        <!-- 我们自定义的绑定Action -->
        <action android:name="com.your.app.package.ACTION_CUSTOM_BIND" />
    </intent-filter>
</service>

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