GreenDao3.2.0项目的接入和简单的使用

96
小龙人的绝望
2016.11.09 19:11* 字数 1019

为什么使用GreenDao?

可能大家都GreenDao有一点了解,有可能没有去使用过,其实我之前也是听说过,没有在项目中真正使用过,只知道它是一个Android中方便操作数据库的一个工具,也没有真正去了结果,今天刚好考虑到有这些需求,就花了一天时间来研究这些东西,把了解到的东西分享给大家,我的应用场景是因为我app端有一些数据需要做缓存,但是考虑到SharedPreferences,因为我个人的理解SharedPreferences里面更适合放一些配置信息,如果我的项目需要缓存的数据比较多,比如:订单信息等等。这样就有点略显无力,所以考虑到使用sqlite去存储,然后就用到开始了GreenDao之旅。

如何使用GreenDao?

起初在简书、掘金、开源中国这些社区里都找了一下,但是发现博客很多讲的都是2.0或者一下的版本的使用教程,没办法,在Android studio编译的是3.2.0,尝试了下2.0的方法发现不行,很多东西对不上,只能去找下新版本的使用方法,然后就通过github [GreenDao]https://github.com/greenrobot/greenDAO 去官网找资料,接口在看完官网的一些介绍之后更懵逼了,下面这张图片是介绍的时候对gradle配置的一个说明,说句实话,自己对gradle了解的真是太少了,开始的时候吧greendao-gradle-plugin:3.2.0直接在app的gradle中compile进去(想喷我稍微轻点哈_),在这里我说下实际是怎么写的,其实上面的buildscript实际上是配置到Project的gradle中的,下面的apply plugin都是在app的Gradle中去配置的。

GreendDao Gradle配置

然后下面就直接介绍了几个核心的类,如:DaoMaster、DaoSession、DevOpenHelper;看完之后就想在as里面试下,结果都把ctrl+space按坏了都按不出来,好吧,我已经感觉自己想的太简单了,然后就去下载Demo,然后才发现了正确打开方式。


官网的介绍

小白步骤:

  • 第一步:在app的gradle文件中配置数据库信息:
    greendao {
            schemaVersion 1
            daoPackage 'com.zgl.greentest.gen'
            targetGenDir 'src/main/java'
}

schemaVersion 对应当前数据库版本
daoPackage 由GreenDao自动生成代码所在的包名,默认的是在项目包下面新建一个gen。
targetGenDir 设置自动生成代码的目录。

  • 第二步:在项目中定义一个实体类,并且使用@Entity和@Id标注
  @Entity
public class User extends BaseBean
{
        @Id
        private Long id;
        private int memberSex;//性别
        private String memberLastX;//X币
        @Property(nameInDb = "sex")
        private String memberNickname;//昵称
        private String memberIcon;//头像地址链接
        private String memberMobile;//手机号
        private int memberId;//用户ID
        @Transient
        private String memberDetailAddr;//用户的详细地址
        private String memberLastExperience;//用户经验值
        private String memberLevelName;//用户等级昵称
        private long memberBirthday;//用户生日
        private String memberProvince;//用户所在地
}

@Entity 标识实体类,GreenDao会映射成sqlite中的一个表
@Id 标识主键
@Property 标识该属性在表中对应的列名称
@Transient 标识该属性将不会映射到表中,也就是没有这列
还有很多的注释,大家可以参考[注释帮助文档]http://greenrobot.org/files/greendao-api/javadoc/current/

  • 第三步:定义好之后按ctrl+F9,也就是工具栏build下面的Make Project对项目进行重新构建,然后就在daoPackage 'com.zgl.greentest.gen'去看自动生成的代码了。
    由GreenDao插件生成的代码
  • 第四步:使用部分,就是在别的地方怎么使用api来存取对象。首先是实例化GreenDao所需要的几个关键对象,DaoMaster,DaoSession,代码如下:
public class GreenDaoManager
{
    private DaoMaster mDaoMaster;
    private DaoSession mDaoSession;

    private GreenDaoManager()
    {
        init();
    }

    /**
     * 静态内部类,实例化对象使用
     */
    private static class SingleInstanceHolder
    {
        private static final GreenDaoManager INSTANCE = new GreenDaoManager();
    }

    /**
     * 对外唯一实例的接口
     *
     * @return
     */
    public static GreenDaoManager getInstance()
    {
        return SingleInstanceHolder.INSTANCE;
    }

    /**
     * 初始化数据
     */
    private void init()
    {
        DaoMaster.DevOpenHelper devOpenHelper = new DaoMaster.DevOpenHelper(App.getmAppContext(),
                                                                            "shopping_guide");
        mDaoMaster = new DaoMaster(devOpenHelper.getWritableDatabase());
        mDaoSession = mDaoMaster.newSession();
    }
    public DaoMaster getmDaoMaster()
    {
        return mDaoMaster;
    }
    public DaoSession getmDaoSession()
    {
        return mDaoSession;
    }
    public DaoSession getNewSession()
    {
        mDaoSession = mDaoMaster.newSession();
        return mDaoSession;
    }
}

还要记着在Application中去初始化:

//GreenDao的初始化
GreenDaoManager.getInstance();

这些工作做完了之后就可以在正式使用了

    public UserDao getUserDao()
    {
        return GreenDaoManager.getInstance().getmDaoSession().getUserDao();
    }

    public User getUser(Long id)
    {
        return getUserDao().load(id);
    }

还有很多使用方法,这里就不介绍了,可以查看文档[GreenDao api]http://greenrobot.org/files/greendao/javadoc/current/
也可以参考[大城小小爱的博客]http://blog.csdn.net/scorpio_gao/article/details/53048699 感谢分享。有什么建议可以留言。谢谢

Android开发积累
Web note ad 1