【威哥说】realm是什么?可能很多人都没有听说过,realm是一个跨平台移动数据库引擎,支持iOS、OS X(Objective-C和Swift)以及Android。专门针对移动平台设计的数据库。目标是取代SQLite,核心数据引擎C++打造,比单独无封装的SQLite还要快。这篇投稿详细讲解了realm的使用,分享给大家。
【正文】当我们的app有数据需要保存到本地缓存时,可以使用file,sharedpreferences,还有sqlite。sharedpreferences其实使用xml的方式,以键值对形式存储基本数据类型的数据。对于有复杂筛选查询的操作,file和sharedpreferences都不能满足了。sqlite可以满足有大量复杂查询要求的缓存数据操作。但是sqlite的使用略复杂,代码量很大,还好网上有很多优秀的orm框架可使用,比喻ORMlite,greenDao等。
ORMlite,greenDao这些框架都是在SQLite的基础上封装的ORM对象关系映射框架,简化了代码操作。而今天的主角:Realm是一个可以替代SQLite以及ORM Libraries的轻量级数据库。相比SQLite,Realm更快并且具有很多现代数据库的特性,比如支持JSON,流式api,数据变更通知,以及加密支持,这些都为安卓开发者带来了方便。不多介绍我们重点来说说Reaml的使用,看看到底爽在哪里。
环境配置:
1、在Project的build.gradle文件中添加依赖:
dependencies {
...
classpath "io.realm:realm-gradle-plugin:1.1.0"
...
}
2、在app module的build.gradle文件的top添加下面代码:
apply plugin: 'com.android.application'
apply plugin: 'realm-android'
....
配置完毕.
使用:
在整个使用的过程中,Realm是主角,我们先来看看Realm类中的一段翻译:
/**
* Realm类可以对你的持久化对象进行存储和事务管理,可以用来创建RealmObjects实例。领域内的对象可以在任何时间查询和读取。
* 创建,修改和删除等操作必须被包含在一个完整的事务里面,后面的代码会讲到。
* 该事务确保多个实例(在多个线程)可以在一个一致的状态和保证事务在ACID前提下,访问相同的对象。
* 当一个Realm实例操作完成后,切记不要忘记调用close()方法。否则会导致本地资源无法释放,引起OOM。
* Realm实例不能在不同的线程间访问操作。确切的说,你必须在每个要使用的线程上打开一个实例
* 每个线程都会使用引用计数来自动缓存Realm实例,所以只要引用计数不达到零,
* 调用getInstance(RealmConfiguration)方法将会返回缓存的Realm实例,应该算是一个轻量级的操作。
* 对于UI线程来说,打开和关闭Realm实例,应当放在onCreate/onDestroy或者onStart/onStop方法中
* 在不同的线程间,Realm实例使用Handler机制来调整他的状态。也就是说,Realm实例在线程中,如果没有Looper,是不能收到更新通知的,
* 除非手动调用waitForChange()方法
* 在安卓Activity领域工作的一个标准模式可以在下面看到
* 在Android Activity中,Realm的标准工作模式如下:
*
* public class RealmApplication extends Application {
*
* \@Override
* public void onCreate() {
* super.onCreate();
*
* // The Realm file will be located in package's "files" directory.
* RealmConfiguration realmConfig = new RealmConfiguration.Builder(this).build();
* Realm.setDefaultConfiguration(realmConfig);
* }
* }
*
* public class RealmActivity extends Activity {
* private Realm realm;
* \@Override
* protected void onCreate(Bundle savedInstanceState) {
* super.onCreate(savedInstanceState);
* setContentView(R.layout.layout_main);
* realm = Realm.getDefaultInstance();
* }
* \@Override
* protected void onDestroy() {
* super.onDestroy();
* realm.close();
* }
* }
*
* Realm支持String和byte字段长度高达16MB
* 参考连接:
* ACID
* Examples using Realm
*
*/
部分源码分析:
public final class Realm extends BaseRealm {
//默认的文件名,是啥?
public static final String DEFAULT_REALM_NAME = RealmConfiguration.DEFAULT_REALM_NAME;
//怎么这么熟悉呢?是RxJava?
@Override
@OptionalAPI(dependencies = {"rx.Observable"})
public Observable asObservable() {
return configuration.getRxFactory().from(this);
}
//下面这些方法,应该都能顾名思义吧
public void createAllFromJson(Class clazz, JSONArray json) {
}
public void createOrUpdateAllFromJson(Class clazz, JSONArray json) {
}
public E createOrUpdateObjectFromJson(Class clazz, JSONObject json) {
}
public E createObject(Class clazz) {
}
public E copyToRealmOrUpdate(E object) {
}
public void executeTransaction(Transaction transaction) {
}
public void delete(Class clazz) {
}
}
RealmConfiguration类的说明翻译:
/**
* 一个RealmConfiguration对象,可用来设置特定的Realm实例
* RealmConfiguration实例只能通过io.realm.RealmConfiguration.Builder类的build()方法来创建
* 想使用默认的RealmConfiguration实例,请使用io.realm.Realm#getDefaultInstance()方法。
* 如果想使用自己配置RealmConfiguration实例的Realm实例,需要调用Realm#setDefaultConfiguration(RealmConfiguration)
*
*
* 可以用下面代码创建一个最简单配置的实例:
* RealmConfiguration config = new RealmConfiguration.Builder(getContext()).build())
* 这样创建的实例,具有一下属性:
*
*
*
*
*
*
*/
部分源码分析:
public final class RealmConfiguration {
//默认文件名
public static final String DEFAULT_REALM_NAME = "default.realm";
//Rx工厂
private final RxObservableFactory rxObservableFactory;
//弱引用
private final WeakReference contextWeakRef;
/**
* 从Asset目录中返回Realm文件名,还可以保存在Asset中?
* @return input stream to the asset file.
* @throws IOException if copying the file fails.
*/
InputStream getAssetFile() throws IOException {
Context context = contextWeakRef.get();
if (context != null) {
return context.getAssets().open(assetFilePath);
} else {
}
}
/**
* 使用app自己内置硬盘目录来存储Realm file。不需要任何扩展访问权限。
* 默认目录为:/data/data//files,这个路径能否修改取决于供应商的具体实现
*
* @param 参数context请使用application的context.
*/
public Builder(Context context) {
if (context == null) {
throw new IllegalArgumentException("A non-null Context must be provided");
}
RealmCore.loadLibrary(context);
initializeBuilder(context.getFilesDir());
}
}
通过上面的翻译说明和源码分析,应该几乎明白了Realm的原理和基本使用了吧。总结下面几点:
1、Realm保存的结果其实是在一个文件里面,默认的文件名是"default.realm",在"Context.getFilesDir()"目录中,即:/data/data//files/default.realm。意思是,当你在应用管理里面给当前app"清除数据",realm数据库的数据会丢失。故我们需要把默认的数据文件放到asset目录中,当数据库初始化时再copy到"Context.getFilesDir()"下。
2、在创建RealmConfiguration对象时,可以通过.assetFile(this,"realm file path in assets")方法指定初始化的数据库文件。Realm会把制定路径下的xxx.realm文件copy到Context.getFilesDir()目录中,以替换默认创建的空数据库文件。
3、可以设置默认文件名,通过RealmConfiguration类进行配置。路径似乎改不了,需要看具体设备供应商的实现。
4、Realm的实例需要在每次的具体操作中获取,可以看成是一个数据操作的sessin,用完后必须close关闭。打开和关闭Realm实例,应当放在onCreate/onDestroy或者onStart/onStop方法中。
5、Realm中似乎有RxJava的影子,支持链式异步任务?
6、Realm中有个各种增删改差的方法,还可以根据JSON的数据实例化一个RealmObject子类java bean。
7、重点:切记,Realm数据库的主键字段不是自动增长的,需要自己设置,做添加的时候如果不给id字段值,默认会为0。后面再添加会报错,说id为0的数据已经存在。尤其是批量添加的时候要注意,当心出现只添加了一条记录的悲剧。
8、数据自动更新。mRealm.addChangeListener(this);//当数据库的数据有变化时,系统回调此方法。
经过上面的分析和总结,其实已经很明了了。为了那些伸手主义者,还是简单撸些代码吧。还有些需要注意的地方,在代码中讲解。
本文出自微信公众号mjw-java,更多内容微信公众号或访问www.moliying.com