Android之greenDao使用

程序员文章站 2022-04-20 18:12:50

文章大纲一、greenDao简介二、greenDao实战三、项目源码下载四、参考文章一、greenDao简介 1. 什么是greenDao GreenDAO是一个开源的Android ORM(“对象/关系映射”)，通过ORM（称为“对象/关系映射”），在我们数据库开发过程中节省了开发时间。 2. ......

文章大纲

一、greendao简介
二、greendao实战
三、项目源码下载
四、参考文章

一、greendao简介

1. 什么是greendao

greendao是一个开源的android orm(“对象/关系映射”)，通过orm（称为“对象/关系映射”），在我们数据库开发过程中节省了开发时间。

2. greendao的官方文档

（1）greendao：适用于您的sqlite数据库的android orm
（2）greendao的github地址
（3）greendao的google讨论区
（4）greendao 加密sqlcipher for android官方说明地址
（5） greendao使用文档

3. greendao原理

dao的core library中有以下几个核心类，也是后面常用到的，先来大概了解下他们的结构。

daomaster：dao中的管理者。它保存了sqlitedatebase对象以及操作dao classes（注意：不是对象）。其提供了一些创建和删除table的静态方法，其内部类openhelper和devopenhelper实现了
sqliteopenhelper，并创建数据库的框架。
daosession：会话层。操作具体的dao对象（注意：是对象），比如各种getter方法。
daos：实际生成的某某dao类，通常对应具体的java类，比如notedao等。其有更多的权限和方法来操作数据库元素。
entities：持久的实体对象。通常代表了一个数据库row的标准java properties。

4. greendao的优点

(1)一个精简的库
(2)性能最大化
(3)内存开销最小化
(4)易于使用的 apis
(5)对 android 进行高度优化

二、greendao实战

1. 添加依赖

在项目的build.gradle添加

在app的build.gradle添加

具体代码如下：

apply plugin: 'com.android.application'

//添加greendao相关的plugin
apply plugin: 'org.greenrobot.greendao'

android {
    compilesdkversion 27
    defaultconfig {
        applicationid "top.daxianwill.greendaodemo"
        minsdkversion 15
        targetsdkversion 27
        versioncode 1
        versionname "1.0"
    }
    buildtypes {
        release {
            minifyenabled false
            proguardfiles getdefaultproguardfile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }

    greendao{

        //指定数据库schema版本号，迁移等操作会用到;
        schemaversion 1
        //dao的包名，包名默认是entity所在的包；
        daopackage 'com.greendao.gen'
        //生成数据库文件的目录;
        targetgendir 'src/main/java'
    }
}

dependencies {
    implementation filetree(dir: 'libs', include: ['*.jar'])
    implementation 'com.android.support:appcompat-v7:27.1.1'
    implementation 'com.android.support.constraint:constraint-layout:1.1.0'

    //添加greendao相关依赖
    implementation 'org.greenrobot:greendao:3.2.2'
}

2. 创建实体类

package top.daxianwill.greendaodemo;

import org.greenrobot.greendao.annotation.entity;
import org.greenrobot.greendao.annotation.id;
import org.greenrobot.greendao.annotation.property;
import org.greenrobot.greendao.annotation.transient;
import org.greenrobot.greendao.annotation.generated;

/**
 * 创建数据库实体类
 *
 *   @entity 表示这个实体类一会会在数据库中生成对应的表，

     @id 表示该字段是id，注意该字段的数据类型为包装类型long

     @property 则表示该属性将作为表的一个字段，其中nameindb看名字就知道这个属性在数据库中对应的数据名称。

     @transient 该注解表示这个属性将不会作为数据表中的一个字段。

     @notnull 表示该字段不可以为空

     @unique 表示该字段唯一
 */
@entity
public class user {
    @id
    private long id;

    @property(nameindb = "name")
    private string name;

    @transient
    private int tempusagecount; // not persisted

    @generated(hash = 873297011)
    public user(long id, string name) {
        this.id = id;
        this.name = name;
    }
    @generated(hash = 586692638)
    public user() {
    }
    public long getid() {
        return this.id;
    }
    public void setid(long id) {
        this.id = id;
    }
    public string getname() {
        return this.name;
    }
    public void setname(string name) {
        this.name = name;
    }
}

注解介绍
（1）@entity
用来声明类实体，表示它将映射为数据表
@entity（）括号内可加入更详细的设置，如：
nameindb =“table_name” ——> 声明该表的表名，默认取类名
createindb = true ——> 是否创建表，默认为true
generateconstructors = true ——> 是否生成含所有参数的构造函数，默认为true
generategetterssetters = true ——> 是否生成getter/setter，默认为true

（2）@id
用来声明某变量为表的主键，类型使用long
@id（）括号可加入autoincrement = true表明自增长

（3）@unique
用来声明某变量的值需为唯一值

（4）@notnull
用来声明某变量的值不能为null

（5）@property
@property(nameindb = “url”) 用来声明某变量在表中的实际字段名为url

（6）@transient
用来声明某变量不被映射到数据表中

（7）@toone、@tomany
用来声明”对一”和“对多”关系，下面举例说明：
学生与学校之间一对多的关系（一个学生对应一个学校，一个学校对应有多个学生）

@entity
class student{
    //...省略其他变量
    private long fk_schoolid;//外键
 
    @toone(joinproperty = "fk_schoolid")
    private school school;
}
 
@entity
class school{
    //...省略其他变量 
    @tomany(referencedjoinproperty = "fk_schoolid")
    private list<student> students;
}

学生与课程之间“多对多”的关系（一个学生对应有多门课程，一门课程对应有多个学生）

@entity
class student{
    //...省略其他变量
    @tomany
    @joinentity(
            entity = studentwithcourse.class,
            sourceproperty = "sid",
            targetproperty = "cid"
    )
    private list<course> courses;
}
 
@entity 
class course{
    //...省略其他变量
    @tomany
    @joinentity(
            entity = studentwithcourse.class,
            sourceproperty = "cid",
            targetproperty = "sid"
    )
    private list<course> courses;
}
 
@entity
class studentwithcourse{
    @id
    private long id;
    private long sid;
    private long cid;
}

3. make project

利用上面注解写好表实体后，通过build—>make project重新编译项目，将会在表实体中自动生成构造方法和getter/setter方法，另外在指定（或默认）的包中生成daomaster、daosession以及表实体对应的dao（如moviecollectdao）。
daomaster：用于创建数据库以及获取daosession
daosession：用于获取各个表对应的dao类
各个表对应的dao：提供了对表进行增删改查的方法

4. 进行数据增删改查

进行操作前，我们先获取操作的对象

userdao muserdao = myapplication.getinstances().getdaosession().getuserdao();

进行数据增加

    public void insert(){

        muser = new user(id++,"any"+id);

        muserdao.insert(muser);

        notifylistview();
    }

补充：
(1)上述代码讲的是插入单条数据，插入多条数据方式为：

list<moviecollect> listusercollect;
muserdao.insertintx(listusercollect);

(2)插入或替换数据
//插入的数据如果已经存在表中，则替换掉旧数据（根据主键来检测是否已经存在）

moviecollect usercollect;
muserdao.insertorreplace(usercollect);//单个数据

list<moviecollect> listusercollect;
muserdao.insertorreplace(listusercollect);//一组数据

进行数据删除

public void delete(){

        long l = muserdao.count() - 1;

        muserdao.deletebykey(l);

        notifylistview();
    }

补充：
（1）上面代码讲的是删除一条数据，删除所有数据方式为：

muserdao.deleteall();

（2）删除多条数据

list<user> listusercollect;
muserdao.deleteintx(listusercollect）;

进行数据修改

    public void update(){

        muser = new user((long)3,"any0803");

        muserdao.update(muser);

        notifylistview();
    }

补充：
（1）上面代码介绍的是修改单条数据，修改多条数据方式如下：

list<user> listusercollect;
muserdao.updateintx(listusercollect）;

进行数据查询

public void loadall(){

        muserlist = muserdao.loadall();//查询所有数据

        notifylistview();
    }

补充：
（1）上面代码介绍的是查询所有数据，查询数据数量方式如下：

int count = muserdao.count();

（2）精确（where）条件查询

//查询电影名为“肖申克的救赎”的电影
moviecollect moviecollect = 
mmoviecollectdao.querybuilder().where(moviecollectdao.properties.title.eq("肖申克的救赎")).unique(); 
 
//查询电影年份为2017的电影
list<moviecollect> moviecollect =
mmoviecollectdao.querybuilder().where(moviecollectdao.properties.year.eq(2017)).list();

（3）模糊查询（like）

//查询电影名含有“传奇”的电影
list<moviecollect> moviecollect = mmoviecollectdao.querybuilder().where(moviecollectdao.properties.title.like("传奇")).list();
 
//查询电影名以“我的”开头的电影
list<moviecollect> moviecollect = mmoviecollectdao.querybuilder().where(moviecollectdao.properties.title.like("我的%")).list();

（4）区间查询

//大于
//查询电影年份大于2012年的电影
list<moviecollect> moviecollect = mmoviecollectdao.querybuilder().where(moviecollectdao.properties.year.gt(2012)).list();
 
//大于等于
//查询电影年份大于等于2012年的电影
list<moviecollect> moviecollect = mmoviecollectdao.querybuilder().where(moviecollectdao.properties.year.ge(2012)).list();
 
//小于
//查询电影年份小于2012年的电影
list<moviecollect> moviecollect = mmoviecollectdao.querybuilder().where(moviecollectdao.properties.year.lt(2012)).list();
 
//小于等于
//查询电影年份小于等于2012年的电影
list<moviecollect> moviecollect = mmoviecollectdao.querybuilder().where(moviecollectdao.properties.year.le(2012)).list();
 
//介于中间
//查询电影年份在2012-2017之间的电影
list<moviecollect> moviecollect = mmoviecollectdao.querybuilder().where(moviecollectdao.properties.year.between(2012,2017)).list();

（5）升序降序

//查询电影年份大于2012年的电影，并按年份升序排序
list<moviecollect> moviecollect = mmoviecollectdao.querybuilder().where(moviecollectdao.properties.year.gt(2012)).orderasc(moviecollectdao.properties.year).list();
 
//查询电影年份大于2012年的电影，并按年份降序排序
list<moviecollect> moviecollect = mmoviecollectdao.querybuilder().where(moviecollectdao.properties.year.gt(2012)).orderdesc(moviecollectdao.properties.year).list();

（6）and/or

//and
//查询电影年份大于2012年且电影名以“我的”开头的电影
list<moviecollect> moviecollect = mmoviecollectdao.querybuilder().and(moviecollectdao.properties.year.gt(2012), moviecollectdao.properties.title.like("我的%")).list();
 
//or
//查询电影年份小于2012年或者大于2015年的电影
list<moviecollect> moviecollect = mmoviecollectdao.querybuilder().or(moviecollectdao.properties.year.lt(2012), moviecollectdao.properties.year.gt(2015)).list();

5. 缓存处理

由于greendao默认开启了缓存，所以当你调用a查询语句取得x实体，然后对x实体进行修改并更新到数据库，接着再调用a查询语句取得x实体，会发现x实体的内容依旧是修改前的。其实你的修改已经更新到数据库中，只是查询采用了缓存，所以直接返回了第一次查询的实体。
解决方法：查询前先清空缓存，清空方法如下

//清空所有数据表的缓存数据
daosession daosession = myapplication.getinstances().getdaosession();
daosession .clear();
 
//清空某个数据表的缓存数据
userdao userdao = myapplication.getinstances().getdaosession().getuserdao();
userdao.detachall();

6. 数据库加密

添加依赖

compile 'net.zetetic:android-database-sqlcipher:3.5.7'//使用加密数据库时需要添加

获取操作的数据库对象

msqliteopenhelper = new mysqliteopenhelper(myapplication.getinstance(), db_name, null);//建库
mdaomaster = new daomaster(msqliteopenhelper.getencryptedwritabledb("你的密码"));//加密
//mdaomaster = new daomaster(msqliteopenhelper.getwritabledatabase());
mdaosession = mdaomaster.newsession();

温馨提示：
（1）使用上面步骤得到的daosession进行具体的数据表操作。
（2）如果运行后报无法加载有关so库的异常，请对项目进行clean和rebuild。

7. 数据库版本升级

在版本迭代时，我们经常需要对数据库进行升级，而greendao默认的daomaster.devopenhelper在进行数据升级时，会把旧表删除，然后创建新表，并没有迁移旧数据到新表中，从而造成数据丢失。
这在实际中是不可取的，因此我们需要作出调整。下面介绍数据库升级的步骤与要点。
第一步
新建一个类，继承daomaster.devopenhelper，重写onupgrade(database db, int oldversion, int newversion)方法，在该方法中使用migrationhelper进行数据库升级以及数据迁移。
网上有不少migrationhelper的源码，这里采用的是https://github.com/yuweiguocn/greendaoupgradehelper中的migrationhelper，它主要是通过创建一个临时表，将旧表的数据迁移到新表中，大家可以去看下源码。

public class myopenhelper extends daomaster.openhelper {
    public myopenhelper(context context, string name, sqlitedatabase.cursorfactory factory) {
        super(context, name, factory);
    }
 
    @override
    public void onupgrade(database db, int oldversion, int newversion) {
 
        //把需要管理的数据库表dao作为最后一个参数传入到方法中
        migrationhelper.migrate(db, new migrationhelper.recreatealltablelistener() {
 
            @override
            public void oncreatealltables(database db, boolean ifnotexists) {
                daomaster.createalltables(db, ifnotexists);
            }
 
            @override
            public void ondropalltables(database db, boolean ifexists) {
                daomaster.dropalltables(db, ifexists);
            }
        },  moviecollectdao.class);
    }
}

然后使用myopenhelper替代daomaster.devopenhelper来进行创建数据库等操作

msqliteopenhelper = new myopenhelper(myapplication.getinstance(), db_name, null);//建库
mdaomaster = new daomaster(msqliteopenhelper.getwritabledatabase());
mdaosession = mdaomaster.newsession();

第二步
在表实体中，调整其中的变量（表字段），一般就是新增/删除/修改字段。注意：
（1）新增的字段或修改的字段，其变量类型应使用基础数据类型的包装类，如使用integer而不是int，避免升级过程中报错。
（2）根据migrationhelper中的代码，升级后，新增的字段和修改的字段，都会默认被赋予null值。

第三步
将原本自动生成的构造方法以及getter/setter方法删除，重新build—>make project进行生成。

第四步
修改module下build.gradle中数据库的版本号schemaversion ，递增加1即可，最后运行app

    greendao{
    //数据库版本号，升级时进行修改
        schemaversion 2
        //dao的包名，包名默认是entity所在的包；
        daopackage 'com.greendao.gen'
        //生成数据库文件的目录;
        targetgendir 'src/main/java'
    }

8. 代码混淆

&emsp;&emsp;在proguard-rules.pro文件中添加以下内容进行混淆配置
# greendao开始
-keepclassmembers class * extends org.greenrobot.greendao.abstractdao {
public static java.lang.string tablename;
}
-keep class **$properties
# if you do not use sqlcipher:
-dontwarn org.greenrobot.greendao.database.**
# if you do not use rxjava:
-dontwarn rx.**
# greendao结束
 
 
# 如果按照上面介绍的加入了数据库加密功能，则需添加一下配置
#sqlcipher数据库加密开始
-keep  class net.sqlcipher.** {*;}
-keep  class net.sqlcipher.database.** {*;}
#sqlcipher数据库加密结束

三、项目源码下载

链接:https://pan.baidu.com/s/1usivgwpgwijqp0ytd962aa
密码:iel2

四、参考文章

3.https://blog.csdn.net/qq_35956194/article/details/79167897

上一篇：我的小舅是头驴

下一篇： Lucene-分词器简介及IK分词器的使用

Android之greenDao使用

文章大纲

一、greendao简介

1. 什么是greendao

2. greendao的官方文档

3. greendao原理

4. greendao的优点

二、greendao实战

1. 添加依赖

2. 创建实体类

3. make project

4. 进行数据增删改查

5. 缓存处理

6. 数据库加密

7. 数据库版本升级

8. 代码混淆

三、项目源码下载

四、参考文章

oracle分区表之hash分区表的使用及扩展

Android项目实战之Glide 高斯模糊效果的实例代码

Android中碎片的使用方法详解

用Python操作字符串之rindex()方法的使用

在Python中操作字符串之rstrip()方法的使用

Mysql数据库之Binlog日志使用总结(必看篇)

JS基础之BOM的作用和使用实例讲解

JS基础之语法的作用和使用实例讲解

JS基础之DOM的作用和使用实例讲解

电脑上如何使用Android系统