在上一篇我们讲了关于原生的SQLite数据库的使用,不知道大家有没有发现一个问题,就是对于原生的SQLite数据库而言,在后期的升级或者新增表的时候会非常的麻烦,需要删除原来的表再重新创建表,但是这样会导致原来表里面的数据会丢失,感觉好坑有木有,所以,为了解决这些问题以及减少学习时间(因为对于很多小白来说要重新学习增删改查语句),后面又涌现出来了很多优秀的数据库框架,因为太多,所以我就拿一个最流行也是应用最广的GreenDao数据库来讲讲。
GreenDao是一个开源的Android ORM嵌入式关系数据库,通过将Java对象映射到数据库表(称为ORM,对象关系映射),使用一个简单的面向对象的API来存储、更新、删除和查询Java对象。
GreenDao特点
(1)最佳性能 (可能是 Android 中最快的 ORM) ,基准测试也是开源的;
(2)易于使用的功能强大的 api,涵盖关系和连接;
(3)最小的内存消耗;
(4)小型库大小(< 100KB) ,以保持较低的构建时间,并避免65k 方法限制;
(5)数据库加密:greenDAO 支持 SQLCipher 来保证用户数据的安全;
(6)强大而活跃的社区交流支持。
项目配置
1.项目目录下build.gradle配置
buildscript {
ext.kotlin_version = '1.4.10'
repositories {
google()
jcenter()
// 依赖远程仓库
mavenCentral()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.6.0'
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
// GreenDao插件
classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
allprojects {
repositories {
google()
jcenter()
mavenCentral()
maven { url "https://jitpack.io" }
}
}
2.app目录下配置
apply plugin: 'org.greenrobot.greendao'
android {
// ...
}
greendao {
schemaVersion 1 //当前数据库版本
// 生成数据库文件的目录
targetGenDir 'src/main/java'
// 生成的数据库相关文件的包名
daoPackage 'com.steven.sunworld.data'
}
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
implementation 'org.greenrobot:greendao:3.2.2' // 添加库
}
具体使用
1.首先创建一个实体类用于映射数据库表
@Entity
public class PersonInfo {
// 设置主键自增长
@Id(autoincrement = true)
private Long id;
// 设置唯一性
@Index(unique = true)
private int bookId;
private String bookName;
private String authorName;
private String bookNotes;
private String playUrl;
}
在这里可以使用很多注解,下面一一来看:
(1)@Entity:作用于实体类,意味着会在数据库中生成一个与之相对应的表,可选项有:
1》nameInDb:可以自定义表名,表明该实体对应数据库中的那张表,默认为实体类名;
2》createInDb:如果是有多个实体都关联这个表,可以把多余的实体里面设置为false避免重复创建(默认是true);
3》active:是否应该生成更新/删除/刷新方法。如果Entity定义了 @ToOne 或 @ToMany关系,那么独立于该值是有效的。意为是否支持实体类之间update,refresh,delete等操作。
(2)@Id:对应数据表中的主键,是一条数据的唯一标识。如果实体没有声明主键,默认创建Long类型主键"_id"自增。使用Long类型主键时可以通过@Id(autoincrement = true)设置为自增。
(3)@Property(nameInDb = "USER_NAME" ):可以自定义字段名,注意外键不能使用该属性。表明这个属性对应数据表中的 USER_NAME 字段,如果不设置则意味着字段名为变量名。
(4)NotNull:该属性值不能为空。
(5)Transient:该属性不会被存入数据库中。
(6)Unique:表明该属性在数据库中只能有唯一值。
(7)ToOne:定义自己与一个实体对象的关系。
(8)ToMany:定义自己与多个实体对象的关系(可不与@ToOne联合使用)。@ToMany的属性referencedJoinProperty,类似于外键约束。
2.在实体类创建完毕之后,点击android studio上面的Build->Make project,在结束后发现系统会帮我们做几件事情。
1》补充我们的实体类,会自动生成构造函数以及所有变量的get和set方法。
2》会自动生成PersonInfoDao(我的实体类名称为PersonInfo)。
3》会生成DaoSession。
4》会生成DaoMaster。
DaoMaster:使用greenDAO的切入点。DaoMaster保存数据库对象(SQLiteDatabase)并管理特定模式的DAO类(而不是对象)。 它具有静态方法来创建表或将它们删除。 其内部类OpenHelper和DevOpenHelper是在SQLite数据库中创建模式的SQLiteOpenHelper实现。一个DaoMaster就代表着一个数据库的连接;有点类似于SQLite的new DatabaseHelper().getWritableDatabase()。你可以将之理解为对数据库本身的操作,比如删除表、更新表等等。
DaoSession:管理特定模式的所有可用DAO对象,您可以使用其中一个getter方法获取。 DaoSession还为实体提供了一些通用的持久性方法,如插入,加载,更新,刷新和删除。DaoSession可以让我们使用一些Entity的基本操作和获取Dao操作类,DaoSession可以创建多个,每一个都是属于同一个数据库连接的;你可以理解为管理所有生成的Dao文件。
PersonInfoDao:数据访问对象(DAO)持续存在并查询实体。 对于每个实体,GreenDAO生成一个DAO。你可以理解为对所有的数据的操作(表的操作)都是由它来完成的。
3.编写DaoManager,用于创建数据库、创建数据库表、包含增删改查的操作。
public class GreenDaoController {
private DaoMaster.DevOpenHelper mHelper;
private SQLiteDatabase db;
private DaoMaster mDaoMaster;
private DaoSession mDaoSession;
private Context mContext;
private PersonInfoDao personInfoDao;
private static volatile GreenDaoController mInstance;
public static GreenDaoController getInstance(Context context) {
if (mInstance == null) {
synchronized (GreenDaoController.class) {
if (mInstance == null) {
mInstance = new GreenDaoController(context.getApplicationContext());
}
}
}
return mInstance;
}
/**
* 初始化
*/
private GreenDaoController(Context context) {
mContext = context;
// 创建数据库
mHelper = new DaoMaster.DevOpenHelper(mContext, "book.db", null);
// 建立连接(打开数据库)
mDaoMaster = new DaoMaster(getWritableDatabase());
mDaoSession = mDaoMaster.newSession();
personInfoDao = mDaoSession.getPersonInfoDao();
}
/**
* 获取可读取数据库
*/
private SQLiteDatabase getReadableDatabase() {
if (mHelper == null) {
mHelper = new DaoMaster.DevOpenHelper(mContext, "book.db", null);
}
return mHelper.getReadableDatabase();
}
/**
* 获取可写入数据库
*/
private SQLiteDatabase getWritableDatabase() {
if (mHelper == null) {
mHelper = new DaoMaster.DevOpenHelper(mContext, "book.db", null);
}
return mHelper.getWritableDatabase();
}
/**
* 会自动判定是插入还是替换
*/
public long insertOrReplace(PersonInfo personInfo) {
return personInfoDao.insertOrReplace(personInfo);
}
/**
* 插入一条新数据
*/
public long insert(PersonInfo personInfo) {
return personInfoDao.insert(personInfo);
}
/**
* 更新数据
*/
public void update(PersonInfo personInfo) {
PersonInfo oldPersonInfo = personInfoDao.queryBuilder().where(PersonInfoDao.Properties.BookId.eq(personInfo.getBookId())).build().unique();
if (oldPersonInfo != null) {
oldPersonInfo.setBookName(personInfo.getBookName());
personInfoDao.update(oldPersonInfo);
}
}
/**
* 查询所有数据
*/
public List<PersonInfo> searchAll() {
return personInfoDao.queryBuilder().list();
}
/**
* 根据bookId删除数据
*/
public void delete(int bookId) {
personInfoDao.queryBuilder().where(PersonInfoDao.Properties.BookId.eq(bookId)).buildDelete().executeDeleteWithoutDetachingEntities();
}
}
最后看下效果