安卓GreenDao框架一些进阶用法整理

时间 2019-12-05

原文原文链接

大体分为如下几个方面：java

一些查询指令整理
使用SQL语句进行特殊查询
检测表字段是否存在
数据库升级
数据库表字段赋初始值

1、查询指令整理

1.链式执行的指令

        return mDaoSession.getUserDao().queryBuilder().
                XXX.
                XXX.
                XXX.
                list();

通常的查询语句会在中间xxx的位置加上各类判断和过滤的方法指令，除了最后的终结指令list（）或unique（）返回的是集合或业务对象，其余的都是返回QueryBuilder对象，大多数状况下XXX的位置都是填上where语句，还有一些其余和sql关联的语句便于使用。sql

“whereOr” where语句里面写的条件都是用“且”链接，whereOr里的语句使用“或”链接数据库

“distinct” 直接过滤掉重负字段api

“limit” 分页n个一页，通常和offset结合使用session

“offset” 忽略查询出的前n条结果ide

“orderAsc” 以字段升序排序gradle

“orderDesc”以字段降序ui

“preferLocalizedStringOrder” 本地化字符串排序spa

“orderCustom” 自定义排序里面须要传两个参数：一个属性和对应的排序方案 ASC 或是 DESC 版本控制

“orderRaw” 也是自定义排序，把字段和排序方案写在一个字符串传入

“stringOrderCollation” 也是自定义排序能够合并多个升降排序方案以日期升序且价格降序

2.条件里的指令

        return mDaoSession.getUserDao().queryBuilder().
                where(UserDao.Properties.UserId.in(userIdList), UserDao.Properties.UserAge.eq(19)).
                list();

一个简单的where语句大概是这样，在where的括号里面能够并列的写不少条件，其中所有以“且” 来链接。除了上面的“in”和“eq”还有不少其余判断条件

“notEq” 和eq相反，别傻傻在再去外面敲“！”取反

“notIn” 同上

“or” 或者

“like” 就是sql语句的LIKE "%"+string+"%"

“between” 也就是BETWEEN ? AND ? 能够取两个值的区间 (可是这条语句要慎用，不一样的数据库不同，有的是A<条件<B，有的是A<=条件<=B)

“gt” 至关于 >

“ge”至关于 >=

“lt” 至关于 <

“le”至关于 <=

“isNull” 为空

“notIsNull” 不为空

2、使用SQL语句进行特殊查询

通常遇到普通的增删改查操做没法轻易实现的功能，会使用这种rawQuery的方式。我常常遇到的也就是两种场景：

1.使用SELECT DISTINCT

经常使用与一对多关系，假设图书馆如今有个“用户存书表” 有的用户有20本书，表里就会有20条他的数据，每条对应一本不一样的书。

这时假设有个需求，查出这个表中，全部的用户名字，不准重复。这时候用普通的查询指令就会很是麻烦了，须要使用SELECT DISTINCT指令查出某列名全部不重复的条目。

        String queryString =
                "SELECT DISTINCT " + UserBookDao.Properties.UserName.columnName + " FROM " + UserBookDao.TABLENAME
                        + " ORDER BY "
                        + UserBookDao.Properties.CreatedTime
                        + " DESC "
                        + " LIMIT "
                        + page * LIMIT_NUM
                        + " , "
                        + LIMIT_NUM;

        ArrayList<String> result = new ArrayList<>();
        Cursor c = mDaoSession.getDatabase().rawQuery(queryString,new String[]{});
        try {
            if (c != null) {
                if (c.moveToFirst()) {
                    do {
                        result.add(c.getString(0));
                    } while (c.moveToNext());
                }
            }
        } finally {
            if (c != null) {
                c.close();
            }
        }

大概代码的画风就是这个样子，先拼接出一个符合sql语法的字符串，上面也随机加了一写其余的操做指令字段排序和分页，使得查询指令看上去更加完整，而后使用游标来接收上面的查询结果。

可能大多数查询的时候会带上一些参数，好比where XX = XX 的过滤条件，假设有个需求须要在以前的查询用户需求上加上对出版社和图书价格的限制，则查询方式以下

        String queryString =
                "SELECT DISTINCT " + UserBookDao.Properties.UserName.columnName + " FROM " + UserBookDao.TABLENAME   // 董铂然博客园
                        + " WHERE "
                        + UserBookDao.Properties.Publisher.columnName + " = ?"
                        + " AND "
                        + UserBookDao.Properties.Price.columnName + " > ?"
                        + " ORDER BY "
                        + UserBookDao.Properties.CreatedTime
                        + " DESC ";

        ArrayList<String> result = new ArrayList<>();
        Cursor c = mDaoSession.getDatabase().rawQuery(queryString, new String[]{"某出版社"),
                String.valueOf(100.00)});
        try {
            if (c != null) {
                if (c.moveToFirst()) {
                    do {
                        result.add(c.getString(0));
                    } while (c.moveToNext());
                }
            }
        } finally {
            if (c != null) {
                c.close();
            }
        }

带上参数的查询字符串须要在上面使用问号占位，而后在下面用rawQuery带参数的api里填上相关的入参。

2. SELECT同时查询多个字段

仍是用这个查书的例子，假设一下要查“书名”、“出版社”、“价格” 三个字段

        String queryString = "SELECT "
                + UserBookDao.TABLENAME + "." + UserBookDao.Properties.BookName.columnName + ","
                + UserBookDao.TABLENAME + "." + UserBookDao.Properties.Publisher.columnName + ","
                + UserBookDao.TABLENAME + "." + UserBookDao.Properties.Price.columnName + " "
                + "FROM "
                + UserBookDao.TABLENAME + " "
                + "WHERE"
                + UserBookDao.Properties.Price + " > 100.00 ";

        Cursor cursor = null;
        try {
            cursor = session.getDatabase().rawQuery(queryString,new String[]{});
            if (cursor == null) {
                return payMap;
            }
            // 取出三个字段分别对应的索引，下面再对着索引去取值
            int nameIndex = cursor.getColumnIndex(UserBookDao.Properties.BookName.columnName);
            int publisherIndex = cursor.getColumnIndex(UserBookDao.Properties.Publisher.columnName);
            int priceIndex = cursor.getColumnIndex(UserBookDao.Properties.Price.columnName);

            if (nameIndex != -1 && publisherIndex != -1 && priceIndex != -1) {
                while (cursor.moveToNext()) {
                    String name = cursor.getString(nameIndex);
                    String publisher = cursor.getString(publisherIndex);
                    Double price = cursor.getDouble(priceIndex);
                    // 这里取到三个字段 本身是存模型仍是字典 本身处理。
                }
            }
        } finally {
            if (null != cursor) {
                cursor.close();
            }
        }

下面能够一次性的取出三个所需字段进行使用，须要先获得字段对应索引，而后再对着索引取值。

3、检测表字段是否存在

        private boolean hasColumn(SQLiteDatabase db, String tableName, String column) {
            if (TextUtils.isEmpty(tableName) || TextUtils.isEmpty(column)) {
                return false;
            }
            Cursor cursor = null;
            try {
                cursor = db.query(tableName, null, null, null, null, null, null);
                if (null != cursor && cursor.getColumnIndex(column) != -1) {
                    return true;
                }
            } finally {
                if (null != cursor) {
                    cursor.close();
                }
            }
            return false;
        }

和上面取游标的方式相似，取出的列索引值若是不是-1，则表明可以取到这个字段返回true，不然和入参非法一块儿返回fasle。

4、数据库升级

这边会调用上面判断列名是否已经存在的方法。

而后重写父类的这个onUpgrade方法

    private static class DemoOpenHelper extends DaoMaster.OpenHelper {

        public DemoOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory) {
            super(context, name, factory);
        }

        @Override
        public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
            // 数据库的版本控制 能够随着版本叠加不断增长差值
            if (oldVersion < 2) {
                if (!hasColumn(db, UserBookDao.TABLENAME, UserBookDao.Properties.Author.columnName)) {
                    String sql = "alter table " + UserBookDao.TABLENAME +
                            " add COLUMN " + UserBookDao.Properties.Author.columnName + " TEXT";
                    db.execSQL(sql);
                }
                if (!hasColumn(db, UserBookDao.TABLENAME, UserBookDao.Properties.Type.columnName)) {
                    String sql = "alter table " + UserBookDao.TABLENAME +
                            " add COLUMN " + UserBookDao.Properties.Type.columnName + " INTEGER";
                    db.execSQL(sql);
                }
            }
        }
    }

除了上面的修改表，若是改动太多或是换了代表，还能够直接删了重建（这么作的话以前的数据也就删了）

            if (oldVersion < 3) {
                UserDao.dropTable(new StandardDatabase(db),true);
                UserStudentDao.createTable(new StandardDatabase(db),true);
            }

5、数据库表字段赋初始值

有些字段的初始值若是你不但愿是0，或是空字符串，能够赋初始值。如今的赋值初始值就分为两种状况了

1.建表时附初始值

在3.0之前的版本仍是要写一个module，里面写相似代码来建表的

    private static void addUser(Schema schema) {
        Entity user = schema.addEntity("User");
        user.addIdProperty();
        user.addStringProperty("name").notNull().defValue("\"jack\"");
        user.addStringProperty("address");
        user.addStringProperty("teacher");
        user.addIntProperty("age").primJavaType().defValue("17");
    }

在3.0以后推行用注解和直接写Entity的写法，因此能够直接在Entity的类里指定

@Entity
public class Student {
    @Id(autoincrement = true)
    private long id; //主键
    private String name;
    private String schoolTime = "09-01"; //开学时间默认都是9月1日
    private int age = 19; // 刚上大学的默认都是19岁
    // 下面生成的getter 和setter省略 。。。
}

2.数据库升级时给升级字段赋初始值

上面说的的数据库升级，是须要写一条alter table的sql语句，能够直接拼接到这一行后面

            // 上面判断该列名是否存在
            // ...
            String sql = "alter table " + UserBookDao.TABLENAME +
                    " add COLUMN " + UserBookDao.Properties.Type.columnName + " INTEGER" + " NOT NULL DEFAULT(-1) "; // 直接拼接在语句最后 董铂然博客园
            db.execSQL(sql);
            // ...

注：之前听过一种说法是直接在UserDao这种生成的类里直接在生成的建立语句后面拼接DEFAULT，这里很是反对，首先人家类名明确代表 // THIS CODE IS GENERATED BY greenDAO, DO NOT EDIT. 而且有些人的代码可能设置的是手动生成，但咱们的项目就在gradle里设置了每次build都会先自动生成一下，这种状况每次都会覆盖。

开发中一些整理，欢迎讨论。