ModuleCommunication

ModuleCommunication 旨在解决模块间的通信需求，可以让模块间的代码在依旧存在于其自己的模块的前提下，实现能够互相访问而不需要下沉到公共模块。以此来解决公共模块因为各个模块下沉代码而导致的不断膨胀的问题

每个模块使用此库生成属于自己模块的跳转 Activity 的帮助类，也是可以做到市面上那些 router 的功能，框架代码极少，风险可控！（不过仅限您一个小项目可以这么做，如果没有插件化完全够用）点此查看 router 功能的使用

特色功能

1、支持模块间共享 Java 或 Kotlin 代码

2、支持模块间共享 res 文件夹下的资源

3、支持模块间共享 assets 资源

4、支持自动生成 Router 帮助类，并支持共享 Router 帮助类

5、使用本库，真正打进安装包里的代码只有BindClass 和 ImplementClassUtils 这两个类，代码极少！

灵感来源-微信Android模块化架构重构实践

功能示意图

我们常见的模块化架构模型基本上就是这样的，本库在不影响任何结构的情况下即可做到通信

如下图所示，把所有 module 需要共享的代码全部暴露到 communication 模块下，然后想要使用共享代码的 module 使用 compileOnly 方式引入 communication 模块就可以了

💡compileOnly 方式导入 在打包时，整个 module 都不会打进安装包，可以说是起一个桥梁作用。

通信 module 可以配置多个点此查看

使用步骤

在开始之前可以给项目一个Star吗？非常感谢，你的支持是我唯一的动力。欢迎Star和Issues!

一、引入插件

1、在 项目根目录 的 build.gradle 里依赖插件

buildscript {
    dependencies {
        //必须项 👇
        classpath 'io.github.flyjingfish:modulecommunication-plugin:1.3.1'
    }
}

2、在 项目根目录 的 build.gradle 里依赖插件

plugins {
    //必须项 👇下边版本号根据你项目的 Kotlin 版本决定👇
    id 'com.google.devtools.ksp' version '1.8.10-1.0.9' apply false
}

Kotlin 和 KSP Github 的匹配版本号列表

二、新增负责通信的 module

• 1、例如新建一个名为 communication 的module(下文将以 communication 为例介绍)

• 2、在 communication 的 build.gradle 添加

//必须项 👇
plugins {
    ...
    id 'communication.module'
}

• 3、在项目根目录的 gradle.properties 新增如下配置

//公共导出的 module 名
communication.moduleName = communication
//是否自动在设置 communication.export 插件的 module 自动 compileOnly 入公共的 module（前提是已经设置了 communication.moduleName）
communication.antoCompileOnly = true

三、开始使用

1⃣️ 共享 Kotlin 或 Java 代码

以下面代码结构为例介绍下

下边的暴露代码在本项目的 lib-user 模块中

• 1、在需要暴露代码的模块 lib-user 的 build.gradle 添加

//必须项 👇
plugins {
    ...
    id 'communication.export'
}

• 2、在需要暴露给其他module使用的逻辑代码接口上使用 @ExposeInterface

@ExposeInterface
interface UserHelper {
    fun getUser():User
}

• 3、把@ExposeInterface注解的接口类涉及的数据类上使用 @ExposeBean

@ExposeBean
data class User (val id:String)

• 4、在@ExposeInterface注解的接口类的实现类上使用 @ImplementClass(UserHelper::class)

@ImplementClass(UserHelper::class)
class UserHelperImpl :UserHelper {
    override fun getUser():User {
        Log.e("UserHelperImpl","getUser")
        return User("1111")
    }
}

• 5、调用 gradle 命令，生成共享代码

communication -> generateCommunication

调用这个命令，将会生成共享代码。不调用直接运行代码可能会报错，一般报错最多次数为项目的 module 个数，即可生成完所有共享代码，如下图示 暴露的代码出现在了 communication 模块下

• 6、在需要使用 lib-login 模块 上引入通信模块 communication

a、lib-login 引入通信模块(配置了这里3 以及 id 'communication.export' 就无需配置这一步)

compileOnly(project(":communication"))

注意引入方式必须是 compileOnly ，否则会导致打包失败。并且在哪个 module 中使用就在哪引入

b、如果 lib-login 也没有引入过 communication.export 插件，也同样需要引入

dependencies {
    //必须项 👇（可以直接放在公共 module）
    implementation 'io.github.flyjingfish:modulecommunication-annotation:1.3.1'
}

• 7、在 lib-login 模块使用 lib-user 暴露出来的的代码

class LoginActivity: AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        //getSingleInstance 是获取单例  getNewInstance 是获取新的对象
        val userHelper = ImplementClassUtils.getSingleInstance<UserHelper>(UserHelper::class)
        val user = userHelper.getUser()
        Log.e("user",""+user)
    }
}

2⃣️ 共享 res 或 assets 文件夹下的资源

res 目录下共享的资源目前支持的类型包括 drawable、mipmap、string、array、layout、style、color（包括 xml 的 color 文件）、dimen、anim、animator、styleable、raw、menu、xml、navigation、font、transition

以下面代码结构为例介绍下（共享的资源文件如果牵涉到其他资源，注意也要一并共享）

• 1、 lib-login 需要暴露 res 或 assets 代码，可在 build.gradle 设置如下代码：

communicationConfig{
     exposeResIds.addAll(arrayOf(
        "R.drawable.login_logo",
        "R.mipmap.login_logo2",
        "R.string.login_text",
        "R.array.weekname",
        "R.style.LoginAppTheme",
        "R.color.color_theme",
        "R.color.color_white_both",
        "R.layout.activity_login",
        "R.anim.toast_out",
        "R.animator.animator_incoming",
        "R.styleable.ColorTextView",
        "R.dimen.dp20",
        "R.raw.call_video_play",
        "R.raw.connecting",
        "R.menu.main_menu",
        "R.xml.dialog_match_success_scene",
        "R.navigation.nav_main",
        "R.color.textcolor_btn_tiger_bottom",
        "R.font.call_font",
        "R.transition.login_tran"
    ))
    //直接可以输入 assets 下的文件夹或者文件路径即可
    exposeAssets.addAll(arrayOf(
        "matching",
        "swipe_like"
    ))
}

直接调用下边命令即可

然后必须在使用共享资源之前需要把下边这项设置关掉

根目录下的 gradle.properties 的 android.nonTransitiveRClass 设置为 false（否则 R 文件的包名只能用通信module的，打包后会出现异常）

• 2、在 lib-user 中使用资源即可

class UserActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_user)
        findViewById<ImageView>(R.id.iv_image).setImageResource(R.drawable.login_logo)
        val text = R.string.login_text
        val theme = R.style.LoginAppTheme
    }
}

3⃣️、番外（非必须项）

• 1、如果你想定义更多的通信模块，而不是使用同一个，可以在使用 'communication.export' module 加入以下配置项

plugins {
    id("communication.export")
}
communicationConfig{
    exportModuleName = "communication2"
}

这样共享代码会转移到 communication2 这个 module 中

• 2、调用以下命令可一键暴露所有代码

4⃣️、路由注解

更多路由的详细用法点此查看

• @Route 路由页面

• @RouteParams 路由页面参数

👇👇👇这两个库都需要 AndroidAOP 提供支持,详细使用方式下文有介绍

dependencies {
    //使用拦截器（不是必须的）
    implementation 'io.github.flyjingfish:modulecommunication-intercept:1.3.1'
    //使用路径的方式跳转才需要 （不是必须的）
    implementation 'io.github.flyjingfish:modulecommunication-route:1.3.1'
}

示例

// activity 
@Route("/user/UserActivity")
class UserActivity : AppCompatActivity() {

    @delegate:RouteParams("params1")
    val params1 :String ? by lazy(LazyThreadSafetyMode.NONE) {
        intent.getStringExtra("params1")
    }

    @delegate:RouteParams("params2")
    val params2 :User ? by lazy(LazyThreadSafetyMode.NONE) {
        intent.getSerializableExtra("params2") as User
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_user)
        Log.e("UserActivity","params1=$params1,params2=$params2")
    }
}

//fragment
@Route("/user/UserFragment")
class UserFragment : Fragment() {
    @delegate:RouteParams("params1")
    val params1 :String ? by lazy(LazyThreadSafetyMode.NONE) {
        arguments?.getString("params1")
    }

    @delegate:RouteParams("params2")
    val params2 :User ? by lazy(LazyThreadSafetyMode.NONE) {
        arguments?.getSerializable("params2") as User
    }
    override fun onCreateView(
        inflater: LayoutInflater,
        container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View {
        val binding = ActivityUserBinding.inflate(inflater,container,false)
        Log.e("UserFragment","params1=$params1,params2=$params2")
        return binding.root
    }

}

在其他 module 调用

class LoginActivity: AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        val binding = ActivityLoginBinding.inflate(layoutInflater)
        setContentView(binding.root)
        val userHelper = ImplementClassUtils.getSingleInstance<UserHelper>(UserHelper::class)
        val user = userHelper.getUser()
        binding.btnGo.setOnClickListener {
            //在 module-communication-route 可以使用路径跳转
            ModuleRoute.builder("/user/UserActivity")
                            .putValue("params1","lalla")
                            .putValue("params2",user)
                            .go(this)
            //直接使用路由帮助类，需借助上边介绍的通信功能
            `LibUser$$Router`.goUser_UserActivity(this,"hahah",user)
        }

        binding.btnGoFragment.setOnClickListener {
            //在 module-communication-route 可以使用路径拿到 class ，反射新建fragment对象
            val instance : Any = ModuleRoute.builder("/user/UserFragment")
                            .putValue("params1","lalla")
                            .putValue("params2",user)
                            .go()
            instance?.let {
                val fragment : Fragment = instance as Fragment  
            }
            //直接使用路由帮助类，需借助上边介绍的通信功能
            val fragment : Fragment = `LibUser$$Router`.newUser_UserFragment("lalala",user) as Fragment
            supportFragmentManager.beginTransaction().replace(R.id.container,fragment).commit()
        }

        Log.e("user",""+user)
    }
}

想要让 拦截器 和 ModuleRoute 起作用，您还需要使用 AndroidAOP 点此跳转查看使用方式,没有特别需要的话，使用里边的 debugMode 就够了,配置完之后设置下边的信息。更多路由的详细用法点此查看

class MyApp : Application() {
    override fun onCreate() {
        super.onCreate()
        //一键初始化所有需要的信息
        CollectApp.onCreate(this)
    }
}


// 下边的可以按需选择，不一定全部都要设置
object CollectApp {
    private val allRouterIntercept = mutableSetOf<RouterIntercept>()
    private val allIApplication = mutableSetOf<IApplication>()
    private val allRouteClazz = mutableSetOf<BaseRouterClass>()

    /**
     * 这一步才可以收集到所有的拦截器
     */
    @AndroidAopCollectMethod
    @JvmStatic
    fun collectIntercept(sub: RouterIntercept){
        Log.e("CollectIntercept","collectIntercept=$sub")
        allRouterIntercept.add(sub)
    }

    /**
     * 这一步才可以收集到所有的路由路径信息
     */

    @AndroidAopCollectMethod
    @JvmStatic
    fun collectRouterClass(sub: BaseRouterClass){
        Log.e("CollectIntercept","collectRouterClass=$sub")
        allRouteClazz.add(sub)
    }

    /**
     * 收集所有的 module 的 IApplication 类
     */
    @AndroidAopCollectMethod
    @JvmStatic
    fun collectIApplication(sub: IApplication){
        Log.e("CollectIntercept","collectIApplication=$sub")
        allIApplication.add(sub)
    }

    fun onCreate(application: Application){
        Log.e("CollectIntercept","getAllRouterIntercept-size=${allRouterIntercept.size}")
        //设置全部的拦截器让其起作用
        RouterInterceptManager.addAllIntercept(allRouterIntercept)
        //设置全部路由路径信息，这样ModuleRoute才可以起作用
        ModuleRoute.autoAddAllRouteClass(allRouteClazz)
        //循环调用各个 module 的 IApplication.onCreate
        allIApplication.forEach {
            it.onCreate(application)
        }
    }
}

如果是使用通信路由帮助类，设置以下设置可以生成空的导航方法，这样方便移除当前module

communicationConfig{
    // 第1步让导航方法失效
    exportEmptyRoute = false
    // 第2步 导出一个单独的 module
    exportModuleName = "communication2"
}

可能你会问移除当前module，那么导航类不也就没了吗，当然是的，exportEmptyRoute = false 是第1步，第2步就是设置单独导出的通信 module，然后在强引用（例如：implementation）通信 module ，第3步在原来使用这个module的地方compileOnly第2步的通信module

混淆规则

下边是涉及到本库的一些必须混淆规则

# ModuleCommunication必备混淆规则 -----start-----

-keepnames @com.flyjingfish.module_communication_annotation.ExposeInterface class * {*;}
-keepnames class * implements com.flyjingfish.module_communication_annotation.interfaces.BindClass
-keep class * implements com.flyjingfish.module_communication_annotation.interfaces.BindClass{
    public <init>();
}

# ModuleCommunication必备混淆规则 -----end-----

常见问题

1、删除某一个类或资源后，通信 module 中依然存在删除的代码

• 这种情况下建议直接 clean 项目，再次重新调用 generateCommunication 命令。

最后推荐我写的另外一些库

• OpenImage 轻松实现在应用内点击小图查看大图的动画放大效果

• AndroidAOP 是专属于 Android 端 Aop 框架，只需一个注解就可以请求权限、切换线程、禁止多点、监测生命周期等等，没有使用 AspectJ，也可以定制出属于你的 Aop 代码

• ShapeImageView 支持显示任意图形，只有你想不到没有它做不到

• FormatTextViewLib 支持部分文本设置加粗、斜体、大小、下划线、删除线，下划线支持自定义距离、颜色、线的宽度；支持添加网络或本地图片

• 主页查看更多开源库