您当前位置：首页 > php开源 > 综合技术 > Android ORM-GreenDao学习之一基础篇

Android ORM-GreenDao学习之一基础篇

来源：程序员人生发布时间：2015-06-19 08:49:18 阅读次数：3844次

概述

GreenDao是Android当中的高性能ORM框架。（其他的有OrmLite等）

项目地址：https://github.com/greenrobot/greenDAO

同时GreenDao还有1个子项目为GreenDao Code Generator:

GreenDao的核心类及其工作以下：

使用初始化

使用greendao添加greendao.jar;

（使用greendao-generator则需要添加greendao-generator.jar与freemarker.jar这1点在以后讲）

相干jar包可以通过maven中央仓库下载。

helper = new DaoMaster.DevOpenHelper(this, "notes-db", null);//greendao会创建notes-db这个数据库 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); Log.d("DaoExample", "Inserted new note, ID: " + note.getId());

noteDao.deleteByKey(id);

数据模型与代码生成

1般情况下，你使用GreeDao需要创建两个项目，1个是你的Android项目添加greendao.jar依赖，另外1个是普通的java se工程.添加greendao-generator.jar与freemarker.jar依赖。后者用于数据模型domain,dao,DaoMaster等代码的生成。

DoMaster与DaoSession及XxxDao和实体类均会生成。DoMaster与DaoSession对应于你当前的数据模型。这两个类中每一个数据模型生成的方法均不同

数据模型代码生成示例-使用greendao-generator:

Schema schema = new Schema(1, "de.greenrobot.daoexample"); Entity note= schema.addEntity("Note"); note.addIdProperty(); note.addStringProperty("text").notNull(); note.addStringProperty("comment"); note.addDateProperty("date"); new DaoGenerator().generateAll(schema, "../DaoExample/src-gen");

Schema代表你的数据库，Entity代表你要生成的数据表结构。向Entity添加属性相当于添加列结构。

注意：../DaoExample/src-gen路径必须存在否则会报错

模型化实体Entities

Schema:

Schema schema = new Schema(1, "de.greenrobot.daoexample");//第1个参数代表版本，第2个参数代表要生成代码的包名

默许情况下Dao类与Test类是在1个包下，如果你想分开他们，可以这样：

schema.setDefaultJavaPackageTest("de.greenrobot.daoexample.test"); schema.setDefaultJavaPackageDao("de.greenrobot.daoexample.dao");

Schema对Entity还有两个默许的标志Flags可以设置：

schema2.enableKeepSectionsByDefault(); schema2.enableActiveEntitiesByDefault();

Entity

Schema可以用于添加Entity:

Entity user = schema.addEntity("User");

为实体添加属性：

user.addIdProperty(); user.addStringProperty("name"); user.addStringProperty("password"); user.addIntProperty("yearOfBirth");

为实体添加主键

注意：greendao的主键支持目前其实不完善，还处于开发中，但是我们可使用下面的方式添加主键：

user.addIdProperty().primaryKey().autoIncrement();

关于Java属性与对应的数据库表名列名命名的规则与区分

Java中属性1般采取驼峰命名法。

你可以通过Entity.setTableName修改表名

	表名/domain类名	属性/列I	属性/列II
Java	User	name	myName
数据库	USER	NAME	MY_NAME

Inheritance, Interfaces, and Serializable

对继承：（不推荐）

myEntity.setSuperclass("MyCommonBehavior");

推荐使用接口将1些公共的属性提取出来。

entityA.implementsInterface("C"); entityB.implementsInterface("C"); entityB.implementsSerializable();

触发代码生成

DaoGenerator daoGenerator = new DaoGenerator(); daoGenerator.generateAll(schema, "../MyProject/src-gen");

还可以指定第3个参数来将test代码分开。

Keep sections片断

由于GreenDaoGenerator会在每次运行后覆盖原本的生成的实体代码,为了允许添加兵保存你自定义代码到你的实体当中，greendao使用"keep sections"来允许你添加，但是要先调用Schema的enableKeepSectionsByDefault()或setHasKeepSections(true) .运行generator以后就会在生成的实体类当中生成以下注释，我们只需要往这些注释中添加自定义代码以后每次运行generator后都会保存这部份代码。

// KEEP INCLUDES - put your custom includes here // KEEP INCLUDES END ... // KEEP FIELDS - put your custom fields here // KEEP FIELDS END ... // KEEP METHODS - put your custom methods here // KEEP METHODS END

不要删除这些注释。