26.1.2015

foto Petr Bravenec

Petr Bravenec
+420 777 566 384
petr.bravenec@hobrasoft.cz

Poděkování

Http server, který zde popisuji, je založený na tomto projektu, autorem je Stefan Frings:
http://stefanfrings.de/qtwebapp/index-en.html.
Tímto bych rád autorovi poděkoval.

Odkazy

Koukněte se, jak to běhá
Dokumentace
Download

Proč jiný server?

Pro jeden z našich projektů jsem hledal nějaký vhodný webový server. První nápad byl samozřejmě server QtWebapp, už s ním mám většinou dobré zkušenosti z jiného projektu: Fotobot. Ale už v prvním projektu jsem narazil na některé nepříjemné vlastnosti: parametry se v mnoha místech předávají jako reference (ač reference je skoro totéž, co odkaz, není to tak docela odkaz), server je vícevláknový a počet vláken je předem daný v konfiguračním souboru. Omezení počtu vláken dělalo občas problémy už v prvním projektu, v dalším projektu se daly očekávat problémy řádově horší.

Vyzkoušeli jsme i jiný http server, ale tam jsme na vícevláknovost a omezený počet vláken narazili taky.

Aby to nevypadalo, že mám něco proti vícevláknovým aplikacím - ne tak docela. Ale Qt je knihovna hodně orientovaná na událostní zpracování, a pokud je celá aplikace řízená událostmi, je vícevláknový web server zbytečná komplikace (je nutné začít zamykat a podobně).

Lidé na internetu opisují nápady jeden od druhého. Apache jednou ukázal cestu, které se nyní lidé drží zuby nehty, a když je Apache takto úspěšný, nelze přeci udělat chybu, když se pro další servery zvolí podobné řešení. Použitelný jednovláknový server jsme nenašli.

Naštěstí jsou tady servery jako je Nginx, Lightttpd a HobrasoftHttpd.

Požadavky na server

Embedded

Spousta našich aplikací běží v prostředí malých ARM počítačů BeagleBone. Je nesmysl psát v C++ malinké rutiny pro bitové žonglování s jednotlivými vývody procesoru a pro publikaci výsledků pak použít kombajn typu Apache a PHP. I když Apache na BeagleBone samozřejmě chodí, chceme mít celé prostředí jednoduché, včetně instalace. Ideální instalace vypadá takto:

apt-get install fotobot

Nechce se mi psát sáhodlouhé návody "Apache nakonfigureje takto: 1. apt-get... 2. cd /etc/apache2/vhost.conf... 3. vi default_vhost.conf.... 99. /etc/init.d/apache restart".

Windows

Napsat podrobný návod na instalaci si dovedu představit, pokud je cílovou skupinou zkušený linuxový administrátor nebo můj vlastní zaměstanec. Ale nedovedu si představit, že bych vyráběl produkt, který by měl poskytovat nějaké informace přes HTTP rozhraní na Windows a nemohl bych použít embedded http server. Instalace na Windows spočívá v klikání na "Další... další... další..." a přes to vlak nejede.

Neomezený počet spojení

Aplikace, které poslední dobou děláme, otevírají na každé stránce hned několik spojení a nepouštějí je. Dokud je stránka v prohlížeči aktivní, je otevřené i spojení. Deset vláken je málo - s deseti vlákny zablokuje webový server už druhý uživatel. (Neomezený počet spojení mě samozřejmě přejde - hned jak mi někdo položí server ;-)

Jednovláknový

V jednovláknové aplikaci chci používat jednovláknový http server. Více vláken vede k zamykání, kód se stává složitějším a náchylnějším k chybám - jeden chybějící mutex v kritickém místě dovede klidně shodit aplikaci, v horším případě pak i vyrobit nesmysly v datech.

Řízený událostmi

Knihovna Qt je řízená událostmi. I když psaní vícevláknových aplikací je v Qt snadné, psaní aplikací řízených událostmi je snazší. Nechci se ubírat trnitými cestami, pokud existuje asfaltka.

Jak to používat

Stačí-li vám servírovat pouze statický obsah, je použití serveru ve vašem vlastním kódu takto jednoduché:

#include 
#include "httpd.h"
using namespace HobrasoftHttpd;
int main(int argc, char *argv[]) {
    QCoreApplication app(argc, argv);
    new HttpServer(0); // Server can serve static file from current directory 
    return app.exec();
}

Konfigurace celého serveru je obsažená v samostatné třídě, načítá se z klasického objektu třídy QSettings. Pokud chcete použít jiný konfigurační soubor, můžete to udělat třeba takto:

    QSettings qsettings("/etc/http.conf", QSettings::IniFormat);
    HttpSettings settings(&qsettings, 0);
    new HttpServer(&settings,0);

Pokud potřebujete, aby vaše aplikace generovala obsah dynmaciky, musíte rozšířit třídu HttpServer a reimplementovat metodu HttpServer::requestHandler() tak, aby vracela ukazatel na váš vlastní request mapper:

#include "httpserver.h"
#include "httprequesthandler.h"
#include "myclass.h"

using namespace HobrasoftHttpd;

class RequestMapper : public HttpRequestHandler {
    Q_OBJECT
  public:
    RequestMapper(HttpConnection *parent);
    void service(HttpRequest *request, HttpResponse *response) {
        if (request->path().startsWith("/my-function")) {
            HttpRequestHandler controller = new MyClass(connection());
            controller->service(request, response);
            return;
            }
        // call default handler - static html pages, shtml pages, images, javascript, styles...
        HttpRequestHandler::service(request, response);
        }
};

class MyHttpd : public HttpServer {
    Q_OBJECT
  public:
    Httpd(QObject *parent) : QObject(parent) { }
    // The method returns pointer to new instance of your own request mapper
    // The request mapper maps requests like "/my-function" to call your own classes
    HttpRequestHandler *requestHandler(HttpConnection *connection) {
        return new RequestMapper(connection);
        }
};

Více se dočtete v dokumentaci: http://www.hobrasoft.cz/en/httpserver/doc/

Součástí balíku ke stažení je i zdokumentovaný příklad - doporučuji prostudovat třídu AbstractController a její použití. Tato třída vám dovolí snadno implementovat velmi častou třídu úloh:

  • načíst seznam objektů jedné skupiny (například seznam pokojů)
  • načíst konkrétní objekt skupiny (pokoj)
  • vytvořit, změnit nebo smazat objekt
  • hlásit změny v konkrétním objektu nebo v celé skupině

Celá třída komunikuje přes JSON, změny se předávají přes HTML5 proudy událostí.

 
 
Hobrasoft s.r.o. | Kontakt