Programmierung
•
Mar 16, 2023

Konrad Badzioch
Senior Backend-Entwickler
In diesem Artikel konzentrieren wir uns auf die Konfiguration der Hanami-Webanwendung zusammen mit der PostgreSQL-Datenbank unter Verwendung von Docker Compose.
Kürzlich habe ich begonnen, mich mit dem Hanami-Framework zu beschäftigen, dessen Version 2 vor ein paar Monaten veröffentlicht wurde. Seitdem ich Docker und Docker Compose kennengelernt habe, verwende ich sie immer wieder, weil sie mir helfen, verschiedene Dienste auf meinem Rechner auszuführen, ohne dass ich die erforderlichen Abhängigkeiten installieren muss, usw. Wenn Sie sie noch nicht kennen, empfehle ich Ihnen, sich mit ihnen vertraut zu machen. Ich finde sie sehr praktisch und möchte sie auch für die Einrichtung eines API-Dienstes verwenden, der mit einer relative Datenbank verbunden ist, in meinem Fall wird es PostgreSQL sein. Los geht's.
Zuallererst müssen wir sicherstellen, dass die Ruby-Version, die wir verwenden, mindestens die Version 3.0.0 hat. Um zu beginnen, müssen wir den hanami
gem installieren.
Sobald das erledigt ist, erstellen wir eine neue Hanami-Anwendung von Grund auf.
Dieser Prozess erstellt eine Reihe von Dateien innerhalb des Verzeichnisses, das auf den Namen der Anwendungen folgt, die wir im vorherigen Befehl angegeben haben. In meinem Fall ist es simple_api
. Nun müssen wir ein Dockerfile erstellen, um die Laufzeitumgebung für unsere Anwendung festzulegen.
Wir werden ruby:3.2.1-alpine
Image verwenden, um ein überladenes Ruby-Image zu vermeiden, aber es ist erforderlich, zwei Bibliotheken zu installieren, damit es funktioniert: build-base
und ruby-dev
. Wenn Sie mit Rails vertraut sind, kennen Sie vielleicht die Portnummer 3000, die weit verbreitet ist. Im Fall von Hanami-Anwendungen ist der Standardport 2300. Sobald das Dockerfile fertig ist, können wir ein Image
Alles sieht gut aus, also können wir in eine Docker-Kompositionsdatei springen.
Was wir hier spezifiziert haben, ist der db
-Dienst, der die PostgreSQL-Datenbank und unseren Webanwendungsserver darstellt - app
. Die Benennung der Images ist ziemlich einfach, wie Sie auch bei den Ports feststellen konnten. Wir werden die Standard-Portnummer verwenden. Ausserdem müssen wir die Umgebungsvariable POSTGRES_PASSWORD
zur Datei .env
hinzufügen, in meinem Fall: POSTGRES_PASSWORD=XYZ123QWE
.
Let’s run our containers by running
Grossartig, alles sieht gut aus, aber es gibt noch eine wichtige Sache zu tun: Wir müssen simple-api
Webserver mit Postgres verbinden. Zu Beginn fügen wir ein paar Gems zum Gemfile hinzu.
Als Nächstes müssen wir die Bibliothek postgresql-dev
zur Datei Dockerfile.dev
hinzufügen, damit sie das pg
Gem erfolgreich installieren kann. Die Zeile in der Datei sollte wie unten aussehen:
Lassen Sie uns die Container stoppen, das Image neu erstellen und die Container erneut starten. Bevor wir mit der Verbindung der API-Anwendung mit dem Datenbankserver beginnen, können wir eine Datenbank erstellen. Wir müssen eine Verbindung zu psql
auf dem Datenbankcontainer herstellen und eine SQL-Anweisung aufrufen, also:
Nun ist es an der Zeit, das Hanami-Framework selbst näher zu betrachten, denn wir müssen einen Persistenzanbieter hinzufügen. Wir sollen die folgende Datei erstellen:
Dieser target["settings"].database_url
verweist auf eine Umgebungsvariable mit DATABASE_URL
, also fügen wir DATABASE_URL=postgres://postgres:XYZ123QWE@db:5432/simple_api_development
zur .env
Datei.
Leider ist das nicht alles, wir müssen auch die Einstellung database_url
zur Klasse Settings
hinzufügen:
Nun können wir unser simple-api
-Image neu erstellen und Container neu starten.
Testing
Lassen Sie uns beweisen, dass die Verbindung hergestellt ist und wir die DB benutzen können. Wir werden eine Tabelle erstellen, Beispieldaten einfügen und versuchen, sie zu lesen. Als ersten Schritt werden wir Rake-Migrationen aktivieren, indem wir den folgenden Code an das Rakefile
anhängen.
Wir fügen alle notwendigen Codes hinzu und erstellen dann das simple-api
Image neu.
Eine Migration zur Tabellenerstellung
und eine Beziehung
Sobald dies abgeschlossen ist, können wir das Image neu erstellen und die Container neu starten. Dann können wir uns mit einer Shell auf dem app
Container verbinden, indem wir docker-compose exec app sh
aufrufen. Wir müssen Migrationen durchführen, indem wir das Bundle bundle exec rake db:migrate
ausführen. Dann hanami console
und app["persistence.rom"].relations[:books].insert(title: 'The Alloy of Law', author: 'Brandon Sanderson')
. Das Einfügen der Daten selbst zeigt uns, dass die Verbindung funktioniert, aber lassen Sie uns versuchen, Daten zu lesen: app["persistence.rom"].relations[:books].to_a
.
Voilà! Wir haben die Hanami-Anwendung mit der PostgreSQL-Datenbank verbunden. Weitere Informationen finden Sie im Hanami 2.0 Getting Started Guide.
✍️
ÜBER DEN AUTOR

Konrad Badzioch
Senior Backend-Entwickler
Programmieren ist mein Beruf sowie mein Hobby. Ausserdem liebe ich Fantasy-Bücher, Radfahren und viele, viele andere Dinge. Ein produktiver Tag macht mich glücklich und gibt mir Energie für den nächsten Tag.