GreenDao3.2.2使用详解

由于项目优化，将项目使用的数据库GreenDao从2.0升级到3.0，两者在配置及使用上均有很大的不同，关于GreenDao的介绍，可以在我之前的文章 GreenDao2.0使用详解中了解，本文主讲GreenDao3.2.2的使用。

使用配置

在project的build.gradle -> buildscript -> dependencies中配置如下：

 dependencies {
    classpath 'com.android.tools.build:gradle:3.1.2'
    // NOTE: Do not place your application dependencies here; they belong
    // in the individual module build.gradle files
    classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2'
}

在module（一般为app）的build.gradle中配置如下：

apply plugin: 'org.greenrobot.greendao' 
android {
    compileSdkVersion compile_sdk_version
    greendao {
        schemaVersion 1  //版本号，升级时可配置
        daoPackage 'com.xxx.xxx.greendao'//设置DaoMaster、DaoSession、Dao包名，自行设置
        targetGenDir 'src/main/java'//设置DaoMaster、DaoSession、Dao目录，自行设置
    }
}
dependencies {
    api 'org.greenrobot:greendao:3.2.2' 
}

代码混淆

-keep class freemarker.** { *; }
-dontwarn freemarker.**
-keep class org.greenrobot.greendao.**{*;}
-dontwarn org.greenrobot.greendao.**
-keepclassmembers class * extends org.greenrobot.greendao.AbstractDao {
    public static java.lang.String TABLENAME;
}
-keep class **$Properties

实现代码

一. 创建bean对象例如MsgModel.java

/**
* Created by wangfengkai on 2018/12/6.
* Github:https://github.com/github/jxwangfengkai
*/

@Entity
public class MsgModel {
@Id(autoincrement = true)
public Long tableId;
@Transient
public String userId;
@Transient
public String content;
@Transient
public String title;
public int status;
@Transient
public Long createTime;
@Property(nameInDb = "msgId")
@Index
public int id;
@Transient
public int topicId;
public int type;

//以下代码编译后自动生成
@Generated(hash = 1890461423)
public MsgModel(Long tableId, int status, int id, int type) {
    this.tableId = tableId;
    this.status = status;
    this.id = id;
    this.type = type;
}

@Generated(hash = 60092432)
public MsgModel() {
}

public Long getTableId() {
    return this.tableId;
}

public void setTableId(Long tableId) {
    this.tableId = tableId;
}

public int getStatus() {
    return this.status;
}

public void setStatus(int status) {
    this.status = status;
}

public int getId() {
    return this.id;
}

public void setId(int id) {
    this.id = id;
}

public int getType() {
    return this.type;
}

public void setType(int type) {
    this.type = type;
}
}

编写完变量之后，编译project：
（1）会自动构造方法，get,set方法。
（2）会生成 DaoMaster、DaoSession、DAOS类，类的位置位于你在 app的build.gradle的schema配置。
@Entity：告诉GreenDao该对象为实体，只有被@Entity注释的Bean类才能被dao类操作。
@Id：对象的物理Id，使用Long类型作为EntityId，否则会报错，(autoincrement = true)表示主键会自增，如果false就会使用旧值。
@Property：可以自定义字段名，注意外键不能使用该属性。
@NotNull：属性不能为空。
@Unique：该属性值必须在数据库中是唯一值。
@Generated：greenDao生产代码注解，手动修改报错。
@Transient：bean中不需要存入数据库表中的属性字段。
@Index(unique = true)：为相应的数据库列创建数据库索引，并向索引添加UNIQUE约束，强制所有值都是唯一的。

二. 创建DaoManager类对数据库进行管理

public class DaoManager {
private static final String TAG = DaoManager.class.getSimpleName();
private static final String DB_NAME = "name.db";
private static DaoManager mInstance;
private DaoMaster daoMaster;
private DaoSession daoSession;

public static DaoManager getInstance() {
    if (mInstance == null) {
        synchronized (DaoManager.class) {
            if (mInstance == null) {
                mInstance = new DaoManager();
            }
        }
    }
    return mInstance;
}

private DaoManager() {
    if (mInstance == null) {
        DBHelper helper = new DBHelper(MCApplication.getInstance(), DB_NAME);
        Database db = helper.getWritableDb();
        daoMaster = new DaoMaster(db);
        daoSession = daoMaster.newSession();
    }
}

public DaoSession getDaoSession() {
    return daoSession;
}

public DaoMaster getDaoMaster() {
    return daoMaster;
}

/**
 * 打开输出日志，默认关闭
 */
public void setDebug(boolean debug) {
    QueryBuilder.LOG_SQL = debug;
    QueryBuilder.LOG_VALUES = debug;
}
}

三. 创建DBHelper类做升级处理

public class DBHelper extends DaoMaster.OpenHelper {
private static final String TAG = DaoManager.class.getSimpleName();

public DBHelper(Context context, String dbName) {
    super(context, dbName, null);
}

@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
    super.onUpgrade(db, oldVersion, newVersion);
//----------------------------使用sql实现升级逻辑
    if (oldVersion == newVersion) {
        Log.e("onUpgrade", "数据库是最新版本,无需升级" );
        return;
    }
    Log.e("onUpgrade", "数据库从版本" + oldVersion + "升级到版本" + newVersion);
    switch (oldVersion) {
        case 1:
            String sql = "";
            db.execSQL(sql);
        case 2:
        default:
            break;
    }
}
}

四. 创建ModelDaoUrils类对数据库表进行增删改查等操作
例如：

 modelDaoUtils = new ModelDaoUtils(context);
 modelDaoUtils.insertModel(model);

类具体代码如下：

public class MsgModelDaoUtils {
private static final String TAG = MsgModelDaoUtils.class.getSimpleName();
private DaoManager daoManager;

public MsgModelDaoUtils(Context context) {
    daoManager = DaoManager.getInstance();
}

/**
 * 完成msgModel记录的插入，如果表未创建，先创建msgModel表
 *
 * @return
 */
public boolean insertMsgModel(MsgModel msgModel) {
    return daoManager.getDaoSession().getMsgModelDao().insert(msgModel) == -1 ? false : true;
}

/**
 * 插入多条数据，在子线程操作
 *
 * @param msgModelList
 * @return
 */
public boolean insertMultMsgModel(final List msgModelList) {
    boolean flag = false;
    try {
        daoManager.getDaoSession().runInTx(new Runnable() {
            @Override
            public void run() {
                for (MsgModel msgModel : msgModelList) {
                    daoManager.getDaoSession().insertOrReplace(msgModel);
                }
            }
        });
        flag = true;
    } catch (Exception e) {
        e.printStackTrace();
    }
    return flag;
}

/**
 * 修改一条数据
 *
 * @param msgModel
 * @return
 */
public boolean updateMsgModel(MsgModel msgModel) {
    boolean flag = false;
    try {
        daoManager.getDaoSession().update(msgModel);
        flag = true;
    } catch (Exception e) {
        e.printStackTrace();
    }
    return flag;
}

/**
 * 删除单条记录
 *
 * @param msgModel
 * @return
 */
public boolean deleteMsgModel(MsgModel msgModel) {
    boolean flag = false;
    try {
        //按照id删除
        daoManager.getDaoSession().delete(msgModel);
        flag = true;
    } catch (Exception e) {
        e.printStackTrace();
    }
    return flag;
}

/**
 * 删除所有记录
 *
 * @return
 */
public boolean deleteAll() {
    boolean flag = false;
    try {
        //按照id删除
        daoManager.getDaoSession().deleteAll(MsgModel.class);
        flag = true;
    } catch (Exception e) {
        e.printStackTrace();
    }
    return flag;
}

/**
 * 查询所有记录
 *
 * @return
 */
public List queryAllMsgModel() {
    return daoManager.getDaoSession().loadAll(MsgModel.class);
}

/**
 * 根据主键id查询记录
 *
 * @param id
 * @return
 */
public MsgModel queryMsgModelById(long id) {
    return daoManager.getDaoSession().load(MsgModel.class, id);
}

/**
 * 使用queryBuilder进行查询
 *
 * @return
 */
public MsgModel queryMsgModelByQueryBuilder(long id) {
    try {
        QueryBuilder queryBuilder = daoManager.getDaoSession().queryBuilder(MsgModel.class);
        return queryBuilder.where(MsgModelDao.Properties.Id.eq(id)).unique();
    } catch (Exception e) {
        e.printStackTrace();
        return null;
    }

}
}

五. 在Application的onCreate()方法中初始化

DaoManager.getInstance();

推新

GreenDao的使用介绍在这就结束了，不过Google在2017年推出了自己的数据操作库room。接下来的文章将重点介绍这个谷歌官方本地数据操作库。

GreenDao3.2.2使用详解

使用配置

代码混淆

实现代码

推新

你可能感兴趣的:(GreenDao3.2.2使用详解)