1 Star 0 Fork 0

ztfb / Storage

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Storage

项目简介

项目结构

Storage由一个基于C++的http服务器和一个动态库形式的存储引擎构成。存储引擎和服务器之间的接口层通过头文件Processor.h描述。不同的存储引擎按照不同的方式实现Processor接口,并将编译构建出的动态库放在特定的目录下,即可得到不同的可对外提供服务的存储引擎。

整体结构分成以下三层:

  • 服务器层:http报文经过一定的解析和处理后,传递给接口层(即Processor)。
  • 接口层:调用存储引擎,处理服务器层传递过来的数据,并将处理结果封装后返回给服务器层。
  • 存储引擎:给接口层提供API。

Storage的优势:C++ 服务器的性能良好;更换存储引擎方便快捷;轻量级,即开即用,无需安装其他依赖。

HTTP服务器

http服务器包含的模块如下:

  • 异步的日志系统,方便在开发中进行调试以及在服务器运行时监控服务器的运行状态。
  • 单例模式的线程池,避免频繁创建和销毁线程带来的额外开销。
  • 基于小根堆的定时器,用于清除到期的非活跃的连接。
  • 自定义的可以自动增长的缓冲区,用于读取文件中的数据或者向文件中写数据。
  • 封装epoll函数,使用I/O多路复用监听文件描述符的状态。
  • 利用正则表达式和状态机解析http请求报文,根据处理结果构造http响应报文。

实现细节见http服务器文档:HTTP服务器文档

K-V存储引擎

Storage实现了基于跳表的轻量级K-V存储引擎,对外提供增删改查API,以及数据落盘API。接口层Processor从用户的http请求报文中解析出存储引擎的操作命令,根据命令调用相应的函数,并根据函数的返回结果返回http响应体。

实现细节见K-V存储引擎文档:K-V存储引擎文档

目录结构

-bin				# 存放二进制文件
 --lib				# 存储引擎动态库目录
  ---processor.so	# 存储引擎动态库
 --config.ini		# 服务器配置文件
 --http_server		# http服务器(可执行程序)
-http_server		# C++ http服务器
 --Buffer			# 自动增长的缓冲区
 --Epoll			# epoll相关函数封装
 --Log				# 异步日志系统
 --Server			# 通信主循环
 --ThreadPool		# 线程池
 --Timer			# 基于小根堆的定时器
 --Connection		# 客户端连接封装
 --HttpProcess		# HTTP解析器和构造器
 --Processor		# 存储引擎接口(存储引擎和http服务器对接层)
 --main.cpp			# 主程序(启动程序)
 --config.ini		# 服务器启动时要读取的配置文件
 --CMakeLists.txt	# CMake
 --README.md		# 说明文件
-kv_store			# 基于跳表的轻量级K-V存储引擎
-.gitignore			# git忽略
-LICENSE			# Apache2.0 开源许可
-README.md			# README.md文件,Storage的说明文件

编译和运行

Storage由一个http服务器和一个动态库形式的存储引擎构成。编译Storage时,需要先编译构建存储引擎动态库processor,再编译构建http服务器Ray

生成动态库

# 以生成kv_store引擎的动态库为例
cd kv_store  # 进入kv_store目录
mkdir build  # 新建build目录
cd build     # 进入build目录
cmake ../    # CMake生成Makefile
make         # 构建动态链接库

生成可执行文件

# 将上一步生成的动态库复制到bin/lib目录下
cd http_server  # 进入http_server目录
mkdir build     # 新建build目录
cd build        # 进入build目录
cmake ../       # CMake生成Makefile
make            # 构建可执行文件

注:编译构建http_server前,需要修改其CMakeLists.txt文件的link_directories。将其修改为自己项目的本地路径。

运行

# 将上一步生成的可执行文件复制到bin目录下
# 将config.ini文件复制到bin目录下
cd bin          # 进入bin目录
./http_server   # 执行http_server
# 注:如果config.ini与http_server不在同一目录下,终端启动http_server时要携带参数:
./http_server 配置文件路径
# 成功启动服务器后如下图所示

致谢

@ LZF

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

轻量级KV数据库 展开 收起
C++ 等 2 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/tian-wenzhuo/Storage.git
git@gitee.com:tian-wenzhuo/Storage.git
tian-wenzhuo
Storage
Storage
master

搜索帮助