Paozhu 炮竹

📚 框架简介 📚 Framework Introduction

💻 Hello World 示例 💻 Hello World Example

📦 项目完整源码已开源，欢迎访问 GitHub: https://github.com/hggq/paozhu 获取全部源码与示例 📦 The full source code is open source. Visit GitHub: https://github.com/hggq/paozhu for all source code and examples

仅需几行代码即可创建一个 Web 接口 testhello.cpp 文件 放在 controller/src 目录下面 Create a web endpoint with just a few lines of code, testhello.cpp in controller/src directory

#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 ";
    return "";
}
}// namespace http

无需编写 testhello.h 文件，框架自动生成这个文件，直接编译 No need to write the testhello.h file, the framework will automatically generate it, Directly compile by running

mkdir build
cd build 
cmake ..
make

📁 控制器文件必须放在 controller/src 目录下面 📁 Controller files must be placed in the controller/src directory

//@urlpath 注解自动将函数映射到 /hello 路径 //@urlpath annotation auto-maps function to /hello path

✨ 核心特色 ✨ Core Features

强大的内置功能，助你快速构建高性能 Web 应用 Powerful built-in features to help you build high-performance web apps

🔐 SSL 证书自动续期 🔐 SSL Certificate Auto-Renewal

内置 ACME 协议支持，自动申请与续期 SSL 证书，HTTPS 永不过期 Built-in ACME protocol for automatic SSL certificate issuance and renewal

; conf/server.conf ACME 配置ACME settings
acme_auto = 0             自动 SSL 证书更新Auto SSL certificate renewal
acme_every_day = 7        每天几点执行 ACMEDaily hour to run ACME
ocsp_intv_time = 14400    OCSP 更新间隔（秒）OCSP update interval (seconds)

; conf/acme.conf ACME 证书配置ACME certificate config
[info]
acme_path = ./acme        ACME 工作目录ACME working directory
cert_path = ./conf        证书存储目录Certificate storage directory
email = your@email.com    邮箱（必须）Email (mandatory)
days_remain = 10          提前多少天更新证书Renew days before expiry

[zerossl]
server_url = https://acme.zerossl.com/v2/DV90  ZeroSSL 接口ZeroSSL endpoint
eab_kid =                 EAB Key IDEAB Key ID
eab_hmac_key =            EAB HMAC KeyEAB HMAC Key
                    

💻 需求环境 💻 System Requirements

框架基于 C++20，确保你的系统支持相应的编译器 Built on C++20, ensure your compiler supports C++20 standard

🏗️ 技术架构 🏗️ Technical Architecture

框架使用 M:N 并发模型，IO 线程与业务线程分离 Uses M:N concurrency model with separated IO and business threads

+-----------------------+  +-----------------------+   +----------------------------+
| thread accept(80 443) |  | asio coroutine thread |   | thread pool(business code) |
+-----------------------+  +-----------------------+   +----------------------------+
                    

📂 项目结构 📂 Project Structure

框架未分离命令行工具独立安装，全部包含在一个项目内 Framework and CLI are bundled in a single project

.
├── asio                    asio 库文件ASIO library files
├── bin                     编译后的执行文件Compiled executables
├── cache                   缓存压缩文件Cache compressed files
├── conf                    配置文件 (server.conf, orm.conf)Config files (server.conf, orm.conf)
├── controller              路由器代码入口Router code entry
├── libs                    业务代码库Business code library
├── log                     日志目录Log directory
├── models                  ORM 业务代码ORM business code
├── module                  可插拔 SO 存放Pluggable SO storage
├── orm                     ORM 实体映射类ORM entity mapping classes
├── startup                 框架 main 入口Framework main entry
├── temp                    临时文件Temporary files
├── vendor                  主程序与第三方包Main program and third-party packages
├── view                    HTML 模板HTML templates
├── viewsrc                 编译好的视图Compiled views
├── websockets              WebSocket 程序WebSocket programs
└── www                     静态文件目录Static file directory
                    

🎯 核心特性 🎯 Core Features

强大的内置功能，助你快速构建高性能 Web 应用 Powerful built-in features to help you build high-performance web apps

📊 SVG 图表模块 📊 SVG Charts Module

Paozhu 内置强大的 SVG 图表生成库 pzcharts，支持 17 种图表类型，纯 C++ 实现，无需任何前端依赖 Paozhu includes the powerful pzcharts SVG chart library with 17 chart types, pure C++ implementation with no frontend dependencies

📖 入门完整简介 📖 Complete Introduction

从零开始，系统学习 Paozhu 框架 Systematically learn Paozhu from scratch

💻 平台安装指南 💻 Platform Installation

选择你的平台，查看详细的安装步骤 Choose your platform and view detailed installation steps