# WebKish
-------
WebKish是一个运行在Linux系统上基于现代C++11标准的一个natvie高性能多线程并发服务器框架,代码的编写采用面向对象设计方式,每一个连接对应一个handler,并且handler自己管理着文件描述符的生命周期,断开连接会自动关闭该文件描述符,该框架既可以用作tcp服务器也可以用作http服务器。
其核心来自于Linux2.6之后新增的系统调用epoll,当然也可以实现select和poll版本的poller,继承即可。
WebKish拥有完善的异步日志系统,在Apple mini M1版的parallels Desktop虚拟机安装的Fedora操作系统中(2个CPU核心),并发写入500W条数据用了不到2s的时间,思路借鉴了[linyacool](https://github.com/linyacool/WebServer)。
整个项目的核心框架借鉴了开源的web服务框架:[muduo](https://github.com/chenshuo/muduo), 所以该框架是响应式的,并且CPU占用率很小,但不影响它的高并发和高性能,编写更加简洁更加完善,自己也封装了Linux的pthread库,以及实现了一个简单版本的线程池。
http服务器有一个同步的loop timer,每隔一定的时间会检查连接队列的最新心跳时间,如果设置了timeout,将会根据timeout来进行过期淘汰,keep-alive将保持永久连接,除非对端主动断开,而一次性的请求将会被直接移除,间隔检查时间暂时设置为10ms,可以在服务器启动前自己更改。
http报文的解析采用了开源库[llhttp](https://github.com/nodejs/llhttp), 并对该库做了一个较为完善的封装,该部分花了我不少的精力。
## 安装webkish组件
### 必要库
因为webkih包含对mysql的API封装,所以请确保你有mysql的API库:mariadb库,以及pthread库
> mariadb库的安装:以我的fedora为例
>
> ```bash
> sudo yum install -y community-mysql
> sudo yum install -y community-mysql-server
> sudo yum install -y mysql-devel
> ```
>
> 可以使用:
>
> ```bash
> mysql_config --flags --libs
> ```
>
> 查看mysql的devel库安装成功了没
Webkish-0.0.1-release版本已经基本实现了http常见的功能,所以安装webkish请使用0.0.1的TAG:
![tag](readme-images/tag-0.0.1.png)
1. 首先git clone仓库到你要运行的Linux机器上:
```bash
git clone https://github.com/Kish29/WebKish.git
```
2. 进入WebKish目录
```bash
cd WebKish
```
3. 切换到0.0.1分支
```bash
git checkout 0.0.1
```
4. 将build- release目录下的三个文件移动到WebKish工程的根目录
```bash
mv build-release/install.kish build-release/CMakeLists.txt build-release/webkish.pc.in .
```
5. 然后使用bash脚本安装即可,记得需要root权限才能将头文件和动态库安装到usr/local目录下
```bash
sudo bash install.kish
```
![install-kish](readme-images/install-kish.png)
可以看到lib库在64位机子上安装到了/usr/local/lib64/kish,32位应该是/usr/local/lib/kish,而头文件默认是/usr/local/include/kish
install成功后,/usr/local/lib64/kish路径(32位应该是:usr/local/lib/kish,)下会有三个动态连接库
```bash
libkish.so libksql.so libthird_pt.so
```
## 接入开发
如果你是cmake工程,使用target_link_libraries链接这三个动态库即可:
![need-so](readme-images/need-so.png)
WebKish的http接入很简单,只需要包含 "kish/http_server.h"用于创建http服务器,然后包含"kish/http_interface.h"这个头文件,用于实现请求接口,http_interface.h文件中定义了两个接口:
![http-interface](readme-images/http-interface.png)
### 各举一个例子
1. 比如我要实现一个静态文件的resolver,表示请求的都是一些文件,把这些文件信息返回给客户端:
```c++
// 首先该类继承自http_resolver类:
#include "http_interface.h"
class example_files_resolver : public kish::http_resolver {
public:
// src_dir 表示目录的前缀
explicit example_files_resolver(const char *src_dir) : file_src_dir(src_dir) {}
bool can_resolve(const string &uri) override;
void on_request(const kish::http_request_ptr &, kish::http_response &response) override;
private:
const string file_src_dir;
string curr_file_mime_type{MIME_T_TXT};
};
// 然后实现这两个方法
bool example_files_resolver::can_resolve(const string &uri) {
if (!file_reader) {
file_reader = new kish::file_wrapper();
}
if (file_reader) {
// 首先判断本路径下该文件是否存在
string target_file(file_src_dir);
// 拼接文件完整路径
target_file.append("/");
if (uri == "/") { // 如果是根目录,默认打开index.html
target_file.append("index.html");
} else {
target_file.append(uri);
}
if (file_reader->open(target_file.c_str(), kish::READONLY)) {
// 记录当前文件的类型
curr_file_mime_type = get_file_mime_type(target_file.c_str());
return true; // 返回true,表示能够解析该uri请求
} else {
return false; // 返回false,表示解析失败,不能接受该请求
}
} else return false;
}
// 如果can_resolve返回false,该方法是不会被调用的
void example_files_resolver::on_request(const kish::http_request_ptr &, kish::http_response &response) {
...
// 读取文件数据
flen = file_reader->read_unlock(fbuf, file_size);
// response的contents是body数据
response.contents.emplace_back(string(fbuf, flen));
// 设置内容的类型,比如文本、html、图片,不设置默认是文本格式
response.set_content_type(curr_file_mime_type);
// 设置内容长度
response.headers.insert(std::make_pair("Content-Length", std::to_string(flen)));
// 关闭文件
file_reader->close();
...
}
```
2. 如果我想实现接口的请求,请实现http_interface类:
```c++
#include "http_interface.h"
using namespace kish;
class example_users_interface : public kish::http_interface {
public:
void on_reg_in(http_interface_holder &holder) override;
void user_login(const http_request_ptr &request, http_response &response);
void user_regis(const http_request_ptr &request, http_response &response);
private:
size_t login_times{0};
size_t reg_times{0};
};
// on_reg_in方法会在reg_http_interface的时候调用,所以在这时候
// 注册我们要实现的方法,传入uri,接口,请求方法的类型
void example_users_interface::on_reg_in(http_interface_holder &holder) {
holder.regin("/users/login", infc_type_t{
.infc = std::bind(&example_users_interface::user_login, this, std::placeholders::_1, std::placeholders::_2),
.method = HTTP_POST});
holder.regin("/users/reg", infc_type_t{
.infc = std::bind(&example_users_interface::user_regis, this, std::placeholders::_1, std::placeholders::_2),
.method = HTTP_POST});
}
void example_users_interface::user_login(const http_request_ptr &request, http_response &response) {
login_times++;
response.update_stat(200);
response.contents.emplace_back("登陆成功");
response.set_content_type_with_charset(MIME_T_TXT);
}
void example_users_interface::user_regis(const http_request_ptr &request, http_response &response) {
reg_times++;
// 获取请求的内容类型
const string &type = request->get_content_type();
// 如果是json格式
if (type == MIME_A_JSON) {
// 注意!所有的强制转化,必须要进行异常catch,否则强转失败抛出异常导致本线程异常退出!
try {
// 将参数转化为json对象
auto param_json = (CJsonObject) request->get_param(http_message::JSON_PARAM);
string password;
// 获取value
param_json.Get("password", password);
printf("password: %s\
没有合适的资源?快使用搜索试试~ 我知道了~
linux项目工程资料-上基于现代C++11标准的一个natvie高性能多线程并发服务器框架.zip
共118个文件
h:49个
cpp:40个
png:16个
0 下载量 79 浏览量
2024-02-24
10:28:59
上传
评论
收藏 3.1MB ZIP 举报
温馨提示
Linux项目是一个开放源代码的操作系统项目,由林纳斯·托瓦兹(Linus Torvalds)于1991年首次发布。该项目以Linux内核为核心,围绕其构建了一个完整的操作系统,包括各种系统工具、库、应用程序和硬件支持。 以下是Linux项目的一些主要特点和资料介绍: 开放源代码:Linux项目的所有源代码都是公开的,并允许任何人自由使用和修改。这为开发者提供了极大的灵活性和创新能力,同时也促进了全球范围内的协作和发展。 跨平台性:Linux操作系统可以在多种硬件架构和平台上运行,包括x86、ARM、MIPS等。这使得Linux成为了一种非常灵活的操作系统,适用于各种设备和应用场景。 可定制性:由于Linux的源代码是公开的,用户可以根据自己的需求进行定制和修改。这使得Linux成为了一种非常适合企业级应用的操作系统,可以根据企业的特定需求进行定制和优化。 安全性:Linux操作系统在安全性方面表现出色,具有强大的访问控制和安全机制。这使得Linux成为了一种非常适合用于服务器和安全敏感的应用场景的操作系统。
资源推荐
资源详情
资源评论
收起资源包目录
linux项目工程资料-上基于现代C++11标准的一个natvie高性能多线程并发服务器框架.zip (118个子文件)
llhttp.c 427KB
cJSON.c 28KB
api.c 9KB
multipart_parser.c 8KB
http.c 4KB
CJsonObject.cpp 110KB
http_parser.cpp 10KB
logger.cpp 8KB
http_handler.cpp 6KB
socket.cpp 5KB
sysio_utils.cpp 4KB
log_stream.cpp 4KB
epoll_poller.cpp 4KB
mysql_proxy.cpp 3KB
thread.cpp 3KB
file_wrapper.cpp 3KB
http_request.cpp 3KB
tcp_server.cpp 3KB
kish_utils.cpp 3KB
thread_pool.cpp 3KB
example_users_interface.cpp 2KB
http_server.cpp 2KB
inet_address.cpp 2KB
example_files_resolver.cpp 2KB
http_message.cpp 2KB
event_looper.cpp 2KB
timer.cpp 2KB
http_transform.cpp 2KB
tcp_handler.cpp 2KB
time_stamp.cpp 2KB
accept_handler.cpp 1KB
looper_pool.cpp 1KB
mysql_conn_pool.cpp 1KB
http_interface.cpp 1KB
http_response.cpp 1KB
server_config.cpp 1KB
epoll_handler.cpp 1KB
example_webserver.cpp 720B
file_writer.cpp 699B
wakeup_handler.cpp 665B
fdholder.cpp 201B
select_poller.cpp 107B
netio_utils.cpp 106B
poll_poller.cpp 105B
list_map.cpp 103B
.gitignore 66B
llhttp.h 15KB
http_parser.h 8KB
cJSON.h 6KB
http_message.h 5KB
list_map.h 4KB
http_response.h 3KB
sync.h 3KB
epoll_poller.h 3KB
base.h 3KB
http_request.h 3KB
kish_utils.h 3KB
http_handler.h 2KB
epoll_handler.h 2KB
socket.h 2KB
logger.h 2KB
file_wrapper.h 2KB
thread.h 2KB
http_interface.h 2KB
sized_buffer.h 2KB
sql_proxy.h 2KB
log_stream.h 1KB
thread_pool.h 1KB
multipart_parser.h 1KB
timer.h 1KB
mysql_conn_pool.h 1KB
event_looper.h 1KB
http_transform.h 1KB
server_config.h 1KB
http_server.h 1KB
tcp_server.h 1KB
inet_address.h 1KB
mysql_proxy.h 956B
sysio_utils.h 900B
time_stamp.h 863B
looper_pool.h 820B
accept_handler.h 815B
wakeup_handler.h 772B
netio_utils.h 737B
poller.h 690B
example_files_resolver.h 623B
example_users_interface.h 619B
fdholder.h 568B
select_poller.h 565B
poll_poller.h 552B
event_handler.h 484B
tcp_handler.h 463B
file_writer.h 460B
http_heart_check.h 440B
server.h 428B
CJsonObject.hpp 8KB
webkish.pc.in 341B
install.kish 536B
LICENSE-MIT 1KB
README.md 10KB
共 118 条
- 1
- 2
资源评论
妄北y
- 粉丝: 2w+
- 资源: 1万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
- 莱斯衰落信道下面向虚拟现实应用的无人机 MEC 系统的延迟优化matlab代码.rar
- 利用MATLAB中的固定铂工具箱在定点扩展卡尔曼滤波器仿真.rar
- 利用测量参数的相关性改进的扩展卡尔曼滤波器的Matlab实现.rar
- 历元基音估计Matlab代码.rar
- 利用六种(SO2、NO2、CO、O3、PM10、PM2.5)污染物浓度数据计算空气质量AQI值 Matlab代码.rar
- 粒子滤波算法Matlab实现.rar
- 路径和轨迹规划:同时定位和建图:(EKF,FAST) 和控制系统:(LQG,MPC)Matlab代码.rar
- 模拟高斯光束的三维光强分布,以及峰值分布 matlab代码.rar
- 美国五大湖多边形Matlab代码.rar
- 凸轮搬运机械手装置3D图纸和工程图机械结构设计图纸和其它技术资料和技术方案非常好100%好用.zip
- 漂移扩散不足以作为决策模型 matlab代码.rar
- 漂移扩散近似中基本半导体方程的模拟器工具 matlab代码.rar
- yolo-world官方代码,预测 + 训练
- 华为CD32的键盘指纹驱动
- week4_answer.py
- flask+mysql+html+CSS原生sql实现的超市配货管理
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功