2020-10-03 15:34:29 +00:00
[](https://travis-ci.com/an-tao/drogon)
2020-12-13 10:12:30 +00:00
2020-10-03 15:34:29 +00:00
[](https://ci.appveyor.com/project/an-tao/drogon/branch/master)
[](https://lgtm.com/projects/g/an-tao/drogon/alerts/)
[](https://gitter.im/drogon-web/community?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
[](https://cloud.docker.com/u/drogonframework/repository/docker/drogonframework/drogon)
[English ](./README.md ) | [简体中文 ](./README.zh-CN.md ) | 繁體中文
2020-10-06 16:20:42 +00:00
**Drogon**是一個基於C++14/17的Http應用框架，
本版本庫是github上[Drogon](https://github.com/an-tao/drogon)的鏡像庫。 **Drogon**是作者非常喜歡的美劇《冰與火之歌：權力遊戲》中的一條龍的名字(漢譯作卓耿)， ，
2020-11-15 14:59:52 +00:00
Drogon是一個跨平台框架， ， ：
2020-10-06 16:20:42 +00:00
* 網路層使用基於epoll(macOS/FreeBSD下是kqueue)的非阻塞IO框架， & hw=ph& test=composite)；
* 全異步程式設計；
* 支援Http1.0/1.1(server端和client端)；
* 基於模板(template)實現了簡單的反射機制，使主程式框架、控制器(controller)和視圖(view)完全去耦；
* 支援cookies和內建的session；
* 支援後端渲染， ， ， ，
* 支援運行期的視圖頁面動態加載(動態編譯和載入so文件)；
2020-10-03 15:34:29 +00:00
* 非常方便靈活的路徑(path)到控制器處理函數(handler)的映射方案；
2020-10-06 16:20:42 +00:00
* 支援過濾器(filter)鏈，方便在控制器之前執行統一的邏輯(如登錄驗證、Http Method約束驗證等)；
* 支援https(基於OpenSSL);
* 支援websocket(server端和client端);
* 支援Json格式的請求和回應, 方便開發Restful API;
* 支援文件下載和上傳,支援sendfile系統呼叫；
* 支援gzip/brotli壓縮傳輸；
* 支援pipelining；
* 提供一個輕量的指令列工具drogon_ctl， ；
* 非同步的讀寫資料庫，
* 基於執行序池實現sqlite3資料庫的異步讀寫， ；
* 支援ARM架構；
* 方便的輕量級ORM實現， ；
* 支援外掛，可通過設定文件在載入時動態載入；
* 支援內建插入點的AOP
2020-10-03 15:34:29 +00:00
## 一個非常簡單的例子
2020-10-06 16:20:42 +00:00
不像大多數C++框架那樣，
2020-10-03 15:34:29 +00:00
2020-10-06 16:20:42 +00:00
下面是一個典型的主程式的樣子:
2020-10-03 15:34:29 +00:00
```c++
#include <drogon/drogon.h>
using namespace drogon;
int main()
{
app().setLogPath("./")
.setLogLevel(trantor::Logger::kWarn)
.addListener("0.0.0.0", 80)
.setThreadNum(16)
.enableRunAsDaemon()
.run();
}
```
2020-10-06 16:20:42 +00:00
如果使用設定文件，可以進一步簡化成這樣:
2020-10-03 15:34:29 +00:00
```c++
#include <drogon/drogon.h>
using namespace drogon;
int main()
{
app().loadConfigFile("./config.json").run();
}
```
2020-10-06 16:20:42 +00:00
當然， ， ， ， ， ：
2020-10-03 15:34:29 +00:00
```c++
app().registerHandler("/test?username={name}",
[](const HttpRequestPtr& req,
std::function< void ( const HttpResponsePtr & ) > & & callback,
const std::string & name)
{
Json::Value json;
json["result"]="ok";
json["message"]=std::string("hello,")+name;
auto resp=HttpResponse::newHttpJsonResponse(json);
callback(resp);
},
{Get,"LoginFilter"});
```
2020-10-06 16:20:42 +00:00
這看起來是很方便， ， ， ， ， ， ， ， ， ：
2020-10-03 15:34:29 +00:00
```c++
/// The TestCtrl.h file
#pragma once
#include <drogon/HttpSimpleController.h>
using namespace drogon;
class TestCtrl:public drogon::HttpSimpleController< TestCtrl >
{
public:
virtual void asyncHandleHttpRequest(const HttpRequestPtr& req, std::function< void ( const HttpResponsePtr & ) > & & callback) override;
PATH_LIST_BEGIN
PATH_ADD("/test",Get);
PATH_LIST_END
};
/// The TestCtrl.cc file
#include "TestCtrl.h"
void TestCtrl::asyncHandleHttpRequest(const HttpRequestPtr& req,
std::function< void ( const HttpResponsePtr & ) > & & callback)
{
//write your application logic here
auto resp = HttpResponse::newHttpResponse();
resp->setBody("< p > Hello, world!< / p > ");
resp->setExpiredTime(0);
callback(resp);
}
```
2020-10-06 16:20:42 +00:00
**上面程式的大部分程式碼都可以由`drogon_ctl`指令創造**（這個指令是`drogon_ctl create controller TestCtr`） ，
2020-10-03 15:34:29 +00:00
2020-10-06 16:20:42 +00:00
對於JSON格式的回應， ：
2020-10-03 15:34:29 +00:00
```c++
/// The header file
#pragma once
#include <drogon/HttpSimpleController.h>
using namespace drogon;
class JsonCtrl : public drogon::HttpSimpleController< JsonCtrl >
{
public:
virtual void asyncHandleHttpRequest(const HttpRequestPtr & req, std::function< void ( const HttpResponsePtr & ) > & & callback) override;
PATH_LIST_BEGIN
//list path definitions here;
PATH_ADD("/json", Get);
PATH_LIST_END
};
/// The source file
#include "JsonCtrl.h"
void JsonCtrl::asyncHandleHttpRequest(const HttpRequestPtr & req,
std::function< void ( const HttpResponsePtr & ) > & & callback)
{
Json::Value ret;
ret["message"] = "Hello, World!";
auto resp = HttpResponse::newHttpJsonResponse(ret);
callback(resp);
}
```
2020-10-06 16:20:42 +00:00
讓我們更進一步， ， （ ） ：
2020-10-03 15:34:29 +00:00
```c++
/// The header file
#pragma once
#include <drogon/HttpController.h>
using namespace drogon;
namespace api
{
namespace v1
{
class User : public drogon::HttpController< User >
{
public:
METHOD_LIST_BEGIN
//use METHOD_ADD to add your custom processing function here;
METHOD_ADD(User::getInfo, "/{id}", Get); //path is /api/v1/User/{arg1}
METHOD_ADD(User::getDetailInfo, "/{id}/detailinfo", Get); //path is /api/v1/User/{arg1}/detailinfo
METHOD_ADD(User::newUser, "/{name}", Post); //path is /api/v1/User/{arg1}
METHOD_LIST_END
//your declaration of processing function maybe like this:
void getInfo(const HttpRequestPtr & req, std::function< void ( const HttpResponsePtr & ) > & & callback, int userId) const;
void getDetailInfo(const HttpRequestPtr & req, std::function< void ( const HttpResponsePtr & ) > & & callback, int userId) const;
void newUser(const HttpRequestPtr & req, std::function< void ( const HttpResponsePtr & ) > & & callback, std::string &&userName);
public:
User()
{
LOG_DEBUG < < "User constructor!";
}
};
} // namespace v1
} // namespace api
```
2020-10-06 16:20:42 +00:00
如你所見，通過`HttpController`類別， ，
2020-10-03 15:34:29 +00:00
2020-10-06 16:20:42 +00:00
另外，你可以發現前面所有的處理函數接口都是異步的，處理器的回應是通過回調對象回傳的。這種設計是出於對高性能的考慮，因為在異步模式下，可以使用少量的執行序（比如和處理器核心數相等的執行序）處理大量的並發請求。
2020-10-03 15:34:29 +00:00
2020-10-06 16:20:42 +00:00
編譯上述的所有源文件後， ， **請瀏覽[wiki](https://github.com/an-tao/drogon/wiki/CHN-01-概述)或者[doxiz](https://doxiz.com/drogon/master/overview/)以獲取更多的信息**
2020-10-03 15:34:29 +00:00
## 貢獻方式
歡迎您的貢獻。請閱讀[貢獻指南](CONTRIBUTING.md)以獲取更多的信息。
## QQ交流群：
2020-10-06 16:20:42 +00:00
歡迎交流探討。
