Android数据库-GreenDao

简介

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

我认为GreenDao绝对是目前最好用的Android数据库框架,性能很强,但是我觉得它最大的优点是易用。自从用了GreenDao我都不会写SQL了,妈妈表示非常担心我的SQL知识是否会遗忘干净。

GitHub:https://github.com/greenrobot/greenDAO
官网:http://greenrobot.org/greendao/

使用

1、导包

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

2、Gradle配置

apply plugin: 'org.greenrobot.greendao'
buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'org.greenrobot:greendao-gradle-plugin:3.2.1'
    }
}

3、数据库配置

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

说明:
schemaVersion:指定数据库版本号,每次数据库表改动只需要在此修改一下版本号,GreenDao就会自动进行相应的表升级操作
daoPackage:dao的包名,包名默认是entity所在的包
targetGenDir:生成库文件的目录,默认为build/generated/source/greendao
generateTests:设置为true可以自动生成单元测试
targetGenDirTests:设置单元测试生成的目录,默认为src/androidTest/java
以上参数除schemaVersion都可以使用默认的,无需配置。generateTests默认false

4、实体类和注解

@Entity
public class User {
    @Id
    private Long id;
    private String name;
    @Transient
    private int tempUsageCount; // not persisted
 
   // getters and setters for id and user ...
}
  • @Entity注解的Java类回自动转化为一个数据库支持的实体类。同时会在重新编译后自动生成Get、Set方法。
  • 实体类中的所有字段的类型不能是常用数据类型。int -> Integer 、 long->Long
  • 使用@Transient可以让GreenDao忽略某一变量

5、基本使用

/**
 * Created by AskSky on 2016/11/22.
 * 数据库辅助类
 */

public class DBHelper {
    private static final String TAG = DBHelper.class.getSimpleName();
    private static DBHelper mInstance;
    private DaoMaster.DevOpenHelper mOpenHelper;
    private DaoMaster mDaoMaster;
    private DaoSession mDaoSession;
    private String password = "AskSky_TanPeiQi_1195211669_JMSQJ";
    private static final String DBName = "testDb";

    private DBHelper() {
    }

    public static DBHelper getInstance() {
        if (mInstance == null) {
            mInstance = new DBHelper();
        }
        return mInstance;
    }

    public void init(Context context) {
        mOpenHelper = new DaoMaster.DevOpenHelper(context, DBName, null);
        mDaoMaster = new DaoMaster(mOpenHelper.getEncryptedWritableDb(Utils.getMd5(password)));
        mDaoSession = mDaoMaster.newSession();
    }

    public DaoSession getSession() {
        return mDaoSession;
    }

    public DaoMaster getMaster() {
        return mDaoMaster;
    }

}

**说明:
不要忘记在Application中调用init()方法初始化
mDaoMaster = new DaoMaster(mOpenHelper.getEncryptedWritableDb(Utils.getMd5(password)));这一行是开启数据库加密,若要使用数据库加密,需要导入:
compile 'net.zetetic:android-database-sqlcipher:3.5.4@aar'
**

6 、增删改查


  • DBHelper.getInstance().getSession().getUserDao().insert(mUser);
//DBHelper.getInstance().getSession().getUserDao().deleteByKey(mUser.getId());
//DBHelper.getInstance().getSession().getUserDao().delete(mUser);
DBHelper.getInstance().getSession().getUserDao().deleteAll();

  • DBHelper.getInstance().getSession().update(mUser);

  • List<User> users = DBHelper.getInstance().getSession().getUserDao().loadAll();
    很明显,增删改查简单的过分

7、其他注解

@Entity注解的细节配置:

@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 {
  ...
}
  • @Entity 定义实体
  • @nameInDb 在数据库中的名字,如不写则为实体中类名
  • @indexes 索引
  • @createInDb 是否创建表,默认为true,false时不创建
  • @schema 指定架构名称为实体
  • @active 无论是更新生成都刷新

8、成员变量参数配置

@Entity
public class User {
    @Id(autoincrement = true)
    private Long id;
 
    @Property(nameInDb = "USERNAME")
    private String name;
 
    @NotNull
    private int repos;
 
    @Transient
    private int tempUsageCount;
 
    ...
}
  • @Id 主键 参数autoincrement表示是否自增长
  • @Property 列名 nameInDb制定具体列名
  • @NotNull 非空
  • @Transient 指定GreenDao忽略此变量

9、约束

@Entity
public class User {
    @Id private Long id;
    @Index(unique = true)
    private String name;
}
  • @Index 创建数据库索引 unique 添加唯一约束,使所有的值都是唯一的
@Entity
public class User {
    @Id private Long id;
    @Unique private String name;
}
  • @Unique 指定序列使用唯一约束 注意,SQLite还隐式地创建一个索引

总结

GreenDao是目前比较火的数据库管理框架,经过千千万万次验证,其稳定性和性能自不用说,而其易用性也确实很强。本文仅介绍了GreenDao的基本用法,其他高级用法可以去官网查看。如根据时间倒序查询前50条数据可以这样写:

List<Message> data = DBHelper.getInstance().getSession().getMessageDao().queryBuilder()
.orderDesc(MessageDao.Properties.Time).limit(50).list();

我在GitHub上放了一个简单Demo,大家可以参考一下:
https://github.com/AskSky924/GreenDaoDemo

以上内容如有错误或不足,欢迎指正。QQ:1195211669

推荐阅读更多精彩内容