iBoxDB的学习与使用

1. 引言

一次偶然的机会接触到了iBoxDB这样一个小型的嵌入式对象数据库。感觉非常惊讶有这样轻巧的数据库。iBoxDB 本身是一个NOSQL 同时也有关系数据库的特点。

说说iBoxDB的优点：

1）无需安装，不像其他数据库比如MongoDB, MySQL 需要安装。iBOXDB只需要某个目录存放最终的数据即可。完全就像操作本地文件一  样，应该说比本地文件更方便。

2) 支持多种设备，只需要添加.Net 或者 Java的驱动程序，就可以在多种设备上使用iBoxD，比如Android, Linux，Windows Phone, PC程序等。

3）提供数据库事务支持，可以使用类SQL语法存取对象数据。

4）提供索引，主键以及主从和多主的数据库热同步。

4) 性能优越，这里展示下iBoxDB官方网站提供的和MongoDB性能测试对比结果

在32位机子下的测试结果，代码见Github

这里可以看到iBoxDB有三种运行模式：File 、 MemoryMappedFile、 InMemory。熟悉操作系统的同学对这三个概念肯定不会陌生。它的性能一个比一个高。

2. iBoxDB 的 CRUD 操作

任何DB的肯定包含CRUD的操作，这里给出一个简单的C#实现。

        public class Account
        {
            public string Name { get; set; }
            public int Age { get; set; }
            public string Email { get; set; }
            public string Desc { get; set; }

        }

        public static DB.AutoBox InitAndCreateAutoBox()
        {
            var dbPath = Path.Combine(Directory.GetCurrentDirectory(), "ibox");
            if (!Directory.Exists(dbPath))
            {
                Directory.CreateDirectory(dbPath);
            }

            var server = new DB(dbPath);
            var config = server.GetConfig();

            config.EnsureTable<Account>("AccountTable", "Name");

            return server.Open();
        }

函数 InitAndCreateAutoBox 初始化iBoxDB的环境，创建需要表以及指定主键，保存最终数据的目录。

从DB.Open()方法可获得一个AutoBox对象，这个对象是操作CRUD的。它不需要管理，也不需要释放。

比如：

        static void Main(string[] args)
        {
            //初始化DB
            var box = InitAndCreateAutoBox();

            //插入数据
              box.Insert("AccountTable",
                new Account() {Name = "001", Age = 14, Desc = "this is test", Email = "fake@qq.com"});
            box.Insert("AccountTable",
                new Account() {Name = "002", Age = 88, Desc = "this is test 33", Email = "fake2@qq.com"});
            box.Insert("AccountTable",
                new Account() { Name = "003", Age = 88, Desc = "this is test 88", Email = "fake3@qq.com" });

            //更新特定数据
              var account = box.SelectKey<Account>("AccountTable", "001");
            account.Age = 15;
            account.Desc = "fake";
            account.Email = "email";
            box.Update("AccountTable", account);

            //删除特定数据
              box.Delete("AccountTable", "002");

            var age15Account = box.Select<Account>("from AccountTable where Age==?", 88);
        }

另外一种方式就是利用AutoBox.Cube()获得一个Box对象，这个对象是用于控制事务的。此对象一定要释放，典型的就是利用using语句。

        static void Main(string[] args)
        {
            //初始化DB
            var box = InitAndCreateAutoBox();

            using (var cube = box.Cube())
            {
                cube.Bind("AccountTable")
                    .Insert(new Account() {Name = "001", Age = 14, Desc = "this is test", Email = "fake@qq.com"});

                cube.Bind("AccountTable")

                    .Insert(new Account() {Name = "002", Age = 15, Desc = "this is test", Email = "fake@qq.com"});

                var result = cube.Commit();
            }
        }

如果是一次性批量处理数据，最好是在一个事务中进行，建议使用Cube，这样效率可以达到最好。

3. iBoxDB下数据库同步

可以看到iBoxDB对于CRUD的便利，利用iBoxDB我们可以快速的搭建一个数据存储的原型并且Demo。但是如何才能将iBoxDB运用到实际的生产环境肯定还有很多工作需要完成。

如果数据量达到某种程度。对于Website而言数据库服务器很有可能成为网站的性能瓶颈。配置数据库的master slave 实现读写分离已经是老生常谈的问题。

不像MongoDB, 直接可以通过配置实现数据同步，iBoxDB 需要代码来实现同步，它提供两种形式：

不管哪种形式都，iBoxDB都用IBoxRecycler 实现数据同步。

这里自定义一个简单的接口实现，主要就是提取出master中数据存放到内存。

    public class Package
    {
        public Socket Socket;
        public byte[] OutBox;
    } 

    public class InMemoryBoxRecycler : IBoxRecycler
    {
        List<Package> qBuffer;
        public InMemoryBoxRecycler(long name, DatabaseConfig config)
        {
            qBuffer = new List<Package>();
        }

        public void OnReceived(Socket socket, BoxData outBox, bool normal)
        {
            if (socket.DestAddress == long.MaxValue)
            {
                 return;
            }
            lock (qBuffer)
            {
                qBuffer.Add(new Package { Socket = socket, OutBox = outBox.ToBytes() });
            }
        }
        public List<Package> GetPackage()
        {
            return qBuffer;
        }
                

        public void Dispose()
        {
            qBuffer = null;
        }
    }

自定义Server来管理所有的master 和 slave 节点

    public class MsaterSlaveReplicableServer : LocalDatabaseServer
    {
        public const int MasterAddress = 10;
        public const int SlaveAddress = 11;

        protected override DatabaseConfig BuildDatabaseConfig(long name)
        {
            if (name == MasterAddress || name == SlaveAddress)
            {
                var config = new DBPlatform.Config();
                config.EnsureTable<Account>("Account", "Name");
            }

            throw new NotImplementedException(name);
        }

        protected override IBoxRecycler BuildBoxRecycler(long name, DatabaseConfig config)
        {
            if (name == MasterAddress || name == SlaveAddress)
            {
                return new InMemoryBoxRecycler(name, config);
            }

            return base.BuildBoxRecycler(name, config);
        }
    }

最后启动Server：

              using (var server = new MsaterSlaveReplicableServer())
            {
                var master = server.GetInstance(MsaterSlaveReplicableServer.MasterAddress);
                var slave = server.GetInstance(MsaterSlaveReplicableServer.SlaveAddress);

                //在master 节点中插入数据
                   using (var box = master.Cube())
                {
                    for (var i = 0; i < 10; i++)
                    {
                        box.Bind("Account").Insert(
                            new Account()
                            {
                                Name = "account" + i,
                                Age = i,
                                Desc = "fake",
                                Email = "email" + i
                            });
                    }
                    box.Commit();
                }

                //将master数据复制到slave
                var recycler = (InMemoryBoxRecycler)master.GetBoxRecycler();
                lock (recycler.GetPackage())
                {
                    foreach (var p in recycler.GetPackage())
                    {
                        if (p.Socket.SourceAddress == MsaterSlaveReplicableServer.MasterAddress)
                        {
                            (new BoxData(p.OutBox)).SlaveReplicate(slave).Assert();
                        }
                    }
                    recycler.GetPackage().Clear();
                }

                //检查slave 中的数据
                   using (var box = slave.Cube())
                {
                    foreach (var item in box.Select<Account>("from Account", null))
                    {
                        Console.WriteLine(item);
                    }
                }
            }

4. 总结

iBoxDB 这样轻巧的数据库非常适合做项目Demo，但是在实际的Production环境中还是介意大家用MongoDB 等数据库。

欢迎访问我的个人网站 51zhang.net 网站还在不断开发中…