ObjectBox 浅析

博主： VergilWu
发布时间：2019 年 07 月 18 日
661次浏览
1 条评论
5897字数
分类： Android
加载中

公司项目用到数据库，本来准备使用GreenDAO来写，可是突然发现自己的项目gradle版本太高了，GreenDAO有些不适配。去GreenDAO提交issul时看到README.MD开头：

数据库简介

objectbox数据库是greenrobot团队开发的全新非关系型数据库框架，该团队还开发过greenDao,EventBus等热门框架，可谓实力雄厚。按照官方介绍，该库有如下特点:

超快速:号称胜过测试过的所有嵌入式数据库。
面向对象的 API: 没有 rows、columns 和 SQL，完全从0开始的对象（没有ORM，没有SQLite）。
反应性:对数据变化的反应简单而强大,使用ObjectBox中的反应数据观察器或与RxJava集成。
多平台:已经支持安卓和java,ios和MacOs正在集成
简单的线程:ObjectBox返回的对象可以在所以线程中运行
没有手动模式迁移:ObjectBox负责添加，删除和重命名属性的新对象版本，意味着数据库的升级不再需要我们自己管理版本号，ObjectBox内部会自动帮我们管理。

安装（本文以Java为例, Kotlin详见ObjectBox - docs）

build.gradle(module)添加

buildscript {
ext.objectboxVersion = '2.3.4'
repositories {
  jcenter()
}
dependencies {
  // Android Gradle Plugin 3.0.0 or later supported
  classpath 'com.android.tools.build:gradle:3.3.2'
  classpath "io.objectbox:objectbox-gradle-plugin:$objectboxVersion"
  }
}

build.gradle(app)添加

apply plugin: 'com.android.application'
apply plugin: 'io.objectbox' // apply last

初始化数据库

@Override
    public void onCreate() {
        super.onCreate();

        //注册数据库
        ObjectBox.init(this);
        ...
    }

//////////////////////////////////////////////////////////////

private static BoxStore boxStore;

public static void init(Context context) {

    boxStore = MyObjectBox.builder()
            .androidContext(context.getApplicationContext())
            .build();
    //这句是开启浏览器数据可视化，详情参阅官方文档
    new AndroidObjectBrowser(boxStore).start(context.getApplicationContext());
}

public static BoxStore get() {
    return boxStore;
}

定义实体类

objectbox是通过注解来标明哪个类是实体，若新建了一个新的实体或对实体进行了修改,都需要重新Make Project来生成新的实体操作对象。常用的注解如下：

@Entity   //表示这是一个需要持久化的实体
public class Student {
    @Id 
    public long id;

    @Index
    public String name;

    @Transient
    public int tempUsageCount;

    @NameInDb("USERNAME")
    public String name;

    public ToOne<Class> classToOne;

    public int age;
}

@Entity：这个对象需要持久化。
@Id：这个对象的主键,默认情况下，id是会被objectbox管理的，也就是自增id，如果你想手动管理id需要在注解的时候加上@Id(assignable= true)即可。当你在自己管理id的时候如果超过long的最大值，objectbox 会报错.id的值不能为负数。当id等于0时objectbox会认为这是一个新的实体对象,因此会新增到数据库表中。
@Index：这个对象中的索引。对经常大量进行查询的字段创建索引，会提高你的查询性能。
@Transient:如果你有某个字段不想被持久化，可以使用此注解,那么该字段将不会保存到数据库。
@NameInDb：有的时候数据库中的字段跟你的对象字段不匹配的时候，可以使用此注解。
@ToOne:做一对一的关联注解，例如示例中表示一张学生表（Student）关联一张班级表（Class）,此外还有一对多，多对多的关联，例如Class的示例：

    @Entity
    public class Class{
        @Id
        long id;

        @Backlink(to = "classToOne")
        public ToMany<Student> studentEntitys;
    }

@ToMany:做一对多的关联注解，如示例中表示一张班级表(Class)关联多张学生表(Student)
@Backlink:表示反向关联

增删改查

实体类建立完后，在Android Studio中使用Build > Make project编译一次，objectbox会自动帮你生成相应的操作实体,例如·Student则会生成一个Student_的类，该类通常作为Params传递。

增
首先我们获取该实体的Box对象，随后调用该对象的put()方法即可完成新增操作

Box<Student> StudentBox = BaseApp.getInstence().getBoxStore().boxFor(Student.class);
Student student = new Student();
student.name = "Jay";
StudentBox.put(student);

StudentBox.remove(student);  //该参数可以传要删除的实体，也可以传入要删除的实体的id,可以批量传入

改
objectBox修改数据非常简单，首先得到要修改的实体类，直接修改数据，随后调用put()方法即可，示例如下：

//查询一个名叫Jay的学生信息的表
Student jayStudent = StudentBox.query().equal(Student_.name, "Jay").build().find();
jayStudent.name = "Vergil";
StudentBox.put(jayStudent);

查
通过Box的query()方法可以得到一个QueryBuilder对象，该对象可以实现各种查询操作，里面包含contains(),equal()等各种便捷的查询方法，示例如下：

//查询一个名叫Jay的学生信息的表
Student jayStudent = StudentBox.query().equal(Student_.name, "Jay").build().find();

数据库的其它操作

数据库的数据升级

当我们需要新增和删除字段时，直接操作实体类即可，不需要做特殊的更改，如果需要重命名字段名或实体类名，可以按照如下步骤操作：
第一步：给需要修改的类名加上@UID注解

@Entity
@Uid
public class MyName { ... }

第二步：编译项目，编译将失败，并且会给你一个UID

error: [ObjectBox] UID operations for entity "MyName": [Rename] apply the current UID using @Uid(6645479796472661392L) - [Change/reset] apply a new UID using @Uid(4385203238808477712L)

第三步：将Rename后面的UID放入到要修改的类中：

@Entity
@Uid(6645479796472661392L)
public class MyName { ... }

第四步：进行数据的修改

@Entity
@Uid(6645479796472661392L)
public class MyNewName { ... }

更改数据属性或重命名字段名同理操作。

表关系

@ToOne和@ToMany可以看作JAVA中的T和List的关系,拿班级和学生举例，设置相关的学生对象如下：

Class class = new Class(); //先创建一个班级
Student student = new Student();
student.name = "Jay";
student.classToOne.setTarget(class);  //设置一对一的target对象，字段参见以上示例
long studentId = StudentBox.put(student);

获取该学生的班级信息：

Student student = StudentBox.get(studentId);
Class class = student.classToOne.getTarget();

而一对多的关系更为简单，你可以像List集合一样去操作它：

Class class_ = new Class(); //先创建一个班级
Student s1 = new Student(); //添加一个学生
student.name = "Jay";

Student s2 = new Student();
s2.name = "Android";

class_ .studentEntitys.add(s1);
class_ .studentEntitys.add(s2);
Box classBox = BaseApp.getInstence().getBoxStore().boxFor(Class.class);
classBox.put(class);

这样的话一张Class表中就有两个学生表的数据了，查询的话可以获取该Class的实体，随后像遍历List集合一样去遍历studentEntitys字段,objectBox提供的方法和List集合几乎一样，这里就不做示例了。

求和等操作
使用Query对象即可进行求和等操作,通过QueryBuilder的build()方法即可得到。随后调用sumDouble()等方法传入求和条件即可。我们获取实体类或实体类集合也是使用的该对象获取。

另外，objectBox还支持事务，Rxjava查询，Kotlin的支持，更多详情可以通过官方文档了解http://objectbox.io.

补充

浏览器数据可视化相关
build.gradle(app)添加

dependencies {
...    
debugImplementation "io.objectbox:objectbox-android-objectbrowser:$objectboxVersion"
releaseImplementation "io.objectbox:objectbox-android:$objectboxVersion"
}

并且把：

apply plugin: 'io.objectbox'

放到dependencies字段后面sync。

版权属于：Vergil Wu
本文链接：https://www.vergil.com.cn/24.html
转载时须注明出处及本声明

最后修改：2020 年 06 月 14 日 01 : 33 PM

如果觉得我的文章对你有用，请随意赞赏

发表评论取消回复

1 条评论

7
December 10th, 2019 at 12:49 am

nice写的简单易懂哈哈哈

回复

ObjectBox 浅析

VergilWu • 2019 年 07 月 18 日

公司项目用到数据库，本来准备使用GreenDAO来写，可是突然发现自己的项目gradle版本太高了，GreenDAO有些不适配。去GreenDAO提交issul时看到README.MD开头：

数据库简介

超快速:号称胜过测试过的所有嵌入式数据库。
面向对象的 API: 没有 rows、columns 和 SQL，完全从0开始的对象（没有ORM，没有SQLite）。
反应性:对数据变化的反应简单而强大,使用ObjectBox中的反应数据观察器或与RxJava集成。
多平台:已经支持安卓和java,ios和MacOs正在集成
简单的线程:ObjectBox返回的对象可以在所以线程中运行
没有手动模式迁移:ObjectBox负责添加，删除和重命名属性的新对象版本，意味着数据库的升级不再需要我们自己管理版本号，ObjectBox内部会自动帮我们管理。

安装（本文以Java为例, Kotlin详见ObjectBox - docs）

build.gradle(module)添加

buildscript {
ext.objectboxVersion = '2.3.4'
repositories {
  jcenter()
}
dependencies {
  // Android Gradle Plugin 3.0.0 or later supported
  classpath 'com.android.tools.build:gradle:3.3.2'
  classpath "io.objectbox:objectbox-gradle-plugin:$objectboxVersion"
  }
}

build.gradle(app)添加

apply plugin: 'com.android.application'
apply plugin: 'io.objectbox' // apply last

初始化数据库

@Override
    public void onCreate() {
        super.onCreate();

        //注册数据库
        ObjectBox.init(this);
        ...
    }

//////////////////////////////////////////////////////////////

private static BoxStore boxStore;

public static void init(Context context) {

    boxStore = MyObjectBox.builder()
            .androidContext(context.getApplicationContext())
            .build();
    //这句是开启浏览器数据可视化，详情参阅官方文档
    new AndroidObjectBrowser(boxStore).start(context.getApplicationContext());
}

public static BoxStore get() {
    return boxStore;
}

定义实体类

objectbox是通过注解来标明哪个类是实体，若新建了一个新的实体或对实体进行了修改,都需要重新Make Project来生成新的实体操作对象。常用的注解如下：

@Entity   //表示这是一个需要持久化的实体
public class Student {
    @Id 
    public long id;

    @Index
    public String name;

    @Transient
    public int tempUsageCount;

    @NameInDb("USERNAME")
    public String name;

    public ToOne<Class> classToOne;

    public int age;
}

@Entity：这个对象需要持久化。
@Id：这个对象的主键,默认情况下，id是会被objectbox管理的，也就是自增id，如果你想手动管理id需要在注解的时候加上@Id(assignable= true)即可。当你在自己管理id的时候如果超过long的最大值，objectbox 会报错.id的值不能为负数。当id等于0时objectbox会认为这是一个新的实体对象,因此会新增到数据库表中。
@Index：这个对象中的索引。对经常大量进行查询的字段创建索引，会提高你的查询性能。
@Transient:如果你有某个字段不想被持久化，可以使用此注解,那么该字段将不会保存到数据库。
@NameInDb：有的时候数据库中的字段跟你的对象字段不匹配的时候，可以使用此注解。
@ToOne:做一对一的关联注解，例如示例中表示一张学生表（Student）关联一张班级表（Class）,此外还有一对多，多对多的关联，例如Class的示例：

    @Entity
    public class Class{
        @Id
        long id;

        @Backlink(to = "classToOne")
        public ToMany<Student> studentEntitys;
    }

@ToMany:做一对多的关联注解，如示例中表示一张班级表(Class)关联多张学生表(Student)
@Backlink:表示反向关联

增删改查

增
首先我们获取该实体的Box对象，随后调用该对象的put()方法即可完成新增操作

Box<Student> StudentBox = BaseApp.getInstence().getBoxStore().boxFor(Student.class);
Student student = new Student();
student.name = "Jay";
StudentBox.put(student);

StudentBox.remove(student);  //该参数可以传要删除的实体，也可以传入要删除的实体的id,可以批量传入

改
objectBox修改数据非常简单，首先得到要修改的实体类，直接修改数据，随后调用put()方法即可，示例如下：

//查询一个名叫Jay的学生信息的表
Student jayStudent = StudentBox.query().equal(Student_.name, "Jay").build().find();
jayStudent.name = "Vergil";
StudentBox.put(jayStudent);

查
通过Box的query()方法可以得到一个QueryBuilder对象，该对象可以实现各种查询操作，里面包含contains(),equal()等各种便捷的查询方法，示例如下：

//查询一个名叫Jay的学生信息的表
Student jayStudent = StudentBox.query().equal(Student_.name, "Jay").build().find();

数据库的其它操作

数据库的数据升级

@Entity
@Uid
public class MyName { ... }

第二步：编译项目，编译将失败，并且会给你一个UID

error: [ObjectBox] UID operations for entity "MyName": [Rename] apply the current UID using @Uid(6645479796472661392L) - [Change/reset] apply a new UID using @Uid(4385203238808477712L)

第三步：将Rename后面的UID放入到要修改的类中：

@Entity
@Uid(6645479796472661392L)
public class MyName { ... }

第四步：进行数据的修改

@Entity
@Uid(6645479796472661392L)
public class MyNewName { ... }

更改数据属性或重命名字段名同理操作。

表关系

@ToOne和@ToMany可以看作JAVA中的T和List的关系,拿班级和学生举例，设置相关的学生对象如下：

Class class = new Class(); //先创建一个班级
Student student = new Student();
student.name = "Jay";
student.classToOne.setTarget(class);  //设置一对一的target对象，字段参见以上示例
long studentId = StudentBox.put(student);

获取该学生的班级信息：

Student student = StudentBox.get(studentId);
Class class = student.classToOne.getTarget();

而一对多的关系更为简单，你可以像List集合一样去操作它：

Class class_ = new Class(); //先创建一个班级
Student s1 = new Student(); //添加一个学生
student.name = "Jay";

Student s2 = new Student();
s2.name = "Android";

class_ .studentEntitys.add(s1);
class_ .studentEntitys.add(s2);
Box classBox = BaseApp.getInstence().getBoxStore().boxFor(Class.class);
classBox.put(class);

另外，objectBox还支持事务，Rxjava查询，Kotlin的支持，更多详情可以通过官方文档了解http://objectbox.io.

补充

浏览器数据可视化相关
build.gradle(app)添加

dependencies {
...    
debugImplementation "io.objectbox:objectbox-android-objectbrowser:$objectboxVersion"
releaseImplementation "io.objectbox:objectbox-android:$objectboxVersion"
}

并且把：

apply plugin: 'io.objectbox'

放到dependencies字段后面sync。

版权属于：Vergil Wu
本文链接：https://www.vergil.com.cn/24.html
转载时须注明出处及本声明

ObjectBox 浅析

数据库简介

安装（本文以Java为例, Kotlin详见ObjectBox - docs）

定义实体类

增删改查

数据库的其它操作

表关系

补充

发表评论取消回复

1 条评论

Python之Scrapy爬取某网站图片通过api接口上传到chevereto图床

🌈 Intellij Plugin: INTELLIJ-RAINBOW-FART

Android面试基础 - 更新中

记录Android Studio CMake一处错误 - Cause: executing external native build for cmake

ADB/Linux Shell/Vim/Git/Markdown 等常用命令、快捷键记录备忘

CORS Anywhere

ADB/Linux Shell/Vim/Git/Markdown 等常用命令、快捷键记录备忘

Android面试基础 - 更新中

ObjectBox 浅析

线程与进程 Q&A

ObjectBox 浅析

数据库简介

安装（本文以Java为例, Kotlin详见ObjectBox - docs）

定义实体类

增删改查

数据库的其它操作

表关系

补充

数据库简介

安装（本文以Java为例, Kotlin详见ObjectBox - docs）

定义实体类

增删改查

数据库的其它操作

表关系

补充

发表评论 取消回复

1 条评论

ObjectBox 浅析

数据库简介

安装（本文以Java为例, Kotlin详见ObjectBox - docs）

定义实体类

增删改查

数据库的其它操作

表关系

补充

发表评论取消回复