Android GreenDao数据库使用-CFANZ编程社区

GreenDao介绍

GreenDao是一个开源的 Android ORM嵌入式关系数据库，通过将 Java 对象映射到数据库表(称为 ORM，“对象/关系映射”) ，使用一个简单的面向对象的 API 来存储、更新、删除和查询 Java 对象。

GreenDao特点

● 最佳性能 (可能是 Android 中最快的 ORM) ，基准测试也是开源的；

● 易于使用的功能强大的 api，涵盖关系和连接；

● 最小的内存消耗；

● 小型库大小(< 100KB) ，以保持较低的构建时间，并避免65k 方法限制；

● 数据库加密：greenDAO 支持 SQLCipher 来保证用户数据的安全；

● 强大而活跃的社区交流支持。

GreenDao使用

依赖

1.根目录build.gradle配置

buildscript {
    
    repositories {
        google()
        jcenter()
        // GreenDao仓库
        mavenCentral()
        maven{url 'http://maven.aliyun.com/nexus/content/groups/public/'}
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.5.2'
        // GreenDao插件
        classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2'
    }
}

allprojects {
    repositories {
        google()
        jcenter()
        // GreenDao仓库
        mavenCentral()
        maven{url 'http://maven.aliyun.com/nexus/content/groups/public/'}
        maven { url 'https://jitpack.io' }

    }
}

2.app目录下的build.gradle配置

apply plugin: 'com.android.application'
// greenDao 插件
apply plugin: 'org.greenrobot.greendao'

dependencies {
    ...
    /*greenDao 数据库框架*/
    implementation 'org.greenrobot:greendao:3.2.2'
    // add library
    implementation 'org.greenrobot:greendao-generator:3.2.2'
    //如果需要数据库加解密操作，导入sqlcipher
    implementation 'net.zetetic:android-database-sqlcipher:3.5.1'
  ...
}

//配置GreenDao文件生成位置，它的级别是与Android标签和dependencies标签一个级别的
greendao {
    /**
     * 建议对数据库每个版本更新的内容进行注释
     * */
    schemaVersion 1
    //生成的Daos、DaoMaster路径
    daoPackage 'com.xxx.xxx.greendao'
    //生成的资源路径，默认存放在build中
    targetGenDir 'src/main/java'
}

3.proguard-rules.pro文件

-keepclassmembers class * extends org.greenrobot.greendao.AbstractDao {
public static java.lang.String TABLENAME;
}
-keep class **$Properties { *; }

# If you DO use SQLCipher:
-keep class org.greenrobot.greendao.database.SqlCipherEncryptedHelper { *; }

# If you do NOT use SQLCipher:
-dontwarn net.sqlcipher.database.**
# If you do NOT use RxJava:
-dontwarn rx.**

4：注意

GreenDao会受到项目ide版本的影响，导致依赖加载不成功亲测如下配置正常添加： gradle-wrapper.properties配置

#Tue May 18 17:31:34 CST 2021
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-all.zip

app下build.gradle配置

android {
    compileSdkVersion 28
    buildToolsVersion "28.0.3"

    defaultConfig {
        applicationId "com.github.xxxxxx"
        minSdkVersion 19
        targetSdkVersion 28
        versionCode 1
        versionName "1.0"
        multiDexEnabled true
    }
}

创建实体类

/*nameInDb为表名*/
@Entity(nameInDb = "T_BillEntity")
public class BillEntity {

    @Id()
    private Long id;
    private String username;//用户名
    private String productDesc;
    private String makecompany; //工厂编号
   ...
   ...
    
}

实体类中详细注解说明：

● @Entity：表明这个实体类会在数据库中生成一个与之相对应的表，其中可配置项： nameInDb：可以自定义表名，表明该实体对应数据库中的那张表，默认为实体类名； indexes：定义索引，这里可跨越多个列； createInDb：如果是有多个实体都关联这个表，可以把多余的实体里面设置为false避免重复创建（默认是true）； schema：一个项目中有多个schema时，表明要让这个dao属于哪个schema； active：是否应该生成更新/删除/刷新方法。如果Entity定义了 @ToOne 或 @ToMany关系，那么独立于该值是有效的。意为是否支持实体类之间update，refresh，delete等操作。

● @Id：对应数据表中的主键，是一条数据的唯一标识。如果实体没有声明主键，默认创建Long类型主键"_id"自增。使用Long类型主键时可以通过@Id(autoincrement = true)设置为自增。

● @Property(nameInDb = "USER_NAME" )：可以自定义字段名，注意外键不能使用该属性。表明这个属性对应数据表中的 USER_NAME 字段。

● @NotNull：该属性值不能为空。

● @Transient：该属性不会被存入数据库中。

● @Unique：表明该属性在数据库中只能有唯一值。

● @Index：创建一个索引。通过name设置索引别名，也可以通过unique给索引添加约束。

● @Convert：指定一个PropertyConverter用于支持自定义类型(没用过)。

● @ToOne：定义自己与一个实体对象的关系。

● @ToMany：定义自己与多个实体对象的关系(可不与@ToOne联合使用)。@ToMany的属性referencedJoinProperty，类似于外键约束。

● @JoinProperty：对于更复杂的关系，可以使用这个注解标明目标属性的源属性，起关联作用。

● @JoinEntity:如果你在做多对多的关系，有其他的表或实体参与，可以给目标属性添加这个额外的注解。

● @OrderBy：指定{@ToMany}关系的相关集合的排序，(propertyA, propertyB)默认为按主键ASC排序。

● @Generated：这个是build后greendao自动生成的，这个注解理解为防止重复，每一块代码生成后会加个hash作为标记。

Make Project

Android GreenDao数据库使用_ORM

实体类建完毕后，通过点击AndroidStudio中的Make Project（小锤子的图标），便发现GreenDao为我们的实体类生成了对应的Getter、Setter方法以及俩个构造函数，同时在我们配置的daoPackage对应路径下生成了三个对应类文件DaoMaster、DaoSession和BillEntityDao，之后所有相关的数据库操作都依靠这三个文件了：

Android GreenDao数据库使用_ORM_02

● DaoMaster：使用greenDAO的切入点。DaoMaster保存数据库对象（SQLiteDatabase）并管理特定模式的DAO类（而不是对象）。它具有静态方法来创建表或将它们删除。其内部类OpenHelper和DevOpenHelper是在SQLite数据库中创建模式的SQLiteOpenHelper实现。一个DaoMaster就代表着一个数据库的连接；

● DaoSession：管理特定模式的所有可用DAO对象，您可以使用其中一个getter方法获取。 DaoSession还为实体提供了一些通用的持久性方法，如插入，加载，更新，刷新和删除。 DaoSession可以让我们使用一些Entity的基本操作和获取Dao操作类，DaoSession可以创建多个，每一个都是属于同一个数据库连接的；

● xxDAO：数据访问对象（DAO）持续存在并查询实体。对于每个实体，GreenDAO生成一个DAO。它比DaoSession有更多的持久化方法，例如：count，loadAll和insertInTx等。

GreenDaoManager

创建GreenDaoManager,用于创建数据库、创建数据库表、包含增删改查的操作。

/**
 * GreenDao管理类
 */
public class GreenDaoManager {

    private static final String TAG = "GreenDaoManager";
    private static final String DB_NAME = "DB_Test.db";

    //创建的数据库是否需要加密，默认创建不加密数据库
    private boolean isDbEncrypted = false;
    private DaoMaster mDaoMaster;
    private DaoSession mDaoSession;

    private GreenDaoManager() {
        init();
    }

    /**
     * 静态内部类，实例化对象使用
     */
    private static class SingleInstanceHolder {
        private static final GreenDaoManager INSTANCE = new GreenDaoManager();
    }

    /**
     * 对外唯一实例的接口
     *
     * @return
     */
    public static GreenDaoManager getInstance() {
        return SingleInstanceHolder.INSTANCE;
    }

    /**
     * 初始化数据
     */
    private void init() {
        try {
            if (isDbEncrypted) {
                //创建加密数据库
                DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(MyApplication.getAppContext(), DB_NAME);
                //创建的数据库密码默认为包名，可以自行修改
                Database db = helper.getEncryptedWritableDb(MyApplication.getAppContext().getPackageName());
                mDaoMaster = new DaoMaster(db);
            } else {
                // 创建不加密的数据库
                MyOpenHelper myOpenHelper = new MyOpenHelper(MyApplication.getAppContext(), DB_NAME, null);
                mDaoMaster = new DaoMaster(myOpenHelper.getWritableDatabase());
            }
            mDaoSession = mDaoMaster.newSession();
        } catch (Exception e) {
            //如果已有未加密的数据库存在，先对这个数据库做一次加密，完成后再次初始化
            Log.e(TAG, "catch Exception:" + e.getMessage());
            try {
                encrypt(MyApplication.getAppContext(), DB_NAME, MyApplication.getAppContext().getPackageName());
            } catch (IOException ioException) {
                ioException.printStackTrace();
            }
        } finally {
            Log.e(TAG, "finally");
        }

    }

    public DaoMaster getDaoMaster() {
        return mDaoMaster;
    }

    public DaoSession getDaoSession() {
        return mDaoSession;
    }

    /**
     * 加密已存在的未加密数据库
     *
     * @param context
     * @param dbName
     * @param passphrase
     * @throws IOException
     */
    private void encrypt(Context context, String dbName,
                         String passphrase) throws IOException {
        Log.e(TAG, "encrypt 开始");
        File originalFile = context.getDatabasePath(dbName);
        if (originalFile.exists()) {
            File newFile = File.createTempFile("sqlcipherutils", "tmp",
                    context.getCacheDir());
            SQLiteDatabase db = SQLiteDatabase.openDatabase(originalFile.getAbsolutePath(),
                    "", null,
                    SQLiteDatabase.OPEN_READWRITE);
            db.rawExecSQL(String.format("ATTACH DATABASE '%s' AS encrypted KEY '%s';",
                    newFile.getAbsolutePath(), passphrase));
            db.rawExecSQL("SELECT sqlcipher_export('encrypted')");
            db.rawExecSQL("DETACH DATABASE encrypted;");
            int version = db.getVersion();
            db.close();
            db = SQLiteDatabase.openDatabase(newFile.getAbsolutePath(),
                    passphrase, null,
                    SQLiteDatabase.OPEN_READWRITE);
            db.setVersion(version);
            db.close();
            originalFile.delete();
            newFile.renameTo(originalFile);
        }

        Log.e(TAG, "encrypt 结束");
        //再次初始化
        init();
    }

}

初始化

public class MyApplication extends MultiDexApplication {

    private static Context mContext;
    public static MyApplication instance;

    @Override
    public void onCreate() {
        super.onCreate();
        init();

        //GreenDao的初始化
        GreenDaoManager.getInstance();
    }

    private void init() {
        if (instance == null) {
            instance = this;
        }
        mContext = getApplicationContext();
    }

    public static Context getAppContext() {
        return mContext;
    }
}

完成以上操作后，可以导出数据库，通过数据库可视化工具进行查看表结构及数据，进行验证。

注意

如果创建的是加密数据库，则数据库可视化工具打开也会失败，需要在代码中进行数据读写验证。