这两天听朋友说起了最近Android出来了一个NoSql数据库ObjectBox，怀揣着好奇就建了一个Android程序进行了简单的运用和测试，感觉效果很好，特此记~
- 此文主要供 Kotlin使用ObjectBox
1.添加依赖
- 在project的build.gradle添加如下配置
buildscript {
//目前版本是1.4.1
ext.objectboxVersion = '1.4.1'
ext.kotlin_version = '1.2.10'
repositories {
google()
jcenter()
maven { url "http://objectbox.net/beta-repo/" }
}
dependencies {
classpath 'com.android.tools.build:gradle:3.0.1'
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
classpath "io.objectbox:objectbox-gradle-plugin:$objectboxVersion"
}
}
allprojects {
repositories {
google()
jcenter()
maven { url "http://objectbox.net/beta-repo/" }
}
}
- 在app的build.gradle中需要添加如下配置
apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'kotlin-kapt'
//此依赖主要用于browser，可以在浏览器中查看app的数据
dependencies {
debugImplementation "io.objectbox:objectbox-android-objectbrowser:$objectboxVersion"
releaseImplementation "io.objectbox:objectbox-android:$objectboxVersion"
}
//一定要在 上面两个依赖之下 此plugin
apply plugin: 'io.objectbox' // after applying Android plugin
//在正常的dependencies中添加如下依赖
dependencies{
//主要是针对kotlin
compile "io.objectbox:objectbox-kotlin:$objectboxVersion"
}
- 在应用中的正常使用(建议在Applicaion中初始化),以下是初始化（我也是初学kotlin可能存在一些语法不够简洁，不喜勿喷哈）：
class App : Application() {
override fun onCreate() {
super.onCreate()
initObjectBox()
}
//定义静态块 静态方法
companion object {
lateinit var boxStore: BoxStore
fun getBoxStoreInstance() = boxStore
}
private fun initObjectBox() {
boxStore = MyObjectBox.builder().androidContext(this).build()
if (BuildConfig.DEBUG) {
boxStore?.let {
//可以理解为初始化连接浏览器(可以在浏览器中查看数据，下面再说)
val started = AndroidObjectBrowser(boxStore).start(this)
Log.i("ObjectBrowser", "Started: " + started)
}
}
}
}
- 创建实体类
//实体类学生
@Entity
class Student{
@Id var id:Long = 0
lateinit var name:String
//这里是假设学生和老师的关系(relation)是一对一
lateinit var teacher:ToOne<Teacher>
}
//实体类老师
@Entity
class Teacher{
@Id var id:Long =0
lateinit var name:String
//这里假设老师和学生的关系是一对多(一个老师有多个学生)
@Backlink
lateinit var students: ToMany<Student>
}
- 基本使用方法
//此处是我在Application里面做了初始化操作
var boxStore = App.getBoxStoreInstance()
//如果没有在Application里面初始化，使用的地方初始化可以这样操作，MyObjectBox需要build工程之后才会出来
//var boxStore = MyObjectBox.builder().androidContext(this).build()
var studentBox: Box<Student> = boxStore.boxFor<Student>()
var teacherBox: Box<Teacher> = boxStore.boxFor<Teacher>()
//创建一个老师对象和一个学生对象
var teacher = Teacher()
teacher.name = "我是老师"
//学生和老师的relation是1对1 如果没有关系则不用这一步
//student.teacher.target = teacher
var student = Student()
student.name = "我是学生"
//创建一个学生列表
var allStudents: MutableList<Student> = mutableListOf()
//老师和学生是一对多的关系，不用relation则可以不用次关系
teacher.students.addAll(allStudents)
//以下是对数据的基本操作
//- 添加数据(可以单个数据添加，也可以添加一个列表数据)
studentBox.put(student)
studentBox.put(mutableListOf())
//查询数据的几种方式
1.get方式查询数据(可以传入id，id列表等等，具体查看api)
var student=studentBox.get(id)
2.find方式(传入你Entity对应的属性和值进行查询，Student_构建会自动生成)
var findStudents: List<Student> = studentBox.find(Student_.name, "张三")
3.query方式(适用于复杂查询可以拼接各种条件，如下简单拼接)
var queryStudents: List<Student> = studentBox.query()
.equal(Student_.name, "张三")
.between(Student_.id, 1, 10)
.build()
.find();
//更新数据的操作和插入的操作相同都是put
studentBox.put(student)
//删除数据的操作(可以单个id，多个id，单个对象，对象列表等)
studentBox.remove(id)
studentBox.remove(id1,id2...)
studentBox.remove(student)
studentBox.remove(mutableListOf())
- 其他操作(browser查看数据)，上面依赖其实已经添加过也加了注释，但是在这还是做个补充吧.
//1.app的build.gradle中加入如下依赖
dependencies {
debugImplementation "io.objectbox:objectbox-android-objectbrowser:$objectboxVersion"
releaseImplementation "io.objectbox:objectbox-android:$objectboxVersion"
}
//一定要在 上面两个依赖之下 此plugin
apply plugin: 'io.objectbox'
//2.代码中加入如下代码（加入到初始化之后）
if (BuildConfig.DEBUG) {
boxStore?.let {
val started = AndroidObjectBrowser(boxStore).start(this)
Log.i("ObjectBrowser", "Started: " + started)
}
//3.在manifest中添加网络访问权限
<uses-permission android:name="android.permission.INTERNET" />
4.以上已经完成基本浏览数据的配置，如果Android手机当前引用的消息通知是打开的会打开的,
则会收到一条通知点击通知则浏览器会打开数据浏览。如果需要浏览器打开则需要转发端口
adb forward tcp:8090 tcp:8090
浏览器可以访问 http://localhost:8090/index.html 直接打开
- 温馨提示
1.@Id var id:Long =0 表示ID从1开始 自增长 且必须指定为Long类型
2.数据的存储位置为/data/data/com.xx.xx(应用包名)/objectbox/
如上即学习ObjectBox一点简记，如有错误欢迎指正~
网友评论