GreenDAO简介-阿里云开发者社区

开发者社区> 爆米花9958> 正文

GreenDAO简介

简介: Android本身自带的SQLite,大家一定都用过,然而在使用它时,我们往往需要做许多额外的工作,像编写 SQL 语句与解析查询结果等。
+关注继续查看
Android本身自带的SQLite,大家一定都用过,然而在使用它时,我们往往需要做许多额外的工作,像编写 SQL 语句与解析查询结果等。所以,适用于 Android 的ORM 框架也就孕育而生了,现在市面上主流的框架有 OrmLite、SugarORM、Active Android、Realm 与 GreenDAO。简单的讲,greenDAO 是一个将对象映射到 SQLite 数据库中的轻量且快速的 ORM 解决方案。
其核心概念:为了在我们的 Android 工程中使用 greenDAO ,我们需要另建一个纯 Java Project,用于自动生成后继 Android 工程中需要使用到的 Bean、DAO、DaoMaster、DaoSession 等类。

一、 在 ANDROID 工程中配置「GREENDAO GENERATOR」模块

1、在src/main 目录下新建一个与 java 同层级的「java-gen」目录,用于存放由 greenDAO 生成的 Bean、DAO、DaoMaster、DaoSession 等类。


2、配置 Android 工程(app)的 build.gradle,如图分别添加 sourceSets 与dependencies

二. 新建「GREENDAO GENERATOR」模块 (纯 JAVA 工程)
1、通过 File -> New -> New Module -> Java Library -> 填写相应的包名与类名 -> Finish


2、配置 daogenerator 工程的 build.gradle,添加 dependencies.

3、编写 DaoExampleGenerator 类,因为我们的 Java 工程只有一个类,它的内容决定了「GreenDao Generator」的输出,你可以在这个类中通过对象、关系等创建数据库结构,下面我将以注释的形式详细讲解代码内容。

import de.greenrobot.daogenerator.DaoGenerator;
import de.greenrobot.daogenerator.Entity;
import de.greenrobot.daogenerator.Schema;

public class DaoExampleGenerator {
public static void main(String[] args) throws Exception {
// 正如你所见的,你创建了一个用于添加实体(Entity)的模式(Schema)对象。
// 两个参数分别代表:数据库版本号与自动生成代码的包路径。
Schema schema = new Schema(1, "com.example.greendao");
//当然,如果你愿意,你也可以分别指定生成的 Bean 与 DAO 类所在的目录,只要如下所示:
//Schema schema = new Schema(1, "com.example.bean");
//schema.setDefaultJavaPackageDao("com.example.dao");

// 模式(Schema)同时也拥有两个默认的 flags,分别用来标示 entity 是否是 activie 以及是否使用 keep sections。
// schema2.enableActiveEntitiesByDefault();
// schema2.enableKeepSectionsByDefault();

// 一旦你拥有了一个 Schema 对象后,你便可以使用它添加实体(Entities)了。
addTables(schema);

// 最后我们将使用 DAOGenerator 类的 generateAll() 方法自动生成代码,此处你需要根据自己的情况更改输出目录(既之前创建的 java-gen)。
// 其实,输出目录的路径可以在 build.gradle 中设置,有兴趣的朋友可以自行搜索,这里就不再详解。
new DaoGenerator().generateAll(schema, "../GreenDAO/app/src/main/java-gen");
}

/**
* @param schema
*/
private static void addTables(Schema schema) {
// 一个实体(类)就关联到数据库中的一张表,此处表名为「User」(既类名)
Entity user = schema.addEntity("User");
// 你也可以重新给表命名
// user.setTableName("USER");

// greenDAO 会自动根据实体类的属性值来创建表字段,并赋予默认值
// 实体类有多种属性字段,自然也有多个方法,可以自己看看,接下来你便可以设置表中的字段:
user.addIdProperty();
user.addStringProperty("name").notNull();
// 与在 Java 中使用驼峰命名法不同,默认数据库中的命名是使用大写和下划线来分割单词的。
// For example, a property called “creationDate” will become a database column “CREATION_DATE”.
user.addDateProperty("birthday");

//我们是可以创建多个表的,只要再重新创建一个实体类即可
// Entity user1 = schema.addEntity("User1");
// user1.addIdProperty();
// user.addStringProperty("name").notNull();
}
}

三. 生成 DAO 文件(数据库)

执行 generator 工程,如一切正常,你将会在控制台看到如下日志,并且在主工程「java-gen」下会发现生成了UserDao、User、DaoMaster、DaoSession共4个类文件。
如果在此处出错,你可以依据错误日志进行排查,主要看是否输出目录存在,其他配置是否正确等

四. 在 ANDROID 工程中进行数据库操作

官方推荐将获取 DaoMaster 对象的方法放到 Application 层,这样将避免多次创建生成 Session 对象,我们写一个Application类

public class DaoApplication extends Application {
private static DaoApplication instance;
public static DaoApplication getInstance() {
return instance;
}
private DaoMaster.DevOpenHelper helper;
private SQLiteDatabase db;
private DaoMaster daoMaster;
private DaoSession daoSession;
private UserDao userDao;

@Override
public void onCreate() {
super.onCreate();
instance = this;
setupDatabase();
}

private void setupDatabase() {
// 通过 DaoMaster 的内部类 DevOpenHelper,你可以得到一个便利的 SQLiteOpenHelper 对象。
// 可能你已经注意到了,你并不需要去编写「CREATE TABLE」这样的 SQL 语句,因为 greenDAO 已经帮你做了。
// 注意:默认的 DaoMaster.DevOpenHelper 会在数据库升级时,删除所有的表,意味着这将导致数据的丢失。
// 所以,在正式的项目中,你还应该做一层封装来实现数据库的安全升级。
helper = new DaoMaster.DevOpenHelper(this, "User", null);
db = helper.getWritableDatabase();
// 注意:该数据库连接属于 DaoMaster,所以多个 Session 指的是相同的数据库连接。
daoMaster = new DaoMaster(db);
daoSession = daoMaster.newSession();
userDao=daoSession.getUserDao();
}

public DaoSession getDaoSession() {
return daoSession;
}
public UserDao getUserDao() {
return userDao;
}
public SQLiteDatabase getDb() {
return db;
}
}
下面简单写个例子,实现一些基本操作,布局如下:
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical">

<LinearLayout
android:id="@+id/linearLayout1"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:orientation="horizontal">

<EditText
android:id="@+id/et_main_user"
android:layout_width="0dp"
android:layout_height="wrap_content"
android:layout_weight="1"
android:hint="Enter new user"
android:inputType="text"/>

<Button
android:id="@+id/btn_main_add"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:onClick="onMyButtonClick"
android:text="Add"/>

<Button
android:id="@+id/btn_main_search"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:onClick="onMyButtonClick"
android:text="Search"/>
</LinearLayout>

<ListView
android:id="@+id/lv_main_content"
android:layout_width="match_parent"
android:layout_height="wrap_content"/>
</LinearLayout>
 MainActivity如下:
public class MainActivity extends AppCompatActivity {
private EditText mEditText;
private ListView mListView;
private Cursor mCursor;
private DaoApplication instance;

@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);

mEditText = (EditText) findViewById(R.id.et_main_user);
mListView = (ListView) findViewById(R.id.lv_main_content);
instance = DaoApplication.getInstance();
String nameColumn = UserDao.Properties.Name.columnName;
String birthColumn = UserDao.Properties.Birthday.columnName;
mCursor = instance.getDb().query(instance.getUserDao().getTablename(),
instance.getUserDao().getAllColumns(), null, null, null, null, null);
String[] from = {nameColumn, birthColumn};
int[] to = {android.R.id.text1, android.R.id.text2};

SimpleCursorAdapter adapter = new SimpleCursorAdapter(this, android.R.layout.simple_list_item_2, mCursor, from,
to, CursorAdapter.FLAG_REGISTER_CONTENT_OBSERVER);
mListView.setAdapter(adapter);
mListView.setOnItemLongClickListener(new AdapterView.OnItemLongClickListener() {
@Override
public boolean onItemLongClick(AdapterView<?> adapterView, View view, int i, long l) {
// 删除操作,你可以通过「id」也可以一次性删除所有
instance.getUserDao().deleteByKey(l);
// instance.getUserDao().deleteAll();
mCursor.requery();
return true;
}
});
}

/**
* Button 点击的监听事件
*
* @param view
*/
public void onMyButtonClick(View view) {
switch (view.getId()) {
case R.id.btn_main_add:
addUser();
break;
case R.id.btn_main_search:
search();
break;
default:
Log.d(">>>", "what has gone wrong ?");
break;
}
}

private void addUser() {
String str = mEditText.getText().toString();
mEditText.setText("");
final DateFormat df = DateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.MEDIUM);
String birthday = df.format(new Date());

// 插入操作,简单到只要你创建一个 Java 对象
User user = new User(null, str, new Date(), "f");
instance.getUserDao().insert(user);
mCursor.requery();
}

private void search() {
// Query 类代表了一个可以被重复执行的查询
String str = mEditText.getText().toString();
Query query = instance.getUserDao().queryBuilder()
.where(UserDao.Properties.Name.eq(str))
.orderAsc(UserDao.Properties.Birthday)
.build();
// 查询结果以 List 返回
List list = query.list();
Toast.makeText(MainActivity.this, "长度为" + list.size(), Toast.LENGTH_SHORT).show();
// 在 QueryBuilder 类中内置两个 Flag 用于方便输出执行的 SQL 语句与传递参数的值
QueryBuilder.LOG_SQL = true;
QueryBuilder.LOG_VALUES = true;
}


}
效果如下:


源代码

当然这是最简单的一些介绍,更深层次的挖掘还得需要各位共同努力了,如有不当之处,请不吝赐教

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
怎么设置阿里云服务器安全组?阿里云安全组规则详细解说
阿里云服务器安全组设置规则分享,阿里云服务器安全组如何放行端口设置教程
6376 0
阿里云服务器端口号设置
阿里云服务器初级使用者可能面临的问题之一. 使用tomcat或者其他服务器软件设置端口号后,比如 一些不是默认的, mysql的 3306, mssql的1433,有时候打不开网页, 原因是没有在ecs安全组去设置这个端口号. 解决: 点击ecs下网络和安全下的安全组 在弹出的安全组中,如果没有就新建安全组,然后点击配置规则 最后如上图点击添加...或快速创建.   have fun!  将编程看作是一门艺术,而不单单是个技术。
3965 0
使用OpenApi弹性释放和设置云服务器ECS释放
云服务器ECS的一个重要特性就是按需创建资源。您可以在业务高峰期按需弹性的自定义规则进行资源创建,在完成业务计算的时候释放资源。本篇将提供几个Tips帮助您更加容易和自动化的完成云服务器的释放和弹性设置。
7612 0
阿里云ECS云服务器初始化设置教程方法
阿里云ECS云服务器初始化是指将云服务器系统恢复到最初状态的过程,阿里云的服务器初始化是通过更换系统盘来实现的,是免费的,阿里云百科网分享服务器初始化教程: 服务器初始化教程方法 本文的服务器初始化是指将ECS云服务器系统恢复到最初状态,服务器中的数据也会被清空,所以初始化之前一定要先备份好。
10744 0
阿里云服务器ECS登录用户名是什么?系统不同默认账号也不同
阿里云服务器Windows系统默认用户名administrator,Linux镜像服务器用户名root
726 0
阿里云ECS云服务器初始化设置教程方法
阿里云ECS云服务器初始化是指将云服务器系统恢复到最初状态的过程,阿里云的服务器初始化是通过更换系统盘来实现的,是免费的,阿里云百科网分享服务器初始化教程: 服务器初始化教程方法 本文的服务器初始化是指将ECS云服务器系统恢复到最初状态,服务器中的数据也会被清空,所以初始化之前一定要先备份好。
2902 0
112
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
文娱运维技术
立即下载
《SaaS模式云原生数据仓库应用场景实践》
立即下载
《看见新力量:二》电子书
立即下载