ObjectBox[二] 教程:如何开始使用ObjectBox
ObjectBox[六] 数据监听和RX(Data Observers and Reactive Extensions)
ObjectBox[七] 支持LiveData(Android体系结构组件)
ObjectBox[十二] Meta Model, IDs, and UIDs
自定义类型允许实体具有任何类型(类)的属性。这是基于将内置类型映射到类自定义类。ObjectBox具有以下内置类型(Java):
boolean, Boolean
int, Integer
short, Short
long, Long
float, Float
double, Double
byte, Byte
byte[]
String
Date
类型转换器
要添加对自定义类型的支持,可以使用@Convert注释将属性映射到其中一种内置类型。您还需要实现 PropertyConverter
接口。
例如,您可以使用自定义Color
类在实体中定义 颜色,并将其映射到 Integer
。或者你可以将Long
转换为org.joda.time.DateTime
。
下面是一个将枚举映射到 Integer
的例子 :
@Entity
public class User {
@Id
private Long id;
@Convert(converter = RoleConverter.class, dbType = Integer.class)
private Role role;
public enum Role {
DEFAULT(0), AUTHOR(1), ADMIN(2);
final int id;
Role(int id) {
this.id = id;
}
}
public static class RoleConverter implements PropertyConverter<Role, Integer> {
@Override
public Role convertToEntityProperty(Integer databaseValue) {
if (databaseValue == null) {
return null;
}
for (Role role : Role.values()) {
if (role.id == databaseValue) {
return role;
}
}
return Role.DEFAULT;
}
@Override
public Integer convertToDatabaseValue(Role entityProperty) {
return entityProperty == null ? null : entityProperty.id;
}
}
}
注意:如果您在实体类中定义自定义类型或转换器,则它们必须是静态的。
不要忘记正确处理空值 - 如果输入为空,通常应该返回null
。
转换器意义上的数据库类型是ObjectBox提供的基本Java类型,如开始所述。建议使用易于转换的基本类型(int,long,byte array,String,…)。
注意:为了获得最佳性能,ObjectBox将为所有转换使用一个转换器实例。确保转换器只有一个无参构造函数。此外,使其线程安全,因为它可能会被同时调用多个实体。
列表/数组类型
您可以使用List类型的转换器。例如,您可以将字符串列表转换为JSON数组,从而生成数据库的单个字符串。目前无法在转换器中使用数组(您可以跟踪此功能请求)。
如何正确转换枚举
枚举在数据对象中很受欢迎。当坚持枚举时,有几个最佳实践:
- 不要坚持枚举的序号或名称:两者都不稳定,在枚举中变更很频繁。
- 使用稳定的ID:在你的枚举中定义一个保证稳定的自定义属性(整数或字符串)。用它来做你的持久化映射。
- 为未知做准备:定义一个UNKNOWN枚举值。它可以用来处理空值或未知值。这将允许你处理一些旧的枚举值,而不会让你的应用程序崩溃。
查询中的自定义类型
QueryBuilder 不支持自定义类型。您必须使用原始数据库类型进行查询。
因此,对于上面的角色示例,你需要查询admin类型的用户的查询语句是:
.equal(UserProperties.Role, 2)