【开发框架】GreenDao数据库框架的搭建和使用

阔别好久的Android开发平台，由于公司需要又转战过来进行开发，首先就是我要搭建公司Andorid平台的项目框架，都使用什么快速开发框架进行开发。数据库方面的框架，经过挑选，我选用了GreenDao框架，下面就讲一下该框架的配置和使用方法。注意：我是在AS开发工具下。

GreenDao配置

需要在工程（Project）的build.gradle中添加依赖

buildscript {    repositories {        jcenter()    }    dependencies {        classpath 'com.android.tools.build:gradle:2.0.0'        //GreenDao3依赖        classpath 'org.greenrobot:greendao-gradle-plugin:3.2.1'    }}

在项目（Module）的build.gradle中添加依赖

apply plugin: 'com.android.application'apply plugin: 'com.neenbedankt.android-apt'//使用greendaoapply plugin: 'org.greenrobot.greendao'android {    compileSdkVersion 23    buildToolsVersion "25.0.0"    defaultConfig {        applicationId "com.cdfy.iapp"        minSdkVersion 21        targetSdkVersion 21        versionCode 1        versionName "1.0"        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"    }    //greendao配置    greendao {        //版本号，升级时可配置        schemaVersion 1    }    buildTypes {        release {            minifyEnabled false            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'        }    }}dependencies {    compile fileTree(dir: 'libs', include: ['*.jar'])    androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {        exclude group: 'com.android.support', module: 'support-annotations'    })    compile 'com.android.support:appcompat-v7:23.3.0'    compile 'com.android.support.constraint:constraint-layout:1.0.0-alpha8'    testCompile 'junit:junit:4.12'    apt 'com.jakewharton:butterknife-compiler:8.0.0'    compile 'com.jakewharton:butterknife:8.0.0'    //greendao依赖    compile 'org.greenrobot:greendao:3.2.0'}

以上就算配置成功，迈出了第一步!

GreenDao使用

数据库操作需要：数据库名、表名、字段名，缺一不可。简单来说，这个框架类似标签类的，数据库名就是获得连接时填写的数据库名（稍后说到），表名就是实体的名字，字段就是JAVA实体类中的成员变量。

@Entitypublic class User {    //不能用int    @Id(autoincrement = true)    private Long id;    //用户名    @Unique    private String username;    //密码    @Unique    private String password;}

这里需要注意的是，创建完成之后，需要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 BaseApplication extends Application {    private static DaoSession daoSession;    @Override    public void onCreate() {        super.onCreate();        setupDatabase();    }    /**     * 配置数据库     */    private void setupDatabase() {        //创建数据库app.db"        DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "app.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对象，编译后会自动生成我们的UserDao对象，可通过DaoSession获得

UserDao dao = daoSession.getUserDao();

这里的Dao（Data Access Object）是指数据访问接口，即提供了数据库操作一些API接口，可通过dao进行增删改查操作

GreenDao增删改查

先看我写的例子代码，最简单的实现：

@OnClick({R.id.btAdd, R.id.btQuery, R.id.btUpdate, R.id.btDelete})    public void onViewClicked(View view) {        List list=null;       UserDao dao = BaseApplication.getDaoInstant().getUserDao();        String username = etUsername.getText().toString();        String password = etPassword.getText().toString();        switch (view.getId()) {            case R.id.btAdd:                //增加               User user = new User();                user.setUsername(username);                user.setPassword(password);                long i1 = dao.insert(user);                Toast.makeText(this, String.valueOf(i1), Toast.LENGTH_SHORT).show();                break;            case R.id.btQuery:                //查询所有               list = dao.loadAll();                StringBuffer strbuff = new StringBuffer();                for (int i = 0; i < list.size(); i++) {                    strbuff.append("ID:").append(list.get(i).getId()).append("用户名：").append(list.get(i).getUsername()).append("密码：").append(list.get(i).getPassword()).append(";");                }                tvText.setText(strbuff.toString());                break;            case R.id.btUpdate:                //更新               User users = list.get(Integer.parseInt(etId.getText().toString()));                users.setUsername(username);                users.setPassword(password);                dao.update(users);                break;            case R.id.btDelete:                //删除按照ID进行的删除                dao.deleteByKey(Long.parseLong(etId.getText().toString()));                break;        }    }

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();

结尾

还有好多的用法，这里只是介绍个简单基础用法，其他的比如多表查询，主外键关联等等自行百度或者官网学习，有时间我也会更新。