這兩天聽朋友說起了最近Android出來了一個NoSql數(shù)據(jù)庫ObjectBox，懷揣著好奇就建了一個Android程序進(jìn)行了簡單的運(yùn)用和測試锌畸，感覺效果很好毅整，特此記~
- 此文主要供 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的數(shù)據(jù)
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"
}
- 在應(yīng)用中的正常使用(建議在Applicaion中初始化),以下是初始化（我也是初學(xué)kotlin可能存在一些語法不夠簡潔阅悍，不喜勿噴哈）：
class App : Application() {
override fun onCreate() {
super.onCreate()
initObjectBox()
}
//定義靜態(tài)塊 靜態(tài)方法
companion object {
lateinit var boxStore: BoxStore
fun getBoxStoreInstance() = boxStore
}
private fun initObjectBox() {
boxStore = MyObjectBox.builder().androidContext(this).build()
if (BuildConfig.DEBUG) {
boxStore?.let {
//可以理解為初始化連接瀏覽器(可以在瀏覽器中查看數(shù)據(jù)，下面再說)
val started = AndroidObjectBrowser(boxStore).start(this)
Log.i("ObjectBrowser", "Started: " + started)
}
}
}
}
- 創(chuàng)建實體類
//實體類學(xué)生
@Entity
class Student{
@Id var id:Long = 0
lateinit var name:String
//這里是假設(shè)學(xué)生和老師的關(guān)系(relation)是一對一
lateinit var teacher:ToOne<Teacher>
}
//實體類老師
@Entity
class Teacher{
@Id var id:Long =0
lateinit var name:String
//這里假設(shè)老師和學(xué)生的關(guān)系是一對多(一個老師有多個學(xué)生)
@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>()
//創(chuàng)建一個老師對象和一個學(xué)生對象
var teacher = Teacher()
teacher.name = "我是老師"
//學(xué)生和老師的relation是1對1 如果沒有關(guān)系則不用這一步
//student.teacher.target = teacher
var student = Student()
student.name = "我是學(xué)生"
//創(chuàng)建一個學(xué)生列表
var allStudents: MutableList<Student> = mutableListOf()
//老師和學(xué)生是一對多的關(guān)系，不用relation則可以不用次關(guān)系
teacher.students.addAll(allStudents)
//以下是對數(shù)據(jù)的基本操作
//- 添加數(shù)據(jù)(可以單個數(shù)據(jù)添加益楼，也可以添加一個列表數(shù)據(jù))
studentBox.put(student)
studentBox.put(mutableListOf())
//查詢數(shù)據(jù)的幾種方式
1.get方式查詢數(shù)據(jù)(可以傳入id猾漫，id列表等等，具體查看api)
var student=studentBox.get(id)
2.find方式(傳入你Entity對應(yīng)的屬性和值進(jìn)行查詢感凤，Student_構(gòu)建會自動生成)
var findStudents: List<Student> = studentBox.find(Student_.name, "張三")
3.query方式(適用于復(fù)雜查詢可以拼接各種條件悯周，如下簡單拼接)
var queryStudents: List<Student> = studentBox.query()
.equal(Student_.name, "張三")
.between(Student_.id, 1, 10)
.build()
.find();
//更新數(shù)據(jù)的操作和插入的操作相同都是put
studentBox.put(student)
//刪除數(shù)據(jù)的操作(可以單個id，多個id陪竿，單個對象禽翼，對象列表等)
studentBox.remove(id)
studentBox.remove(id1,id2...)
studentBox.remove(student)
studentBox.remove(mutableListOf())
- 其他操作(browser查看數(shù)據(jù))，上面依賴其實已經(jīng)添加過也加了注釋族跛，但是在這還是做個補(bǔ)充吧.
//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中添加網(wǎng)絡(luò)訪問權(quán)限
<uses-permission android:name="android.permission.INTERNET" />
4.以上已經(jīng)完成基本瀏覽數(shù)據(jù)的配置捐康，如果Android手機(jī)當(dāng)前引用的消息通知是打開的會打開的,
則會收到一條通知點擊通知則瀏覽器會打開數(shù)據(jù)瀏覽。如果需要瀏覽器打開則需要轉(zhuǎn)發(fā)端口
adb forward tcp:8090 tcp:8090
瀏覽器可以訪問 http://localhost:8090/index.html 直接打開
- 溫馨提示
1.@Id var id:Long =0 表示ID從1開始 自增長 且必須指定為Long類型
2.數(shù)據(jù)的存儲位置為/data/data/com.xx.xx(應(yīng)用包名)/objectbox/
如上即學(xué)習(xí)ObjectBox一點簡記庸蔼，如有錯誤歡迎指正~
