Android 数据库框架 DBFlow 的使用

DBFlow 是一个基于注解处理器开发的使用方便的 ORM Android 数据库,该库简化了很多多余的代码,并且提供了好用的 API 来处理与数据库的交互,让开发者专注 App 的开发。下面将从以下几个方面来学习 DBFlow 数据库框架的使用,具体如下:

DBFlow 的优势

配置 DBFlow

创建数据库

创建表

插入数据

删除数据

更新数据

查询数据

案例

DBFlow 的优势

DBFlow 借鉴了一些其他优秀数据库框架的特性,下面是 DBFlow 的优势,具体如下:

Extensibility(扩展性):对表类的继承类没有限制,可以是一个普通的 JavaBean,使用时为了方便推荐表类继承 BaseModel 类你可以扩展不同包中的非模型类,并将它们用作数据库表,此外,你可以将其他表的子类加入到 @Column 中,并且它们可以位于不同的包中;

Speed(速度):该库基于 Java 的注解处理器生成,使用它对运行时性能几乎没有任何影响(反射仅仅用于生数据库模块的生成),可以节省生成样板代码的时间,支持模型缓存(多主键模型),在可能的情况下比原生的 SQLite 速度要快,支持懒加载、@ForeignKey、@OneToMany等使得查询更有效率;

SQLite Query Flow(SQLite查询流):DBFlow 的查询尽可能的贴近原生 SQLite 查询;

Open Source(开源):开源地址见文末;

Robust(健壮性):支持 Trigger, ModelView, Index, Migration 以及内置的管理数据库的方式, 此外,还支持 SQLCipher, RXJava 等;

Multiple Databases, Multiple Modules(多数据库、多模型):无缝支持多数据库文件以及使用 DBFlow 的其他依赖中的数据库模型;

Built On SQLite(基于 SQLite):SQLite 是世界上使用最广泛的数据库引擎,它不仅限于某个平台。

配置 DBFlow

因为 DBFlow 任然不是官方发布的,你需要在项目的 build.gradle 文件中进行如下配置,具体如下:

1allprojects {

2repositories {

3jcenter()

4maven { url"https://jitpack.io"}

5}

6}

然后,在 Module 对应的 build.gradle 文件中添加依赖,具体如下:

1//为了方便可使用 def 关键字定义版本号

2def dbFlow_version ="4.2.4"

3dependencies {

4//...

5annotationProcessor"com.github.Raizlabs.DBFlow:dbflow-processor:$"

6compile"com.github.Raizlabs.DBFlow:dbflow-core:$"

7compile"com.github.Raizlabs.DBFlow:dbflow:$"

8}

上面代码中的依赖只是针对于 Java,如果你要使用 Kotlin、RxJava 等要配置相对应的依赖即可。

注意:升级新版本的 DBFlow 时,一定要删除旧版本的依赖,因为新旧版本的注解处理器可能不同,如果未移除旧版本,将会报如下错误,具体如下:

1java.lang.NoSuchMethodError: com.raizlabs.android.dbflow.annotation.Table.tableName()Ljava/lang/String

然后,自定义 Application ,在相应的 onCreate() 方法中初始化 DBFlow,具体如下:

1/**

2* 自定义Application

3*@authorjzman

4* create at 2018/4/16 0016 17:28

5*/

6publicclassMyApplicationextendsApplication{

7@Override

8publicvoidonCreate(){

9super.onCreate();

10//初始化DBFlow

11FlowManager.init(newFlowConfig.Builder(this).build());

12//设置日志显示

13FlowLog.setMinimumLoggingLevel(FlowLog.Level.V);

14}

15}

最后,在 AndroidManifest.xml 文件中使用自定义的 Application,具体如下:

1

2android:name=".app.MyApplication"

3// ...

4

此时,DBFlow 就引入当前项目中咯。

创建数据库

创建一个类并使用 @Database 注解来定义自己的数据库,该类应该要定义数据库的名称和数据库的版本,具体如下:

1/**

2* MyDatabase

3*@authorjzman

4* create at 2018/4/17 0017 9:08

5*/

6@Database(name = MyDatabase.NAME, version = MyDatabase.VERSION)

7publicclassMyDatabase{

8//数据库名称

9publicstaticfinalString NAME ="MyDatabase";

10//数据库版本号

11publicstaticfinalintVERSION =1;

12}

注意:如果以后要修改任意表的结构,为避免与旧版本数据库冲突一定要修改版本号,且保证版本号只升不降。

创建表

在已经创建好数据库的前提下就可以创建表了,表的模型类一般需要继承 BaseModel,并为模型类中的每个字段添加 @Column 注解,该注解将映射模型类的字段到对应表中的列,定义一张表具体如下:

1/**

2* NoteTable.java

3*@authorjzman

4* create at 2018/4/17 0017 9:54

5*/

6@Table(database = MyDatabase.class)

7publicclassNoteTableextendsBaseModel{

8@Column

9@PrimaryKey

10intid;

11@Column

12privateString title;

13@Column

14privateString date;

15@Column

16privateString content;

17

18publicStringgetTitle(){

19returntitle;

20}

21

22publicvoidsetTitle(String title){

23this.title = title;

24}

25

26publicStringgetDate(){

27returndate;

28}

29

30publicvoidsetDate(String date){

31this.date = date;

32}

33

34publicStringgetContent(){

35returncontent;

36}

37

38publicvoidsetContent(String content){

39this.content = content;

40}

41}

注意:在一张表中至少必须定义一个字段作为主键(primary key),如果模型类中某个字段是私有的,一定要定义相应的 getter、setter 方法,否则会在创建表的环节失败,表的命名要使用驼峰命名法,否则可能会出现如此下问题:

1java.lang.IllegalArgumentException: expected type but wasnull

插入数据

使用 DBFlow 插入数据常用的有二种方式,具体如下:

model.insert()

SQLite.insert()

前者用于单个模型类对象的的插入,创建完具体的对象后,调用 model.insert() 即可插入该对象所对应的记录;后者使用 SQLite Wrapper Language 来插入数据,类似于原生的 insert 语句,支持多列数据的插入,使用起来比较方便,具体参考如下:

1/**

2* 插入数据

3*@parammodel

4*/

5publicvoidinseartData(NoteBean model){

6//1.model,insert()

7model.setTitle("title");

8model.setDate("2018-04-17");

9model.setContent("content");

10model.insert();

11//2.SQLite.insert()

12SQLite.insert(NoteBean.class)

13.columns(NoteBean_Table.title,NoteBean_Table.date,NoteBean_Table.content)

14.values("title","2018-04-17","content")

15.execute();

16}

删除数据

使用 DBFlow 删除数据常用的有二种方式,具体如下:

model.delete():删除某条记录

SQLite.delete():根据条件删除

前者用于单个模型类对象的的删除,创建完具体的对象后,调用 model.delete() 即可删除该对象所对应的记录;后者使用 SQLite Wrapper Language 来条件删除数据,类似于原生的 delete 语句,使用起来比较方便,具体参考如下:

1/**

2* 删除数据

3*@parammodel

4*/

5publicvoiddeleteData(NoteBean model){

6//1.model.delete()

7model.delete();

8//2.SQLite.delete()

9SQLite.delete(NoteBean.class)

10.where(NoteBean_Table.title.is("title"))

11.and(NoteBean_Table.id.is(10))

12.async()

13.execute();

14//删除整张表

15Delete.table(NoteBean.class);

16//删除多张表

17Delete.table(NoteBean.class,NoteBean1.class);

18}

更新数据

使用 DBFlow 删除数据常用的有二种方式,具体如下:

model.update():更新某条记录

SQLite.update():根据条件更新某条记录

前者用于单个模型类对象的的更新,创建完具体的对象后,调用 model.update() 即可更新该对象所对应的记录;后者使用 SQLite Wrapper Language 来条件删除数据,类似于原生的 update 语句,使用起来比较方便,具体参考如下:

1/**

2* 更新数据

3*@parammodel

4*/

5publicvoidupdateData(NoteBean model){

6//1.model.update()

7model.update();

8//2.SQLite.update()

9SQLite.update(NoteBean.class)

10.set(NoteBean_Table.title.eq("title"),

11NoteBean_Table.content.eq("content"))

12.where(NoteBean_Table.id.is(10))

13.async()

14.execute();

15}

查询数据

查询使用 SQLite.select() 方法,查询还有许多可以作为条件的关键字,这里就不在赘述了,下面是一个开发者做常用的查询,具体参考如下:

1/**

2* 查询数据

3*/

4publicListqueryData(){

5//根据条件查询

6List noteBeans = SQLite.select()

7.from(NoteBean.class)

8.where(NoteBean_Table.title.is("title"))

9.queryList();

10returnnoteBeans;

11}

注意:对于插入、更新操作可以使用 model.save() 方法。

案例

上文中介绍了 DBFlow 的配置以及增删改查等基本操作,DbFlow 还有其他比较高级的用法,比如使用 Transactions 来进行数据的安全操作等,下面写一个简单的案例()来结束对 DBFlow 的学习,具体效果如下:

案例下载地址:https://github.com/jzmanu/DBFlowDemo

  • 发表于:
  • 原文链接http://kuaibao.qq.com/s/20180419G076GJ00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 yunjia_community@tencent.com 删除。

扫码关注云+社区

领取腾讯云代金券