从很早之前就很想要自己搞一个能够重复使用的保存架构,但是一直没有什么好灵感。直到开始接触了 SQLite,发现它真的是一个小而轻巧的数据库系统,甚至在移动平台(Android 和 iOS)中都有内置,才兴起了用它当底层来制作保存架构的念头。

也许很多人会觉得很奇怪,既然都有 SQLite 或是其他的数据库软件了,为什么还需要自己做一个保存架构呢?是自找麻烦吗?当然不是!有鉴于目前 Java 编程语言能够应用在许多地方,像是窗口程序、网页前端程序或是网页后端程序,甚至连 Android SDK 也是用 Java 语言,但是即使都是 Java,在不同应用上程序也都有不同的写法,彼此间的架构很难重用。而且有时候并不是想要开发一个大项目,而只是想写一个小小程序保存一些数据,就要实作庞大的架构出来,使得程序复杂难用又不易调试,这成本实在是太高了。

ContentCenter

开发数据量不大的小项目,使用 ContentCenter 是一个不错的解决方案。ContentCenter 实作了部份 SQLite 的常用功能,甚至可以不必写到任何一个 SQL 语法就能轻易建出 SQLite 的数据库。ContentCenter 另外还结合了 Observer,当保存的数据有改变时,可以更新显示画面;也结合了 Sync,当本地端或是 Server 远程的数据有改变时,可以在彼此间做同步的动作。此外,ContentCenter 可以在任意位置存放数据库文件,在创建数据库表格(表单)的时候,还可以提供密钥指定哪些表单的字段需要隐藏内容(使用 String Hider),大大地提升数据的安全性。

ContentCenter 的架构

ContentCenter 与 SQLite、Syncs、Observers 和 Application 的架构图

ContentCenter 的底层是 SQLite,透过 JDBC 去连接,用来保存数据到硬盘。除了 ContentCenter 外,没有其他地方可以直接操作到 SQLite。实作 Observer 可用来处理本地端数据改变时,图形组件的显示方式;实作 Sync 可用来处理本地端同步到服务器端的数据。至于顶层的 Application 除了可以使用 ContentCenter 外,还可以不需透过 ContentCenter 而直接调用 Sync 和 Observer,如此在写程序的时候才不会绑手绑脚,提供了更高的自由度。ContentCenterListener 是链接与集成 ContentCenter、Sync、Observer 和 Application 之间沟通的重要组件,在初始化 ContentCenter 前,一定要先将 ContentCenterListener 在 Application 内实作出来。

取得 ContentCenter

GitHub:

ContentCenter 一般使用方式

实作 ContentCenterListener

实作 ContentCenterListener 界面,需要实作以下方法:

public boolean onActionPerforming(EVENT event, NOTIFY notify, JSONObject information) throws Exception;
  • event:触发 Listener 的事件。共有以下几种:
    • INITIAL_PRAGMA:在 ContentCenter 运行 initialContentCenter 方法时,若发现 DB 文件并不存在,将会重新创建 DB 文件,此时就会以这个事件来通知 ContentCenterListener。通常会利用这个事件来决定数据库要打开或是关闭的特性。
    • INITIAL:在 ContentCenter 运行 initialContentCenter 方法时,若发现 DB 文件并不存在,将会重新创建 DB 文件,此时就会以这个事件来通知 ContentCenterListener。通常会利用这个事件来初始化 DB 的表单。
    • AVAILABLE:在 ContentCenter 运行 initialContentCenter 方法时,若已经加载好 DB 文件,将会进入 AVAILABLE 状态,并且以这个事件来通知 ContentCenterListener。通常会利用这个事件来先验证 DB 的数据。
    • INSERT、DELETE、UPDATE:在 ContentCenter 运行 insert、delete 或是 update 方法时,如果需要通知 observer 或是 sync 的话,就会以这个事件来通知 ContentCenterListener。
    • REMOTESYNC:在 ContentCenter 运行 runPeriodicSync 方法时,会尽量在一个固定时间不断以这个事件来通知 ContentCenterListener。通常用于检查远程数据是否有更变,如果有的话再同步到本地端。
  • notify:ContentCenterListener 的通知类型。共有以下几种:
    • OBSERVER:通知给 Observer。
    • SYNC:通知给 Sync,使其将本地端更动的数据同步到远程上。若是 REMOTESYNC 事件,也会属于 SYNC 通知。
  • information:ContentCenterListener 所传递的消息,用于 INSERT、DELETE、UPDATE 事件。消息为 JSON 格式,其字段可以使用对应的 JSONInsert, JSONDelete, JSONUpdate 界面来找到。

初始化 ContentCenter

在使用 ContentCenter 的各项功能之前,必须先初始化 ContentCenter。

ContentCenter.initialContentCenter(dbFile, listener, hideKey);
  • dbFile:DB 的 File 对象或是路径。
  • listener:实作出来的 ContentCenterListener。
  • hideKey:字段隐藏内容所使用的密钥。没有设置的话预设不使用密钥,只是单纯的隐藏字符串(将可被任何的 StringHider 解开)。

添加表单(Table)

由于 ContentCenter 的底层为 SQLite,因此在查找或是更新任何数据时,都是在表单上面操作,因此通常会在 ContentCenterListener 的 INITIAL 事件就把 ContentCenter 的所有表单都通通建好。

ContentCenter.createTable(tableName, metadata);
  • tableName:表单名称。
  • metadata:表单描述数据(请参考文档来创建)。

注册 Observer 和 Sync

ContentCenterListener 的 REMOTESYNC 事件用来处理远程的数据改变,ContentCenterListener 的 INSERT、DELETE、UPDATE 事件用来处理本地端数据的改变。Observer 和 Sync 专门用来回应本地端数据的改变,因此通常会和 INSERT、DELETE、UPDATE 合用。如果通知类型为 OBSERVER,就使用 Observer;如果通知类型为 SYNC,就使用 Sync。

如果不注册 Observer 和 Sync 对象也是可以完成通知组件更新和同步到远程的功能,但是当程序跨了好几个 Class 时,就会变得十分难用。因此建议在一开始,就把组件更新的方式和同步到远程的方式事先写好,注册到 ContentCenter 中,以后便可以透过 ContentCenter 去调用。

ContentCenter.registerObserver(observerID, observer);
ContentCenter.registerSync(syncID, sync);

透过自订的 ID 注册 Observer 和 Sync 后,在 ContentCenterListener 里面就可以用 notify 方法来通知他们进行工作。

ContentCenter.notifyObserver(observerID);
ContentCenter.notifySyncToServer(syncID);

查找数据

ContentCenter.query(tableName,columnNames,condition,orders);
  • tableName:表单名称。
  • columnNames:要保留的字段名称(Projection)。
  • condition:查找的条件。
  • orders:查找结果的排序方式。

插入、更新、删除数据

ContentCenter.insert(tableName,content,notifyObserver,notifySync,notifyID);
ContentCenter.update(tableName,content,condition,notifyObserver,notifySync,notifyID);
ContentCenter.delete(tableName,condition,notifyObserver,notifySync,notifyID);
  • tableName:表单名称。
  • content:数据内容。
  • condition:比对的条件。
  • notifyObserver:是否将更动通知给 Observer。
  • notifySync:是否将更动通知给 Sync。
  • notifyID:自订通知的 ID,有助于在 ContentCenterListener 中辨认通知。预设为时间(毫秒)。

启动与关闭自动同步

ContentCenterListener 的 SYNC 通知必须由 ContentCenter 内的 PeriodicSync Thread 来运行。PeriodicSync 会每隔一段时间自动处理远程和本地端互相同步的相关事项,必须要打开 PeriodicSync,ContentCenterListener 才可以接到 SYNC 通知。

ContentCenter.setSyncPeriod(period);
ContentCenter.runPeriodicSync();
  • period: 自动同步的同步周期。(单位为毫秒)

如果要关闭自动同步,使用以下方式。

ContentCenter.stopPeriodicSync();

关闭 ContentCenter

由于 ContentCenter 拥有自己的线程,因此若要关闭程序必须先关闭 ContentCenter。

ContentCenter.closeContentCenter();

ContentCenter 特殊使用方式

User Settings

如果像是要保存用户的设置值这种简单的数据,可以不必另外创建表单,ContentCenter 提供 put、get、remove 方法来快速插入任意字符串数据,而且插入数据会被隐藏,如此就不必担心设置值会外泄。

ContentCenter.put(key,value);
ContentCenter.get(key);
ContentCenter.remove(key);
  • key: 数据的 key(独特字符串)。
  • value: 数据的内容(字符串)。

MagicLen JSON(Mson)

ContentCenter 内置 Mson,可以透过 Mson 快速将对象转换成 JSONObject 或是 JSONArray。也可以透过 Mson 将 JSONObject 或是 JSONArray 转换成对象。

Mson 介绍

MagicStringHider

ContentCenter 内置 MagicStringHider,可以透过 MagicStringHider 隐藏保存在数据库的数据。

MagicStringHider 介绍