Android实战——GreenDao3.2的使用，爱不释手
GreenDao3.2的使用，爱不释手
本篇文章包括以下内容：
- 前言
- GreenDao3.2的简介
- GreenDao3.2的配置
- GreenDao3.2的使用
- 结语
前言
GreenDao是一款操作数据库的神器，经过了2.0版本的升级后，已经被广泛的开发者使用。确实是很好用，入门简单，可以剩去了数据库的建表操作和数据库SQL的编写，博主用了一次之后爱不释手，和以前的数据库操作一大堆的代码将它缩成了一句话，舒服
GreenDao3.2的简介
认识GreenDao之前必须知道ORM（Object Relation Mapping对象关系映射），其表现形式就是通过GreenDao将数据库和Bean对象关联起来，其表现形式如下图
GreenDao之所以很流行，跟它的优点是息息相关的，从官网中可以看到这样一张图，其表示了在主流的ORM第三方库中，其对数据库操作的速度是最快的
不仅如此，其优点还包括有以下几点
- 存取速度快
- 支持数据库加密
- 轻量级
- 激活实体
- 支持缓存
- 代码自动生成
GreenDao3.2的配置
GreenDao的配置很简单，不过需要注意的是，有些人按照正确的配置后却频频出错，个人也经历过，最后的原因是网络有问题。因为校园网的DNS服务很差，所以解析不到GreenDao的依赖网站
一、需要在工程（Project）的build.gradle中添加依赖
buildscript {
repositories {
jcenter()
//此处也要添加
mavenCentral()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.3.2'
//依赖3.2.2
classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2'
}
}
allprojects {
repositories {
jcenter()
}
}
task clean(type: Delete) {
delete rootProject.buildDir
}
apply plugin: 'com.android.application'
//使用greendao
apply plugin: 'org.greenrobot.greendao'
android {
compileSdkVersion 25
buildToolsVersion "25.0.3"
defaultConfig {
applicationId "com.marshu.xianheng"
minSdkVersion 15
targetSdkVersion 25
versionCode 1
versionName "1.0"
testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
}
//greendao配置
greendao {
schemaVersion 1 //数据库 版本号
targetGenDir 'src/main/java' //生成DaoMaster类文件夹
daoPackage 'com.marshu.xianheng.dao' //生成DaoMaster类包名
}
dependencies {
compile fileTree(include: ['*.jar'], dir: 'libs')
androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
exclude group: 'com.android.support', module: 'support-annotations'
})
compile files('libs/glide-3.7.0.jar')
compile files('libs/ksoap2-android-assembly-3.0.0-jar-with-dependencies.jar')
// compile 'org.greenrobot:greendao:3.1.0'
compile project(':ptrlistview')
compile 'com.android.support:appcompat-v7:25.3.1'
compile 'com.android.support.constraint:constraint-layout:1.0.2'
compile 'com.squareup.okhttp3:okhttp:3.8.1'
compile 'com.google.code.gson:gson:2.8.1'
compile 'com.jakewharton:butterknife:7.0.1'
//下面两行是greendao的依赖
compile 'org.greenrobot:greendao:3.2.2'
compile 'org.greenrobot:greendao-generator:3.2.2'
compile 'com.android.support:design:26.0.0-alpha1'
testCompile 'junit:junit:4.12'
} 到这里就配置成功了
GreenDao3.2的使用
配置完成后，最重要的就是GreenDao的使用了，或许使用过Bmob第三方后端云的同学会知道，他们的API有些相像，都是通过API来拼装SQL语句的
一、创建Bean对象（表名和字段名）
GreenDao需要创建Bean对象之后，该Bean对象就是表名，而它的属性值就是字段名，其实现是通过注释的方式来实现的，下面是资产的Bean对象（每个Bean对象对应一张表），为了之后的对象传递，这里可提前序列化对象
public class Product implements Parcelable {
@Id
private String labellingNumber; //标签编号
private String assetName; //资产名称
private String model; //型号
private String remark; //备注
private String usingState; //使用状态
private String assetState; //资产状态
这里需要注意的是，创建完成之后，需要build gradle来完成我们的代码自动生成。自动生成的代码有
- Bean实体的构造方法和get、set方法
- DaoMaster、DaoSession、DAOS类
这里对Bean对象的注释进行解释
- @Entity：告诉GreenDao该对象为实体，只有被@Entity注释的Bean类才能被dao类操作
- @Id：对象的Id，使用Long类型作为EntityId，否则会报错。(autoincrement = true)表示主键会自增，如果false就会使用旧值
- @Property：可以自定义字段名，注意外键不能使用该属性
- @NotNull：属性不能为空
- @Transient：使用该注释的属性不会被存入数据库的字段中
- @Unique：该属性值必须在数据库中是唯一值
- @Generated：编译后自动生成的构造函数、方法等的注释，提示构造函数、方法等不能被修改
二、创建数据库（数据库名）
数据库的表名和字段都建好了，下面差个数据库的创建，下面通过传统和GreenDao的比较来体验其优点
① 传统的数据库创建
public class CommonOpenHelper extends SQLiteOpenHelper {
private static CommonOpenHelper helper;
public static CommonOpenHelper getInstance(Context context) {
if (helper == null) {
helper = new CommonOpenHelper(context, "common.db", null, 1);
}
return helper;
}
private CommonOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory, int version) {
super(context, name, factory, version);
}
@Override
public void onCreate(SQLiteDatabase db) {
//创建love表
db.execSQL("create table love(" +
"id integer primary key autoincrement, " +
"name varchar, " +
"price varchar, " +
"sell_num integer, " +
"image_url varchar, " +
"address varchar" +
")");
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
}
}public class BaseApplication extends Application {
private static DaoSession daoSession;
@Override
public void onCreate() {
super.onCreate();
//配置数据库
setupDatabase();
}
/**
* 配置数据库
*/
private void setupDatabase() {
//创建数据库shop.db"
DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "shop.db", null);
//获取可写数据库
SQLiteDatabase db = helper.getWritableDatabase();
//获取数据库对象
DaoMaster daoMaster = new DaoMaster(db);
//获取Dao对象管理者
daoSession = daoMaster.newSession();
}
public static DaoSession getDaoInstant() {
return daoSession;
}
}可以发现，GreenDao已经将我们的数据库创建缩成几句话，代码会自动将Bean对象创建成表，不再是传统的手写SQL语句。这里的数据库创建只需要在Application中执行一次即可，这里对几个类进行解释
- DevOpenHelper：创建SQLite数据库的SQLiteOpenHelper的具体实现
- DaoMaster：GreenDao的顶级对象，作为数据库对象、用于创建表和删除表
- DaoSession：管理所有的Dao对象，Dao对象中存在着增删改查等API
由于我们已经创建好了DaoSession和Shop的Bean对象，编译后会自动生成我们的ShopDao对象，可通过DaoSession获得
ShopDao dao = daoSession.getProductDao();这里的Dao（Data Access Object）是指数据访问接口，即提供了数据库操作一些API接口，可通过dao进行增删改查操作
三、数据库的增删改查
数据库的表名、字段、数据库都建好了，下面就通过传统和GreenDao对数据库的操作来比较体验其优点
① 传统的增删改查
/**
* 采用ContentProvider进行增删改查
*/
public class CartDao {
/**
* 添加数据
*
* @param resolver
* @param shop
* @return
*/
public static boolean insertCart(ContentResolver resolver, Shop shop) {
ContentValues values = new ContentValues();
values.put("name", shop.getName());
values.put("price", shop.getPrice());
values.put("sell_num", shop.getSell_num());
values.put("image_url", shop.getImage_url());
values.put("address", shop.getAddress());
resolver.insert(MyCartProvider.URI.CODE_CART_INSERT, values);
BaseApplication.getDaoInstant().getShopDao().insert(shop);
return true;
}
/**
* 删除数据
*
* @param resolver
* @param id
*/
public static void deleteCart(ContentResolver resolver, int id) {
resolver.delete(MyCartProvider.URI.CODE_CART_DELETE, "id = " + id, null);
}
/**
* 查询数据
*
* @param resolver
* @return
*/
public static List queryCart(ContentResolver resolver) {
List list = new ArrayList();
String[] projection = {"id", "name", "price", "sell_num", "image_url", "address"};
Cursor cursor = resolver.query(MyCartProvider.URI.CODE_CART_QUERY, projection, null, null, null);
while (cursor.moveToNext()) {
Shop shop = new Shop();
shop.setId(cursor.getLong(cursor.getColumnIndex("id")));
shop.setName(cursor.getString(cursor.getColumnIndex("name")));
shop.setPrice(cursor.getString(cursor.getColumnIndex("price")));
shop.setSell_num(cursor.getInt(cursor.getColumnIndex("sell_num")));
shop.setImage_url(cursor.getString(cursor.getColumnIndex("image_url")));
shop.setAddress(cursor.getString(cursor.getColumnIndex("address")));
list.add(shop);
}
return list;
}
/**
* 省略更新数据
*/
} public class ProductsDaoUtil {
public static String TAG = "ProductsDaoUtil-test";
/**
* 添加数据，如果有重复则覆盖
* @param product
*/
public static void insertProducts(Product product) {
BaseApplication.getDaoInstant().getProductDao().insert(product);
}
/**
* 根据标签号去删除
* @param labellingNumber
*/
public static void deleteProducts(String labellingNumber) {
BaseApplication.getDaoInstant().getProductDao().deleteByKey(labellingNumber);
}
/**
* 更新数据
* @param product
*/
public static void updateProducts(Product product) {
BaseApplication.getDaoInstant().getProductDao().update(product);
}
/**
* 查询条件使用状态
* @return 返回查询数据列表
*/
public static List queryProductsUsing(Product product) {
List productList= null;
try{
productList = BaseApplication.getDaoInstant().getProductDao().queryBuilder().where(ProductDao.Properties.UsingState.eq(product.getUsingState())).list();
}catch (Exception e){
e.printStackTrace();
}
return productList;
}
/**
* 查询条件【正常】【损坏】【遗失】【报废】
* @return 返回查询数据列表
*/
public static List queryProductsAssetState(String assetState) {
List productList= null;
try{
productList = BaseApplication.getDaoInstant().getProductDao().queryBuilder().where(ProductDao.Properties.AssetState.eq(assetState)).list();
}catch (Exception e){
e.printStackTrace();
}
return productList;
}
/**
* 查询条件【在库】【出库】
* @return 返回查询数据列表
*/
public static List queryProductsUsingState(String assetState) {
List productList = null;
try {
productList = BaseApplication.getDaoInstant().getProductDao().queryBuilder().where(ProductDao.Properties.UsingState.eq(assetState)).list();
}catch (Exception e){
e.printStackTrace();
}
return productList;
}
/**
* 查询条件【资产名称】
* @return 返回查询数据列表
*/
public static List queryProductsAssectName(String assetName) {
List productList = null;
try {
productList = BaseApplication.getDaoInstant().getProductDao().queryBuilder().where(ProductDao.Properties.AssetName.like(assetName + "%")).list();
}catch (Exception e){
e.printStackTrace();
}
return productList;
}
/**
* 查询全部数据
*/
public static List queryAll() {
List loadAll = null;
try {
loadAll = BaseApplication.getDaoInstant().getProductDao().loadAll();
} catch (Exception e) {
e.printStackTrace();
}
return loadAll;
} 多条件语句查询是
//查询语句：标签编号像【inputString】且使用状态【状态一，状态二（两种状态为或的关系）】且【资产状态一，资产状态二，资产状态三，资产状态四（四中状态为或的关系）】
WhereCondition whereCondition_labllingNumber = BaseApplication.getDaoInstant().getProductDao().queryBuilder().and(ProductDao.Properties.LabellingNumber.like(inputString + "%"), ProductDao.Properties.UsingState.in(usingState_i, usingState_ii), ProductDao.Properties.AssetState.in(assectState_i, assectState_ii, assectState_iii, assectState_iv));
WhereCondition whereCondition_name = BaseApplication.getDaoInstant().getProductDao().queryBuilder().and(ProductDao.Properties.AssetName.like(inputString + "%"), ProductDao.Properties.UsingState.in(usingState_i, usingState_ii), ProductDao.Properties.AssetState.in(assectState_i, assectState_ii, assectState_iii, assectState_iv));
qb.whereOr(whereCondition_labllingNumber, whereCondition_name); // 资产名称或者标签编号效果很明显，GreenDao的封装更加短小精悍，语义明朗，下面对GreenDao中Dao对象其他API的介绍
- 增加单个数据
- getShopDao().insert(shop);
- getShopDao().insertOrReplace(shop);
- 增加多个数据
- getShopDao().insertInTx(shopList);
- getShopDao().insertOrReplaceInTx(shopList);
- 查询全部
- List< Shop> list = getShopDao().loadAll();
- List< Shop> list = getShopDao().queryBuilder().list();
- 查询附加单个条件
- .where()
- .whereOr()
- 查询附加多个条件
- .where(, , ,)
- .whereOr(, , ,)
- 查询附加排序
- .orderDesc()
- .orderAsc()
- 查询限制当页个数
- .limit()
- 查询总个数
- .count()
- 修改单个数据
- getShopDao().update(shop);
- 修改多个数据
- getShopDao().updateInTx(shopList);
- 删除单个数据
- getTABUserDao().delete(user);
- 删除多个数据
- getUserDao().deleteInTx(userList);
- 删除数据ByKey
- getTABUserDao().deleteByKey();
结语
关于GreenDao的的基本概念与基本操作就讲到这里，更多对于GreenDao的数据库操作还需要多多从实战中去探索，这里只是一个快速入门的引导.GreenDao高级操作还包括有：多表查询、多表关联、session缓存等用法，可以到GreenDao的官网进行学习