请选择 进入手机版 | 继续访问电脑版

GreenDao 3.0 简介、使用及踩坑

[复制链接]
钟启航 发表于 2021-1-3 11:53:46 | 显示全部楼层 |阅读模式 打印 上一主题 下一主题
一、GreenDao 简介


  GreenDAO 是一款开源的面向 Android 的轻便、快捷的 ORM 框架,将 Java 对象映射到 SQLite 数据库中,我们操纵数据库的时候,不再需要编写复杂的 SQL语句, 在性能方面,greenDAO 针对 Android 举行了高度优化,最小的内存开销 、依赖体积小 同时照旧支持 数据库加密。
  greenDAO 官网地点:greenrobot.org/greendao/
  greenDAO GitHub 源码地点:greenrobot/greenDAO
二、GreenDao 特征



  • 1、支持 protocol buffer(protobuf) 协议
    GreenDao 支持 protocol buffer(protobuf) 协议数据的直接存储,如果你通过 protobuf 协议与服务器交互,将不需要任何的映射
  • 2、代码生成
    greenDAO 会根据设置信息自动生成核心管理类以及 DAO 对象
  • 3、性能
    所有 ORM 数据库的,greenDAO 是最快的,greenDAO 不作性能方面任何妥协
三、核心类先容

1、DaoMaster:

  使用 greenDAO 的入口点。DaoMaster 负责管理数据库对象(SQLiteDatabase)和 DAO 类(对象),我们可以通过它内部类 OpenHelper 和 DevOpenHelper SQLiteOpenHelper 创建差异模式的 SQLite 数据库。
2、DaoSession :

  管理指定模式下的所有 DAO 对象,DaoSession 提供了一些通用的长期性方法比如插入、负载、更新和删除实体。
3、XxxDAO :

  对于每个实体类, greenDAO 都会生成一个与之对应 DAO 对象,如:User 实体,则会生成一个 UserDao 类
4、Entities:

  可长期化对象。通常,实体对象代表一个数据库行,使用标准 Java 属性(如一个 POJO 或 JavaBean )

四、集成 GreenDao

a、设置堆栈与插件(Project: build.gradle)

  1. buildscript {    repositories {        jcenter()        mavenCentral() // add repository    }    dependencies {        classpath 'com.android.tools.build:gradle:3.1.3'        classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2'  // add plugin    }}
复制代码
b、设置依赖 ( Module:app build.gradle )

  1. apply plugin: 'com.android.application'apply plugin: 'org.greenrobot.greendao'  // apply plugindependencies {    compile 'org.greenrobot:greendao:3.2.2'  // add library    // This is only needed if you want to use encrypted databases    compile 'net.zetetic:android-database-sqlcipher:3.5.6' //加密库依赖(可选项)}
复制代码
c、设置数据库相关信息 ( Module:app build.gradle )

  1. greendao {    schemaVersion 1 // 数据库版本号    daoPackage 'com.example.zhangruirui.greendao'  // 设置 DaoMaster、DaoSession、Dao 包名    targetGenDir 'src/main/java'  // 设置 DaoMaster、DaoSession、Dao 目次}
复制代码
d、根本使用步调

  1. // 生成数据库文件,名为 students-dbDaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "students-db", null);SQLiteDatabase db = helper.getWritableDatabase();// 创建特定模式下的所有的 DAO 对象和数据 db 对象的映射DaoMaster master = new DaoMaster(db);// 管理特定模式下的所有 DAO 对象,并提供一些通用的 CRUD 长期化方法DaoSession session = master.newSession();// 得到指定的 StudentDao 对象StudentDao dao = session.getStudentDao();dao.insert(student);//...
复制代码
五、实战

1、我们写一个简单的实体类(User),测试一下
  1. package com.example.zhangruirui;import org.greenrobot.greendao.annotation.Entity;import org.greenrobot.greendao.annotation.Generated;import org.greenrobot.greendao.annotation.Id;@Entitypublic class User {  @Id  private long id;  private String name;  private int age;  @Generated(hash = 446251977)  public User(long id, String name, int age) {    this.id = id;    this.name = name;    this.age = age;  }  @Generated(hash = 586692638)  public User() {  }  public long getId() {    return id;  }  public void setId(long id) {    this.id = id;  }  public String getName() {    return name;  }  public void setName(String name) {    this.name = name;  }  public int getAge() {    return age;  }  public void setAge(int age) {    this.age = age;  }}
复制代码
2、点击 Make Project(大概 Make Moudle ‘App’) 编译一下工程 。如果设置正确,会在设置的包目次下自动会生成 DaoMaster,DaoSession 和 UserDao 类 。

3、然后我们界说 OpenHelper 类:UserDBOpenHelper
  1. package com.example.zhangruirui.greendao;import android.content.Context;import android.database.sqlite.SQLiteDatabase;import com.example.zhangruirui.DaoMaster;public class UserDBOpenHelper extends DaoMaster.DevOpenHelper {  public UserDBOpenHelper(Context context, String name) {    super(context, name);  }  public UserDBOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory) {    super(context, name, factory);  }  @Override  public void onDowngrade(SQLiteDatabase db, int oldVersion, int newVersion) {    DaoMaster.dropAllTables(wrap(db), true);  }}
复制代码
4、然后,类似 SQLite ,我们需要界说 DBManager:UserManager 创建单例实例,来供外部操纵数据库
  1. package com.example.zhangruirui.greendao;import android.content.Context;import android.support.annotation.WorkerThread;import com.google.gson.Gson;import java.io.Serializable;import java.lang.reflect.Type;public class UserManager {  private volatile static UserManager mInstance = null;  private Context mContext;  private UserStorage mUserStorage = new UserStorage(mContext);  private UserManager() {  }  public static UserManager getInstance() {    if (mInstance == null) {      synchronized (UserManager.class) {        if (mInstance == null) {          mInstance = new UserManager();        }      }    }    return mInstance;  }  public  T getUserAge(String key, Type typeOfT) {    try {      String json = mUserStorage.getUserAge(key);      Gson gson = new Gson();      CacheEntry entry = gson.fromJson(json, CacheEntry.class);      return gson.fromJson(entry.mJson, typeOfT);    } catch (Exception e) {      e.printStackTrace();    }    return null;  }  @WorkerThread  public void setUserAge(String key, Object entity, Type type) {    setUserInner(key, entity, type);  }  @WorkerThread  private void setUserInner(String key, Object entity, Type type) {    Gson gson = new Gson();    String json = gson.toJson(entity, type);    CacheEntry entry = new CacheEntry(json);    json = gson.toJson(entry, CacheEntry.class);    if (entity == null) {      mUserStorage.removeUser(key);    } else {      mUserStorage.addUser(key, json);    }  }  static class CacheEntry implements Serializable {    final String mJson;    CacheEntry(String json) {      mJson = json;    }  }}
复制代码
5、获取 UserDao 对数据库表举行 CRUD 操纵即可:UserStorage
  1. package com.example.zhangruirui.greendao;import android.content.Context;import android.database.sqlite.SQLiteDatabase;import android.support.annotation.WorkerThread;import com.example.zhangruirui.User;import org.greenrobot.greendao.query.DeleteQuery;import org.greenrobot.greendao.query.QueryBuilder;public class UserStorage {  private SQLiteDatabase mDatabase;  private UserDao mUserDao; // 获取 dao 对象  private final static String DB_NAME = "user_name_age.db"; // 界说数据库名  // 获取核心类的实例  UserStorage(Context context) {    DaoMaster.OpenHelper helper = new UserDBOpenHelper(context, DB_NAME, null);    try {      mDatabase = helper.getWritableDatabase();      DaoMaster daoMaster = new DaoMaster(mDatabase);      DaoSession daoSession = daoMaster.newSession();      mUserDao = daoSession.getUserDao();    } catch (Exception e) {      e.printStackTrace();    }  }  public User getUserByName(String name) {    if (!isDataBaseValid()) {      return null;    }    return mUserDao.queryBuilder().where(UserDao.Properties.Name.eq(name)).unique();  }  /**   * 根据用户的名字删除对应的记载   */  public void removeUser(String name) {    if (!isDataBaseValid()) {      return;    }    try {      QueryBuilder qb = mUserDao.queryBuilder();      DeleteQuery bd = qb.where(UserDao.Properties.Name.eq(name))          .buildDelete();      bd.executeDeleteWithoutDetachingEntities();    } catch (Exception e) {      e.printStackTrace();    }  }  /**   * 新增记载,如果存在则更新,不存在直接插入   */  @WorkerThread  public synchronized void addUser(String name, String json) {    if (!isDataBaseValid()) {      return;    }    try {      User user = new User();      user.setName(name);      user.setAge(json);      /**       * 办理 Exception:       * Cannot update entity without key - was it inserted before?       */      User oldUser = getUserByName(name);      if (oldUser != null) {        user.setId(oldUser.getId());      }      // mUserDao.save(user);      if (getUserByName(name) == null) {        mUserDao.insert(user);      } else {        mUserDao.update(user);      }    } catch (Exception e) {      e.printStackTrace();    }  }  /**   * 删除所有数据   */  @WorkerThread  public synchronized void deleteAll() {    mUserDao.deleteAll();  }  private boolean isDataBaseValid() {    return mUserDao != null;  }  public String getUserAge(String key) {    return mUserDao.queryBuilder().where(UserDao.Properties.Name.eq(key)).list().get(0).getAge();  }}
复制代码
六、注解

@Entity

表明这个实体类会在数据库中生成一个与之相对应的表
  1. @Entity(        // If you have more than one schema, you can tell greenDAO        // to which schema an entity belongs (pick any string as a name).        schema = "myschema",                // Flag to make an entity "active": Active entities have update,        // delete, and refresh methods.        active = true,                // Specifies the name of the table in the database.        // By default, the name is based on the entities class name.        nameInDb = "AWESOME_USERS",                // Define indexes spanning multiple columns here.        indexes = {                @Index(value = "name DESC", unique = true)        },                // Flag if the DAO should create the database table (default is true).        // Set this to false, if you have multiple entities mapping to one table,        // or the table creation is done outside of greenDAO.        createInDb = false,        // Whether an all properties constructor should be generated.        // A no-args constructor is always required.        generateConstructors = true,        // Whether getters and setters for properties should be generated if missing.        generateGettersSetters = true)public class User {  ...}
复制代码
@Id(autoincrement = true)

对应数据表中的 Id 字段,主键,必须为 Long 型
如果需要使用主键自增,此时 id 范例为 Long(注意是大写的)
  1. /** * Marks field is the primary key of the entity's table */@Retention(RetentionPolicy.SOURCE)@Target(ElementType.FIELD)public @interface Id {    /**     * Specifies that id should be auto-incremented (works only for Long/long fields)     * Autoincrement on SQLite introduces additional resources usage and usually can be avoided     * @see [url=https://www.sqlite.org/autoinc.html]SQLite documentation[/url]     */    boolean autoincrement() default false;}
复制代码
@Transient

添加此标志后不会生成数据库表的列,仅仅作为一个平凡的 java 类字段,用到暂时存储数据的,不会被长期化
@Unique

表名该属性在数据库中只能有唯一值
  1. @Index(unique = true)
复制代码
七、重要的 api 方法

注意:这些 api 方法中,提到的 key,都是指的主键 Long id
1、查询

http://greenrobot.org/greendao/documentation/queries/
https://juejin.im/post/5abf6ef9f265da2396128456
  1. QueryBuilder.java
复制代码
2、插入

  1. /**     * Insert an entity into the table associated with a concrete DAO.     *     * @return row ID of newly inserted entity     */    public long insert(T entity) {        return executeInsert(entity, statements.getInsertStatement(), true);    }
复制代码
3、更新

  1. public void update(T entity) {        assertSinglePk();        DatabaseStatement stmt = statements.getUpdateStatement();        if (db.isDbLockedByCurrentThread()) {            synchronized (stmt) {                if (isStandardSQLite) {                    updateInsideSynchronized(entity, (SQLiteStatement) stmt.getRawStatement(), true);                } else {                    updateInsideSynchronized(entity, stmt, true);                }            }        } else {            // Do TX to acquire a connection before locking the stmt to avoid deadlocks            db.beginTransaction();            try {                synchronized (stmt) {                    updateInsideSynchronized(entity, stmt, true);                }                db.setTransactionSuccessful();            } finally {                db.endTransaction();            }        }    }
复制代码
4、插入or更新

  1. public long insertOrReplace(T entity) {        return executeInsert(entity, statements.getInsertOrReplaceStatement(), true);    }    private long executeInsert(T entity, DatabaseStatement stmt, boolean setKeyAndAttach) {        long rowId;        if (db.isDbLockedByCurrentThread()) {            rowId = insertInsideTx(entity, stmt);        } else {            // Do TX to acquire a connection before locking the stmt to avoid deadlocks            db.beginTransaction();            try {                rowId = insertInsideTx(entity, stmt);                db.setTransactionSuccessful();            } finally {                db.endTransaction();            }        }        if (setKeyAndAttach) {            updateKeyAfterInsertAndAttach(entity, rowId, true);        }        return rowId;    }
复制代码
save() 方法:
通过 key 属性判定是否存在,如果存在就更新数据,如果 key 为 null 就插入。这里的 key 是什么东东?这就是我本日被坑的地方,这个 key 就是 Long id 这个字段,也就是表中的主键!!!
  1. /**     * "Saves" an entity to the database: depending on the existence of the key property, it will be inserted     * (key is null) or updated (key is not null).     *
  2.      * This is similar to {@link #insertOrReplace(Object)}, but may be more efficient, because if a key is present,     * it does not have to query if that key already exists.     */    public void save(T entity) {        if (hasKey(entity)) {            update(entity);        } else {            insert(entity);        }    }
复制代码
5、删除

  1. /** Deletes the given entity from the database. Currently, only single value PK entities are supported. */    public void delete(T entity) {        assertSinglePk();        K key = getKeyVerified(entity);        deleteByKey(key);    }
复制代码
八、入坑系列

1、https://www.jianshu.com/p/7bb9693ea380
2、https://blog.csdn.net/anyanyan07/article/details/73410053
3、打包肴杂问题(打包后的 APK,使用不了): 打包后使用不了,debug 能使用,很显着,肴杂的问题。报错如下:
https://blog.csdn.net/ddxxii/article/details/54866871
  1. Caused by: org.greenrobot.greendao.DaoException: Could not init DAOConfig
复制代码
办理办法:
针对 GreenDao 3.0 ,使用时,发布包需要设置肴杂
  1. #greendao-keep class org.greenrobot.greendao.**{*;}-keep public interface org.greenrobot.greendao.**-keepclassmembers class * extends org.greenrobot.greendao.AbstractDao {public static java.lang.String TABLENAME;}-keep class **$Properties#optional-keep class net.sqlcipher.database.**{*;}-keep public interface net.sqlcipher.database.**-dontwarn net.sqlcipher.database.**-dontwarn org.greenrobot.greendao.**
复制代码
  ------致所有正在积极奋斗的步伐猿们!加油!!
有码走遍天下 无码寸步难行
1024 - 空想,永不止步!
爱编程 不爱Bug
爱加班 不爱黑眼圈
固执 但不偏执
疯狂 但不疯癫
生活里的菜鸟
工作中的大神
身怀宝藏,一心向往星辰大海
追求极致,目的始于高山之巅
一群怀揣好奇,空想改变世界的孩子
一群追日逐浪,正在改变世界的极客
你们用最美的语言,诠释着科技的气力
你们用极速的创新,引领着时代的变迁
——乐于分享,共同进步,接待增补
——Treat Warnings As Errors
——Any comments greatly appreciated
——Talking is cheap, show me the code
——恳切接待各位交换讨论!QQ:1138517609
——CSDN:https://blog.csdn.net/u011489043
——简书:https://www.jianshu.com/u/4968682d58d1
——GitHub:https://github.com/selfconzrr


来源:https://blog.csdn.net/u011489043/article/details/112008804
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则


专注素材教程免费分享
全国免费热线电话

18768367769

周一至周日9:00-23:00

反馈建议

27428564@qq.com 在线QQ咨询

扫描二维码关注我们

Powered by Discuz! X3.4© 2001-2013 Comsenz Inc.( 蜀ICP备2021001884号-1 )