入门
蚁后:我们想知道蚁群数据是怎幺保存的。我们要跟踪和标记所有蚂蚁的特定群体以及每个蚁后。
我们有这样的关系:
要初始化DBFlow,放置在这段代码( FlowManager.init(this);)在你自定义的 类中(推荐):
public class ExampleApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
FlowManager.init(this);
}
}
别担心,这只是初始化一次,它会守住只有应用程序,即使使用其他Context
初始化。
最后,定义添加到清单(对应您的自定义应用程序的名称):
<application
android:name="{packageName}.ExampleApplication"
...>
</application>
在DBFlow,一个 @Database
是一个占位符,这个占位符可以生产子类对象 BaseDatabaseDefinition
, BaseDatabaseDefinition
连接所有表,ModelAdapter,Views,Queries还有更多其下的对象。所有连接都在预编译的时候完成,所以没有搜索,反射,和任何其他能减慢您的应用程序的运行时间的影响。
在这个例子中,我们需要定义我们要把蚁群保存到哪里(定义数据库):
对于最佳实践,我们声明的常量NAME
和 VERSION
为public,以便于我们以后可以使用它。
Note: 如果你想使用SQLCipher(数据库加密) 请阅读 setup here
现在,我们有了保存蚁群数据的地方了(ColonyDatabase),我们需要明确定义Model
来保存数据和展示数据
在DBFlow,任何要使用ORM实现数据库交互的都必须实现接口Model
(也就是说如果你的数据库表一定要实现Model
接口)。这样做的原因是统一接口balabala。。。。。为了方便起见,我们可以extends BaseModel
(BaseModel
已经实现了 Model
接口)
要正确定义一个表,我们必须:
@Table注释标记类
将表到正确的数据库,例如
ColonyDatabase
至少定义一个主键
类及其所有数据库中的列(model中的变量)必须用
private
或public
,private
的必须有(getter和setter方法)。这样从DBFlow生成的类可以访问它们。
我们可以这样定义一个基础的 Queen
表:
@Table(database = ColonyDatabase.class)
public class Queen extends BaseModel {
@PrimaryKey(autoincrement = true)
long id;
@Column
String name;
}
因此,我们有一个蚁后的定义后,现在我们需要为蚁后定义一个蚁群。
@Table(database = ColonyDatabase.class)
public class Colony extends BaseModel {
@PrimaryKey(autoincrement = true)
long id;
@Column
String name;
}
现在,我们有一个Queen
和Colony
,我们要建立一个1对1的关系。我们希望,当数据被删除,例如,如果发生火灾,破坏蚁群 Colony
。当蚁群被破坏,我们假设女王Queen
不再存在,所以我们要为 Colony
“杀”了Queen
,使其不再存在。
为了建立他们的关系,我们将会定义一个外键作为Child:
如果你想保持这种配对完好,设置saveForeignKeyModel=true
。
在3.0,我们不再需要明确地定义@ForeignKeyReference
每个引用列。DBFlow会自动将它们添加到表定义中,基于引用表的@PrimaryKey
。它们将出现在格式{foreignKeyFieldName}_{referencedColumnName}
。(如上外键colony
的格式是:colony_id
)
现在,我们有一个蚁群Colony
与蚁后 Queen
属于它,我们需要一些蚂蚁服侍她!
@Table(database = ColonyDatabase.class)
public class Ant extends BaseModel {
@PrimaryKey(autoincrement = true)
long id;
@Column
String type;
@Column
@ForeignKey(saveForeignKeyModel = false)
ForeignKeyContainer<Queen> queenForeignKeyContainer;
/**
* Example of setting the model for the queen.
*/
queenForeignKeyContainer = FlowManager.getContainerAdapter(Queen.class).toForeignKeyContainer(queen);
}
}
我们有 type
,它可以是 “worker”, “mater”, 或 “other”。此外,如果蚂蚁还有男女之分。
在这种情况下,我们使用 ForeignKeyContainer
,因为我们可以有成千上万的蚂蚁。出于性能的考虑,Queen
将会被“延迟加载的”,只有我们调用toModel()
,才会查询数据库找出对应的 Queen
。与此说,为了在ForeignKeyContainer
上设置适当的值,你应该通过调用其生成的方法(FlowManager.getContainerAdapter(Queen.class).toForeignKeyContainer(queen)
)为自己转换成 ForeignKeyContainer
。
由于ModelContainer
默认情况下不会使用,所以我们必须添加 @ModelContainer
注释到Queen
累中才能使用 ForeignKeyContainer
。
最后,使用可以防止循环引用。如果这
Queen
和 Colony
互相引用,我们会碰上的StackOverflowError,因为他们都将尝试从数据库加载对方中。
接下来,我们通过延迟加载蚂蚁建立“一对多”的关系,因为我们可能有成千上万,甚至是,数以百万计的储存:
@ModelContainer
@Table(database = ColonyDatabase.class)
public class Queen extends BaseModel {
//...
// needs to be accessible for DELETE
List<Ant> ants;
@OneToMany(methods = {OneToMany.Method.SAVE, OneToMany.Method.DELETE}, variableName = "ants")
public List<Ant> getMyAnts() {
if (ants == null || ants.isEmpty()) {
ants = SQLite.select()
.from(Ant.class)
.where(Ant_Table.queenForeignKeyContainer_id.eq(id))
.queryList();
}
return ants;
}
注意
:如果你发现Ant_Table
报错的时候,跑一下,让库自动生成模板就不会再报错了
如果你想给自己懒加载,指定OneToMany.Method.DELETE
和SAVE
,代替ALL
。如果每当女王的数据变化时候,您不希望保存,那幺只指定 和 LOAD
。