GreenDao2.2升級GreenDao3.0的適配之路,greendao資料庫升級
前言.為什麼要升級到Greendao3.0?1. 多人開發
以往的資料庫建表建Dao等操作要新開一個module,在統一的地方管理資料庫建表,現在可以直接寫Entity。多人開發時自己管自己的Entity即可 不用像以前衝突成狗。
2. 結構簡潔方便
以往是在寫CreateTable addEntity("")等方法建表,現在只需要在Entity裡使用3.0的註解文法
3. 註解使用
以前的Entity是會經常產生和覆蓋的,所以不建議改Entity的代碼,所以就不好在Entity裡面加註解了,這也使得放棄gson的@SerializedName("id") 這個返回欄位與自寫欄位不同時的註解。3.0以後Greendao自己都用註解了那我們也就可以用了。
4. 資料庫安全
資料庫加密 3.0的GreenDao提供了內建加密的功能非常實用。
升級之路
官網說這裡升級有兩條路可走,一條是保留之前產生代碼的那個模組,另一條是遷移實體類並且刪除之前的其他組建檔案。這裡推薦第二種做法,第一種總感覺升級的不徹底會留坑。
1.將之前的Entity保留好
這裡可以選擇遷移一下檔案夾裡的Entity,並且直接將之前的組建組態給去掉。
settings.gradle裡面的include去掉之前的module, 主build.gradle裡的preBuild.dependsOn那個模組也去掉。
2.升級gradle
在build.gradle的dependence裡面升級版本號碼,改成如下
compile 'org.greenrobot:greendao-generator:3.0.0'compile 'org.greenrobot:greendao:3.0.1'
3.改配置的地址
因為把之前用來產生的Module棄用了,所以要把一些之前在就Module配置的東西補到工程的build.gradle裡面。
在頂部加上
apply plugin: 'org.greenrobot.greendao'
在dependencies{}下面加上
greendao { targetGenDir 'src/main/java' //產生代碼放的路徑 daoPackage 'com.XXX.platform.dao'}
4.刪除派生部分,加上註解,主鍵,依賴,entity
將之前代碼裡的派生代碼刪除,比如getter setter方法,還有一些注釋包裹著的代碼/*ToOne*/ 類似於下面都能刪了。
/** To-one relationship, resolved on first access. */ public OrderBase getOrderBase() { Long __key = this.orderId; if (orderBase__resolvedKey == null || !orderBase__resolvedKey.equals(__key)) { if (daoSession == null) { throw new DaoException("Entity is detached from DAO context"); } OrderBaseDao targetDao = daoSession.getOrderBaseDao(); OrderBase orderBaseNew = targetDao.load(__key); synchronized (this) { orderBase = orderBaseNew; orderBase__resolvedKey = __key; } } return orderBase;
將之前被這個注釋包裹的屬性刪掉,並在前面加上@Transient
// KEEP INCLUDES - put your custom includes here// 屬性代碼// KEEP INCLUDES END // KEEP FIELDS - put your custom fields here// 屬性getter setter方法// KEEP FIELDS END
下面的getset方法可以保留,也可刪了讓他重建。 但這裡要說一下加了@Transient註解的屬性 不會自動產生getset方法,所以你可以先run一次待他產生後再加上@Transient註解。
接下來就是把之前建立表的舊代碼的一些特殊寫法,改成新版本的註解寫法。
在這段過程中可能會經常改一點Run一下,這時可以先不考慮工程裡的各種紅線,因為build的時候會先產生這些Dao,然後再編譯業務的代碼。所以當你看到下面的報錯已經和greendao無關時就說明這邊已經通過了。如果是greendao的產生報錯也不用擔心,這些錯誤的描述都是精確位置和非常易懂的。
列出幾種錯誤:
Error:Execution failed for task ':platform:greendao'.> Currently only single FK columns are supported: ToOne 'orderBase' from OrderXXX to OrderBase
上面沒有添加主鍵
Error:Execution failed for task ':platform:greendao'.> Can't replace field in /Users/dsx/Documents/XXX/platform/src/main/java/com/XXX/platform/bean/OrderXXX.java:43 with generated version.//董鉑然 部落格園 If you would like to keep it, it should be explicitly marked with @Keep annotation. Otherwise please mark it with @Generated annotation
上面需要加上@keep
Error:Execution failed for task ':platform:greendao'.> Can't add field `Variable(type=VariableType(name=com.xxx.platform.dao.OrderBase, isPrimitive=false, originalName=OrderBase, typeArguments=null), name=orderBase)` // 董尚先for entity OrderXXX due to: Unsupported type com.xxx.platform.dao.OrderBase
上面需要設定好表關係。 應該是漏了ToOne或ToMany
5.前後文法對比
一般在幹這種升級操作之前應該都是對3.0文法有瞭解的了,如果不熟可以看下這篇文章的註解部分。就是之前2.2的某某某代碼應該改為3.0的某某某註解
http://www.cnblogs.com/dsxniubility/p/5699543.html
6.把包名檔案替換
全文檢索搜尋把包名替換成下面的
// old package nameimport de.greenrobot.dao.database.Database;... // new package nameimport org.greenrobot.greendao.database.Database;...
7.最後解決一些編譯錯誤
1.DaoOpenHelper改成DevOpenHelper
2.sqldatabase 換成database
3.getWritableDatabase()換成getWritableDb()
至此完成