2 ENG 09 0 References request

ProTankerAlfa edited this page 2024-05-30 04:17:24 -03:00

Table of Contents

• isOnSecureConnection()
• Summary:
• Inputs:
• Returns:
• getMethod()
• Summary:
• Inputs:
• Returns:
• Examples:
• getParameter(const std::string &key)
• Summary:
• Inputs:
• Returns:
• Examples:
• getPath()
• Similar:
• Summary:
• Inputs:
• Returns:
• Examples:
• getBody()
• Similar:
• Summary:
• Inputs:
• Returns:
• getHeader(std::string key)
• Summary:
• Inputs:
• Returns:
• Examples:
• headers()
• Summary:
• Inputs:
• Returns:
• Examples:
• getCookie()
• Summary:
• Inputs:
• Returns:
• cookies()
• Summary:
• Inputs:
• Returns:
• Examples:
• getJsonObject()
• Summary:
• Inputs:
• Returns:
• Examples:
• Useful Things
• From here are not methods of the Http Request object, but some useful things you can do to process the requests you will receive
• Parsing File Request
• Next: Plugins

The HttpRequest type pointer commonly named req in the examples in this documentation represents the data contained in a request received or sent by drogon, below are the some methods by which you can interact with this object:

• isOnSecureConnection()

  Summary:

  Function that returns if the request was made on https.

  Inputs:

  None.

  Returns:

  bool type.

• getMethod()

  Summary:

  Function that returns the request method. Useful to differentiate the request method if a single handle allows more than one type.

  Inputs:

  None.

  Returns:

  HttpMethod request method object.

  Examples:

  #include "mycontroller.h"
  
  using namespace drogon;
  
  void mycontroller::anyhandle(const HttpRequestPtr &req, std::function<void (const HttpResponsePtr &)> &&callback) {
      if (req->getMethod() == HttpMethod::Get) {
        // do something
      } else if (req->getMethod() == HttpMethod::Post) {
        // do other something
      }
  }
  

• getParameter(const std::string &key)

  Summary:

  Function that returns the value of a parameter based on an identifier. The behavior changes based on the Get or Post request type.

  Inputs:

  string type identifier of param.

  Returns:

  param content on string format.

  Examples:

  On Get type:

  #include "mycontroller.h"
  #include <string>
  
  using namespace drogon;
  
  void mycontroller::anyhandle(const HttpRequestPtr &req, std::function<void (const HttpResponsePtr &)> &&callback) {
      // https://mysite.com/an-path/?id=5
      std::string id = req->getParameter("id");
      // or 
      long id = std::strtol(req->getParameter("id"));
  }
  

  Or On Post type:

  #include "mycontroller.h"
  #include <string>
  
  using namespace drogon;
  
  void mycontroller::loginHandle(const HttpRequestPtr &req, std::function<void (const HttpResponsePtr &)> &&callback) {
      // request contain a Form Login
      std::string email = req->getParameter("email");
  
      std::string password = req->getParameter("password");
  }
  

• getPath()

  Similar:

  path()

  Summary:

  Function that returns the request path. Useful if you use an ADD_METHOD_VIA_REGEX or other type of dynamic URL in the controller.

  Inputs:

  None.

  Returns:

  string representing the request path.

  Examples:

  #include "mycontroller.h"
  #include <string>
  
  using namespace drogon;
  
  void mycontroller::anyhandle(const HttpRequestPtr &req, std::function<void (const HttpResponsePtr &)> &&callback) {
      // https://mysite.com/an-path/?id=5
      std::string url = req->getPath();
  
      // url = /an-path/
  }
  

• getBody()

  Similar:

  body()

  Summary:

  Function that returns the request body content (if any).

  Inputs:

  None.

  Returns:

  String representing the request body (if any).

• getHeader(std::string key)

  Summary:

  Function that returns a request header based on an identifier.

  Inputs:

  String header identifier.

  Returns:

  The content of the header in string format.

  Examples:

  #include "mycontroller.h"
  #include <string>
  
  using namespace drogon;
  
  void mycontroller::anyhandle(const HttpRequestPtr &req, std::function<void (const HttpResponsePtr &)> &&callback) {
      if (req->getHeader("Host") != "mysite.com") {
        // return http 403 
      }
  }
  

• headers()

  Summary:

  Function that returns all headers of a request.

  Inputs:

  None.

  Returns:

  An unordered_map containing the headers.

  Examples:

  #include "mycontroller.h"
  #include <unordered_map>
  #include <string>
  
  using namespace drogon;
  
  void mycontroller::anyhandle(const HttpRequestPtr &req, std::function<void (const HttpResponsePtr &)> &&callback) {
      for (const std::pair<const std::string, const std::string> &header : req->headers()) {
        auto header_key = header.first;
        auto header_value = header.second;
      }
  }
  

• getCookie()

  Summary:

  Function that returns request cookie based on an identifier.

  Inputs:

  None.

  Returns:

  Value of cookie on string format.

• cookies()

  Summary:

  Function that returns all cookies of a request.

  Inputs:

  None.

  Returns:

  An unordered_map containing the cookies.

  Examples:

  #include "mycontroller.h"
  #include <unordered_map>
  #include <string>
  
  using namespace drogon;
  
  void mycontroller::anyhandle(const HttpRequestPtr &req, std::function<void (const HttpResponsePtr &)> &&callback) {
      for (const std::pair<const std::string, const std::string> &header : req->cookies()) {
        auto cookie_key = header.first;
        auto cookie_value = header.second;
      }
  }
  

• getJsonObject()

  Summary:

  Function that converts the body value of a request into a Json object (normally POST requests).

  Inputs:

  None.

  Returns:

  A Json object.

  Examples:

  #include "mycontroller.h"
  
  using namespace drogon;
  
  void mycontroller::anyhandle(const HttpRequestPtr &req, std::function<void (const HttpResponsePtr &)> &&callback) {
      // body = {"email": "test@gmail.com"}
      auto jsonData = *req->getJsonObject();
  
      std::string email = jsonData["email"].asString();
  }
  

Useful Things

From here are not methods of the Http Request object, but some useful things you can do to process the requests you will receive

Parsing File Request

#include "mycontroller.h"

using namespace drogon;

void mycontroller::postfile(const HttpRequestPtr &req, std::function<void (const HttpResponsePtr &)> &&callback) {
    // Only Post Requests (File Form)

    MultiPartParser file;
    file.parse(req);

    if (file.getFiles().empty()) {
      // Not Files Found
    }

    // Get First file and save then
    const HttpFile archive = file.getFiles()[0];
    archive.saveAs("/tmp/" + archive.getFileName());
  }

For more information about parsing file: File Handler

Next: Plugins

Document

Tutorial

• Overview
• Install drogon
  • System Requirements
  • Library Dependencies
  • System Preparation Examples
    • Ubuntu
    • CentOS
    • MacOS
    • Windows
  • Database Environment
    • PostgreSQL
    • MySQL
    • SQLite3
    • Redis
  • Drogon Installation
    • Install by source in Linux
    • Install by source in Windows
    • Install by vcpkg in Windows
    • Use Docker Image
    • Use Nix Package
    • Use CPM.cmake
    • Include drogon source code locally
• Quick Start
  • Static Site
  • Dynamic Site
• Controller
  • HttpSimpleController
  • HttpController
    • Path Mapping
    • Parameter Mapping
    • Multiple Path Mapping
    • Regular Expressions Mapping
  • WebSocketController
    • Path Mapping
    • Interface
• Middleware and Filter
  • Build-in Middleware/Filter
  • Custom Middleware/Filter
• View
  • Drogon's CSP
  • Automated processing of csp files
  • Dynamic compilation and loading of views
• Session
• Database
  • DbClient
    • Execution Interface
      • execSqlAsync
      • execSqlAsyncFuture
      • execSqlSync
      • operator<<
  • Transaction
  • ORM
    • Model Class Interface
    • Mapper Class Template
    • Criteria
    • Mapper's Chain Interface
    • Convert
    • Relationships
      • has one
      • has many
      • many to many
  • FastDbClient
  • Automatic batch mode
• References
  • Request References
  • File Handler
• Plugins
• Configuration File
• drogon_ctl Command
• AOP
• Benchmarks
• Coz profiling
• Brotli info
• Coroutines
• Redis
• Testing Framework
• FAQ
  • Understanding drogon's threading model

中文文档

教程

• 概述
• 安装 drogon
  • 系统要求
  • 依赖库
  • 系统准备范例
    • Ubuntu
    • CentOS
    • MacOS
    • Windows
  • 数据库环境
    • PostgreSQL
    • MySQL
    • SQLite3
    • Redis
  • 安装 drogon
    • Linux源码安装
    • Windows源码安装
    • Windows vcpkg安装
    • 使用docker镜像
    • 使用Nix包
    • 使用CPM.cmake
    • 直接包含drogon源码
• 快速开始
  • 静态网站
  • 动态网站
• 控制器
  • HttpSimpleController
  • HttpController
    • 路径映射
    • 参数映射
    • 多路径映射
    • 正则表达式映射
  • WebSocketController
    • 路径映射
    • 接口
• 中间件和过滤器
  • 内置中间件/过滤器
  • 自定义中间件/过滤器
• 视图
  • Drogon的csp
  • csp文件的自动化处理
  • 视图的动态编译和加载
• 会话
• 数据库
  • DbClient
    • 执行接口
      • execSqlAsync
      • execSqlAsyncFuture
      • execSqlSync
      • operator<<
  • 事务
  • ORM
    • Model类的接口
    • Mapper类模板
    • 条件对象
    • Mapper 的链式接口
    • 转换
    • 关系
      • has one
      • has many
      • many to many
  • FastDbClient
  • 自动批处理模式
• 插件
• 配置文件
• drogon_ctl命令
• AOP面向切面编程
• 性能测试
• 协程
• Redis
• 测试框架
• FAQ
  • drogon的线程模型