Android ORM 框架——GreenDao的基本用法

参考文章:
http://www.jcodecraeer.com/a/anzhuokaifa/androidkaifa/2017/0703/8144.html

GreenDao

GreenDao

greenDAO 是一款开源的面向 Android 的轻便、快捷的 ORM 框架,将 Java 对象映射到 SQLite 数据库中,我们操作数据库的时候,不在需要编写复杂的 SQL语句, 在性能方面,greenDAO 针对 Android 进行了高度优化, 最小的内存开销 、依赖体积小 同时还是支持数据库加密。

集成 GreenDAO

1. 集成插件

在project级build.gradle中的dependencies中添加plugin:

dependencies {
        classpath 'com.android.tools.build:gradle:2.3.2'
        classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2' // add plugin

        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }

在app的build.gradle中apply plugin:

apply plugin: 'com.android.application'
apply plugin: 'org.greenrobot.greendao' // apply plugin

2. 添加GreenDao依赖

在app的build.gradle的dependencies中添加依赖:

dependencies {
    ...
    compile 'org.greenrobot:greendao:3.2.2' // add library
    ...
}

3. 配置数据库信息

在app的build.gradle中添加以下greendao部分:

android{
    ...
}

//需要添加的
greendao {
    schemaVersion 1 //数据库版本号
    daoPackage 'com.ncd.greendaotest.db'// 设置DaoMaster、DaoSession、Dao 包名
    targetGenDir 'src/main/java'//设置DaoMaster、DaoSession、Dao目录
}

dependencies{
    ...
}

最后同步完成配置。

测试例子GreenDaoTest

1. 编写实体类 User.java

@Entity
public class User {
    @NotNull
    private String name;

    //id 字段必须是Long类型,默认自增
    @Id
    private Long id;

    public User() {
    }

    @Generated(hash = 969448858)
    public User(@NotNull String name, Long id) {
        this.name = name;
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", id=" + id +
                '}';
    }
}

其中注解
@Id 就是将该字段作为数据库表的主键,默认自增,注意:此字段只能是Long类型,不能是long类型,更不能是其他类型。
@Entity是实体注解
具体信息请查看 GreenDao 3.X之注解

2. 生成 DaoMaster,DaoSession 和 UserDao 类

点击make project,如果之前配置无误,就会在之前配置的“daoPackage 'com.ncd.greendaotest.db”目录下生成这三个类。

db.png

3. 初始化

一般将初始化写在Application中

public class MyApplication extends Application {

    private DaoSession daoSession;
    private static MyApplication myApplication;

    @Override
    public void onCreate() {
        super.onCreate();
        initGreenDao();
        myApplication = this;
    }

    /**
     * 初始化 GreenDao
     */
    private void initGreenDao() {
        DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "test.db");
        SQLiteDatabase db = helper.getWritableDatabase();
        DaoMaster master = new DaoMaster(db);
        daoSession = master.newSession();
    }

    public DaoSession getDaoSession() {
        return daoSession;
    }

    public static MyApplication getApplication() {
        return myApplication;
    }
}

4. 使用

为了方便,编写了此实体的工具类(方法没有全部实现,有的方法没测试,可能存在错误)

public class UserUtils {
    private static final String TAG = UserUtils.class.getSimpleName();

    private static UserUtils instance;
    private DaoSession daoSession;
    private UserDao userDao;

    private UserUtils() {
        initDao();
    }

    public static UserUtils getInstance() {
        if (null == instance) {
            synchronized (UserUtils.class) {
                if (null == instance) {
                    instance = new UserUtils();
                }
            }
        }
        return instance;
    }

    //获取DAO
    private void initDao() {
        if (null == daoSession) {
            daoSession = MyApplication.getApplication().getDaoSession();
        }
        if (null == userDao) {
            userDao = daoSession.getUserDao();
        }
    }

    //插入 若数据库中存在此id,则会报错
    public void insert(User user) {
        if (null != userDao && null != user) {
            userDao.insert(user);
        } else {
            return;
        }
    }

    //插入 若数据库中存在此id,则会更新数据
    public void insertOrReplace(User user) {
        if (null != userDao && null != user) {
            userDao.insertOrReplace(user);
        } else {
            return;
        }
    }

    //删除
    public void delete(User user) {
        if (null != userDao && null != user) {
            userDao.delete(user);
        } else {
            return;
        }
    }

    //根据id删除
    public void deleteByUserId(String id) {
        if (null != userDao && !TextUtils.isEmpty(id)) {
            userDao.deleteByKey(Long.valueOf(id));
        } else {
            return;
        }
    }

    //更新
    public void update(User user) {
        if (null != userDao && null != user) {
            userDao.update(user);
        } else {
            return;
        }
    }

    //查询所有
    public List<User> query() {
        if (null != userDao) {
            return userDao.loadAll();
        } else {
            return null;
        }
    }

    //根据id查询
    public User queryById(String id) {
        if (null != userDao && !TextUtils.isEmpty(id)) {
            return userDao.loadByRowId(Long.valueOf(id));
        } else {
            return null;
        }
    }

    //根据条件查询
    public List<User> queryByArgs(String selection, String selectionArg) {
        if (null != userDao && !TextUtils.isEmpty(selection)) {
            return userDao.queryRaw(selection, selectionArg);
        } else {
            return null;
        }
    }
效果图.png

Sample Code:
https://github.com/VersaceSilva/AndroidReview/tree/master/GreenDaoTest

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,591评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,448评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,823评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,204评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,228评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,190评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,078评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,923评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,334评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,550评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,727评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,428评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,022评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,672评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,826评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,734评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,619评论 2 354

推荐阅读更多精彩内容