AndroidManifest 是什么,對不起,我不需要 ^-^

前言

在寫 Android 應用時,當你新建一個 ActivityServiceContentProviderBroadcast(著名的四大組件)時,你是不是經常性的寫完就直接運行,然后程序就崩潰了,通過查看日志,你才發覺原來忘記在 AndroidManifest.xml 中進行注冊。甚至于,當我們代碼運行需要某些權限時,你也要跳轉到 AndroidManifest.xml 中進行權限聲明,然后代碼才能正確運行,而這些操作,我們往往都會忘記。

筆者個人認為,導致我們經常性忘記在 AndroidManifest.xml 中進行注冊的一個主要的原因就在于編寫代碼和進行注冊是發生在兩個文件中的,也就是我們需要進行文件切換,這種切換操作對于我們正在編寫程序的思路起到了切斷作用,所以我們往往在專注于寫代碼的時候,就會忘記進行組件注冊。

基于以上原因,筆者開發了一套開源框架:InjectManifest,這套框架致力于解決上面我們提到的編寫代碼和進行組件注冊需要進行文件切換的不便,框架提供注解進行注冊,讓我們在編寫相關需要進行注冊的代碼的同時,可以很方便地直接使用注解進行相關內容的注冊,再也無需切換到 AndroidManifest.xml 去做這些事。

優點

  • 采用編譯期注解與自定義 Gradle 插件完成注冊過程,對程序運行無任何影響;
  • 支持注解和原生 AndroidManifest.xml 協同工作,最終會將兩者結合起來,保留不一致的元素,相同的元素只保留一份;
  • 對支持的標簽的所有屬性配置均支持;

缺點

  • 在每次使用注解注冊后,需要 rebuild 一下才能生成新的 AndroidManifest.xml文件,如果采用注解注冊后,直接運行程序,可以看到新的 AndroidManifest.xml 也生成了,但是程序此時使用的是舊的(也就是原生的)AndroidManifest.xml配置。這個地方的原因我猜測應該是 processDebugManifest/processReleaseManifest 運行在 新的 AndroidManifest.xml 生成前,所以這個問題我猜測是不是可以有什么辦法把processDebugManifest/processReleaseManifest 放到文件生成后再執行····這個地方我暫時也沒找出什么辦法進行解決,如果有誰知道怎么解決這個問題的,麻煩跟我講下,謝謝。
  • 目前只支持 manifest,application,activity,service,receiver,provider,uses-permission 標簽的解析,對于其他標簽,無法進行融合,在新生成的 AndroidManifest.xml 中這些元素不會被保留;

示例

  1. manifest 標簽注冊
@InjectManifest(
        pkName = "com.yn.injectmanifest",
        installLocation = INTERNAL_ONLY,
        sharedUserId = "android.uid.system"
)

public class App extends Application {
}

rebuild 一下,你就可以看到 AndroidManifest.xml 變成這樣:

@InjectManifest

manifest 標簽的其他屬性 @InjectManifest 均支持。

  1. application 標簽注冊
@InjectApp(
        name = ".App", //you can full class name or just simply using a .classSimpleName
        label = "i am app",
        debuggable = TRUE,
        metaData = @InjectMetaData(name = "app/meta-data")
)
public class App extends Application {
}

rebuild 一下,你就可以看到 AndroidManifest.xml 變成這樣:

@InjectApp

application 標簽的其他屬性 @InjectApp 均支持。

  1. activity 標簽注冊
@InjectActivity(
        name = ".MainActivity",
        intentFilter = @InjectIntentFilter(
                action = {"android.intent.action.MAIN", "android.intent.action_whyn_test"},
                category = {"android.intent.category.LAUNCHER", "android.intent.category.whyn"},
                data = @InjectData(mimeType = "image/*")
        ))
public class MainActivity extends AppCompatActivity {}

rebuild 一下,你就可以看到 AndroidManifest.xml 變成這樣:

@InjectActivity

activity 標簽的其他屬性 @InjectActivity 均支持。

  1. service 標簽注冊
@InjectService(
        enabled = TRUE,
        name = ".FirstService",
        label = "Inject Service test",
        intentFilter = @InjectIntentFilter(
                action = "com.yn.action.FirstService",
                category = "com.yn.category.serviceTest",
                data = @InjectData(
                        host = "sdcard",
                        mimeType = "video/mp4",
                        path = "/sdcard/1.MP4",
                        pathPattern = ".*\\.mp4",
                        pathPrefix = "/sdcard/",
                        port = "-2",
                        scheme = "file"
                )
        ),
        metaData = @InjectMetaData(name = "com.yn.meta-data.service")
)
public class FirstService extends Service {···}

rebuild 一下,你就可以看到 AndroidManifest.xml 變成這樣:

@InjectService

service 標簽的其他屬性 @InjectService 均支持。

  1. receiver 標簽注冊
@InjectReceiver(
        name = ".FirstReceiver",
        label = "hi i am first receiver",
        process = ".remote",
        enabled = TRUE
)
public class FirstReceiver extends BroadcastReceiver {···}

rebuild 一下,你就可以看到 AndroidManifest.xml 變成這樣:

@InjectReceiver

receiver 標簽的其他屬性 @InjectReceiver 均支持。

  1. provider 標簽注冊
@InjectProvider(
        authorities = "com.yn.authorities",
        name = ".FirstProvider",
        label = "I am ContentProvider"
)
public class FirstProvider extends android.content.ContentProvider {···}
@InjectProvider

provider 標簽的其他屬性 @InjectProvider 均支持。

  1. uses-permission 標簽注冊
    @InjectUsesPermission({
            Manifest.permission.ACCESS_FINE_LOCATION,
            Manifest.permission.BLUETOOTH,
            Manifest.permission.ACCESS_WIFI_STATE,
    })
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }

rebuild 一下,你就可以看到 AndroidManifest.xml 變成這樣:

@InjectUsesPermission

uses-permission 標簽的其他屬性 @InjectUsesPermission 均支持。

目前暫時就只支持以上所講的標簽,后續我有時間就會不定時更新下。

下載

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.whyn:injectmanifest-plugin:1.1.0'
    }
}

然后,apply 到你的 module

apply plugin: 'com.android.application'
apply plugin: 'com.whyn.plugin.injectmanifest'

注意事項:

  • InjectManifest 默認會將生成的 AndroidManifest.xml 替換掉原來的 AndroidManifest.xml,但在替換前,會將原來的 AndroidManifest.xml 保存為 AndroidManifest_old.xml,所以,對于暫時未支持的 xml 標簽,新生成的文件無法保留,那么你就可以從 AndroidManifest_old.xml 中找回。
    如果想更換上面的默認行為,那就需要在 modulebuild.gradle 中增加下面的擴展屬性:
manifestConfig {
    //the defautl AndroidManifest.xml path
    originManifestPath android.sourceSets.main.manifest.srcFile.absolutePath

    //the AndroidManifest.xml path generated by annotation processor
    genManifestPath "$project.buildDir/generated/source/apt/debug/Collections.xml"
    
    //to save the original AndroidManifest: true -- save,false -- not save
    saveOrigin false
}
  • 如果你在開發過程中,要為注解處理器傳遞參數,請記住加上 + 號,代表追加,否則,會導致 gradle 插件里面默認設置的注解參數失效,這樣就不會合并原生 AndroidManifest.xml 了。
android {
    defaultConfig{
    ···
    ···
        javaCompileOptions {
            annotationProcessorOptions {
                arguments += [xxxxx: 'yyyyy'] 
            }
        }
    }
}
  • 如果你對 AndroidManifest.xml 的默認路徑進行了修改,如果你還希望能合并 AndroidManifest.xml,那你需要手動傳遞最新路徑給 annotation processor
android {
    defaultConfig{
    ···
    ···
        javaCompileOptions {
            annotationProcessorOptions {
                arguments = [AndroidManifestPath: android.sourceSets.main.manifest.srcFile.absolutePath] 
            }
        }
    }
}

附錄

源碼傳送門:InjectManifest
AndroidManifest.xml 應用清單官方文檔: here

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,362評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,577評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,486評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,852評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,600評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,944評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,944評論 3 447
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,108評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,652評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,385評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,616評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,111評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,798評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,205評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,537評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,334評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,570評論 2 379

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,828評論 18 139
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,747評論 25 708
  • Spring Boot 參考指南 介紹 轉載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,922評論 6 342
  • 如有雷同,不是巧合。 大環境仍然是穩定,國家政策是穩健的貨幣政策和積極的財政政策,說白了就是不放水,搞...
    十二月的陽光閱讀 177評論 0 0
  • 已經過去十天了,距離蘇荷在網上發布籌款開始。這期間,她每天都抱著那部有些破舊的手機查看銀行卡余額,然后將籌款一筆一...
    茶丁故事閱讀 955評論 6 23