Skip to content

Latest commit

 

History

History
executable file
·
392 lines (300 loc) · 11.7 KB

README_CN.md

File metadata and controls

executable file
·
392 lines (300 loc) · 11.7 KB
Raw

简体中文 | English

Paozhu(炮竹🧨)是一个全面、快速的C++ web framework 开发框架，集成C++ ORM，开发速度跟脚本语言一样，日写1000行业务代码没有压力，框架集成了WebServer，自己原生解析HTTP/1、HTTP/2、JSON协议，GET、POST全部解析出来，POST几种方式都做了区分，框架自带一个OBJ微型对象，可以存放char int string float等，框架自动解析URL、POST参数到微型对象里面，使用urlpath映射到函数挂载点，使用协程、线程池、数据库链接池。

QQ群：668296235
作者也在一线写业务代码，根据经验开发本框架，如果有想法可以加群探讨或issues提问，本框架正缺人手，需要完善C++开发web生态。 controller目录是实际使用例子，还在完善中，目前框架压力测试没有什么问题。

1.特性🔥🔥🔥🔥🔥

✅ 1. 自带json编解码不用第三方库，标准json支持
✅ 2. 支持多域名网站
✅ 3. 支持多域名ssl 服务端
✅ 4. 支持http/1.1、http/2协议
✅ 5. 支持websocket服务端
✅ 6. 框架自带websocket推送，支持定时推送到webscoket客户端
✅ 7. 支持httpclient get post，同步异步、协程模式，数据采集
✅ 8. 框架自带ORM,使用链接池方式，目前支持mysql
✅ 9. 框架自带线程池，和用户代码运行的线程池
✅10. 框架使用asio自带的协程
✅11. 框架特色是I/O 使用协程池 用户代码运行使用线程池,类似GO那种调度，只是针对http请求调度
✅12. 框架支持普通文件gzip、br,并支持缓存到磁盘，下次不用cpu再压缩
✅13. URL、POST和上传文件,解析结果client.get[] client.post[] client.files[]方式获取内容
✅14. 自带sendmail类库
✅15. 生成二维码(qrcode),需要gd、qrencode库
✅16. 插件化编程，热动态更新，使用动态库方式
✅17. 框架内置通用数据缓存模块，ORM结果缓存，提高并发能力
✅18. 框架controller目录注解功能，方便添加URL路由映射，降低入门心智
✅19. 结构和类注解JSON功能，使用json_encode json_decode操作复杂C++结构体和JSON互转，可以参考Wiki
✅20. 提供一个完整admin后台管理框架（见后面图片）, 访问URL为 /admin/main
✅21. 支持PHP-FPM fastcgi运行模式，代替Apache做PHP前端，让PHP程序员平稳过渡到 C++ 开发模式

2.运行环境

  • C++ standard request c++20
  • asio mysql libmysqlclient-dev zlib brotli(br) [可选](gd qrencode)

3.环境配置

3.1MacOS

  • 系统要求：
>= BigSur
  • 安装必要库
brew install asio
brew install mysql
brew install mysql-client
brew install zlib
brew install brotli

[可选安装] brew install gd
[可选安装] brew install qrencode

3.2 Ubuntu && Fedora

  • 系统要求：
Ubuntu>= 20.04 , test on Fedora38 需要按装asan（sudo yum install libasan）

sudo apt-get install cmake
sudo apt-get install -y brotli  libbrotli-dev zlib1g-dev
sudo apt-get install libgd-dev
sudo apt-get install qrencode libqrencode-dev
sudo apt-get install openssl libssl-dev
sudo apt-get install mysql-server
sudo apt-get install mysql-common
sudo apt-get install mysql-client
sudo apt-get install libmysqlclient-dev

注意： 需要gcc11支持，安装详情请查看

3.3 Windows

支持vcpkg和xmake

xmake安装

在项目根目录 执行
配置 conf/server.conf 替换 /Users/hzq/paozhu 为你的项目目录

paozhu-main> xmake
paozhu-main> .\build\windows\x64\release\paozhu.exe

vcpkg安装

Invoke-WebRequest -OutFile vcpkg2023.zip https://github.com/microsoft/vcpkg/archive/refs/tags/2023.12.12.zip
            unzip vcpkg2023.zip
            cd vcpkg-2023.12.12
            bootstrap-vcpkg.bat
            vcpkg integrate install
            vcpkg integrate project
            vcpkg install

安装 ninja https://github.com/ninja-build/ninja/releases

编译项目 注意CMAKE_TOOLCHAIN_FILE指定vcpkg位置

unzip asio.zip
cmake . -B ${{github.workspace}} -DENABLE_WIN_VCPKG=ON -DENABLE_VCPKG=ON -DCMAKE_TOOLCHAIN_FILE=vcpkg-2023.12.12/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows -DCMAKE_BUILD_TYPE=Debug -G Ninja
cmake --build . --config Debug

4.安装方法

解压 unzip asio.zip 或 下载新版asio到项目根目录

|-vendor
|-CMakeLists.txt
|-asio
  |-asio
  |-asio.hpp

类似这样的目录结构

linux下注意目录权限

mkdir build
cd build
cmake ..
make

用于生产环境，可以编译为正式版，开-o3 优化同时编译为守护进程模式，方式如下加8个线程编译。

cmake .. -DCMAKE_BUILD_TYPE=Release
make -j8

5.hosts配置

  • 查看conf/server.conf文件中mainhost值
  • 替换 /Users/hzq/paozhu 为你的项目目录
  • 打开host文件
sudo vim /etc/hosts

在hosts文件最后一行添加(如果是www.869869.com)

127.0.0.1 www.869869.com

6.https测试

执行

sudo ./bin/paozhu

打开浏览器，在地址栏输入http://localhost 或 http://www.869869.com

更多细节请查看controller目录下源码，包含CRUD示例

7.压力测试

使用 h2load 和 ab 测试

ApacheBench test

h2load test

webbench test

8.1代码例子 Hello world

在 controller 目录 ,testhello.cpp 文件

#include "orm.h"
#include "httppeer.h"
#include "testhello.h"
namespace http
{
//@urlpath(null,hello)
std::string testhello(std::shared_ptr<httppeer> peer)
{
  httppeer &client = peer->get_peer();
  client << " Hello world! 🧨 Paozhu c++ web framework ";
	
  auto users = orm::cms::User();
  try
  {
    users.where("name","admin").fetch_one();
    if (users.getUserid() > 0)
    {
      client<<"<p>found:"<<users.data.name<<"</p>";
      return "";
    }
  }
  catch (std::exception &e)
  {
    client << "<p>" << e.what() << "</p>";
    return "";
  }
  return "";
}

}// namespace http

浏览器打开 http://localhost/hello

//@urlpath(null,hello) 为注解功能

8.2 代码例子 文章列表、搜索、分页

来源admin后台演示 controller/src/admin/articles.cpp

#include "orm.h"
#include <chrono>
#include <thread>
#include "httppeer.h"
#include "func.h"
#include "articles.h"
#include "json_reflect_headers.h"
#include "array_to_tree.h"

//@urlpath(admin_islogin,admin/listarticle)
std::string admin_listarticle(std::shared_ptr<httppeer> peer)
{
    httppeer &client = peer->get_peer();
    try
    {
        auto topicm = orm::cms::Topic();
        topicm.where("userid", client.session["userid"].to_int()).asc("parentid").fetch();

        unsigned int topicid   = client.get["topicid"].to_int();
        unsigned int page      = client.get["page"].to_int();
        std::string searchword = client.get["searchword"].to_string();
        searchword             = mb_substr(searchword, 0, 15);
        client.val["topicid"]  = topicid;

        client.val["list"].set_array();
        OBJ_ARRAY temp;

        std::map<unsigned int, std::string> topickv;
        std::vector<unsigned int> topic_id_array;//articles under this topic and sub topics

        if (topicid > 0)
        {
            topic_id_array.push_back(topicid);
        }

        for (unsigned int i = 0; i < topicm.record.size(); i++)
        {
            temp["id"]       = topicm.record[i].topicid;
            temp["parentid"] = topicm.record[i].parentid;
            temp["value"]    = topicm.record[i].title;
            client.val["list"].push(temp);

            topickv[topicm.record[i].topicid] = topicm.record[i].title;
            if (topicid > 0)
            {
                for (unsigned int j = 0; j < topic_id_array.size(); j++)
                {
                    if (topicm.record[i].parentid == topic_id_array[j])
                    {
                        topic_id_array.push_back(topicm.record[i].topicid);
                        break;
                    }
                }
            }
        }

        auto artmodel = orm::cms::Article();
        artmodel.where("userid", client.session["userid"].to_int());
        if (topicid > 0)
        {
            std::string topicid_sql_str = array_to_sql(topic_id_array);
            if (topicid_sql_str.size() > 0)
            {
                artmodel.whereIn("topicid", topicid_sql_str);
            }
        }
        if (searchword.size() > 0)
        {
            artmodel.andsub().whereLike("title", str_addslash(searchword));
            artmodel.whereOrLike("content", str_addslash(searchword)).andsub();
            client.val["searchword"] = searchword;
        }
        auto [bar_min, bar_max, current_page, total_page] = artmodel.page(page, 10, 5);

        client.val["pageinfo"].set_array();
        client.val["pageinfo"]["min"]     = bar_min;
        client.val["pageinfo"]["max"]     = bar_max;
        client.val["pageinfo"]["current"] = current_page;
        client.val["pageinfo"]["total"]   = total_page;

        artmodel.select("aid,topicid,title,createtime,sortid,isopen").desc("aid").fetch();
        client.val["alist"].set_array();
        OBJ_ARRAY tempa;

        if (artmodel.size() > 0)
        {
            for (auto &item : artmodel)
            {
                tempa["title"]     = item.title;
                tempa["aid"]       = item.aid;
                tempa["date"]      = item.createtime.substr(0, 10);
                tempa["topicname"] = topickv[item.topicid];
                tempa["sortid"]    = item.sortid;
                tempa["isopen"]    = item.isopen;
                client.val["alist"].push(tempa);
            }
        }
    }
    catch (std::exception &e)
    {
        client.val["code"] = 1;
    }
    peer->view("admin/listarticle");
    return "";
}

9.相关教程

  1. Paozhu 框架原理

  2. Paozhu 框架hello world输出

  3. Paozhu 框架ORM入门

  4. Paozhu 框架view视图入门

  5. Paozhu 框架CRUD教程

10.路线图

  • 增强http特性，主要进行HTTP/1 HTTP/2稳定性测试，抗各种黑客软件扫描
  • 用C++代码解析JSX文件进行服务器端渲染
  • 采集client框架，支持协程，多线程，协议转发
  • Websocket 客户端
  • 支持windows操作系统
  • Postgres、sqlite ORM 支持
  • 支持后端php-fpm，代替apache做前端
  • 直接解析Mysql协议，跟ORM模块无缝集成，提高性能

11.贡献👏👋

欢迎提issue互相交流，当然也欢迎大家踊跃PR

12.LICENSE

Paozhu遵循MIT 开源协议