README_CN.md · zhong/paozhu

简体中文 | [English](README_EN.md)

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

QQ群：668296235  
与社区开发者探讨C++ WEB开发的乐趣

### 1.特性🔥🔥🔥🔥🔥

✅ 1. 自带json编解码不用第三方库，标准json支持  
✅ 2. 支持多域名网站  
✅ 3. 支持多域名ssl 服务端  
✅ 4. 支持http1.1、http2协议  
✅ 5. 支持websocket服务端  
✅ 6. 框架自带websocket推送，支持定时推送到webscoket客户端  
✅ 7. 支持同步httpclient get post  
✅ 8. 框架自带ORM,使用链接池方式，目前支持mysql  
✅ 9. 框架自带线程池，和用户代码运行的线程池  
✅10. 框架使用asio自带的协程  
✅11. 框架特色是I/O 使用协程池 运行使用线程池  
✅12. 框架支持普通文件gzip、br,并支持缓存到磁盘，下次不用cpu再压缩  
✅13. 框架解析URL和POST,解析结果类似PHP GET POST方式获取内容  
✅14. 集成sendmail  
✅15. 生成二维码(qrcode),需要gd、qrencode库  
✅16. 插件化编程，热动态更新，使用动态库方式  
✅17. 框架内置通用数据缓存模块，ORM结果缓存，提高并发能力  
✅18. 框架controller目录注解功能，方便添加URL路由映射

### 2.运行环境

- C++ standard request c++20
- boost asio mysql libmysqlclient-dev gd qrencode
  zlib brotli(br)

### 3.环境配置

#### 3.1MacOS

- 系统要求：

```
>= BigSur
```

- 安装必要库

```bash
brew install boost
brew install asio
brew install mysql
brew install mysql-client
brew install gd
brew install qrencode
brew install zlib
brew install brotli
```

#### 3.2Ubuntu

- 系统要求：

```
>= 20.04
```

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

- 环境配置  
  [paozhu 框架linux 环境配置](https://github.com/hggq/paozhu/wiki/linux-%E7%8E%AF%E5%A2%83%E9%85%8D%E7%BD%AE)

### 4.安装方法

```shell
mkdir temp
mkdir log
mkdir build
cd build
cmake ..
make
```

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

```shell
cmake .. -DCMAKE_BUILD_TYPE=Release
make -j8
```

### 5.hosts配置

- 查看`conf/server.conf`文件中`mainhost`值
- 替换 /Users/hzq/paozhu 为你的项目目录
- 打开host文件

```shell
sudo vim /etc/hosts
```

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

```text
127.0.0.1 www.869869.com
```

### 6.https测试

执行

```shell
sudo ./bin/paozhu 
```

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

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

### 7.相关教程

1. [Paozhu 框架原理](https://github.com/hggq/paozhu/wiki/paozhu-cpp-web-framework-%E6%A1%86%E6%9E%B6%E5%8E%9F%E7%90%86)

2. [Paozhu 框架hello world输出](https://github.com/hggq/paozhu/wiki/paozhu-%E6%A1%86%E6%9E%B6hello-world)

3. [Paozhu 框架ORM入门](https://github.com/hggq/paozhu/wiki/paozhu-%E6%A1%86%E6%9E%B6ORM%E5%85%A5%E9%97%A8)

4. [Paozhu 框架view视图入门](https://github.com/hggq/paozhu/wiki/paozhu-%E6%A1%86%E6%9E%B6view-%E8%A7%86%E5%9B%BE%E5%85%A5%E9%97%A8)

5. [Paozhu 框架CRUD教程](https://github.com/hggq/paozhu/wiki/paozhu-%E6%A1%86%E6%9E%B6-CRUD-%E6%95%99%E7%A8%8B)

### 8.路线图

* [x] 增强http特性
* [x] Websocket 客户端
* [x] 支持windows操作系统
* [x] Postgres、sqlite orm 支持

### 9.贡献👏👋

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

### 10.LICENSE

Paozhu遵循[MIT 开源协议](LICENSE)

zhong/paozhu

简介

发行版

贡献者

近期动态

zhong/paozhu .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

zhong/paozhu