[Java] JAR-Datei mit Netbeans + Maven erzeugen

Standardmäßig wird bei der Verwendung von Netbeans + Maven keine JAR-Datei erzeugt. Dies muss erst in den Projekteinstellungen in der Datei “Project Files/pom.xml” festgelegt werden. Dazu sind folgende Eintragungen notwendig:

<build>
  <plugins>
    <plugin>
      <!-- Build an executable JAR -->
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-assembly-plugin</artifactId>
      <version>2.4</version>
      <configuration>
        <descriptorRefs>
          <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
        <archive>
          <manifest>
            <!-- mainpackage: your main package name -->
            <!-- mainclassname: your main class -->
            <mainClass>mainpackage.mainclassname</mainClass>
          </manifest>
        </archive>
      </configuration>
      <executions>
        <execution>
          <id->make-assembly</id>
          <phase->package</phase>
          <goals>
            <goal>single</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

Durch diese Eintragung wird eine JAR-Datei erzeugt, welche alle abhängigen Libraries integriert hat.

Weiterführende Links:

[Java] log4j verwenden

log4j dient dem Loggen von Anwendungsmeldungen in Java. Das Framework wird im Code importiert und wie im folgenden Beispiel verwendet:

import org.apache.log4j.*;

public class myClass {

    private final static Logger log = Logger.getLogger( myClass.class );
    
    public void Test() {
      log.trace("Trace");
      log.debug("Debug");
      log.info("Info");
      log.warn("Warn");
      log.error("Error");
      log.fatal("Fatal");
    }
}

Wichtig ist außerdem die Definition einer Konfigurationsdatei “log4j.properties” im Verzeichnis “Projektname\src\main\resources\”, im Projektbaum unter “Other Sources”.

# Root logger option
log4j.rootLogger=DEBUG, file, stdout

# Direct log messages to stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target=System.out
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

# Direct log messages to a log file
log4j.appender.file=org.apache.log4j.RollingFileAppender
# Create a logfile below project main directory
log4j.appender.file.File=logfile.log
log4j.appender.file.MaxFileSize=1MB
log4j.appender.file.MaxBackupIndex=1
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

Weiterführende Links:

[Java] Javadoc verwenden

Zur Softwaredokumentation von Java-Quelltext eigenet sich hervorragend Javadoc.
Eine Dokumentation dazu ist auf www.oracle.com zu finden. Eine Kurzbeschreibung ist auch auf www.wikipedia.org vorhanden.

/**
 * Beschreibungstext<br>
 * <p>
 * Beschreibungstext
 *
 * @param  par1 dies ist Parameter1
 * @param  par2 dies ist Parameter2
 * @return      Rückgabeparameter
 * @see         Verweis
 */
public String getText(String par1, int Par2) {
        return null;
}

[Java] Bibliothek (*.jar) in Netbeans einbinden

Standardprojekt, Fall 1:

  • Bibliothek herunterladen und in ein beliebiges Verzeichnis kopieren.
  • Die System-PATH-Variable sollte zu folgenden wichtigen Verzeichnissen verweisen:
    c:\Program Files\Java\jdk#Versionsnummer#\bin\
    c:\Program Files\NetBeans #Versionsnummer#\java\ant\bin\
    
  • Wenn das Unterverzeichnis “ant” vorhanden ist und eine Sofrwaredokumentation gewünscht ist sollte in das Verzeichnis “ant” gewechselt und dort auf Konsole folgendes eingegeben werden:
    ant javadoc
    

    Das ant-Buildscript erzeugt mittels javadoc.exe die Softwaredokumentation. Diese liegt dann auf der gleichen Ebene wie das Verzeichnis “ant” im Unterverzeichnis “javadoc”.

  • Im NetBeans Menü unter Tools->Ant Libraries->New Library einen Namen für die importierte Library vergeben.
  • Reiter Classpath->Add JAR/Folder…->*.jar-Datei auswählen (meißt im Unterverzeichnis “lib”)
  • Reiter Sources->Add JAR/Folder…->Sourcen-Pfad auswählen (meißt im Unterverzeichnis “source”)
  • Reiter Javadoc->Add ZIP/Folder…->Javadoc-Pfad auswählen (meißt im Unterverzeichnis “javadoc”)
  • jeweils mit Ok bestätigen

Maven-Projekt, Fall 2:

  • Bibliothek herunterladen und in ein beliebiges Verzeichnis kopieren.
  • Im Projektbaum auf “Dependencies” rechtsklicken und “Add Dependency…” wählen.
  • Group ID (org.blah), Artifakt ID (name), Version (x.x), Type (jar) eintragen und mit “Add” bestätigen.
  • Auf die neu eingetragenen Dependency rechtsklicken und “Manually install artifact” wählen.
  • Unter “Browse…” die “jar” wählen und mit “Install locally” installieren. Anschließend kurz warten, bis die Bibliothek im Projekt installiert wurde.