Dienstag, 10. Juni 2014

Open Source REST Server-Anwendung (Dropwizard - Google Guice - JPA Hibernate)

Vor ziemlich genau einem Jahr habe ich mich dazu entschieden, das Java-Webframework Dropwizard für unsere Server-Anwendung einzusetzen. Seitdem habe ich viel gelesen, viel gelernt und auch Einiges in unserer Server-Anwendung implementiert. Nun stand eine Umstellung auf die neueste Dropwizard-Version an. Diese Gelegenheit habe ich dafür genutzt, Alles nochmal "von vorne" zu entwickeln, um meine Erkenntnisse über die Anwendung zu festigen. Ich möchte die komplette Implementierung dauerhaft überblicken, verstehen und gescheit dokumentieren. Das wird anderen dabei helfen, in die Entwicklung mit einzusteigen und den Code langfristig wartbar zu halten.

Um die ganzen technischen Features der Server-Anwendung für die Allgemeinheit zur Verfügung zu stellen, habe ich eine neue Anwendung erstellt, die alleinstehend und außerhalb des Oregami-Kontextes lauffähig und sinnvoll ist und eine klassische "ToDo-Applikation" darstellt. Ihr wisst schon: eine Liste von Dingen (Name, Beschreibung, Status, ...), die man noch erledigen muss.

Die Anwendung enthält momentan die folgenden technischen Features:
  • REST-Anwendung basierend auf Dropwizard Version 0.7.0
  • Dependency Injection mit Google Guice
  • Hibernate / JPA 2.1 als Persistenz-Framework
  • HSQLDB als (In-Memory-)Datenbank
  • "Transaction-per-HTTP-request" mit Guice PersistentFilter
  • Unterstützung für cross-origin resource sharing
  • JPA Entitäten mit UUIDs als Identifikator
  • Ein Muster für den Zugriff und die Manipulation von Entitäten über REST Aufrufe
    (Ressource => Service => DataAccessObject)
  • Ein Muster für Service-Aufruf-Ergebnisse, welche Fehlermeldungen enthalten können, inkl. der Information, bei welchem Feld der Anwendung der Fehler aufgetreten ist. Auf diese Weise kann später in der Weboberfläche die Fehlermeldung an der richtigen Stelle eingeblendet werden.
  • Durchgehende JUnit-Tests zur Absicherung der korrekten Funktionalität
In möglichst naher Zukunft sollen die folgende Dinge noch hinzugefügt werden:
  • Authentifizierung
  • Hypermedia mit HATEOAS
  • komplexere Entitäten (1-zu-n-Beziehungen)

Der Sourcecode steht bei Github unter dem Namen dropwizard-guice-jpa-seed für jedermann zur Verfügung.

Disclaimer: Es kann natürlich sein, dass ihr Dinge findet, die man besser machen kann. In diesem Fall helft gerne mit, die Anwendung zu verbessern! Geht bei Github über die üblichen Pull-Requests. Das gilt natürlich auch für neue, noch fehlende Features!

Hinweise für Enwtickler

Die Anwendung kann gestartet werden über die Klasse "ToDoApplication" mit den Parametern "server todo.yml".

Auflisten der aktuell gespeicherten Tasks über:
GET => http://localhost:8080/task


Hinzufügen eines neuen Tasks über:
POST => http://localhost:8080/task

Header:
Content-Type:application/json
JSON-Body z.B. :
{"name" : "task 1", "description" : "This is a description"}


Modifizieren eines Tasks über:
PUT => http://localhost:8080/task/[id]
Header:
Content-Type:application/json
Accept:application/json

JSON-Body z.B.:
{
    "id": "402880944687600101468760d9ea0000",
    "version": "0",
    "name": "task 1 with new name",
    "description": "This is an updated description",
    "finished": "false"
}


Ich empfehle die Chrome-Erweiterung Postman, um solche HTTP-Aufrufe durchzuführen!

Freitag, 31. Januar 2014

Nomen est omen: Spielenamen sind viel mehr als Schall und Rauch

Einer der regelmäßig wiederkehrenden Kritikpunkte an MobyGames - und das erstaunlicherweise  trotz all der anderen ernsthaften Schwächen des dortigen Datenmodells - ist die Bezeichnung der Spieleinträge. MobyGames ist und war natürlich auch immer schon ein US-Projekt, weswegen jedes Spiel nur mit dem Titel seiner US-Veröffentlichung als "Haupttitel" in die Datenbank aufgenommen wird. Falls es keine US-Veröffentlichung des Spieles gab, wird der Titel eines Releases in einem anderen englischsprachigen Land herangezogen. Sollte es auch eine solche Veröffentlichung nicht gegeben haben, wird schlussendlich der Originaltitel benutzt, wobei dann dessen Herkunft nicht mehr von Belang ist. Ist ein Haupttitel für das Spiel gefunden, wird jeder andere Name nur als "alternativ" in die Datenbank aufgenommen.

Es gibt ein großes Problem mit diesem Ansatz: Es könnte nämlich durchaus sein, dass der Rest der Welt sich ganz und gar nicht für den US-Veröffentlichungstitel eines Spieles interessiert. Man stelle sich beispielsweise einen japanischen MobyGames-Besucher vor, der irritiert feststellen muss, dass der vierte Teil der Final-Fantasy-Reihe dort als "Final Fantasy II" geführt wird, weil er schlicht das zweite FF-Spiel war, das in den USA veröffentlicht wurde. Bei näherem Nachdenken muss es doch einen besseren Weg der Spielbezeichnung geben, weshalb ich im folgenden Beitrag untersuchen möchte, wie andere Videospieldatenbanken dieses Problem angehen, um dann die geplante Oregami-Lösung vorzustellen. Zu Referenzzwecken werde ich immer Final Fantasy IV als Beispiel verlinken.

Mittwoch, 20. November 2013

Englisch ist jetzt Standard


Es war schon traurig, den kürzlichen Exodus der MobyGames-Community mitansehen zu müssen, aber er hat auch viele enttäuschte Videospiel-Liebhaber auf der Suche nach einer neuen Heimat in das Oregami-Forum gespült. Wir haben nach bestem Wissen und Gewissen versucht, alle Fragen zu beantworten und alle Bedenken zu zerstreuen, die von diesen Leuten an uns herangetragen wurden. Dabei haben wir auch bemerkt, dass die Zeit für die weitere Internationalisierung von Oregami reif ist.

Donnerstag, 12. September 2013

Vereinsgründung in Sicht


Man mag es kaum glauben, aber die ersten konkreten Überlegungen zu unserer Vereinsgründung haben wir bereits im Januar 2012 begonnen, also vor fast 20 Monaten. Und gegründet ist unser Verein immer noch nicht! Was also haben wir getrieben all diese Zeit? Und warum wollen wir eigentlich einen Verein? Ein kleiner Rückblick soll darüber Auskunft geben, außerdem wollen wir einen Ausblick auf die Zukunft wagen.

MobyGames hat sie, TheLegacy hat sie, thematisch andere Seiten haben sie auch - stets die gleichen Probleme. Aufgrund dieser Erfahrungen mit anderen Datenbankprojekten hatten wir uns relativ früh auf ein zentrales Grundprinzip für das Oregami-Projekt festgelegt: die größtmögliche Unabhängigkeit von einzelnen Personen. Dieses Prinzip sollte unbedingt auch auf die Gestaltung der rechtlichen Grundlagen angewendet werden. Die bisher üblichen rechtlichen Erscheinungsformen von Spieledatenbanken (privat, halbkommerziell, kommerziell) hatten in unseren Augen einen entscheidenden Nachteil: alle diese Projekte wurden rein rechtlich von einer Person oder Firma, höchstens von zweien betrieben, was große Fragezeichen hinter der Zukunftssicherheit der Daten zurückließ. Was würde passieren, wenn diese eine Person das Interesse verlor, wenn diese eine Firma verkauft würde oder insolvent wäre? Was geschähe dann mit diesen Projekten?

Dienstag, 7. Mai 2013

Retrobörse in Oberhausen am 11. Mai 2013

Die nächste Retrobörse in NRW steht kurz bevor: am kommenden Samstag, den 11. Mai, findet sie im Zentrum Altenverg in Oberhausen statt.

Ich werde an meinem Verkaufsstand wieder alte Zeitschriften der 80er und 90er Jahre zum Verkauf anbieten: Power Play, Video Games, ASM, PC Joker, Maniac und mehr. Das gewohnt kultige Programm also.

Natürlich stehe ich wieder für nette Gespräche aller Art zur Verfügung - her mit euren Fragen und Ideen zu Oregami oder Kultpower.de !


Freitag, 22. März 2013

Oregami im Podcast der "Drei Vogonen"

Einer der bekanntesten Tech-Nerd-Podcasts ist der von den Drei Vogonen.

Vor einigen Monaten bekam ich eine Anfrage, ob ich als Gast in deren Podcast auftreten wolle. Nun, was sollte ich sagen, JA !

Jetzt ist die neue Podcast-Folge online!

In bester Tradition der Drei Vogonen dauert der Podcast knapp 6 (!) Stunden. Im Abschnitt "Deep Thought" (ab 1 Stunde 29) komme ich dann zur Sprache, und zwar für knapp eine Stunde. Themen: Inhalt und Historie von Kultpower.de, aber auch Ziele unseres Projektes Oregami.org, der (hoffentlich bald gemeinnützigen) Online-Spiele-Datenbank. Die Jungs haben echt mal intelligente Fragen gestellt. Ich hoffe meine Antworten machen einen ähnlichen Eindruck :-)

Reinhören! Und dann am besten mithelfen bei Oregami oder Kultpower. Oder bei beidem :-)

Donnerstag, 6. Dezember 2012

Die verflixte X-Wing-Serie oder Wieso eigentlich Datenmodellierung?

Intro

Oregami soll eine Mitmach-Datenbank für Computer- und Videospiele werden, fachlich ähnlich komplex wie die Internet Movie Database für Film und Fernsehen. Wenn wir also über Oregami sprechen, dann ist schnell von unserem Datenmodell - oder fachlichen Modell - die Rede, und dass dieses ominöse Modell besser sein soll als bei anderen, bereits existierenden Spieledatenbanken. Aber wieso eigentlich? Was ist eigentlich ein Datenmodell und warum ist eigentlich das, was MobyGames und TheLegacy anbieten, nicht ausreichend für uns?

Nun bringt unser aller liebstes Spielzeug einen ganzen Berg an Daten mit: Computer- und Videospiele haben einen Namen, gehören einem Genre an, werden auf verschiedenen Systemen in verschiedenen Versionen zu verschiedenen Zeitpunkten veröffentlicht, das auch noch in verschiedenen Ländern, und so weiter und so fort. All diese Daten sollen in unsere Datenbank eingegeben werden können, aber das alleine reicht natürlich noch nicht aus. Schaut sich der Benutzer ein Spiel an, so möchte er zum Beispiel wissen, auf welchen Systemen dieses Spiel erschienen ist und wann. Schaut er sich eine Spielesammlung an, so sollte erscheinen, welche Spiele sie enthält, und diese Spiele sollten mit einem weiteren Klick für mehr Informationen erreichbar sein. Oder welche Spiele eines bestimmten Genres sind in einem bestimmten Jahr auf einem bestimmten System erschienen?