Android ORM 框架之 greenDAO 使用心得

最新推荐文章于 2024-05-03 09:37:03 发布
最新推荐文章于 2024-05-03 09:37:03 发布
阅读量187 收藏
点赞数

原文：http://itangqi.me/android/using-greendao-experience/ 

前言

我相信，在平时的开发过程中，大家一定会或多或少地接触到 SQLite。然而在使用它时，我们往往需要做许多额外的工作，像编写 SQL 语句与解析查询结果等。所以，适用于 Android 的ORM 框架也就孕育而生了，现在市面上主流的框架有 OrmLite、SugarORM、Active Android、Realm 与 GreenDAO。而今天的主角便是 greenDAO，下面，我将详解地介绍如何在 Android Studio 上使用 greenDAO，并结合代码总结一些使用过程中的心得。

关于 greenDAO

Android ORM 框架之 greenDAO 使用心得

简单的讲，greenDAO 是一个将对象映射到 SQLite 数据库中的轻量且快速的 ORM 解决方案。（greenDAO is a light & fast ORM solution that maps objects to SQLite databases.） 
而关于 ORM （Object Relation Mapping - 对象关系映射）的概念，可参见 Wikipedia。

GREENDAO 设计的主要目标

  • 一个精简的库

  • 性能最大化

  • 内存开销最小化

  • 易于使用的 APIs

  • 对 Android 进行高度优化

GREENDAO 设计的主要特点

  • greenDAO 性能远远高于同类的 ORMLite，具体测试结果可见官网

  • greenDAO 支持 protocol buffer(protobuf) 协议数据的直接存储，如果你通过 protobuf 协议与服务器交互，将不需要任何的映射。

  • 与 ORMLite 等使用注解方式的 ORM 框架不同，greenDAO 使用「Code generation」的方式，这也是其性能能大幅提升的原因。

DAO CODE GENERATION PROJECT

Android ORM 框架之 greenDAO 使用心得

这是其核心概念：为了在我们的 Android 工程中使用 greenDAO ，我们需要另建一个纯 Java Project，用于自动生成后继 Android 工程中需要使用到的 Bean、DAO、DaoMaster、DaoSession 等类。

CORE CLASSES & MODELLING ENTITIES

关于以上几个类的相关概念与作用，我将在下面的代码（注释）中详细讲解。
当然，你也可以在 官网 中找到相关介绍。

让我们开始吧

一. 在 ANDROID 工程中配置「GREENDAO GENERATOR」模块

  1. 在 .src/main 目录下新建一个与 java 同层级的「java-gen」目录，用于存放由 greenDAO 生成的 Bean、DAO、DaoMaster、DaoSession 等类。 
    Android ORM 框架之 greenDAO 使用心得Android ORM 框架之 greenDAO 使用心得

  2. 配置 Android 工程（app）的 build.gradle，如图分别添加 sourceSets 与dependencies。 Android ORM 框架之 greenDAO 使用心得

sourceSets {
        main {
            java.srcDirs = ['src/main/java', 'src/main/java-gen']
        }
    }
compile 'de.greenrobot:greendao:1.3.7'


二. 新建「GREENDAO GENERATOR」模块 (纯 JAVA 工程）

  1. 通过 File -> New -> New Module -> Java Library -> 填写相应的包名与类名 -> Finish.
    Android ORM 框架之 greenDAO 使用心得Android ORM 框架之 greenDAO 使用心得Android ORM 框架之 greenDAO 使用心得

  2. 配置 daoexamplegenerator 工程的 build.gradle，添加 dependencies.

  3.  Android ORM 框架之 greenDAO 使用心得

compile 'de.greenrobot:greendao-generator:1.3.1'

  1. 编写 ExampleDaoGenerator 类，注意： 我们的 Java 工程只有一个类，它的内容决定了「GreenDao Generator」的输出，你可以在这个类中通过对象、关系等创建数据库结构，下面我将以注释的形式详细讲解代码内容。

public class ExampleDaoGenerator {
    public static void main(String[] args) throws Exception {
        // 正如你所见的，你创建了一个用于添加实体（Entity）的模式（Schema）对象。
        // 两个参数分别代表：数据库版本号与自动生成代码的包路径。
        Schema schema = new Schema(1, "me.itangqi.greendao");
//      当然，如果你愿意，你也可以分别指定生成的 Bean 与 DAO 类所在的目录，只要如下所示：
//      Schema schema = new Schema(1, "me.itangqi.bean");
//      schema.setDefaultJavaPackageDao("me.itangqi.dao");

        // 模式（Schema）同时也拥有两个默认的 flags，分别用来标示 entity 是否是 activie 以及是否使用 keep sections。
        // schema2.enableActiveEntitiesByDefault();
        // schema2.enableKeepSectionsByDefault();

        // 一旦你拥有了一个 Schema 对象后，你便可以使用它添加实体（Entities）了。
        addNote(schema);

        // 最后我们将使用 DAOGenerator 类的 generateAll() 方法自动生成代码，此处你需要根据自己的情况更改输出目录（既之前创建的 java-gen)。
        // 其实，输出目录的路径可以在 build.gradle 中设置，有兴趣的朋友可以自行搜索，这里就不再详解。
        new DaoGenerator().generateAll(schema, "/Users/tangqi/android-dev/AndroidStudioProjects/MyGreenDAO/app/src/main/java-gen");
    }

    /**
     * @param schema
     */
    private static void addNote(Schema schema) {
        // 一个实体（类）就关联到数据库中的一张表，此处表名为「Note」（既类名）
        Entity note = schema.addEntity("Note");
        // 你也可以重新给表命名
        // note.setTableName("NODE");

        // greenDAO 会自动根据实体类的属性值来创建表字段，并赋予默认值
        // 接下来你便可以设置表中的字段：
        note.addIdProperty();
        note.addStringProperty("text").notNull();
        // 与在 Java 中使用驼峰命名法不同，默认数据库中的命名是使用大写和下划线来分割单词的。
        // For example, a property called “creationDate” will become a database column “CREATION_DATE”.
        note.addStringProperty("comment");
        note.addDateProperty("date");
    }
}

三. 生成 DAO 文件（数据库）

  • 执行 generator 工程，如一切正常，你将会在控制台看到如下日志，并且在主工程「java-gen」下会发现生成了DaoMaster、DaoSession、NoteDao、Note共4个类文件。 Android ORM 框架之 greenDAO 使用心得

如果在此处出错，你可以依据错误日志进行排查，主要看是否输出目录存在？其他配置是否正确？等

四. 在 ANDROID 工程中进行数据库操作

这里，我们只创建一个 NodeActivity 类，用于测试与讲解 greenDAO 的增、删、查功能。

  • activity_note.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="fill_parent"
    android:layout_height="fill_parent"
    android:orientation="vertical">

    <LinearLayout
        android:id="@+id/linearLayout1"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"
        android:orientation="horizontal">

        <EditText
            android:id="@+id/editTextNote"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_weight="1"
            android:hint="Enter new note"
            android:inputType="text"></EditText>

        <Button
            android:id="@+id/buttonAdd"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:onClick="onMyButtonClick"
            android:text="Add"></Button>

        <Button
            android:id="@+id/buttonSearch"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:onClick="onMyButtonClick"
            android:text="Search"></Button>
    </LinearLayout>

    <ListView
        android:id="@android:id/list"
        android:layout_width="fill_parent"
        android:layout_height="wrap_content"></ListView>
</LinearLayout>

  • NoteActivity.java

public class NoteActivity extends ListActivity {
    private SQLiteDatabase db;
    private EditText editText;
    private DaoMaster daoMaster;
    private DaoSession daoSession;
    private Cursor cursor;
    public static final String TAG = "DaoExample";

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_note);
        // 官方推荐将获取 DaoMaster 对象的方法放到 Application 层，这样将避免多次创建生成 Session 对象
        setupDatabase();
        // 获取 NoteDao 对象
        getNoteDao();

        String textColumn = NoteDao.Properties.Text.columnName;
        String orderBy = textColumn + " COLLATE LOCALIZED ASC";
        cursor = db.query(getNoteDao().getTablename(), getNoteDao().getAllColumns(), null, null, null, null, orderBy);
        String[] from = {textColumn, NoteDao.Properties.Comment.columnName};
        int[] to = {android.R.id.text1, android.R.id.text2};

        SimpleCursorAdapter adapter = new SimpleCursorAdapter(this, android.R.layout.simple_list_item_2, cursor, from,
                to);
        setListAdapter(adapter);

        editText = (EditText) findViewById(R.id.editTextNote);
    }

    private void setupDatabase() {
        // 通过 DaoMaster 的内部类 DevOpenHelper，你可以得到一个便利的 SQLiteOpenHelper 对象。
        // 可能你已经注意到了，你并不需要去编写「CREATE TABLE」这样的 SQL 语句，因为 greenDAO 已经帮你做了。
        // 注意：默认的 DaoMaster.DevOpenHelper 会在数据库升级时，删除所有的表，意味着这将导致数据的丢失。
        // 所以，在正式的项目中，你还应该做一层封装，来实现数据库的安全升级。
        DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "notes-db", null);
        db = helper.getWritableDatabase();
        // 注意：该数据库连接属于 DaoMaster，所以多个 Session 指的是相同的数据库连接。
        daoMaster = new DaoMaster(db);
        daoSession = daoMaster.newSession();
    }

    private NoteDao getNoteDao() {
        return daoSession.getNoteDao();
    }

    /**
     * Button 点击的监听事件
     *
     * @param view
     */
    public void onMyButtonClick(View view) {
        switch (view.getId()) {
            case R.id.buttonAdd:
                addNote();
                break;
            case R.id.buttonSearch:
                search();
                break;
            default:
                Log.d(TAG, "what has gone wrong ?");
                break;
        }
    }

    private void addNote() {
        String noteText = editText.getText().toString();
        editText.setText("");

        final DateFormat df = DateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.MEDIUM);
        String comment = "Added on " + df.format(new Date());

        // 插入操作，简单到只要你创建一个 Java 对象
        Note note = new Note(null, noteText, comment, new Date());
        getNoteDao().insert(note);
        Log.d(TAG, "Inserted new note, ID: " + note.getId());
        cursor.requery();
    }

    private void search() {
        // Query 类代表了一个可以被重复执行的查询
        Query query = getNoteDao().queryBuilder()
                .where(NoteDao.Properties.Text.eq("Test1"))
                .orderAsc(NoteDao.Properties.Date)
                .build();

//      查询结果以 List 返回
//      List notes = query.list();
        // 在 QueryBuilder 类中内置两个 Flag 用于方便输出执行的 SQL 语句与传递参数的值
        QueryBuilder.LOG_SQL = true;
        QueryBuilder.LOG_VALUES = true;
    }

    /**
     * ListView 的监听事件，用于删除一个 Item
     * @param l
     * @param v
     * @param position
     * @param id
     */
    @Override
    protected void onListItemClick(ListView l, View v, int position, long id) {
        // 删除操作，你可以通过「id」也可以一次性删除所有
        getNoteDao().deleteByKey(id);
//        getNoteDao().deleteAll();
        Log.d(TAG, "Deleted note, ID: " + id);
        cursor.requery();
    }
}

五. 运行结果

一切就绪，让我们看看效果吧！运行程序，分别执行添加按钮、删除（点击 List 的 Item）与查询按钮，可以在控制台得到如下日志：
Android ORM 框架之 greenDAO 使用心得 Android ORM 框架之 greenDAO 使用心得 Android ORM 框架之 greenDAO 使用心得

最后

  • 本文的 Demo 下载链接：https://github.com/tangqi92/MyGreenDAO

  • 本教程旨在介绍 greenDAO 的基本用法与配置，更高级与详细的使用，请参见 官网

  • 如本文有任何错误与遗漏，欢迎指正。同时我期待与大家成为朋友，所以欢迎在社交网络上互粉！！！

References & More

http://greendao-orm.com/ https://github.com/greenrobot/greenDAOhttp://stackoverflow.com/questions/tagged/greendaohttps://groups.google.com/forum/#!forum/greendao


Android ORM框架之 greenDAO
05-09
GreenDao是一个用于Android开发的对象/关系映射(ORM)工具。它向SQLite数据库提供了一个对象导向的接口。像GreenDao这样的ORM工具不仅为你省去了很多的重复工作，而且提供了更简便的操作接口。 blog链接：...
Android GreenDao介绍和Generator生成表对象代码
Shi_Liz的博客
11-26 6490
转载请注明： http://blog.csdn.net/sinat_30276961/article/details/50052109 最近无意中发现了GreenDao，然后查看了一些资料后，发现这个数据库框架很适合用，于是乎，查看了官网的api，并自己写了一个小应用总结一下它的使用方法。 介绍按照国际惯例，在开篇，总要先介绍一下什么是GreenDao吧。首先需要说明的是GreenDao是基于
Android系列之GreenDao数据升级和加密(三)
我是你妹她哥的博客
04-09 1498
背景 上一篇文章 Android系列之GreenDao基本使用（增、删、改、查）给大家介绍的GreenDao最基本的用法。看完上篇文章之后，大家对于基本的增删改查应该都已经学会了。那么这篇文章主要就是给大家扩展一下，在实际使用中可能会遇到的一些问题。 优化：新建一个GreenDapUtils类，帮助我们获取daoSession。总不能每次都new一个daoSession。 数据库升级是怎么样的逻...
greenDao框架使用心得
「Android之禅」公众号博主，和你分享有价值有思考的技术文章
10-03 2301
阅读目录 GREENDAO 设计的主要目标GREENDAO 设计的主要特点DAO CODE GENERATION PROJECTCORE CLASSES & MODELLING ENTITIES一. 在 ANDROID 工程中配置「GREENDAO GENERATOR」模块二. 新建「GREENDAO GENERATOR」模块 (纯 JAVA 工程）三. 生成 DAO 文件（数据
三思系列：前人用GreenDao留下的坑，全线被扣了绩效
leobert.lan的博客
04-10 3292
前人挖坑，被扣绩效！快来看看你的项目有没有。 您将从一个GreenDao使用的事故开始，掌握GreenDao的整体设计，最终解决问题并对APT、Gradle插件技术融会贯通。
Android开发，GreenDao的简单使用
qq_41904106的博客
08-28 546
Android开发，GreenDao的简单使用，个人学习记录，错误很多，不供参考 绿刀（自己编）数据库开源框架使用方法： 1.在项目的app,单击右键选择Open Moudle Setting, 找到 app, 右方选择 Dependences依赖，选择”+”添加，输入greendao, 回车（需要网络），然后选择你想要版本. 我选的是“de.greenrobot:greendao:2.1.0” **2.在项目名上，单击右键选择 new --> Moudle. 选择 java Moudle,名字自取
Android_ORM框架_GreenDao
08-09
GreenDao是Android平台上广泛使用的ORM框架之一，尤其受到开发者青睐。本文将深入探讨GreenDao的特性、使用方法以及如何在实际项目中集成和应用。 GreenDao 3.2.2是其最新的稳定版本，它提供了一系列优化和改进，以...
Android ORM数据库之GreenDao使用教程及源码分析.zip
11-22
数据库 教程 学习资料，供相关专业学生、项目人员参考数据库 教程 学习资料，供相关专业学生、项目人员参考数据库 教程 学习资料，供相关专业学生、项目人员参考数据库 教程 学习资料，供相关专业学生、项目人员参考...
Android ORM系列之GreenDao关联关系映射
09-01
在Android应用开发中，ORM（Object-Relational Mapping）框架是一种将数据库操作与业务对象模型进行映射的技术，使得开发者可以使用面向对象的方式来处理数据库，而无需关心底层SQL语句的编写。GreenDao就是Android...
Android ORM系列之GreenDao最佳实践
09-01
GreenDao就是其中一款针对Android平台设计的高性能ORM框架，它通过简化数据库操作，提高了开发效率。本文将深入探讨在Android项目中如何有效地使用GreenDao进行数据库管理，实现最佳实践。 1. **GreenDao安装与配置...
Android 数据库之GreenDAO
qq_19688207的博客
08-08 1352
GreenDAO 是一款开源的面向 Android 的轻便、快捷的 ORM 框架，将 Java 对象映射到 SQLite 数据库中，我们操作数据库的时候，不再需要编写复杂的 SQL语句， 在性能方面，greenDAO 针对 Android 进行了高度优化，最小的内存开销 、依赖体积小 同时还是支持 数据库加密。对于每个实体类， greenDAO 都会生成一个与之对应 DAO 对象，如：User 实体，则会生成一个 UserDao 类。1、build.gradle(Module:app)中添加配置与依赖。
Android GreenDao 使用全面讲解，2024年最新Android性能优化总结
2401_84160041的博客
04-11 1214
初始化完成之后重新rebuild一下项目会发现在设置的targetGenDir的目录生成三个类文件，这个是GreenDao自动生成的！说明数据库已经连接好了，咱们接下来只需要进行数据库的增删改查操作就行了。Let’s Go!
进击的Android程序员：Android 初级——高级知识点汇总+大量2024大厂面试题满满干货
最新发布
2401_84545700的博客
05-03 945
首先是一个知识清单：（对于现在的Android及移动互联网来说，我们需要掌握的技术）泛型原理丶反射原理丶Java虚拟机原理丶线程池原理丶注解原理丶注解原理丶序列化Activity知识体系（Activity的生命周期丶Activity的任务栈丶Activity的启动模式丶View源码丶Fragment内核相关丶service原理等）代码框架结构优化（数据结构丶排序算法丶设计模式）APP性能优化（用户体验优化丶适配丶代码调优）热修复丶热升级丶Hook技术丶IOC架构设计。
GreenDao
liang_autumn_wind的博客
10-12 223
gradle greenDao compile 'de.greenrobot:greendao:2.1.0' greendao-generator,生成器 compile 'de.greenrobot:greendao-generator:2.1.0' java mudole,帮助生成Dao文件，以及实体类，单独进行java程序的运行后生成Android相关文件，再进行编写
Android数据库框架-GreenDao入门，阿里P8架构师Android大厂面试题总结
m0_64604178的博客
12-08 917
// in the individual module build.gradle files } } 之后点击Sync Project 2.2. 在app的build.gradle中配置 apply plugin: ‘com.android.application’ apply plugin: ‘org.greenrobot.greendao’ 之后在dependencies中添加依赖 dependencies { implementation fileTree(dir: ‘libs’, include:
Android greenDao
xiaowang_lj的博客
07-02 1532
greenDAO是一个开源的Android ORM(对象-关系映射)，它让SQLite数据库的开发再次变得有趣。它使开发人员免于处理低级数据库要求，同时节省了开发时间。SQLite是一个很棒的嵌入式关系数据库。尽管如此，编写SQL和解析查询结果仍然是非常繁琐且耗时的任务。通过将Java对象映射到数据库表（称为ORM，“对象/关系映射”），greenDAO使您摆脱了这些麻烦。这样，您可以使用简单的面向对象的API来存储，更新，删除和查询Java对象。 最佳性能 (可能是 Android 中最快的 ORM) ，
greendao 无法自动生成文件_GreenDao的全面使用指南(源码+案列)
weixin_39642622的博客
11-22 1521
好久未更新，赶快把干货整理出来，这篇文章是去年10月份写的，算是自己写的技术文章中读者反响挺不错的一篇，可能有学习GreenDao的朋友看过，这里再推荐一波，希望能帮助大家更深入的学习了解GreenDao的使用。原文如下：之前在开发过程中，数据库基本上会使用Litepal和SQlite自己写，最近换新环境，公司原先使用的数据库就是GreenDao，在各种情况的作用下，准备了解下Green...
GreenDao-多表关联
三杯五岳
09-29 3018
利用GreenDAO可以非常方便的建立多张表之间的关联 一对一关联 通常我们在操作数据库的时候，我们往往不是单独的对一张表进行操作，而是对这张表的操作会联动的影响另外一张表或者多张表，比如：现在有两张表，一张是用户User表（有name、age、sex三个字段），一张是头像Picture表（有pictureId、pictureName、width、height四个字段）。假如用户表和头
Android ORM框架实践：使用ORMLite进行数据持久化
"本文介绍了在Android应用开发中使用ORM框架ORMLite进行数据持久化的实践方法。文章通过比较不同的Android ORM框架，最终选择了ORMLite，并提供了详细的步骤来演示如何使用ORMLite创建一个简单的Android项目...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值