美文网首页
Android GreenDao使用教程

Android GreenDao使用教程

作者: 赵庆峰_ | 来源:发表于2018-10-16 10:27 被阅读540次

    前言

    GreenDao是一款操作数据库的神器,经过了2.0版本的升级后,已经被广泛的开发者使用。确实是很好用,入门简单,可以剩去了数据库的建表操作和数据库SQL的编写

    GreenDao3.2的配置

    一、需要在工程(Project)的build.gradle中添加依赖

    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.2.1'
        //GreenDao3依赖
        classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2'
    }
    

    二、在项目(Module)的build.gradle中添加依赖

    apply plugin: 'com.android.application'
    //使用greendao
    apply plugin: 'org.greenrobot.greendao'
    
    android {
        compileSdkVersion 28
        defaultConfig {
            applicationId "com.zhao.fly"
            minSdkVersion 23
            targetSdkVersion 28
            versionCode 1
            versionName "1.0"
            testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
        }
        //greendao配置
        greendao {
            //版本号,升级时可配置
            schemaVersion 1
        }
        buildTypes {
            release {
                minifyEnabled false
                proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            }
        }
    }
    
    dependencies {
        implementation fileTree(dir: 'libs', include: ['*.jar'])
        implementation 'com.android.support:appcompat-v7:28.0.0'
        implementation 'com.android.support.constraint:constraint-layout:1.1.3'
        testImplementation 'junit:junit:4.12'
        androidTestImplementation 'com.android.support.test:runner:1.0.2'
        androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
        //greendao依赖
        compile 'org.greenrobot:greendao:3.2.2'
    }
    

    到这里就配置成功了

    GreenDao3.2的使用

    一、创建Bean对象(表名和字段名)
    GreenDao需要创建Bean对象之后,该Bean对象就是表名,而它的属性值就是字段名,其实现是通过注释的方式来实现的,下面是学生的Bean对象(每个Bean对象对应一张表)

    @Entity
    public class Student {
        //不能用int
        @Id(autoincrement = true)
        private Long id;
        //姓名
        @NotNull
        private String name;
        //学号
        @Unique
        private String number;
        //性别
        private int sex;
    }
    

    这里需要注意的是,创建完成之后,需要build gradle来完成我们的代码自动生成。自动生成的代码有:
    1.Bean实体的构造方法和get、set方法
    2.DaoMaster、DaoSession、DAOS类

    这里对Bean对象的注释进行解释:
    @Entity:告诉GreenDao该对象为实体,只有被@Entity注释的Bean类才能被dao类操作
    @Id:对象的Id,使用Long类型作为EntityId,否则会报错。(autoincrement = true)表示主键会自增,如果false就会使用旧值
    @Property:可以自定义字段名,注意外键不能使用该属性
    @NotNull:属性不能为空
    @Transient:使用该注释的属性不会被存入数据库的字段中
    @Unique:该属性值必须在数据库中是唯一值
    @Generated:编译后自动生成的构造函数、方法等的注释,提示构造函数、方法等不能被修改

    二、创建数据库(数据库名)
    先定义一个DaoManager类以此方便对数据库进行一系列的操作

    public class DaoManager {
        private static final String DB_NAME = "student.db";//数据库名称
        private volatile static DaoManager mDaoManager;//多线程访问
        private static DaoMaster.DevOpenHelper mHelper;
        private static DaoMaster mDaoMaster;
        private static DaoSession mDaoSession;
        private Context context;
    
        /**
         * 使用单例模式获得操作数据库的对象
         */
        public static DaoManager getInstance() {
            DaoManager instance = null;
            if (mDaoManager == null) {
                synchronized (DaoManager.class) {
                    if (instance == null) {
                        instance = new DaoManager();
                        mDaoManager = instance;
                    }
                }
            }
            return mDaoManager;
        }
    
        /**
         * 初始化Context对象
         */
        public void init(Context context) {
            this.context = context;
        }
    
        /**
         * 判断数据库是否存在,如果不存在则创建
         */
        public DaoMaster getDaoMaster() {
            if (null == mDaoMaster) {
                mHelper = new DaoMaster.DevOpenHelper(context, DB_NAME, null);
                mDaoMaster = new DaoMaster(mHelper.getWritableDatabase());
            }
            return mDaoMaster;
        }
    
        /**
         * 完成对数据库的增删查找
         */
        public DaoSession getDaoSession() {
            if (null == mDaoSession) {
                if (null == mDaoMaster) {
                    mDaoMaster = getDaoMaster();
                }
                mDaoSession = mDaoMaster.newSession();
            }
            return mDaoSession;
        }
    
        /**
         * 设置debug模式开启或关闭,默认关闭
         */
        public void setDebug(boolean flag) {
            QueryBuilder.LOG_SQL = flag;
            QueryBuilder.LOG_VALUES = flag;
        }
    
        /**
         * 关闭数据库
         */
        public void closeDataBase() {
            closeHelper();
            closeDaoSession();
        }
    
        public void closeDaoSession() {
            if (null != mDaoSession) {
                mDaoSession.clear();
                mDaoSession = null;
            }
        }
    
        public void closeHelper() {
            if (mHelper != null) {
                mHelper.close();
                mHelper = null;
            }
        }
    }
    

    说明:这里主要是通过单列模式创建DaoManager,DaoMaster,DaoSession对象,进行初始化以及关闭数据库操作。

    三、数据库的增删改查
    这里Student的增删查改封装在Utils中,其具体代码如下所示

    public class StudentDaoUtil {
        private static final boolean DUBUG = true;
        private DaoManager manager;
        private StudentDao studentDao;
        private DaoSession daoSession;
    
        public StudentDaoUtil(Context context) {
            manager = DaoManager.getInstance();
            manager.init(context);
            daoSession = manager.getDaoSession();
            manager.setDebug(DUBUG);
        }
    
        /**
         * 添加数据,如果有重复则覆盖
         */
        public void insertStudent(Student student) {
            manager.getDaoSession().insertOrReplace(student);
        }
    
        /**
         * 添加多条数据,需要开辟新的线程
         */
        public void insertMultStudent(final List<Student> students) {
            manager.getDaoSession().runInTx(new Runnable() {
                @Override
                public void run() {
                    for (Student student : students) {
                        manager.getDaoSession().insertOrReplace(student);
                    }
                }
            });
        }
    
    
        /**
         * 删除数据
         */
        public void deleteStudent(Student student) {
            manager.getDaoSession().delete(student);
        }
    
        /**
         * 删除全部数据
         */
        public void deleteAll(Class cls) {
            manager.getDaoSession().deleteAll(cls);
        }
    
        /**
         * 更新数据
         */
        public void updateStudent(Student student) {
            manager.getDaoSession().update(student);
        }
    
        /**
         * 按照主键返回单条数据
         */
        public Student listOneStudent(long key) {
            return manager.getDaoSession().load(Student.class, key);
        }
    
        /**
         * 根据指定条件查询数据
         */
        public List<Student> queryStudent() {
            //查询构建器
            QueryBuilder<Student> builder = manager.getDaoSession().queryBuilder(Student.class);
            List<Student> list = builder.where(StudentDao.Properties.Sex.ge(1)).where(StudentDao.Properties.Name.like("王小二")).list();
            return list;
        }
    
        /**
         * 查询全部数据
         */
        public List<Student> queryAll() {
            return manager.getDaoSession().loadAll(Student.class);
        }
    }
    

    效果很明显,GreenDao的封装更加短小精悍,语义明朗,下面对GreenDao中Dao对象其他API的介绍

    查询附加单个条件
    .where()
    .whereOr()
    查询附加多个条件
    .where(, , ,)
    .whereOr(, , ,)
    查询附加排序
    .orderDesc()
    .orderAsc()
    查询限制当页个数
    .limit()
    查询总个数
    .count()

    结语

    关于GreenDao的的基本概念与基本操作就讲到这里,更多对于GreenDao的数据库操作还需要多多从实战中去探索,这里只是一个快速入门的引导.GreenDao高级操作还包括有:多表查询、多表关联、session缓存等用法,可以到GreenDao的官网进行学习

    相关文章

      网友评论

          本文标题:Android GreenDao使用教程

          本文链接:https://www.haomeiwen.com/subject/zluczftx.html