UMLGraph in Javadoc mit Maven

Mit UMLGraph steht ein wunderbares, einfaches Tool zur Verfügung, um UML Klassendiagramme in die Javadoc Dokumentation einzufügen. Diese sind klickbar, d.h. man kann durch die Diagramme navigieren. Wer seine Projekte mit Maven erzeugt, integriert gerne auch die Javadoc-Erstellung in den Maven-Build. Und UMLGraph lässt sich da gleich ganz einfach mitnehmen.

Hier ein Beispiel, wie eine entsprechende Reporting-Sektion im pom.xml aussehen könnte:

<reporting>
  <outputDirectory>/ein/sinnvoller/pfad</outputDirectory>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <configuration>
        <doclet>gr.spinellis.umlgraph.doclet.UmlGraphDoc</doclet>
        <docletArtifact>
          <groupId>gr.spinellis</groupId>
          <artifactId>UmlGraph</artifactId>
          <version>4.6</version>
        </docletArtifact>
        <additionalparam>
           -inferrel -inferdep -quiet -hide java.* -collpackages java.util.* -qualify
           -postfixpackage -nodefontsize 9
           -nodefontpackagesize 7
        </additionalparam>
      </configuration>
    </plugin>
  </plugins>
</reporting>

Und das Ergebnis kann sich sehen lassen:

Wer tiefer in die Materie, Parameter und Möglichkeiten von UMLGraph einsteigen möchte findet in der Onlinedokumentation ausführliche Hilfestellung.

Share

Theory of Constraints

Das JUG ErN Meeting am letzten Donnerstag war etwas anders als die üblichen „Wir setzen uns mal rein und hören, was der da vorne sagt“-JUG-Treffen. Diesmal mussten die Teilnehmer mitspielen! Pierluigi Pugliese und Martin Heider erklärten anhand eines Spiels die „Theory of Constraints“.

Diese Theorie besagt, dass es in jedem System genau einen Flaschenhals (Constraint) gibt und gibt 5 Schritte vor, wie man den Engpass möglichst weit aufmacht, sprich entschärft.

Hier die begleitenden Folien, in denen auch das Spiel erläutert wird:

Und so wurden fleißig Boote und Hüte gefaltet und von Runde zu Runde war tatsächlich ein Fortschritt zu sehen.
Fazit: Ein lustiger Abend mit einem sehr einprägsamen Beispiel – so macht Lernen Spaß.

Share

Zeichensatz festlegen bei generierten E-Mails

Programmierer habens oft eilig. Und sie gehen den Weg des geringsten Widerstands, was einfach geht, wird auch einfach gemacht. Bekanntes Beispiel: das Versenden von E-Mails aus der Applikation heraus, z.B. für Bestätigungsmails, Formularmailer usw.; in nahezu jeder Sprache gibt es dafür einfache Klassen oder Befehle, die eine E-Mail erzeugen und versenden.

Leider wird dabei häufig vergessen, den Zeichensatz der generierten Mail richtig (bzw. überhaupt) zu setzen. Hat eine Mail im Header kein Feld „Content-Type:“ gesetzt, so handelt man sich zwei gravierende Probleme ein:

  1. Der empfangende Client kann die Mail nicht richtig interpretieren, da er nicht weiß, in welcher Codierung der Inhalt der Mail ist. Das hat zur Folge, dass Umlaute, Sonderzeichen usw. nicht richtig angezeigt werden.
  2. viele Spam-Filter werten dies als Negativ-Punkt, somit steigt die Wahrscheinlichkeit, dass die Mail ihren Empfänger nicht erreicht.

Ich schreibe hier mal beispielhaft für PHP, Java, Spring und SEAM, wie man den Header um die Content-Type Angabe ergänzen kann. Dabei beschränke ich mich der Einfachheit halber auf eine simple Textmail, also kein Multipart mit HTML oder Attachment (Beispiele dazu lassen sich schnell im Web finden).

PHP:

$header = 'MIME-Version: 1.0' . "\n" . 'Content-type: text/plain; charset=UTF-8' . "\n" . $strFrom;
mail($strEmpfaenger, $strSubject, $strMailtext, $header) or die("Die Mail konnte nicht versendet werden.");

Java:

MimeMessage message = new MimeMessage(session);
message.setHeader("Content-Type", "text/plain" + "; charset=" + "UTF-8");

Spring:

MimeMessage mimeMessage = ...
MimeMessageHelper message = new MimeMessageHelper(mimeMessage, "UTF-8");

SEAM: (ein Facelet-Template, das vom SEAM gerendert wird)

   ...

Die Beispiele sind bewusst kurz gehalten, das Thema E-Mail-Programmierung kann wohl Bücher füllen. In erster Linie will ich Entwickler motivieren, bei aller Eile auch an die Kleinigkeiten zu denken.

Share

jsolutions.de runderneuert

An dieser Stelle mal ein bisschen offtopic Werbung in eigener Sache: Meine Firmenwebseite http://www.jsolutions.de/ ist in komplett überarbeiteter Form neu online gegangen. In den letzten Jahren war leider nicht viel Zeit, sich um die eigene Präsenz im Web konsequent zu kümmern und es war mehr als überfällig, die Darstellung der Firma an deren Entwicklung anzupassen.

Ich hoffe das neue Design ist gelungen – Kritik kann ja gerne hier in den Kommentaren hinterlassen werden!

Wer über Neues und Interessantes von und mit jsolutions im Bilde bleiben möchte kann via Twitter folgen: http://twitter.com/jsolutions_de

Share