Day5 greenDao的List存储与查询方法大全

2019年5月28日 223次阅读
效果图：

《Day5 greenDao的List存储与查询方法大全》

点此进入目录：[干货] 十天 教你从创意到上线APP

一、什么是greenDao？

greenDao是一个将对象映射到SQLite数据库中的轻量且快速的ORM解决方案。

二、为什么选用greenDAO ？

  • greenDAO 可以将我们数据库的中数据转换为相应的对象，这样可以省去我们自己去转换对象的时间。
  • 和同类型的库相比，性能是最好的。（与OrmLite、ActiveOrm、LitePal等数据库相比，单位时间内可以插入、更新和查询更多的数据，而且提供了大量的灵活通用接口，对比可见下图。）
  • greenDAO 也是当前 Android 开发中比较流行的库，当前的 github 星星数为 7369。
  • 使用 SQL 语句进行查询容易出错，而且错误比较难以发现，使用 greenDAO 的话可以在编译阶段就发现错误。
  • 还有就是代码比较简单明了，程序员都想用最少的代码，做最多的事。

  • 轻量级，整个库大小小于 150 k。

    《Day5 greenDao的List存储与查询方法大全》

三、GreenDao 3.0的使用

当前的 greenDAO 要求 gradle 的版本至少是 3.3，那我们采用3.3来实现。其中GreenDao 3.1采用注解的方式来定义实体类，通过gradle插件生成相应的代码。

1、在Android Studio中导入相关的包

    compile 'org.greenrobot:greendao:3.1.0'
    compile 'org.greenrobot:greendao-generator:3.1.0'

2、在build.gradle中进行配置

buildscript {
    repositories {
        jcenter()
        mavenCentral()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.3.3'
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
        classpath 'org.greenrobot:greendao-gradle-plugin:3.1.0'
    }
}

注：在gradle的根模块中加入上述代码。

3、自定义路径

    greendao {
        schemaVersion 1
        daoPackage 'com.wgh.willflowaicollection.greendao'
        targetGenDir 'src/main/java'
    }

属性介绍：

  • schemaVersion : 指定数据库schema版本号，迁移等操作会用到；
  • daoPackage : dao的包名，包名默认是entity所在的包；
  • targetGenDir : 生成数据库文件的目录；

在gradle的根模块中加入上述代码，就完成了我们的基本配置了。

4、创建一个Category的实体类

/**
 * Created by   : WGH.
 */
@Entity
public class Category implements Serializable {
    private static final long serialVersionUID = 7247714666080613254L;

    @Id(autoincrement = true)
    private Long id;
    private int grade;
    private String name;
    private String selfKey;

    @Convert(columnType = String.class, converter = ListConverter.class)
    private ArrayList<String> nextNames = new ArrayList<>();
    @Convert(columnType = String.class, converter = ListConverter.class)
    private ArrayList<String> contentUrls = new ArrayList<>();
    @Convert(columnType = String.class, converter = ListConverter.class)
    private ArrayList<String> contentTitles = new ArrayList<>();
    @Convert(columnType = String.class, converter = ListConverter.class)
    private ArrayList<String> nextKeys = new ArrayList<>();

    public Category() {
    }

    @Generated(hash = 182005897)
    public Category(Long id, int grade, String name, String selfKey, ArrayList<String> nextNames, ArrayList<String> contentUrls, ArrayList<String> contentTitles, ArrayList<String> nextKeys) {
        this.id = id;
        this.grade = grade;
        this.name = name;
        this.selfKey = selfKey;
        this.nextNames = nextNames;
        this.contentUrls = contentUrls;
        this.contentTitles = contentTitles;
        this.nextKeys = nextKeys;
    }

    public Category(int grade, String name) {
        this.grade = grade;
        this.name = name;
    }
}

5、构造数据转换模板类

/**
 * Created by   : WGH.
 */
public class ListConverter implements PropertyConverter<ArrayList<String>, String> {

    @Override
    public ArrayList<String> convertToEntityProperty(String databaseValue) {
        ArrayList<String> arrayList;
        if (databaseValue == null) {
            return null;
        } else {
            List<String> list = Arrays.asList(databaseValue.split(PreDefine.SplitString));
            arrayList = new ArrayList<>(list);
            return arrayList;
        }
    }

    @Override
    public String convertToDatabaseValue(ArrayList<String> entityProperty) {
        if (entityProperty == null) {
            return null;
        } else {
            StringBuilder sb = new StringBuilder();
            for (String entity : entityProperty) {
                sb.append(entity);
                sb.append(PreDefine.SplitString);
            }
            return sb.toString();
        }
    }
}

6、编译工程

编译项目后Category实体类会自动编译，然后生成get、set方法并且会在greendao目录下生成三个文件：

《Day5 greenDao的List存储与查询方法大全》

另外的三个是其它数据类构造出来的三个文件，在这里可以不用理会。

四、greenDao的增删改查操作

首先在 MyApplication 中进行这样设置：

/**
 * Created by   : WGH.
 */
public class MyApplication extends Application{

    private static DaoMaster daoMaster;
    private static DaoSession daoSession;

    @Override
    public void onCreate() {
        super.onCreate();
    }

    public static DaoMaster getDaoMaster() {
        if (daoMaster == null) {
            DaoMaster.OpenHelper helper = new DaoMaster.DevOpenHelper(mMyApplication, PreDefine.DBNAME, null);
            daoMaster = new DaoMaster(helper.getReadableDatabase());
        }
        return daoMaster;
    }

    public static DaoSession getDaoSession() {
        if (daoSession == null) {
            if (daoMaster == null) {
                daoMaster = getDaoMaster();
            }
            daoSession = daoMaster.newSession();
        }
        return daoSession;
    }
}

然后在使用greenDao的地方进行这样的调用：

CategoryDao categoryDao = MyApplication.getDaoSession().getCategoryDao();

这样就能获得categoryDao 对象了。

1、增删改查的简单实现

  • 增
Category categoryNew = new Category();
CategoryDao categoryDao = MyApplication.getDaoSession().getCategoryDao();
categoryDao.insert(categoryNew);
  • 删
    public void deleteCategoryFromDB(Category category) {
        CategoryDao categoryDao = MyApplication.getDaoSession().getCategoryDao();
        Category categoryOld = getCategotyFromDB(category.getKey());
        if (categoryOld != null) {
            categoryDao.delete(categoryOld);
        }
    }
  • 删除全部
    public void deleteAllCategory() {
        CategoryDao categoryDao = MyApplication.getDaoSession().getCategoryDao();
        categoryDao.deleteAll();
    }
  • 改
    public void updateCategoryToDB(Category categoryNew) {
        CategoryDao categoryDao = MyApplication.getDaoSession().getCategoryDao();
        Category categoryOld = getCategotyFromDB(categoryNew.getKey());
        categoryNew.setId(categoryOld.getId());
        categoryDao.update(categoryNew);
    }
  • Key值查找
    public Category getCategotyFromDB(String key) {
        if (TextUtils.isEmpty(key)) {
            return null;
        }
        CategoryDao categoryDao = MyApplication.getDaoSession().getCategoryDao();
        QueryBuilder<Category> queryBuilder = categoryDao.queryBuilder().where(CategoryDao.Properties.SelfKey.eq(key));
        if (queryBuilder.list().size() > 0) {
            return queryBuilder.list().get(0);
        } else {
            return null;
        }
    }
  • 模糊查询
    public ArrayList<Category> getEligibleCategory(String contentString) {
        CategoryDao categoryDao = MyApplication.getDaoSession().getCategoryDao();
        QueryBuilder<Category> queryBuilder = categoryDao.queryBuilder().where(CategoryDao.Properties.ContentTitles.like("%" + contentString + "%"));
        if (queryBuilder.list().size() > 0) {
            return new ArrayList<>(queryBuilder.list());
        } else {
            return null;
        }
    }
  • 查询全部
    public ArrayList<Category > getAllCategory () {
        Category category  = MyApplication.getDaoSession().getCategoryDao();
        return new ArrayList<>(category  .loadAll());
    }
  • 条件查询
                List<Category > list = categoryDao.queryBuilder()
                        .offset(1)//偏移量，相当于 SQL 语句中的 skip 
                        .limit(3)//只获取结果集的前 3 个数据
                        .orderAsc(categoryDao.Properties.StudentNum)//通过 StudentNum 这个属性进行正序排序
                        .where(categoryDao.Properties.Name.eq("zone"))//数据筛选，只获取 Name = "zone" 的数据。
                        .build()
                        .list();

2、greenDao中的注解详解

(一) @Entity 定义实体
  • @nameInDb 在数据库中的名字，如不写则为实体中类名
  • @indexes 索引
  • @createInDb 是否创建表，默认为true,false时不创建
  • @schema 指定架构名称为实体
  • @active 无论是更新生成都刷新
(二) @Id
(三) @NotNull 不为null
(四) @Unique 唯一约束
(五) @ToMany 一对多
(六) @OrderBy 排序
(七) @ToOne 一对一
(八) @Transient 不存储在数据库中
(九) @generated 由greendao产生的构造函数或方法

联系方式：

简书：WillFlow
GitHub：爱阅

点赞