原先使用android本身内置的sqllite,也就是用的最基本的 SQLiteOpenHelper方法,这种方法对自己来说比较方便易懂。但是在使用过程中感觉很繁琐,从建表到对表的增删改查等操作,如果表对象的属性 很多,就需要使用大量的代码来执行建表、插入等。在代码执行中还需要对数据库和游标的进行及时关闭(开启使用,用完关闭),而且还需要部分sql语言,这 在开发中产生bug进行调试时尤其不方便。

目前android经常用的orm框架主要有greenDAO、OrmLite、AndrORM。 综合了网上的各种评价,greenDAO的运行效率最高,内存消耗最少,性能最佳。因此决定采用greenDAO框架,对项目的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这个目录名需要在运行前手动创建,否则会报错。


(二)创建表

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:

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

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

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


范3:多重条件查询

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

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

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

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

范例6:获取某列对象

picJsonDao.loadByRowId(picId);

2.增添/插入、修改

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

public void addToPhotoTable(Photo p)
{
    photoDao.insert(p);
}

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

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

修改更新:

photoDao.insertOrReplace(photo);
photoDao.insertInTx(photo);

3.删除:

(1)清空表格数据

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

(2)删除某个对象

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

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

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

posted on 2015-01-25 18:33  移动开发者  阅读(305)  评论(0编辑  收藏  举报