手把手教你搭建android模块化项目框架(三)router

2023-09-01 14:00:48 浏览数 (3)

前两节我们了解了android框架搭建的基础,这期我们来补充之前留下的坑:模块间通讯。

模块间由于互相隔离,导致我们不能直接调用到其他模块间的方法、activity及fragment,因此本期将使用基础方法使模块间可以通讯。

上期我们提到的模块结构如下

app->feature->feature_common->data->core

如此结构并不能让我们优雅的进行模块间通信,因此,本期将新增一个通讯模块,既services(本service并非android的service),因此,模块结构将变化为如下:

app->feature->services->feature_common->data->core

即,每个module对应都有一个service,用来定义和提供模块间通讯的服务。

service依赖关系:每个feature都可依赖任意service,service仅提供定义的方法及访问provider的proxy,除router和data外,service不可依赖任何其他的模块。本feature必须依赖自己的service并提供实现的provider用以提供服务。

总体模块间通讯思路:

  • core_router中定义一个接口,统一service类型
  • core_router中定义一个map,使用键值对的方式保存path和service的实现类,即provider
  • service模块定义接口,继承core_router中得service接口,并扩展需要提供的方法
  • service模块提供proxy类,用以通过path查询provider,并调用provider中的方法提供服务
  • feature模块提供provider类,继承至service中的接口并实现,该provider通过path注册到core_router中的map中存储,以供调用
  • app模块创建application时,注册feature中的provider类到core_router中的map中
  • 其他feature可通过proxy类间接调用provider中的方法,从而达到模块间通讯的目的 具体实现如下
新1111BMP 图像.png新1111BMP 图像.png

即:每个feature将包含一个data_feature和一个service_feature模块。

下面将讲述如何模块间通讯,根据我们上期参考的google模块化截图来看,各模块间通讯将借助app模块桥接使用,本项目为了让大家更能理解模块间是如何通讯的,将采用简单的接口注入方式提供模块服务。

首先我们创建一个core_router模块,作为存储、查询service的中介。

代码语言:text复制
object Router {
    //存储注册的provider,即模块的服务提供类
    private val routerServices = mutableMapOf<String, RouterService>()
    fun register(path: String, provider: RouterService) {
        if (routerServices.containsKey(path)) {
            throw DuplicatePathException("path重复注册。")
        }
        routerServices[path] = provider
    }

    fun getProvider(path: String): RouterService {
        return routerServices[path] ?: throw NullPointerException("没有找到对应的provider")
    }
}
//用以统一service类型的接口
interface RouterService {
    fun init(app: Context)
}

下面使用feature_login模块进行示例,

我们定义3个类进行注册、查询及提供服务。

LoginService:服务提供定义接口

代码语言:text复制
interface LoginService : RouterService {
    fun isLogin(): Boolean
    fun launchLoginActivity(context: Context)
}

LoginServicePath: 常量,用以查询provider

代码语言:text复制
object LoginServicePath {
    const val LOGIN_SERVICE_PATH_CODE = "feature.login.provider"
}

LoginProxy:用以方便调用提供服务的方法

代码语言:text复制
object LoginProxy {
    private val provider by lazy {
        Router.getProvider(LoginServicePath.LOGIN_SERVICE_PATH_CODE) as LoginService
    }

    fun isLogin(): Boolean {
        return provider.isLogin()
    }

    fun launchLoginActivity(context: Context) {
        provider.launchLoginActivity(context)
    }
}

通过代码,相信大家已经看懂了如何使用service模块提供服务

首先在application的oncreate方法中注册provider

代码语言:text复制
    fun onCreate(context: Context) {
        LoginApp.context = context
        LoginProvider().init(context)
    }

此时,RouterManager的routerServices中就存储了提供服务的provider。

至此,需要feature_login提供服务的模块依赖service_login,并且使用proxy即可间接调用feature_login模块中的内容了。

代码语言:text复制
        Toast.makeText(this, "login status is ${LoginProxy.isLogin()}", Toast.LENGTH_SHORT).show()
        val btn = findViewById<TextView>(R.id.test)
        btn.setOnClickListener {
            LoginProxy.launchLoginActivity(this@MainActivity)
        }

项目地址

0 人点赞