greenDao的使用教程

最近在对开发项目的性能进行优化。由于项目里涉及了大量的缓存处理和数据库运用，需要对数据库进行频繁的读写、查询等操作。因此首先想到了对整个项目的数据库框架进行优化。
原先使用android本身内置的sqllite，也就是用的最基本的SQLiteOpenHelper方法，这种方法对自己来说比较方便易懂。但是在使用过程中感觉很繁琐，从建表到对表的增删改查等操作，如果表对象的属性很多，就需要使用大量的代码来执行建表、插入等。在代码执行中还需要对数据库和游标的进行及时关闭(开启使用，用完关闭)，而且还需要部分sql语言，这在开发中产生bug进行调试时尤其不方便。
目前android经常用的orm框架主要有greenDAO、OrmLite、AndrORM。综合了网上的各种评价，greenDAO的运行效率最高，内存消耗最少，性能最佳。因此决定采用greenDAO框架，对项目的orm框架进行改进。

greenDAO与ORMLite性能对比
经过两天的修改，终于将项目里的数据库相关的都优化完了。在这过程中，发现greenDAO的性能确实不错，而且使用相当方便，不再需要涉及到任何的sql语言，可以直接通过对象类进行建表、增删改查等，尤其是api接口又方便易懂。在摸索学习中发现国内相关学习资料实在实在是太少，遂决定在此记录下自己对使用这个orm框架的一些心得和方法总结。
一、greenDAO相关
1.greenDAO官网：http://greendao-orm.com/
2.项目下载地址：https://github.com/greenrobot/greenDAO（或者官网）
  greenDAO是一个可以帮助 Android 开发者快速将Java对象映射到SQLite数据库的表单中的ORM解决方案，通过使用一个简单的面向对象API，开发者可以对Java对象进行存储、更新、删除和查询。
greenDAO的主要设计目标：
  *最大性能（最快的 Android ORM）
*易于使用API
*高度优化
*最小内存消耗
二、使用步骤
官方Demo里共有六个工程目录，分别为：
(1).DaoCore：库目录，即jar文件greendao-1.3.0-beta-1.jar的代码；
(2).DaoExample：android范例工程；
(3).DaoExampleGenerator：DaoExample工程的DAO类构造器，java工程；
(4).DaoGenerator：DAO类构造器，java工程；
(5).DaoTest、PerformanceTestOrmLite：其他测试相关的工程。
（一）DAO类构造
首先需要新建一个java工程来生成DAO类文件，该工程需要导入greendao-generator.jar和freemarker.jar文件到项目中。

package de.greenrobot.daogenerator.gentest;
import de.greenrobot.daogenerator.DaoGenerator;
import de.greenrobot.daogenerator.Entity;
import de.greenrobot.daogenerator.Property;
import de.greenrobot.daogenerator.Schema;
import de.greenrobot.daogenerator.ToMany;
/** * Generates entities and DAOs for the example project DaoExample. * * Run it as a Java application (not Android). * * @author Markus */
public class ExampleDaoGenerator
{ public static void main(String[] args) throws Exception { Schema schema = new Schema(3, "de.greenrobot.daoexample"); addNote(schema); addCustomerOrder(schema); new DaoGenerator().generateAll(schema, "../DaoExample/src-gen"); } private static void addNote(Schema schema) { Entity note = schema.addEntity("Note"); note.addIdProperty(); note.addStringProperty("text").notNull(); note.addStringProperty("comment"); note.addDateProperty("date"); } private static void addCustomerOrder(Schema schema) { Entity customer = schema.addEntity("Customer"); customer.addIdProperty(); customer.addStringProperty("name").notNull(); Entity order = schema.addEntity("Order"); order.setTableName("ORDERS"); // "ORDER" is a reserved keyword order.addIdProperty(); Property orderDate = order.addDateProperty("date").getProperty(); Property customerId = order.addLongProperty("customerId").notNull().getProperty(); order.addToOne(customer, customerId); ToMany customerToOrders = customer.addToMany(order, customerId); customerToOrders.setName("orders"); customerToOrders.orderAsc(orderDate); }
}

复制代码

在main方法中，

Schema schema = new Schema(3, "de.greenrobot.daoexample");

复制代码

该方法第一个参数用来更新数据库版本号，第二个参数为要生成的DAO类所在包路径。
然后进行建表和设置要生成DAO文件的目标工程的项目路径。

addNote(schema);
addCustomerOrder(schema);
new DaoGenerator().generateAll(schema, "../DaoExample/src-gen");

复制代码

其中src-gen这个目录名需要在运行前手动创建，否则会报错。
如果运行后出现以下错误，则导入DaoGenerator项目的dao.ftl文件即可(或者直接使用DaoGenerator来生成DAO文件)。

Exception in thread "main" java.io.FileNotFoundException: Template "dao.ftl" not found. at freemarker.template.Configuration.getTemplate(Configuration.java:742) at freemarker.template.Configuration.getTemplate(Configuration.java:665) at de.greenrobot.daogenerator.DaoGenerator.(DaoGenerator.java:68) at de.greenrobot.daogenerator.gentest.ExampleDaoGenerator.main(ExampleDaoGenerator.java:41)

复制代码

运行后出现以下的提示说明DAO文件自动生成成功了，刷新一下DaoExample项目即可看到。

greenDAO Generator
Copyright 2011-2013 Markus Junginger, greenrobot.de. Licensed under GPL V3.
This program comes with ABSOLUTELY NO WARRANTY
Processing schema version 3...
Written F:Android_Exwork_10DaoExamplesrc-gendegreenrobotdaoexampleNoteDao.java
Written F:Android_Exwork_10DaoExamplesrc-gendegreenrobotdaoexampleNote.java
Written F:Android_Exwork_10DaoExamplesrc-gendegreenrobotdaoexampleCustomerDao.java
Written F:Android_Exwork_10DaoExamplesrc-gendegreenrobotdaoexampleCustomer.java
Written F:Android_Exwork_10DaoExamplesrc-gendegreenrobotdaoexampleOrderDao.java
Written F:Android_Exwork_10DaoExamplesrc-gendegreenrobotdaoexampleOrder.java
Written F:Android_Exwork_10DaoExamplesrc-gendegreenrobotdaoexampleDaoMaster.java
Written F:Android_Exwork_10DaoExamplesrc-gendegreenrobotdaoexampleDaoSession.java
Processed 3 entities in 204ms

复制代码

运行后可以看到，DaoExample项目src-gen下面自动生成了8个文件，3个实体对象，3个dao，1个DaoMaster,1个DaoSession.
(二)创建表
1.创建一个实体类

Entity note = schema.addEntity("Note");

复制代码

默认表名就是类名，也可以自定义表名

dao.setTableName("NoteList");

复制代码

greenDAO会自动根据实体类属性创建表字段，并赋予默认值。例如在数据库方面的表名和列名都来源于实体类名和属性名。默认的数据库名称是大写使用下划线分隔单词，而不是在Java中使用的驼峰式大小写风格。例如，一个名为“CREATIONDATE”属性将成为一个数据库列“CREATION_DATE”。
设置一个自增长ID列为主键：

dao.addIdProperty().primaryKey().autoincrement();

复制代码

设置其他各种类型的属性：

dao.addIntProperty("cityId");
dao.addStringProperty("infoType").notNull();//非null字段
dao.addDoubleProperty("Id");

复制代码

在生成的实体类中,int类型为自动转为long类型。
如果在编译过程中出现以下错误，那么有可能是主键的类型错误所致：

java.lang.ClassCastException: java.lang.Integer cannot be cast to java.lang.String

复制代码

在使用greenDAO时，一个实体类只能对应一个表，目前没法做到一个表对应多个实体类，或者多个表共用一种对象类型。后续的升级也不会针对这一点进行扩展。
(二)表的增删改查
增删改查相当方便，完全的面向对象，不需要涉及到任何的sql语言。
1.查询
范例1：查询某个表是否包含某个id:

Schema schema = new Schema(3, "de.greenrobot.daoexample");0

复制代码

范例2：获取整个表的数据集合,一句代码就搞定！

Schema schema = new Schema(3, "de.greenrobot.daoexample");1

复制代码

范例3：通过一个字段值查找对应的另一个字段值(为简便直接使用下面方法，也许有更简单的方法，尚未尝试)

Schema schema = new Schema(3, "de.greenrobot.daoexample");2

复制代码

范例4：查找所有第一姓名是“Joe”并且以lastname排序。

Schema schema = new Schema(3, "de.greenrobot.daoexample");3

复制代码

范例5：多重条件查询
(1)获取id为cityId并且infotype为HBContant.CITYINFO_SL的数据集合：

Schema schema = new Schema(3, "de.greenrobot.daoexample");4

复制代码

(2)获取firstname为“Joe”并且出生于1970年10月以后的所有user集合:

Schema schema = new Schema(3, "de.greenrobot.daoexample");5

复制代码

范例6：获取某列对象

Schema schema = new Schema(3, "de.greenrobot.daoexample");6

复制代码

2.增添/插入、修改
插入数据更加简单，也是只要一句代码便能搞定!

Schema schema = new Schema(3, "de.greenrobot.daoexample");7

复制代码

插入时需要new一个新的对象，范例如下:

Schema schema = new Schema(3, "de.greenrobot.daoexample");8

复制代码

修改更新：

Schema schema = new Schema(3, "de.greenrobot.daoexample");9

复制代码

3.删除:
(1)清空表格数据

addNote(schema);
addCustomerOrder(schema);
new DaoGenerator().generateAll(schema, "../DaoExample/src-gen");0

复制代码

(2)删除某个对象

addNote(schema);
addCustomerOrder(schema);
new DaoGenerator().generateAll(schema, "../DaoExample/src-gen");1

复制代码

参考：https://github.com/greenrobot/greenDAO/issues/34
由上可见，使用greenDAO进行数据库的增删改查时及其方便，而且性能极佳。
(三)常用方法笔记
1.在Application实现得到DaoMaster和DaoSession的方法：

addNote(schema);
addCustomerOrder(schema);
new DaoGenerator().generateAll(schema, "../DaoExample/src-gen");2

复制代码

2.增删改查工具类:

addNote(schema);
addCustomerOrder(schema);
new DaoGenerator().generateAll(schema, "../DaoExample/src-gen");3

复制代码

另外，还有多表关联、惰性加载等功能，待后续研究。
参考资料：
1.https://github.com/greenrobot/greenDAO
2.http://greendao-orm.com/documentation/how-to-get-started/
3.http://blog.csdn.net/krislight/article/details/9391455

greenDao的使用教程相关推荐

GreenDao简明教程（查询，Querying）
亲测可用,若有疑问请私信这是一篇关于greenDao的简明使用教程(其实就是官网tutorial的一个大概的翻译). 一共有四篇,链接如下: 1.基本介绍 2.实体建模 3.查询 4.关系查询查 ...
GreenDao教程(3)：一对一，一对多，多对多
前言一对一 1 注解 2 示例 21 实体类定义 22 insert一组数据 23 delete一组数据 3 结语一对一一对多 1 注解 2 示例 21 实体类定义 22 insert一组数据 3 ...
Android ORM 框架之 greenDAO 使用心得
前言我相信,在平时的开发过程中,大家一定会或多或少地接触到 SQLite.然而在使用它时,我们往往需要做许多额外的工作,像编写 SQL 语句与解析查询结果等.所以,适用于 Android 的ORM ...
Android APP 快速开发教程（安卓）
Android APP 快速开发教程(安卓) 前言本篇博客从开发的角度来介绍如何开发一个Android App,需要说明一点是,这里只是提供一个如何开发一个app的思路,并不会介绍很多技术上的细节, ...
2022 最新 Android 基础教程，从开发入门到项目实战【b站动脑学院】学习笔记——第六章：数据存储
第 6 章数据存储本章介绍Android 4种存储方式的用法,包括共享参数SharedPreferences.数据库SQLite.存储卡文件.App的全局内存,另外介绍Android重要组件-应 ...
GreenDao+SearchView+FlowLoyout实现搜索历史和热门搜索
之前写过一个静态的搜索页 FlowLayout流式布局实现标签.类似热门搜索这种效果只是能实现界面效果,但是往往开发中是要把搜索历史缓存到本地数据库中,所以在原基础上添加了数据库功能. 并且把搜索框 ...
firebase ios_适用于Android和iOS的Firebase实时数据库登录教程
firebase ios Mobile apps need a backend. They store settings & data, high scores, check licenses ...
安卓本地轻量级数据库操作框架 greenDao3.2.2 详细教程附带Demo①——集成环境，开辟难题。
欢迎安卓本地轻量级数据库操作框架 greenDao3.2.2 学习之旅. 本套框架博客系列博客目录: 第一篇:认识 greenDao3.2.2 框架,集成环境,开辟难题. 第二篇:简单的进行增.删. ...
greendao连接mysql_使用GreenDao操作数据库
大神们都说GreenDao性能最好,使用方便,最近在做一个项目,刚好用到操作本地数据库,so机缘巧合,开始学习GreenDao,顺便做一下笔记. (1)原理我总有那么一个习惯,就是使用别人的工具,总 ...
greenDAO与Realm的探索
最近项目中要用到数据库相关的知识,就在网上查了下Android平台上的数据库框架,目前比较热门有GreenDAO和Realm,这两个都是使用者都比较多,并且都在持续发布更新,就对这两个框架进行了一些探 ...

greenDao的使用教程

greenDao的使用教程相关推荐

最新文章

热门文章