《Andorid开源》greenDao 数据库orm框架

perfect亮
2015-03-17
原文

一

前言：以前没用框架写Andorid的Sqlite的时候就是用SQLiteDatabase ，SQLiteOpenHelper ,SQL语句等一些东西，特别在写SQL语句来进行

数据库操作的时候是一件很繁琐的事情，有时候没有错误提示的，很难找到错误的地方，即费力又花时间。

现在使用greenDao就可以避免那些繁琐的SQL文了,极大的简化了对Sqlite的操作。

greenDao官方网址是:http://greendao-orm.com/

greenDao官方demo下载地址:https://github.com/greenrobot/greenDAO

官方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：其他测试相关的工程

二

对greendDao进行一个简单的介绍：

greenDao是一个用于帮助Android开发者操作SQLite的一个开源项目，SQLite是一个极其重要的嵌入关系型数据库，然而开发这个需要完成一些比较传统的工作，写sql和解析查询结果是一件很繁琐的任务。

greenDao将会为你工作：他讲java的Object和数据库的表进行了映射(常被称为ORM),这个方法可以让你用一些简单的面向对象API来完成存储，更新，删除和查询等，节约时间让你专注于实际比较重要的问题上

greenDao主要的设计目的:

最高性能(可能是最快的ORM为Andorid)
简单易用的APIs
高度优化Andorid
最小的内存占用
小的librry size，可以专注于实际问题

三

官方demo的介绍：

（一） DAO类构造(实体 + 数据库的一些初始化的操作代码)

首先要新建一个java工程( 这个工程就是以后用来生成数据库表和对应实体的工程了)来生成DAO类文件，这个工程需要导入greendao-generator-1.3.1和freemarker-2.3.22这两个jar包要下对，版本号不一定是要

我这个的。

01.package de.greenrobot.daogenerator.gentest;<br/>
02.import de.greenrobot.daogenerator.DaoGenerator;<br/>
03.import de.greenrobot.daogenerator.Entity;<br/>
04.import de.greenrobot.daogenerator.Property;<br/>
05.import de.greenrobot.daogenerator.Schema;<br/>
06.import de.greenrobot.daogenerator.ToMany;<br/>
07./**<br/>
08.* Generates entities and DAOs for the example project DaoExample.<br/>
09.*<br/>
10.* Run it as a Java application (not Android).<br/>
11.*<br/>
12.* @author Markus<br/>
13.*/<br/>
14.public class ExampleDaoGenerator<br/>
15.{<br/>
16.<br/>
17.public static void main(String[] args) throws Exception<br/>
18.{<br/>
19.Schema schema = new Schema(3, "de.greenrobot.daoexample");<br/>
20.<br/>
21.addNote(schema);<br/>
22.addCustomerOrder(schema);<br/>
23.<br/>
24.new DaoGenerator().generateAll(schema, "../DaoExample/src-gen");<br/>
25.}<br/>
26.<br/>
27.private static void addNote(Schema schema)<br/>
28.{<br/>
29.Entity note = schema.addEntity("Note");<br/>
30.note.addIdProperty();<br/>
31.note.addStringProperty("text").notNull();<br/>
32.note.addStringProperty("comment");<br/>
33.note.addDateProperty("date");<br/>
34.}<br/>
35.<br/>
36.private static void addCustomerOrder(Schema schema)<br/>
37.{<br/>
38.Entity customer = schema.addEntity("Customer");<br/>
39.customer.addIdProperty();<br/>
40.customer.addStringProperty("name").notNull();<br/>
41.<br/>
42.Entity order = schema.addEntity("Order");<br/>
43.order.setTableName("ORDERS");<br/>
44.order.addIdProperty();<br/>
45.Property orderDate = order.addDateProperty("date").getProperty();<br/>
46.Property customerId = order.addLongProperty("customerId").notNull().getProperty();<br/>
47.order.addToOne(customer, customerId);<br/>
48.<br/>
49.ToMany customerToOrders = customer.addToMany(order, customerId);<br/>
50.customerToOrders.setName("orders");<br/>
51.customerToOrders.orderAsc(orderDate);<br/>
52.}<br/>
53.<br/>
54.}

对上面的代码做一些解释：

Schema schema = new Schema(3, "de.greenrobot.daoexample"); 3 ---- 自己写的数据库版本号 de.greenrobot.daoexample --- 包的所在地址这些都可以不改的

addNote(schema) 方法执行后就在 Android工程DaoExample中的src-gen文件中创建了一个Note实体,其中属性有text , comment , date 和NoteDao 其实就是对数据库的一些操作的

addCustomerOrder（schema）作用和addNote(schema)类似，只不过是多了表之间的关系(一对一和一对多)

方法（建表，查询等）和sql文都在这里面。

<code>  new DaoGenerator().generateAll(schema, "../DaoExample/src-gen"); 指定生成的路径</code>

<code>  其中src-gen这个目录名需要在运行前手动创建，否则会报错。<br/></code>

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

<code>  运行后可以看到，DaoExample项目src-gen下面自动生成了8个文件，3个实体对象，3个dao，1个DaoMaster,1个DaoSession.<br/></code>

　 `DaoExample`基于greenDao的android`工程,他需要导入greendao-1.3.0-beta-1.jar`

以后想在创建表和实体，就可以直接在这个工程里面添加方法就行了，以前的方法不能修改***

Note就是一个实体，代码就不贴出来了

看看NoteDao的代码：

 public class NoteDao extends AbstractDao<Note, Long> {

     public static final String TABLENAME = "NOTE";

     public static class Properties {

         public final static Property Id = new Property(0, Long.class, "id", true, "_id");

         public final static Property Text = new Property(1, String.class, "text", false, "TEXT");

         public final static Property Comment = new Property(2, String.class, "comment", false, "COMMENT");

         public final static Property Date = new Property(3, java.util.Date.class, "date", false, "DATE");

     };

     public NoteDao(DaoConfig config) {

         super(config);

     }

     public NoteDao(DaoConfig config, DaoSession daoSession) {

         super(config, daoSession);

     }

     /** Creates the underlying database table. */

     public static void createTable(SQLiteDatabase db, boolean ifNotExists) {

         String constraint = ifNotExists? "IF NOT EXISTS ": "";

         db.execSQL("CREATE TABLE " + constraint + "'NOTE' (" + //

                 "'_id' INTEGER PRIMARY KEY ," + // 0: id

                 "'TEXT' TEXT NOT NULL ," + // 1: text

                 "'COMMENT' TEXT," + // 2: comment

                 "'DATE' INTEGER);"); // 3: date

     }

     /** Drops the underlying database table. */

     public static void dropTable(SQLiteDatabase db, boolean ifExists) {

         String sql = "DROP TABLE " + (ifExists ? "IF EXISTS " : "") + "'NOTE'";

         db.execSQL(sql);

     }

     /** @inheritdoc */

     @Override

     protected void bindValues(SQLiteStatement stmt, Note entity) {

         stmt.clearBindings();

         Long id = entity.getId();

         if (id != null) {

             stmt.bindLong(1, id);

         }

         stmt.bindString(2, entity.getText());

         String comment = entity.getComment();

         if (comment != null) {

             stmt.bindString(3, comment);

         }

         java.util.Date date = entity.getDate();

         if (date != null) {

             stmt.bindLong(4, date.getTime());

         }

     }

     /** @inheritdoc */

     @Override

     public Long readKey(Cursor cursor, int offset) {

         return cursor.isNull(offset + 0) ? null : cursor.getLong(offset + 0);

     }    

     /** @inheritdoc */

     @Override

     public Note readEntity(Cursor cursor, int offset) {

         Note entity = new Note( //

             cursor.isNull(offset + 0) ? null : cursor.getLong(offset + 0), // id

             cursor.getString(offset + 1), // text

             cursor.isNull(offset + 2) ? null : cursor.getString(offset + 2), // comment

             cursor.isNull(offset + 3) ? null : new java.util.Date(cursor.getLong(offset + 3)) // date

         );

         return entity;

     }

     /** @inheritdoc */

     @Override

     public void readEntity(Cursor cursor, Note entity, int offset) {

         entity.setId(cursor.isNull(offset + 0) ? null : cursor.getLong(offset + 0));

         entity.setText(cursor.getString(offset + 1));

         entity.setComment(cursor.isNull(offset + 2) ? null : cursor.getString(offset + 2));

         entity.setDate(cursor.isNull(offset + 3) ? null : new java.util.Date(cursor.getLong(offset + 3)));

 }

     /** @inheritdoc */

     @Override

     protected Long updateKeyAfterInsert(Note entity, long rowId) {

         entity.setId(rowId);

         return rowId;

     }

     /** @inheritdoc */

     @Override

     public Long getKey(Note entity) {

         if(entity != null) {

             return entity.getId();

         } else {

             return null;

         }

     }

     /** @inheritdoc */

     @Override    

     protected boolean isEntityUpdateable() {

         return true;

     }

 }

从代码中可以看到，就和以前直接操作sqlite是想类似的。

四

一些常用方法进行介绍( 摘至网络):

1.创建一个实体类

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

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

 dao.setTableName("NoteList");

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

设置一个自增长ID列为主键：

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

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

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

在生成的实体类中,int类型为自动转为long类型。

如果在编译过程中出现以下错误，那么有可能是主键的类型错误所致：

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

在使用greenDAO时，一个实体类只能对应一个表，目前没法做到一个表对应多个实体类，或者多个表共用一种对象类型。后续的升级也不会针对这一点进行扩展。

(二)表的增删改查

增删改查相当方便，完全的面向对象，不需要涉及到任何的sql语言。

1.查询

范例1：查询某个表是否包含某个id:

 public boolean isSaved(int ID)<br/>
 {<br/>
 QueryBuilder<SaveList> qb = saveListDao.queryBuilder();<br/>
 qb.where(Properties.Id.eq(ID));<br/>
 qb.buildCount().count();<br/>
 return qb.buildCount().count() > 0 ? true : false;<br/>
 }

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

 public List<PhotoGalleryDB> getPhotoGallery()<br/>
 {<br/>
     return photoGalleryDao.loadAll();// 获取图片相册<br/>
 }

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

01.

 /** 通过图片id查找其目录id */<br/>
 public int getTypeId(int picId)<br/>
 {<br/>
 QueryBuilder<PhotoGalleryDB> qb = photoGalleryDao.queryBuilder();<br/>
 qb.where(Properties.Id.eq(picId));<br/>
 if (qb.list().size() > 0)<br/>
 {<br/>
 return qb.list().get(0).getTypeId();<br/>
 }<br/>
 else<br/>
 {<br/>
 return -1;<br/>
 }<br/>
 }

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

 List joes = userDao.queryBuilder()<br/>
 where(Properties.FirstName.eq("Joe"))<br/>
 orderAsc(Properties.LastName)<br/>
 list();

范例5：多重条件查询

(1)获取id为cityId并且infotype为HBContant.CITYINFO_SL的数据集合：

 public List<CityInfoDB> getSupportingList(int cityId)<br/>
 {<br/>
 QueryBuilder<CityInfoDB> qb = cityInfoDao.queryBuilder();<br/>
 qb.where(qb.and(Properties.CityId.eq(cityId),Properties.InfoType.eq(HBContant.CITYINFO_SL)));<br/>
 qb.orderAsc(Properties.Id);// 排序依据<br/>
 return qb.list();<br/>
 }

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

 QueryBuilder qb = userDao.queryBuilder();<br/>
 qb.where(Properties.FirstName.eq("Joe"),<br/>
 qb.or(Properties.YearOfBirth.gt(1970),<br/>
 qb.and(Properties.YearOfBirth.eq(1970), Properties.MonthOfBirth.ge(10))));<br/>
 List youngJoes = qb.list();

范例6：获取某列对象

 picJsonDao.loadByRowId(picId);

2.增添/插入、修改

插入数据更加简单，也是只要一句代码便能搞定!

 public void addToPhotoTable(Photo p)<br/>
 {<br/>
 photoDao.insert(p);<br/>
 }

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

 DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "notes-db", null);<br/>
 db = helper.getWritableDatabase();<br/>
 daoMaster = new DaoMaster(db);<br/>
 daoSession = daoMaster.newSession();<br/>
 noteDao = daoSession.getNoteDao();<br/>
 Note note = new Note(null, noteText, comment, new Date());<br/>
 noteDao.insert(note);

修改更新：

1.photoDao.insertOrReplace(photo);

2.photoDao.insertInTx(photo);

这里可定有疑问的：例如update table SET age =20 WHERE name = “张三” 这样一个语句在greenDao中怎么执行的，

始终记住一句话，greenDao 对对象的增，删，改，查就是对数据库的增，删，改，查

  String updateName = content.getText().toString().trim();<br/>
    QueryBuilder qb2 = studentDao.queryBuilder();<br/>
    qb2.where(Properties.Name.eq("张三"));<br/>
    List<Student> update = qb2.list();<br/>
    String newName = content.getText().toString().trim();<br/>
    for (Student student222 : update) {<br/>
     student222.setAge(20);<br/>
      studentDao.insertOrReplaceInTx(student222);<br/>
    }

被查询出的对象被修改后，在替换原来自己的对象就可以了

3.删除:

(1)清空表格数据

 /** 清空相册图片列表的数据 */<br/>
 public void clearPhoto()<br/>
 {<br/>
 photoDao.deleteAll();<br/>
 }

(2)删除某个对象

 public void deleteCityInfo(int cityId)<br/>
 {<br/>
 QueryBuilder<DBCityInfo> qb = cityInfoDao.queryBuilder();<br/>
 DeleteQuery<DBCityInfo> bd = qb.where(Properties.CityId.eq(cityId)).buildDelete();<br/>
 bd.executeDeleteWithoutDetachingEntities();<br/>
 }

参考：https://github.com/greenrobot/greenDAO/issues/34

　　　http://my.oschina.net/cheneywangc/blog/196354

由上可见，使用greenDAO进行数据库的增删改查时及其方便，而且性能极佳。