greenDAO 是一个将对象映射到 SQLite 数据库中的轻量且快速的 ORM 解决方案。
官方网站http://greendao-orm.com/
让我们开始吧:
一. 在 ANDROID 工程中配置「GREENDAO GENERATOR」模块
1,在 .src/main 目录下新建一个与 java 同层级的「java-gen」目录,用于存放由 greenDAO 生成的 Bean、DAO、DaoMaster、DaoSession 等类。
2,配置 Android 工程(app)的 build.gradle,如图分别添加 sourceSets 与dependencies。
compile 'de.greenrobot:greendao:2.1.0'
sourceSets {
main {
java.srcDirs = ['src/main/java', 'src/main/java-gen']
}
}
二. 新建「GREENDAO GENERATOR」模块 (纯 JAVA 工程)
1,通过 File -> New -> New Module -> Java Library -> 填写相应的包名与类名 -> Finish.
2,配置 java 工程的 build.gradle,添加 dependencies.
compile 'de.greenrobot:greendao-generator:2.1.0'
3,编写ormGreenDemo这个类
public class ormGreenDemo {
public static void main(String[] args) throws Exception{
// 正如你所见的,你创建了一个用于添加实体(Entity)的模式(Schema)对象。
// 两个参数分别代表:数据库版本号与自动生成代码的包路径。
Schema schema=new Schema(1,"com.example.greendao");
// 一旦你拥有了一个 Schema 对象后,你便可以使用它添加实体(Entities)了。
addNote(schema);
// 最后我们将使用 DAOGenerator 类的 generateAll() 方法自动生成代码,此处你需要根据自己的情况更改输出目录(既之前创建的 java-gen)。
new DaoGenerator().generateAll(schema,"/Users/liulongbing/AndroidStudioProjects/MyApplication/green/src/main/java-gen");
}
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");
}
}
4,执行 generator 工程,如一切正常,你将会在控制台看到如下日志,并且在主工程「java-gen」下会发现生成了DaoMaster、DaoSession、NoteDao、Note共4个类文件。
三. 在 ANDROID 工程中进行数据库操作
在Application里面进行初始化
public class BaseApplication extends Application{
public DaoSession daoSession;
public SQLiteDatabase db;
public DaoMaster.DevOpenHelper helper;
public DaoMaster daoMaster;
@Override
public void onCreate() {
super.onCreate();
setupDatabase();
}
private void setupDatabase(){
// 通过 DaoMaster 的内部类 DevOpenHelper,你可以得到一个便利的 SQLiteOpenHelper 对象。
// 可能你已经注意到了,你并不需要去编写「CREATE TABLE」这样的 SQL 语句,因为 greenDAO 已经帮你做了。
// 注意:默认的 DaoMaster.DevOpenHelper 会在数据库升级时,删除所有的表,意味着这将导致数据的丢失。
// 所以,在正式的项目中,你还应该做一层封装,来实现数据库的安全升级。
helper=new DaoMaster.DevOpenHelper(this,"NOTE",null);
db=helper.getWritableDatabase();
daoMaster=new DaoMaster(db);
// 注意:该数据库连接属于 DaoMaster,所以多个 Session 指的是相同的数据库连接。
daoSession=daoMaster.newSession();
}
public DaoSession getDaoSession(){
return daoSession;
}
public SQLiteDatabase getDb(){
return db;
}
}
在Activity中写
private NoteDao getNoteDao() {
// 通过 BaseApplication 类提供的 getDaoSession() 获取具体 Dao
return ((BaseApplication)this.getApplicationContext()).getDaoSession().getNoteDao();
//return ((BaseApplication) this.getApplicationContext()).getDaoSession().getNoteDao();
}
private SQLiteDatabase getDb() {
// 通过 BaseApplication 类提供的 getDb() 获取具体 db
return ((BaseApplication) this.getApplicationContext()).getDb();
}
增
private void add(){
Note note=new Note(null,"test","test",new Date());
getNoteDao().insert(note);
}
删
private void delete(){
getNoteDao().deleteByKey((long) 1);
}
改
private void update(){
Note note=new Note((long)1,"test-update","test-update",new Date());
getNoteDao().update(note);
}
查
private void query(){
Query query=getNoteDao().queryBuilder().build();
List<Note> list=query.list();
for (Note note:list) {
Log.i("======",note.getText()+"===="+note.getComment()+"===="+note.getId()+"==="+note.getDate());
}
}
关于数据库版本安全升级。
在DaoMaster类里有个内部类DevOpenHelper里的方法onUpgrade里写上数据库结构变化的代码,比如某个表新增字段,并要把里面dropAllTables和onCreate方法删掉
public static class DevOpenHelper extends OpenHelper {
public DevOpenHelper(Context context, String name, CursorFactory factory) {
super(context, name, factory);
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
Log.i("greenDAO", "Upgrading schema from version " + oldVersion + " to " + newVersion + " by dropping all tables");
//dropAllTables(db, true);
//onCreate(db);
}
}