转载请注明出处 第一次翻译文档,水平有限,如有任何错误和不妥,望指正。此外如想知道与Realm 和 GreenDAO的对比请查看这篇 官网: 官方示例:
自定义类型允许实体具有任何类型(类)的属性。这是基于将内置类型映射到类自定义类的。ObjectBox具有以下内置类型(Java):
boolean, Booleanint, Integershort, Shortlong, Longfloat, Floatdouble, Doublebyte, Bytebyte[]StringDate复制代码
Convert注释和属性转换器
要添加对自定义类型的支持,可以使用@convert
注释将属性映射到其中一个内置类型。您还需要提供一个PropertyConverter
的实现。
例如,您可以使用自定义Color
类来定义实体中的颜色,并将其映射到Integer
。或者您也可以将一个org.joda.time.DateTime
对象转换成Long
类型的时间戳:
这里是一个将 enum
装换为 Integer
的例子:
@Entitypublic 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{ @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
,通常应该返回 null
。
在转换器的意义上,数据库类型是 ObjectBox 提供的原始 Java 类型,正如一开始提到的那样。建议使用一种易于转换的原始类型(int, long, byte array, String, …)。
注意:为了获得最佳性能, ObjectBox 将使用单个转换器实例 进行所有转换。确保转换器除了没有参数的默认构造器之外没有其他构造函数。另外,保证线程安全,因为它可以并发地在多个实体上调用。
List/Array类型
您可以使用带有列表类型的转换器。例如,您可以将一个字符串列表转换为一个 JSON 数组,从而为数据库生成一个字符串。目前不可能使用转换器(您可以跟踪这个)。
如何正确地转换枚举
枚举在像实体这样的数据对象中很受欢迎。当持久化枚举时,有一些最佳实践:
- 不要持久保存枚举的顺序或名称:两者都不稳定,并且在下一次编辑枚举定义时很容易更改。
- 使用稳定的ids:在您的枚举中定义一个自定义属性(整数或字符串),保证是稳定的。将此用于您的持久映射。
- 准备unknown:定义一个 unknown 的枚举值。它可以用于处理 null 或未知值。这将允许您处理像旧的 enum 值这样的情况,而不会破坏您的应用程序。
##自定义类型查询 QueryBuilder
不知道定制类型。您必须使用原始的DB类型来查询。 因此,对于上面的角色示例,您将得到具有 admin
角色的用户的查询条件。.equal(UserProperties.Role, 2)