שירותי מיקרו ב-C++. בדיה או מציאות?

במאמר זה אדבר על איך יצרתי תבנית (Cookiecutter) והגדרתי סביבה לכתיבת שירות REST API ב-C++ באמצעות docker/docker-compose ומנהל החבילות של conan.

במהלך ההאקתון הבא, בו השתתפתי כמפתח אחורי, עלתה השאלה במה להשתמש כדי לכתוב את המיקרו-שירות הבא. כל מה שנכתב עד כה נכתב על ידי שלי ושלי חָבֵר ב-Python, מכיוון שעמיתי היה מומחה בתחום זה ופיתח גב-אנדים מקצועי, בעוד שבדרך כלל הייתי מפתח מערכות משובצות וכתבתי ב-C++ הנהדר והנורא, ובדיוק למדתי Python באוניברסיטה.

לכן, עמדה בפנינו המשימה של כתיבת שירות בעומס גבוה, שעיקר המשימה שלו הייתה לעבד מראש את הנתונים המגיעים אליו ולכתוב אותם למסד הנתונים. ואחרי הפסקת עשן נוספת, חבר הציע לי, כמפתח C++, לכתוב את השירות הזה באמצעות המקצוענים. בטענה שזה יהיה מהיר יותר, פרודוקטיבי יותר, ובאופן כללי, חבר המושבעים ישמח מהאופן שבו אנחנו יודעים לנהל את משאבי הצוות. על כך עניתי שמעולם לא עשיתי דברים כאלה ב-C++ ויכולתי בקלות להקדיש את 20+ השעות הנותרות לחיפוש, הידור וקישור ספריות מתאימות. במילים פשוטות, השתחררתי. זה מה שהחלטנו והשלמנו הכל בפייתון בשלווה.

כעת, במהלך הבידוד העצמי הכפוי, החלטתי להבין כיצד לכתוב שירותים ב-C++. הדבר הראשון שצריך לעשות היה להחליט על ספרייה מתאימה. הבחירה שלי נפלה על POCO, שכן הוא נכתב בסגנון מונחה עצמים והתהדר גם בתיעוד רגיל. כמו כן, עלתה השאלה לגבי בחירת מערכת הרכבה. עד לנקודה זו עבדתי רק עם Visual Studio, IAR ו-makefiles חשופים. ואף אחת מהמערכות הללו לא מצאה חן בעיניי, מכיוון שתכננתי להפעיל את כל השירות במיכל דוקר. ואז החלטתי לנסות להבין cmake ומנהל חבילות מעניין קונאן. מנהל החבילות הזה אפשר לך לרשום את כל התלות בקובץ אחד

conanfile.txt
[דורש]poco/1.9.3
libpq/11.5

[גנרטורים] cmeke

ועם פקודה פשוטה "conan install ." להתקין את הספריות הדרושות. מטבע הדברים, היה צורך גם לבצע שינויים ב

CMakeLists.txt

include(build/conanbuildinfo.cmake)
conan_basic_setup()
target_link_libraries(<target_name> ${CONAN_LIBS})

לאחר מכן, התחלתי לחפש ספרייה לעבודה עם PostgreSQL, מכיוון שזו הייתה הספרייה שאיתה היה לי ניסיון מועט בעבודה, והיא גם זו ששירותי Python שלנו יצרו איתה אינטראקציה. ואתה יודע מה למדתי? זה ב-POCO! אבל conan לא יודע שזה ב-POCO ולא יודע איך לבנות את זה, יש קובץ קונפיגורציה מיושן במאגר (כבר כתבתי על השגיאה הזו ליוצרי POCO). זה אומר שתצטרך לחפש ספרייה אחרת.

ואז הבחירה שלי נפלה על ספרייה פחות פופולרית libpg. והיה לי מזל מדהים, זה כבר היה בקונאן ואפילו היה בהרכבה והרכבה.

השלב הבא היה לכתוב תבנית שירות שיכולה לעבד בקשות.
עלינו לרשת את המחלקה TemplateServerApp שלנו מ-Poco::Util::ServerApplication ולעקוף את השיטה הראשית.

TemplateServerApp

#pragma once

#include <string>
#include <vector>
#include <Poco/Util/ServerApplication.h>

class TemplateServerApp : public Poco::Util::ServerApplication
{
    protected:
        int main(const std::vector<std::string> &);
};

int TemplateServerApp::main(const vector<string> &)
{
    HTTPServerParams* pParams = new HTTPServerParams;

    pParams->setMaxQueued(100);
    pParams->setMaxThreads(16);

    HTTPServer s(new TemplateRequestHandlerFactory, ServerSocket(8000), pParams);

    s.start();
    cerr << "Server started" << endl;

    waitForTerminationRequest();  // wait for CTRL-C or kill

    cerr << "Shutting down..." << endl;
    s.stop();

    return Application::EXIT_OK;
}

בשיטה הראשית עלינו להגדיר את הפרמטרים: יציאה, מספר השרשורים וגודל התור. והכי חשוב, עליך לציין מטפל לבקשות נכנסות. זה נעשה על ידי יצירת מפעל

TemplateRequestHandlerFactory

class TemplateRequestHandlerFactory : public HTTPRequestHandlerFactory
{
public:
    virtual HTTPRequestHandler* createRequestHandler(const HTTPServerRequest & request)
    {
        return new TemplateServerAppHandler;
    }
};

במקרה שלי, זה פשוט יוצר את אותו מטפל בכל פעם - TemplateServerAppHandler. זה המקום שבו אנחנו יכולים למקם את ההיגיון העסקי שלנו.

TemplateServerAppHandler

class TemplateServerAppHandler : public HTTPRequestHandler
{
public:
    void handleRequest(HTTPServerRequest &req, HTTPServerResponse &resp)
    {
        URI uri(req.getURI());
        string method = req.getMethod();

        cerr << "URI: " << uri.toString() << endl;
        cerr << "Method: " << req.getMethod() << endl;

        StringTokenizer tokenizer(uri.getPath(), "/", StringTokenizer::TOK_TRIM);
        HTMLForm form(req,req.stream());

        if(!method.compare("POST"))
        {
            cerr << "POST" << endl;
        }
        else if(!method.compare("PUT"))
        {
            cerr << "PUT" << endl;
        }
        else if(!method.compare("DELETE"))
        {
            cerr << "DELETE" << endl;
        }

        resp.setStatus(HTTPResponse::HTTP_OK);
        resp.setContentType("application/json");
        ostream& out = resp.send();

        out << "{"hello":"heh"}" << endl;
        out.flush();
    }
};

יצרתי גם תבנית כיתה לעבודה עם PostgreSQL. לביצוע SQL פשוט, כמו יצירת טבלה, יש שיטה ExecuteSQL(). עבור שאילתות מורכבות יותר או אחזור נתונים, תצטרך להשיג חיבור באמצעות GetConnection() והשתמש בממשק ה-API של libpg. (אולי אחר כך אתקן את העוול הזה).

מסד נתונים

#pragma once

#include <memory>
#include <mutex>
#include <libpq-fe.h>

class Database
{
public:
    Database();
    std::shared_ptr<PGconn> GetConnection() const;
    bool ExecuteSQL(const std::string& sql);

private:
    void establish_connection();
    void LoadEnvVariables();

    std::string m_dbhost;
    int         m_dbport;
    std::string m_dbname;
    std::string m_dbuser;
    std::string m_dbpass;

    std::shared_ptr<PGconn>  m_connection;
};

כל הפרמטרים לחיבור למסד הנתונים נלקחים מהסביבה, לכן צריך גם ליצור ולהגדיר את קובץ ה-.env

.v

DATABASE_NAME=template
DATABASE_USER=user
DATABASE_PASSWORD=password
DATABASE_HOST=postgres
DATABASE_PORT=5432

אתה יכול לראות את כל הקוד ב github.

ועכשיו מגיע השלב האחרון של כתיבת ה- dockerfile ו- docker-compose.yml. למען האמת, זה לקח את רוב הזמן, ולא רק בגלל שאני נוב, כי היה צורך לבנות מחדש את הספריות בכל פעם, אלא בגלל המלכודות של קונאן. לדוגמה, כדי ש-conan יוכל להוריד, להתקין ולבנות את התלות הנדרשת, זה לא מספיק כדי להוריד את "conan install .", הוא צריך גם להעביר את הפרמטר -s compiler.libcxx=libstdc++11, אחרת אתה מסתכן בקבלת שלל שגיאות בשלב הקישור של היישום שלך. אני תקוע עם השגיאה הזו כבר כמה שעות ואני מקווה שמאמר זה יעזור לאנשים אחרים לפתור את הבעיה בפחות זמן.

לאחר מכן, לאחר שכתבתי docker-compose.yml, בעצת חברי, הוספתי תמיכה חותכן עוגיות ועכשיו אתה יכול להשיג לעצמך תבנית מלאה עבור שירות REST API ב-C++, עם סביבה מותאמת, ו-PostgreSQL מותקן, פשוט על ידי הזנת "Cookiecutter" בקונסולה https://github.com/KovalevVasiliy/cpp_rest_api_template.git" ואז "דוקר-compose up - build".

אני מקווה שהתבנית הזו תעזור למתחילים בדרך הקשה שלהם לפיתוח יישומי REST API בשפה הנהדרת והחזקה, אבל כל כך מגושמת כמו C++.
כמו כן, אני ממליץ בחום לקרוא כאן זה מאמר. הוא מסביר ביתר פירוט כיצד לעבוד עם POCO ולכתוב שירות REST API משלך.

מקור: www.habr.com