GreenDao 工具類 --- 使用 Json 快速生成 Bean、表及其結構，"炒雞"快！

時間 2019-11-22

標籤 greendao 工具使用 json 快速生成 bean 及其結構欄目 JavaScript 简体版

原文原文鏈接

做者：林冠宏 / 指尖下的幽靈
掘金：juejin.im/user/587f0d…
博客：www.cnblogs.com/linguanh/
GitHub ： github.com/af913337456…javascript

一直以來，我都是極其反感寫重複的代碼，因此喜歡利用面向對象的編程屬性來本身造輪，或者是二次封裝。前端

前序

GreenDao 相信不少 Android 開發者都熟悉，不知爲什麼物的，這裏不會再介紹它，建議自行百度，介紹文不少。
前天我再次在項目中使用到 Sqlite 來作緩存，通常的代碼是下面這樣的。java

Entity userInfo = schema.addEntity("UserEntity");
        userInfo.setTableName("UserInfo");
        userInfo.setClassNameDao("UserDao");
        userInfo.setJavaPackage(entityPath);
        userInfo.addIdProperty().autoincrement();
        userInfo.addIntProperty("peerId").unique().notNull().index();
        userInfo.addIntProperty("gender").notNull();
        userInfo.addStringProperty("mainName").notNull();
        userInfo.addStringProperty("pinyinName").notNull();
        userInfo.addStringProperty("realName").notNull();
        userInfo.addStringProperty("avatar").notNull();
        userInfo.addStringProperty("phone").notNull();
        userInfo.addStringProperty("email").notNull();
        userInfo.addIntProperty("departmentId").notNull();複製代碼

表結構有多少個字段就寫多少行，表多了還要分開寫。GreenDao自己已是很方便了，但我以爲仍是不夠方便。因此有了下面的"故事"。閱讀完這個"故事"，今後你使用 GreenDao 真正須要你手寫的將會單表是不超過10行！git

思想

作過服務端開發的都知道，通常 C/S 通信採用的數據結構是 Json，當大家公司的後端人員作好了接口後，也會提供測試接口給前端開發者，由於個人APP接口通常也是我寫，因此我有這個習慣，因此，爲什麼不採用 Json的格式來動態生成 客戶端所須要的全部類。故，選擇讀取Jsongithub

GreenDao 的默認 main 函數

public class dao {

    public static void main(String[] args) throws Exception {
        /** 你的生成邏輯代碼 */
    }

}複製代碼

解析JSON

因爲上述是 Java 程序，因此不能使用 Android 的 Json 包，咱們須要下面的幾個 Jar 包，他們的做用的，在 Java 程序了裏面使用到 Json 的操做 API，咱們能夠在解析完以後就再也不引用這些 Jar 包。文末會提供數據庫

dependencies {
    ...
    compile files('libs/commons-beanutils-1.7.0.jar')
    compile files('libs/commons-collections-3.2.jar')
    compile files('libs/commons-lang-2.4.jar')
    compile files('libs/commons-logging-1.0.4.jar')
    compile files('libs/ezmorph-1.0.3.jar')
    compile files('libs/json-lib-2.2.3-jdk15.jar')
}複製代碼

核心函數

利用 Java 關鍵字 instanceof 針對從 Json 裏面解析出來的 value 的不一樣類型來生成不一樣的屬性，Key 作字段名稱，例如 {"name":"lgh"}，解析出來就是 name 做爲字段名詞，因爲 lgh 是字符串，因此對應的是字符串類型。編程

private static void createTable( Schema schema, String tableName, /** 表名 */ String idName, /** 索引 */ String json /** Json */ ) {
        Entity create = schema.addEntity(tableName);
        JSONObject jsonObject = JSONObject.fromObject(json);
        Iterator iterator = jsonObject.keys();
        String key;
        Object value;
        while(iterator.hasNext()){ /** 遍歷 Json */
            key = (String) iterator.next();  /** 字段名詞 */
            value = jsonObject.get(key);
            if(value instanceof Integer){
                if(key.equals(idName)){
                    /** 源碼限制了，主鍵必需是 long 類型 */
                    create.addLongProperty(key).primaryKey().autoincrement();
                    continue;
                }
                create.addIntProperty(key);
            } else if (value instanceof String){
                create.addStringProperty(key).notNull();
            } else if (value instanceof Float){
                create.addFloatProperty(key).notNull();
            } else if (value instanceof Double){
                create.addDoubleProperty(key).notNull();
                /** 其它類型，請自行模仿添加 */
            } else{
                /** 集合類型違反了表結構 */
                throw new IllegalFormatFlagsException("集合類型違反了表結構");
            }
        }
        create.setHasKeepSections(true);
    }複製代碼

一個例子

import net.sf.json.JSONObject;

import java.util.IllegalFormatFlagsException;
import java.util.Iterator;

import de.greenrobot.daogenerator.DaoGenerator;
import de.greenrobot.daogenerator.Entity;
import de.greenrobot.daogenerator.Schema;

/** * 做者：林冠宏 * * author: LinGuanHong ,lzq is my dear wife. * * My GitHub : https://github.com/af913337456/ * * My Blog : http://www.cnblogs.com/linguanh/ * * on 2017/3/21. * */

/** 建立一張表，以及它的字段邏輯，你再也不須要手動一個個寫，只須要傳入 json */

public class dao {

    private final static String YourOutPutDirPath = "./greendaohelper/src/main/java";
    private final static String YourOutPutDirName = "dao";

    public static void main(String[] args) throws Exception {
        Schema schema = new Schema(1, YourOutPutDirName);

        String tableJson =
                "{\n" +
                " \"d_id\": 1278,\n" +         /** 整數類型 */
                " \"d_area\": \"美國\",\n" +   /** 字符串 */
                " \"d_content\": \"講述一個軍事英雄回到美國，隨之也帶來了不少麻煩。他將會和CTU組織合做，來救本身的命或者來拯救一塊兒發生在美國本土的恐怖襲擊的故事。\",\n" +
                " \"d_directed\": \"斯蒂芬·霍普金斯 / 強·卡薩 / 尼爾森·麥科米克 / 布朗溫·休斯\",\n" +
                " \"d_dayhits\": \"2.3\",\n" + /** 浮點類型 */
                " \"d_true_play_url\": \"xxx\"\n" +
                " }";

        createTable(
                schema,
                "pushVideo", /** 表名 */
                "d_id",      /** 主鍵名詞 */
                tableJson
        );

        createTable(
                schema,
                "lghTable", /** 表名 */
                "id",      /** 主鍵名詞 */
                "{\n" +
                " \"id\": 1278,\n" +         /** 整數類型 */
                " \"name\": \"林冠宏\",\n" +   /** 字符串 */
                " \"address\": \"陽江市\",\n" +
                " \"head_url\": \"xxxxxxxx\"\n" +
                " }"
        );
        new DaoGenerator().generateAll(schema,YourOutPutDirPath);
    }

    /** o(n) */
    /** 聚合索引之類的，能夠本身重載此函數 */
    private static void createTable( Schema schema, String tableName, String idName, String json ) {
        ...
    }
}複製代碼

運行結果
在指定的路徑/greendaohelper/src/main/java下生成文件夾dao，裏面包含有

其中lghTable 和 pushVideo 就是咱們生成的 Bean 類，Dao後綴的就是數據表配置類
事實證實，完美符合理想的結果。json

拓展

上述講述瞭如何自動快速地使用 Json 快速生成 Bean、表及其結構，我以爲仍是不夠爽，能更點地調用就更過癮了。後端

公共的抽象
把增、刪、改、查，採用泛型抽象出來。

添加或更新一條緩存

public void insertOrUpdateInfo(K entity){
    T userDao = getWirteDao();
    userDao.insertOrReplace(entity);
}複製代碼

注意這個函數，它是標準的插入或更新一條數據，存在則更新，不然就是插入，兩個泛型類型 K 和 T，K 是 Bean 類，就是上面生成的， T 是dao 數據表配置類，也是上面生成的。到了這裏，就是說，傳入的泛型也是自動生成的，你徹底不須要去手動打碼。

泛型約束

上面說的 T 泛型是屬於 Dao 的配置類，稍做代碼分析就能夠看出，GreenDao 全部生成的數據表配置類都是繼承於 AbstractDao 類。

因此，操做抽象類長這樣

public abstract class DBInterface<K,T extends AbstractDao<K,Long>> {
    ...
}複製代碼

完整例子

public abstract class DBInterface<K,T extends AbstractDao<K,Long>> {

    private LghLogger lghLogger = LghLogger.getLogger(DBInterface.class);

    private DBInit dbInit;

    public DBInterface(){
        /** 不引發 DBInit 的重複實例化 */
        dbInit = DBInit.instance(); /** 初始化用的，這個類在後面提供 */
    }

    protected abstract T getWirteDao();

    protected abstract T getReadDao();

    protected abstract Property getIdProperty();

    private void isInit(){
        if(dbInit.getOpenHelper() == null){
            throw new NullPointerException("openHelper is null!");
        }
    }

    /** * Query for readable DB */
    protected DaoSession openReadableDb() {
        isInit();
        SQLiteDatabase db = dbInit.getOpenHelper().getReadableDatabase();
        DaoMaster daoMaster = new DaoMaster(db);
        DaoSession daoSession = daoMaster.newSession();
        return daoSession;
    }

    /** * Query for writable DB */
    protected DaoSession openWritableDb(){
        isInit();
        SQLiteDatabase db = dbInit.getOpenHelper().getWritableDatabase();
        DaoMaster daoMaster = new DaoMaster(db);
        DaoSession daoSession = daoMaster.newSession();
        return daoSession;
    }

    /** 增 */
    public void insertOrUpdateInfo(K entity){
        T userDao = getWirteDao();
        userDao.insertOrReplace(entity);
    }

    public void batchInsertOrUpdateAllInfo(List<K> entityList){
        if(entityList.size() <=0 ){
            lghLogger.d("本地數據庫插入用戶信息失敗，條數是 0 ");
            return ;
        }
        T userDao = getWirteDao();
        userDao.insertOrReplaceInTx(entityList);
    }



    /** 刪 */
    public void deleteOneById(int id){
        T userDao = getWirteDao();
        DeleteQuery<K> bd = userDao.queryBuilder()
                .where(getIdProperty().eq(id))
                .buildDelete();

        bd.executeDeleteWithoutDetachingEntities();
    }

    public void deleteAllBeans(){
        T userDao =  getWirteDao();
        DeleteQuery<K> bd = userDao.queryBuilder()
                .buildDelete();
        bd.executeDeleteWithoutDetachingEntities();
    }

    /** 改 */
    /** 在查裏面，由於自己就是 insertOrUpdate */

    /** 查，加入了模糊查找 */
    public K getBeanById(int id){
        T dao = getReadDao();
        return dao
                .queryBuilder()
                .where(getIdProperty().eq(id)).unique();
    }

    public K getBeanWithLike(Property property,String what){
        T dao = getReadDao();
        return dao
                .queryBuilder()
                .where(property.like("%"+what+"%")).unique();
    }

    public List<K> loadAllBeans(){
        T dao = getReadDao();
        /** 倒敘 */
        return dao.queryBuilder().orderDesc(getIdProperty()).list();
    }

    public List<K> loadAllBeansWithLike(Property property, String what){
        T dao = getReadDao();
        return dao
                .queryBuilder()
                .where(property.like("%"+what+"%")).orderAsc(getIdProperty()).list();
    }

}複製代碼

DBInit.java 負責初始化，靜態內部類單例，避免了反覆建立對象

public class DBInit {

  private LghLogger lghLogger = LghLogger.getLogger(DBInit.class);

  private int loginUserId = 0;

  private DaoMaster.DevOpenHelper openHelper;

  public static DBInit instance(){
      return DBHelper.dbInit;
  }

  /** 私有 */
  private DBInit(){
      lghLogger.d("初始化 dbinit");
      initDbHelp(LghApp.context,1); /** 能夠本身遷移初始化位置 */
  }

  public DaoMaster.DevOpenHelper getOpenHelper(){
      return openHelper;
  }

  private static class DBHelper{

      private static DBInit dbInit = new DBInit();

  }

  /** 十分建議使用 Application 的 context * 支持用用戶的 ID 區分數據表 * */
  public void initDbHelp(Context ctx, int loginId){
      if(ctx == null || loginId <=0 ){
          throw  new RuntimeException("#DBInterface# init DB exception!");
      }
      /** 切換用戶的時候， openHelper 不是 null */
      String DBName = "lgh_"+loginId+".db";
      if(openHelper!=null){
          /** 判斷下 db name 是否是同樣的，不是同樣就重置 */
          String dbNameTemp = openHelper.getDatabaseName().trim();
          if(dbNameTemp.equals(DBName)){
              lghLogger.d("相同的用戶，不用從新初始化本地 DB");
              return;
          }else{
              lghLogger.d("不是相同的用戶，須要從新初始化本地 DB");
              openHelper.close();
              openHelper = null;
          }
      }
      if(loginUserId !=loginId ){
          loginUserId = loginId;
          close();
          lghLogger.d("DB init,loginId: "+loginId);
          DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(ctx, DBName, null);
          this.openHelper = helper;
      }else{
          lghLogger.d("DB init,failed: "+loginId);
      }
  }

  private void close() {
      if(openHelper !=null) {
          lghLogger.d("關閉數據庫接口類");
          openHelper.close();
          openHelper = null;
          loginUserId = 0;
      }
  }
}複製代碼

使用

有了上面的準備，就可使用了，正在須要本身動手的代碼幾乎沒有。下面咱們建一個操做類型的子類VideoInfoDbCache，集成於 DBInterface，重寫完三個抽象函數後，就是下面這樣。

public class VideoInfoDbCache extends DBInterface<pushVideo, pushVideoDao> {

    @Override
    protected pushVideoDao getWirteDao() {
        return openWritableDb().getPushVideoDao(); /** 該函數由 GreenDao 提供，不用本身編寫 */
    }

    @Override
    protected pushVideoDao getReadDao() {
        return openReadableDb().getPushVideoDao(); /** 該函數由 GreenDao 提供，不用本身編寫 */
    }

    @Override
    protected Property getIdProperty() {
        return pushVideoDao.Properties.D_id;       /** 自定義的拓展，這裏獲取了通常的 id 做爲主屬性 */
    }
}複製代碼

如今咱們看看 MainActivity 裏面的使用。直接採用匿名對象，直接 new，直接用。

public class MainActivity extends AppCompatActivity {

    List<pushVideo> list;
    List<lghTable>  lghList;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ...
        list = new VideoInfoDbCache().loadAllBeans();
        list = new VideoInfoDbCache().loadAllBeans();
        list = new VideoInfoDbCache().loadAllBeans();
        list = new VideoInfoDbCache().loadAllBeans();
        list = new VideoInfoDbCache().loadAllBeans();
        list = new VideoInfoDbCache().loadAllBeans();

        lghList = new LghTableDbCache().loadAllBeans();
        lghList = new LghTableDbCache().loadAllBeansWithLike(
                lghTableDao.Properties.Name,"林冠宏"
        );
        ...
    }
}複製代碼