GreenDao 是在 Android 开发中广泛使用的数据库框架,其优点是运行效率高,内存消耗少,性能佳(没有考证,网上说的😅)
其它一些常用的数据库框架有:
目前还在更新中的有 LitePal
,realm
。本篇博客只讲 GreenDao 相关知识
首先附上 GreenDao 官网和 github 地址
GreenDao github
GreenDao 官网
如何使用 GreenDao
在 Android 工程中配置 GreenDao Generater 模块
说白了就是配置 GreenDao 生成的代码块存放路径
- 首先在
src/main
目录下新建与java
同级的java-gen
目录 - 在
app
的build.gradle
中的android
模块中添加如下代码
sourceSets {
main {
java.srcDirs = ['src/main/java', 'src/main/java-gen']
}
}
并添加依赖 compile ’org.greenrobot:greendao:2.2.0‘
新建 GreenDao Generator 模块(Java 工程)
- 新建一个 Java 工程,
File -> New -> New Module -> Java Library
在新建的 Java 工程中的
build.gradle
中加入依赖compile ’org.greenrobot:greendao-generator:2.2.0‘
定义一个
Schema
,Schema schema = new Schema(1, "com.sivan.greendaopractice");
第一个参数为版本号
第二个参数为包名
编写添加实体类的代码,如下
// 一个实体类对应一张数据库表,此处表名为 PERSON (即类名)
Entity person = schema.addEntity("Person");
// 也可以重新命名表名
// person.setTableName("People");
// 定义一个主键
person.addIdProperty().primaryKey();
// 定义一个非空的列,列名为 NAME
person.addStringProperty("name").notNull();
// 可以使用此方法定义实体类的属性名和数据库的列名不同,如下实体类名为 sex,列名为_SEX
person.addStringProperty("sex").columnName("_sex");
- 最后生成实体类
new DaoGenerator().generateAll(schema, "../GreenDaoPractice/app/src/main/java-gen")
- 第一个参数为
schema
- 第二个参数为文件生成路径
完整代码如下:
public class GreenDaoGenerate {
public static void main(String[] args) throws Exception {
Schema schema = new Schema(1, "com.sivan.greendaopractice");
addPerson(schema);
new DaoGenerator().generateAll(schema, "../GreenDaoPractice/app/src/main/java-gen");
}
private static void addPerson(Schema schema) {
Entity person = schema.addEntity("Person");
person.addIdProperty().primaryKey();
person.addStringProperty("name").notNull();
person.addStringProperty("sex").columnName("_sex");
}
}
- 运行 Java 工程
如果出下下面的提示,表示成功了
- 接下来看一下 Android 工程中的
java-gen
目录
在 Android 工程中进行数据库操作
接下来我们就可以对数据库进行 CRUD (增删改查)操作了
具体看代码,基本上都有注释了
public class MainActivity extends AppCompatActivity {
@BindView(R.id.et_name)
EditText mEtName;
@BindView(R.id.et_sex)
EditText mEtSex;
@BindView(R.id.list_view)
ListView mListView;
@BindView(R.id.et_id)
EditText mEtId;
private DaoMaster.DevOpenHelper mHelper;
private SQLiteDatabase db;
private DaoSession mDaoSession;
private DaoMaster mDaoMaster;
private PersonDao mPersonDao;
private Cursor cursor;
private SimpleCursorAdapter mCursorAdapter;
private String name;
private String sex;
private String id;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
ButterKnife.bind(this);
// 第一个参数为 context,第二个参数为数据库表名,第三个参数通常为 null
mHelper = new DaoMaster.DevOpenHelper(this, "test-db", null);
db = mHelper.getWritableDatabase();
mDaoMaster = new DaoMaster(db);
mDaoSession = mDaoMaster.newSession();
// 得到 Dao 对象,数据库的 CRUD 操作都是通过此对象来进行
mPersonDao = mDaoSession.getPersonDao();
// 遍历表中所有的数据
cursor = db.query(mPersonDao.getTablename(), mPersonDao.getAllColumns(), null, null, null, null, null);
// 通过 PersonDao 的静态内部类得到字段所对应的 列名
String[] from = {PersonDao.Properties.Name.columnName, PersonDao.Properties.Sex.columnName};
int[] to = {android.R.id.text1, android.R.id.text2};
// 使用 SimpleCursorAdapter 将数据库中的数据展示到 ListView 上
mCursorAdapter = new SimpleCursorAdapter(this, android.R.layout.simple_list_item_2, cursor, from, to, Adapter.NO_SELECTION);
mListView.setAdapter(mCursorAdapter);
}
private void search() {
// 通过构建 QueryBuilder 来实现查询功能
QueryBuilder<Person> queryBuilder = mPersonDao.queryBuilder().where(PersonDao.Properties.Name.eq(name));
// .list() 方法会返回实体类集合
List<Person> persons = queryBuilder.list();
// 如果想得到唯一的结果,使用 .unique() 方法
// Person person = queryBuilder.unique();
new AlertDialog.Builder(this).setMessage(persons != null && persons.size() > 0 ? persons.get(0).getName() + "-->" + persons.get(0).getSex() : "查无此数据").setPositiveButton("确定", null).create().show();
}
private void add() {
Person person = new Person(null, name, sex);
// 通过 insert 方法向数据库中添加数据,因为设置了 id 为主键,所以这里 id 填 null
mPersonDao.insert(person);
}
@OnClick({R.id.btn_add, R.id.btn_search, R.id.btn_update, R.id.btn_delete})
public void onClick(View view) {
name = mEtName.getText().toString().trim();
sex = mEtSex.getText().toString().trim();
id = mEtId.getText().toString().trim();
switch (view.getId()) {
case R.id.btn_add:
add();
break;
case R.id.btn_search:
search();
break;
case R.id.btn_update:
update();
break;
case R.id.btn_delete:
delete();
break;
}
Cursor cursor = db.query(mPersonDao.getTablename(), mPersonDao.getAllColumns(), null, null, null, null, null);
// 通过交换 cursor 来更新 UI
mCursorAdapter.swapCursor(cursor);
}
private void delete() {
// 通过主键来删除数据
mPersonDao.deleteByKey(Long.valueOf(id));
// 删除所有
// mPersonDao.deleteAll();
}
private void update() {
// 通过 update 方法更新数据库中的数据
mPersonDao.update(new Person(Long.valueOf(id), name, sex));
}
}
GreenDao 的基本使用就介绍这么多,下一篇博客中我会讲一下 GreenDao 的一些高级用法