手把手教你搭建android模块化项目框架(一)选择篇

本系列旨在帮助android新人搭建属于自己的项目框架。由于篇幅较长,本人时间有限,因此更新系列可能周期较长。
本篇搭建框架适用于中大型项目。

经典框架选取

  • 总模式:mvvm-databinding
  • 图片加载:glide
  • 事件总线:kotlin.flow或eventbus,本篇选用kotlin.flow撸出自己的事件总线
  • 线程调度:kotlin.CoroutineScope
  • 网络请求:retrofit + kotlin.flow
  • 权限请求:后续文章教大家撸出自己的权限工具
  • 数据库:room
  • 分页库:paging
  • 下载工具:aira or okdownload
  • json解析:Gson
  • 图片压缩:luban
  • 模块化路由:arouter or WMRouter ,本篇为了让大家更加理解模块化路由工作方式,因此会使用path简单封装一个自己的router。
  • 动画等:lottie or svga or pag不过本篇不教大家如何使用该框架功能。因为单一的工具并非框架重点功能。
  • 其他:core-ktx,lifecycle,androidx系列库等。
  • 依赖注入:hilt(可选),依赖注入是否需要使用,取决于预估的项目规格大小,本篇抛砖引玉,会带入一点hilt的使用,不过并非重点,可酌情选取使用。
  • 基础存储:mmkv(可选),由于room有一定的性能问题,所以性能优化后的部分常用键值对可以选用mmkv使用。
  • bug采集:bugly 本篇不接入,正式项目可选取合适自己的采集工具。
  • 埋点采集:同上。
    上述基本描写了目前大多数项目使用的三方及jetpack框架,后续可能补充其他选择。如:lifecycle等,不过由于是一方库,所以不过多描述。

下面开始引入:
创建android项目这一步不多说,但是为了引入项目的一致性,我们创建deps.gradle文件,将项目中所有引入的库都放在该文件下,避免各个模块引入的库版本不一致。

rootProject.ext.compileSdkVersion = 33
rootProject.ext.targetSdkVersion = 33

rootProject.ext.minSdkVersion = 21

rootProject.ext.GLIDE_VERSION = "4.13.2"
rootProject.ext.lifecycle_version = "2.5.1"
rootProject.ext.roomVersion = '2.5.2'

rootProject.ext.deps = [

        /////////////////////////// Android官方库  //////////////////////////////////////////////////
        // android
        androidCoreKtx          : 'androidx.core:core-ktx:1.9.0',
        androidAnnotations      : 'androidx.annotation:annotation:1.6.0',
        androidAppCompat        : 'androidx.appcompat:appcompat:1.6.1',
        androidFragmentKtx      : 'androidx.fragment:fragment-ktx:1.5.5',
        androidActivityKtx      : "androidx.activity:activity-ktx:1.6.1",

        androidLifecycleViewModel : "androidx.lifecycle:lifecycle-viewmodel-ktx:$rootProject.ext.lifecycle_version",
        androidLifecycleRuntime   : "androidx.lifecycle:lifecycle-runtime-ktx:$rootProject.ext.lifecycle_version",


        // widget
        androidCardView         : 'androidx.cardview:cardview:1.0.0',
        androidRecyclerView     : 'androidx.recyclerview:recyclerview:1.2.1',
        androidPercent          : 'androidx.percentlayout:percentlayout:1.0.0',
        androidGridLayout       : 'androidx.gridlayout:gridlayout:1.0.0',
        androidConstraintLayout : 'androidx.constraintlayout:constraintlayout:2.0.4',
        androidPalette          : 'androidx.palette:palette-ktx:1.0.0',
        androidSwipe            : 'androidx.swiperefreshlayout:swiperefreshlayout:1.1.0',

        androidDesignLibrary    : 'com.google.android.material:material:1.4.0',
        androidFlexbox          : "com.google.android.flexbox:flexbox:3.0.0",

        // emoji2
        emoji2                  : "androidx.emoji2:emoji2:1.1.0",
        emoji2_views            : "androidx.emoji2:emoji2-views:1.1.0",
        emoji2_helper           : "androidx.emoji2:emoji2-views-helper:1.1.0",

        /////////////////////////// 第三方开源库  ///////////////////////////////////////////////////
        // di 依赖注入
        dagger                  : "com.google.dagger:dagger:2.44.2",
        daggerCompiler          : "com.google.dagger:dagger-compiler:2.44.2",

        // http
        okhttp                  : "com.squareup.okhttp3:okhttp:3.12.13",
        okio                    : "com.squareup.okio:okio:1.17.4",
        okhttpLoggingInterceptor: "com.squareup.okhttp3:logging-interceptor:3.12.13",
        networkConnectionClass  : "com.facebook.network.connectionclass:connectionclass:1.0.1",
        retrofit2AdapterRxJava  : "com.squareup.retrofit2:adapter-rxjava2:2.6.4",
        retrofit                : "com.squareup.retrofit2:retrofit:2.6.4",
        converter_gson          : "com.squareup.retrofit2:converter-gson:2.6.4",

        //json
        gson                    : "com.google.code.gson:gson:2.8.0",

        // glide
        glide                   : "com.github.bumptech.glide:glide:$rootProject.ext.GLIDE_VERSION",
        glideCompiler           : "com.github.bumptech.glide:compiler:$rootProject.ext.GLIDE_VERSION",

        // kv store
        tencentMmkv             : "com.tencent:mmkv-static:1.2.16",
]

由于是粘贴至其他项目的,版本可能不是最新的。
然后将该文件引入至gradle入口处,这样就可以在其他模块引用了。文件如下图


新建 BMP 图像.png

插入代码

plugins {
id 'com.android.application' version '8.1.0' apply false
    id 'org.jetbrains.kotlin.android' version '1.8.0' apply false
}
//引入该文件
apply from: "$rootDir/deps.gradle"

至此,就可以在其他模块中引入了,例如app.gradle中引入

dependencies {
    implementation rootProject.ext.deps.androidCoreKtx
    implementation rootProject.ext.deps.androidAppCompat
    implementation rootProject.ext.deps.androidDesignLibrary
}

本篇至此就结束了,至于gradle的更高级配置会在后续逐步说明。
项目地址
项目持续更新,每个步骤请查询tag

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,922评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,591评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,546评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,467评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,553评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,580评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,588评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,334评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,780评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,092评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,270评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,925评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,573评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,194评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,437评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,154评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,127评论 2 352

推荐阅读更多精彩内容