本文同步發表于我的微信公眾號,掃一掃文章底部的二維碼或在微信搜索 郭霖 即可關注,每個作業日都有文章更新,
2020年只剩下最后半個月了,你今年定下的目標都完成了嗎?
大概是在今年5 6月份的時候,我曾經在公眾號中透漏過,今年打算再開發一個新的開源專案,那個時候基本思路其實已經都想得差不多了,但是因為同時還要維護LitePal和PermissionX這兩個開源專案,時不時還要寫些原創文章,所以我很不確定今年是否真的可以完成這個新開源專案,
而在今年的最后一個月,很高興地告訴大家,這個新專案我已經基本完成了,雖然還有許多不足的地方,但是我相信目前已經可以將第一個測驗版本發布出來了,當然第一個版本一定會存在不少bug,我會根據大家的反饋不斷繼續完善代碼,這也將是另一個我會長期支持下去的開源專案,
那么接下來我們就具體聊一聊這個開源專案到底是什么吧,
其實做了Android開發這么多年,一直以來都有一個我認為非常不人性化的地方,就是開發人員沒有辦法簡單直接地查看當前應用程式中的資料庫檔案,這個問題導致Android資料庫的開發與除錯作業一直都比較困難,
舉個例子,我們撰寫了一段代碼去查詢資料庫當中的某條資料,但是卻沒能查出來,那么到底是因為查詢陳述句寫錯了?還是因為這條資料根本就不存在?要如何定位及解決這種問題是比較頭疼的,因為我們無法直觀地看到當前資料庫中實際的資料,
那么過去大家都是如何解決的呢?
這個真的是八仙過海,各顯神通了,像我個人比較習慣的方式是直接用SQL命令查看,借助adb shell進入控制臺,然后使用sqlite3命令打開某個資料庫檔案,再接下來用傳統的SQL陳述句就能查看該資料庫當中的資料了,只可惜這種方式自Android 7.0之后被禁止使用,主要還是考慮資料的安全性問題吧,
另外也有一些朋友可能會借助一些第三方的工具,比如說SQLite Expert,這種工具是在電腦上用來查看資料庫檔案的,因此需要先想辦法將手機中的資料庫檔案匯出到電腦上(這一步也并不容易,因為內置存盤空間的檔案很難匯出),然后再用SQLite Expert打開該檔案即可查看其中的資料,
不管使用哪種方式,看上去都不是一件簡單的事情,有的時候我在開發程序中遇到一些資料庫的問題,一想到要用這么繁瑣的步驟才能查看到資料庫當中的資料,我寧愿換一種解決問題的思路,
Google在過去一直沒有針對資料庫除錯這方面提供了一個簡便的解決方案,這是我認為非常不人性化的一點,
好訊息是,最新的Android Studio 4.1當中終于內置了Database Inspector這個工具,在很大程度上解決了資料庫除錯困難的問題,并且我認為,Google早就應該提供這個工具了,
而我新開發的這個開源專案同樣也是為了解決這個問題,
最開始想到去做這樣一個開源專案,主要是受到LeakCanary的啟發,LeakCanary相信很多朋友都用過,我們只需要將LeakCanary的庫集成到專案當中,LeakCanary就能自動檢測當前專案的記憶體泄漏情況,并通過可視化的界面將記憶體泄漏問題展示給開發者,
然后我就想到,我是不是也可以開發一個開源庫,當任何專案集成了這個開源庫后,就自動掃描當前專案的內置和外置存盤空間,把所有的資料庫檔案都掃描出來,然后同樣提供一個可視化的界面以方便開發者隨時查看資料庫中的資料,
有了這個庫,當我們在開發程序中再次遇到資料庫問題時,直接通過可視化界面查看一下資料庫當中真實的資料是什么樣的,哪里出了問題就一目了然了,
雖然聽上去和Database Inspector的功能有點重疊,但其實它們的目標場景是完全不同的,Database Inspector需要手機連到電腦上,然后在Android Studio里查看資料庫當中的資料,而我開發的這個開源庫不需要連接電腦,只需在手機上即可查看(有點類似于Profiler和LeakCanary之間的關系),
我給這個開源庫起名為:Glance,意為一瞥的意思,我希望能讓開發者們通過快速一瞥即可定位開發當中遇到的資料庫問題,所以起了這樣一個名字,
確定了專案名和設計思路之后,接下來我就開始動手開發了,事實上,Glance的開發程序一路都比較順利,可能主要是因為之前開發過LitePal,所以在資料庫方面積累了很多經驗,
并且,我對Glance的定位不僅僅只是一個協助查看資料庫內容的工具,同時也是一個非常好的學習專案,在撰寫Glance的時候,我特意使用了許多Google目前最推薦使用的各項新技術,包括Kotlin、協程、Paging3、App Startup、MVVM等等等等,基本都是按照最標準的專案開發規范去實作的,所以,學習這個專案的原始碼相信也會對你的開發水平有非常大的幫助,
我大概是從8月中旬的時候開始著手撰寫的這個專案,到11月份的時候基本就將所有主要的功能都開發完成了,期間還進行了一輪小范圍的內部測驗,幾位熱心群友幫我發現了好幾個頗為嚴重的bug,我又對此一一進行了修復,
那么現在,我認為這可以算是一個相對比較穩定的版本了,但是由于畢竟是全新的開源庫,我還不敢直接發布1.0.0版本,因此這次發布的是1.0.0-alpha01版本,大家如果在使用的程序中發現了任何問題,很正常,反饋給我即可,我會盡快進行修復,
好了,接下來就向大家介紹Glance的具體用法吧,其實真的非常非常簡單,只需要使用如下陳述句將Glance引入到你的專案當中:
dependencies {
debugImplementation 'com.glance.guolindev:glance:1.0.0-alpha01'
}
然后就結束了,
沒錯,就是這么簡單,Glance沒有提供任何對外的API,所以也不需要你進行什么代碼對接操作,只要將依賴庫引入到你的專案當中,就算是對接完成了,
注意上述的參考陳述句中我們使用的關鍵字是debugImplementation,這個關鍵字相信大家用的比較少,通常我們使用的都是implementation關鍵字,那么debugImplementation是什么意思呢?它表示只有在你的專案是debug版的時候,才會將Glance引入到你的專案當中,而release版是不會包含Glance庫的,
這是一種最為安全的做法,因為如果release版中引入了Glance庫,相當于給你的應用程式留了個后門,是有可能引起資料庫安全問題的,
接下來就像平常那樣運行你的程式就可以了,你會發現,你的手機桌面上將會多出一個Glance的圖片,如下圖所示,
這個圖示就是引入了Glance庫之后自動生成的,點擊該圖示即可打開Glance的可視化界面,如下圖所示,
在這里,Glance會自動開始掃描當前應用程式的內置和外置存盤空間,將所有的資料庫檔案全部搜索到,并一一列出,
比如上圖中的demo1.db就是我當前專案工程中的一個資料庫檔案,internal storage表示它是存放在內置存盤空間下的,
點擊demo1.db,即可打開這個資料庫檔案,并將該資料庫中的所有表羅列出來,如下圖所示,
當然這里列出的表并不全部都是由我們自己創建的,比如android_metadata、sqlite_sequence這些表就是自動生成的,但Glance并不會對此進行區分,而是會把它們全部羅列出來,
接下來點擊magazine表,我們即可查看表中的資料,橫向滾動可以查看所有的列,縱向滾動可以查看所有的行,如下圖所示,
這里對表中的資料進行加載使用了分頁技術,所以即使你的表中有上百萬條資料,也會非常快速地加載出來,而Glance的分頁技術是使用Paging3實作的,對Paging3感興趣的朋友可以參考參考這部分的原始碼,
到這里為止,我們就可以非常方便地隨時查看當前應用程式資料庫中的資料了,相比于之前還要想辦法匯出資料庫檔案,發送到電腦上,再借助第三方工具進行查看,是不是簡單了千百倍?
即使相比于Database Inspector,我認為Glance也是有很大優勢的,畢竟你不需要借助電腦,也不需要打開Android Studio才能查看,
另外,假如你的資料庫檔案發生了變化,Glance也可以迅速地感知到,比如我們向當前應用程式的外置存盤空間當中添加一個新的資料庫檔案,如下圖所示,
可以看到,當回到Glance的可視化界面之后,迅速就能發現新增了一個demo2.db,external storage表示它是存放在空間存盤空間下的,
然后我們就可以立刻查看demo2.db當中的全部資料了,
那么關于Glance的用法介紹到這里大概就差不多了,因為畢竟它的主要功能就是一個輔助型的工具,并不是什么需要去開發和對接的庫,所以整體用法是非常簡單的,
接下來我想聊一聊Glance的限制,至少在目前第一個版本中,這些限制是需要提醒大家的,
首先,Glance只提供對資料庫進行查看的功能,并不提供修改和洗掉的功能,當然之所以不支持修改和洗掉,并不是因為什么其他特殊的原因,純粹只是因為我沒時間,為了能趕在今年內上線第一個版本,我選擇了只開發了最核心的查看功能,
在接下來的版本更新當中,修改和洗掉資料庫的功能會有極大的概率被加入進去,
第二,Glance只支持使用AndroidX架構的專案,并且未來也只會支持AndroidX架構,如果你的專案還在使用Support Library架構,那么很遺憾,你將無法使用Glance,
關于這個限制我其實思考了很久,因為本身查看資料庫功能和AndroidX架構一點關系都沒有,但是我在Glance當中使用了大量最新的Google技術,如協程、Paging3、App Startup等等,這些新技術都是只支持AndroidX架構的,那么到底是為了更好的兼容性而不使用這些新技術,還是為了讓Glance更具有學習意義而使用這些新技術,我最終選擇了后者,
另外我相信,AndroidX終將是趨勢,即使現在還在使用Support Library的專案,在不久的將來也必然會轉換到AndroidX架構上,所以對此我并不是很擔心,
好了,關于Glance第一個版本的所有介紹就到這里,也很高興我將今年定下的最后一個小目標也實作了,這一年真的可以說是識訓滿滿,
最后附上Glance的開源庫地址,想學習原始碼的朋友不要錯過哦,另外也請幫我隨手點個star,謝謝大家,
https://github.com/guolindev/Glance
如果想要學習Kotlin和最新的Android知識,可以參考我的新書 《第一行代碼 第3版》,點擊此處查看詳情,
關注我的技術公眾號,每個作業日都有優質技術文章推送,
微信掃一掃下方二維碼即可關注:
![]()
轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/236119.html
標籤:其他
