1 Star 0 Fork 93

Zhanghuahua / CppCloud

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

CppCloud产品说明文档

996.icu LICENSE

  本产品旨在提供适合多语言开发的分布式微服务框架,功能包括服务治理(注册/消费)分布式配置就近访问服务监控集中管理日志收集等。用户或企业可借此产品可以快速开发分布式集群的应用,集中精力来开发自身业务逻辑。

前言/背景

  近年来移动互联网的兴起,各种应用数据量业务量不断攀升;后端架构要不断提高性能和并发能力才能应对大信息时代的来临;传统单体程序 -> 面向服务soa -> 微服务SpringCloudDubbo的出现为企业开发分布式应用提供了很好的脚手架,Java得益于ioc/aop反向代理/注解等技术,开发者可以轻松用来构建自己的应用;
  Java开发分布式微服务是方便了,然而SpringCloud提供java之外的接入文档或sdk却非常少,国内更加少了;微服务不是提昌各类的开发者都能参与进来看发整个系统的某一块服务吗,譬如有关业务计算的让c/c++、golang开发,web展示业务的让py或java开发;虽然Netflix说SpringCloud各个接口是Restful,但学到用起来的成本个人觉得还是很高。

项目介绍

  本人开发的 CppCloud 目的就是快速构建分布式服务之余,特点轻量级,无乎没什么依赖(不需要mysql redis zookeep之类的),可以方便国内不同开发语言的开发者参与微服务的开发,而不仅限java;本项目核心服务(cppcloud_serv)采用c++开发,支持分布式部署,对外提供tcp服务;外部各应用接入时可以采用原生tcp协议接入、sdk接入、http间接接入;sdk方面目前开发了c++和python,由于一个人精力有限,其他的sdk暂时还未开发出来。

目录组织

cppcloud                          -- 根目录
├── common                        -- c++公共类库,编译出libhocomm.so
|   ├── comm                      -- 基础操作封装类(独立于项目的)
|   ├── cloud                     -- 本项目相关的常量及通用类定义
|   ├── rapidjson                 -- 本项目处理json串所用的第3方库
|   ├── Makefile                  -- 编译构建出libhocomm.so/libhocomm.a
|   ├── *.h *.cpp                 -- 具体的文件
├── server                        -- 中心端程序所在目录
|   ├── docs                      -- 说明文档
|   ├── Makefile
|   ├── *.h *.cpp
├── cpp_sdk                       -- c++应用端sdk
|   ├── docs                      -- 说明文档
|   ├── Makefile                  -- 编译构建出libsdk_cppcloud.so
|   ├── *.h *.cpp
├── python_sdk                    -- python应用端sdk(包)
|   ├── cppcloud                  -- 基于python3的sdk
|   ├── cppcloud_py2              -- 基于python2的sdk(弃用)
|   ├── setup.py                  -- 打包、安装、发布脚本
|   ├── Makefile                  -- 提供一些快捷命令(eg. make clean)
|   ├── sample_*.py               -- 常见服务治理的使用示例参考
├── web_py                        -- 基于python_sdk包而开发的cppcloud-web应用
|   ├── src
|   |    ├── static               -- html/css/js 本web应用采用前后端
|   |    ├── cppcloud_web.py      -- 启动时主入口
|   ├── setup.py                  -- 打包、安装、发布脚本
|   ├── Makefile                  -- 提供一些快捷命令
|   ├── LICENSE                   -- 开源授权信息
├── docker                        -- docker方式打包&部署目录(server+cpp_sdk)
|   |── docker-compose.yml
|   |── docker-entrypoint.sh       -- 容器入口点脚本
|   |── Dockerfile                 -- 主构建镜像配置
|   |── help.txt
|   |── Makefile                   -- 主控makefile
├── client_go                      -- 暂未开发

术语约定

名词 说明
serv 后端程序cppcloud_serv
svrname 应用名称,指连接Serv的客户端所取的一个名字
regname 服务提供者名称,可以和svrname一样
cli 客户应用、客户端、客户连接
app 同上差不多一样,都指客户端
svrid 每个客户应用都有一个区分身份的id
era cppcloud_serv内的术语,译作版本号,用于分布式部署Serv时互相同步客户数据
provider 服务提供者,简写prvd、pvd
invoker 服务调用者,服务消费者
consumer 同invoker
mtime 修改时间
atime 访问时间
ctime 初始时间,创建时间

环境及依赖

  cppcloud尽可能少的依赖其他第3方库,部署起来比较轻便。

c++部分

  • linux    2.6.32以上(建议centos7)
  • g++     4.8以上支持c++11

python部分

  • python    3.5以上
  • requests    无特别要求,本人开发时用2.18.4
  • setuptools    无特别要求,本人开发时用28.8.0
  • flask    无特别要求,本人开发时用1.0.2

架构图示

图片加载中

服务端Serv

  CppCloud的核心部分,源码在server目录下,c++实现,提供分布式服务的服务注册、发现、管理等功能,相当于SpringCloud里的Eureka Server的角色(java的同学比较了解);对外提供tcp接口,支持多个Serv集群提高可靠性;cppcloud_serv内部采用epoll异步io复用(Reactor模型),性能比拟nginx/libevent。 

服务提供Provider

  向cppcloud_serv注册了服务的客户应用,与cppcloud_serv通信使用tcp协议,每一类服务都有唯一的名称,以便让调用者(消费者)根据服务名称(regname)调用。 服务注册时需要提供的主要属性有服务名(regname),服务识别号(prvdid,同一进程提供多服务时使用)协议类别(protocol),权重(weight),启用(enable)等。

服务调用Invoker

  需要调用(消费)某服务的客户应用,同样的通过tcp与cppcloud_serv通信。不同服务以服务名称区分,调用前应该是明确知道本次要调用的服务名(regname)。 操作流程是首先拿regname向cppcloud_serv查询服务,返回可用服务列表,然后调用者从列表中选出合适的某个Provider,最后直接向该Provider发起调用,调用的具体内容要看协议类别和需要的参数。

Web管理

  提供可视化web界面操作CppCloud后端,底层用python sdk通过tcp和cppcloud_serv通信,上层对用户提供出restful的接口,和前后端分离的web管理页面。 维护人员可以在web监视服务运行状况、给某应用下发命令,维护分布式配置、修改服务提供者权重等功能。大家可以先参看官网上提供的演示界面,点击这里

开发部署

    有执行过的步骤无需重复进行, 每步序号对应于"源码开发/部署步骤"节

  • serv

    1 > 2 > 5 > 6

  • c++ sdk

    1 > 2 > 5 > 7

  • python sdk

    1 > 3 > 4 > 8

  • web

    1 > 3 > 4 > 9

  • 源码开发/部署步骤

    1. 从git上clone本项目到本地

      git clone https://gitee.com/ho999/CppCloud.git

    2. 安装好编译环境,要求g++ 4.7以上支持c++11特性。如果是centos7就执行如下命令即可;如果centos6的要注意,yum默认不会安装最新版g++,需手动安装,可参考这里

      yum -y install gcc-c++
      yum -y install gdb (如需调试项目)

    1. python环境(含pip),要求python3以上;网上教程很多了,譬如这里;

    2. 安装python依赖;本项目依赖比较少了,主要requests, flask;

      pip3 install requests flask;

    3. 编译生成公共模块库libhocomm.so,即执行

      cd CppCloud/common && make;
      安装 sudo make install

    4. 编译安装cppcloud_serv; 正常的话就会输出有cppcloud_serv可执行文件。

      cd CppCloud/server && make
      安装sudo make install

    5. 编译安装c++ sdk(cpp_sdk)

      cd CppCloud/cpp_sdk && make
      sudo make install;

    6. 安装python sdk; python无需编译

      cd python_sdk; sudo make install;

    7. 安装web_py;; python无需编译

      cd web_py; sudo make install;

快速部署

  本产品可以通过docker快速部署c++部分(cppcloud_serv cpp_sdk),以及通过pip快速部署python部分(python_sdk web_py)

  • c++部分(前提是先安装docker

    本产品c++部分为方便大众开发者使用,作者已上传至dockerhub,通过以下命令获取到;
        docker pull valueho/cppcloud:1

    运行容器
        docker run -p4800:4800 -it valueho/cppcloud:1 -i <servid>
    运行容器帮助信息
        docker run -p4800:4800 -it valueho/cppcloud:1 help

  • python部分(前提是已安装pip3)

    python sdk安装一条命令完成
       pip install cppcloud
    成功后import cppcloud;无错误提示。

    web_py安装命令
       pip install cppcloud-web
    成功安装后可以使用命令cppcloud-web

应用示例

    用简单的demo,帮助开发者快速接入CppCloud,降低学习成本,主要介绍sdk的使用。

GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License.

简介

分布式微服务框架,支持多种语言sdk接入,c/c++后端确保轻量且高效,功能包括服务注册,服务发现,统一配置,消息路由等。代码开源搭配开发说明文档(http://www.cppcloud.cn),可直接应用于中小企业生产应用。 展开 收起
C++
GPL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C++
1
https://gitee.com/zhanghuahua123/CppCloud.git
git@gitee.com:zhanghuahua123/CppCloud.git
zhanghuahua123
CppCloud
CppCloud
master

搜索帮助