Links

  • 1. Sogeti
  • 2. JBoss
  • 3. IBM
  • 4. Oracle
  • 5. SpringSource
  • 6. NL-JUG
  • 7. Java

Archives

Syndication  RSS 2.0

RSS 1.0
RSS 2.0

Bookmark this site

Add 'JCN Blog' site to delicious  Add 'JCN Blog' site to technorati  Add 'JCN Blog' site to digg  Add 'JCN Blog' site to dzone

Posted by Ron Lievens at 13:59 on Wednesday 2 December    Add 'Mijn standaard Jave/Eclipse ontwikkel omgeving' site to delicious  Add 'Mijn standaard Jave/Eclipse ontwikkel omgeving' site to technorati  Add 'Mijn standaard Jave/Eclipse ontwikkel omgeving' site to digg  Add 'Mijn standaard Jave/Eclipse ontwikkel omgeving' site to dzone

Na aanleiding van verschillede discussies over hoe de Java/Eclipse ontwikkel omgeving er uit moet zien, heb ik een voorstel voor een standaard Java/Eclipse ontwikkel omgeving gemaakt.

Mijn voorstel maakt volledig gebruik van open source tooling en is toegespitst op code kwalitie. Mijn voorstel bevat Apache Ant, Apache Maven2, Subversion, CheckStyle en Findbugs intergratie met Eclipse. Verder maakt mijn voorstel gebruik van de EclEmma eclipse plugin voor code dekking en uiteraard maak ik gebruik van de JCN Style Guide in Eclispe.

Java
De Java Development Kit (JDK, soms ook Java SDK) is de software die een programmeur nodig heeft om programma’s in Java te kunnen ontwikkelen. De Java Development Kit bestaat uit de Java Runtime Environment (alles wat nodig is om Java programma’s op een computer te kunnen draaien) met daarbij een reeks tools die voor de programmeur van belang zijn.

De belangrijkste tools die Sun Microsystems in de JDK meelevert zijn:

  • javac – de Java compiler, om broncode om te zetten in bytecode die door de Java Virtual Machine uitgevoerd kan worden.
  • javadoc – een tool om commentaar uit broncode te extraheren en er netjes geformatteerde documentatie van te maken.
  • jar – een tool om JAR files mee te maken.

Installeren
Download de laatste Java SE Development Kit (JDK)versie hier: http://java.sun.com/javase/downloads/index.jsp

Installeer de JDK op D:\Java.

Configureren
Voeg JAVA_HOME toe aan de omgevingsvariabelen met de waarde “D:\Java\jdk1.*.*_*”. (vervang de ‘*’ ) Voeg vervolgens %JAVA_HOME%\bin toe aan het begin van de PATH omgevingsvariabelen.

 

Subversion
Aangezien Subversion de standaard versie beheer systeem is en de Eclipse plugin niet de meest gebruiksvriendelijke. Installeren we naast de Eclipse plug-in ook een Subversion client genaamd TortoiseSVN.

Installeren
Download de laatste versie van TortoiseSVN hier: http://sourceforge.net/projects/tortoisesvn/files/

 
Ant
Apache Ant is een computerprogramma voor het automatiseren van het bouwproces van software. Het is vergelijkbaar met make, met het verschil dat Ant in Java is geschreven en zich ook voornamelijk richt op het bouwen van Java programma’s.

Installeren
Download de laatste Apache Ant versie hier: http://ant.apache.org/bindownload.cgi
Pak de zip uit in D:\Java

Configureren
Voeg ANT_HOME toe aan de omgevingsvariabelen met de waarde “D:\Java\ apache-ant-*.*.*”. (vervang de ‘*’ ) Voeg vervolgens %ANT_HOME%\bin toe aan het einde van de PATH omgevingsvariabelen.

 

Maven2
Apache Maven is een softwaregereedschap voor Java project management en geautomatiseerde softwarebouw. Het is gelijk in functionaliteit aan het gereedschap Apache, maar heeft een simpeler bouwconfiguratie, gebaseerd op de taal XML. Maven wordt gefaciliteerd door de Apache Software Foundation, waar het voorheen een onderdeel was van het Jakarta Project.
Maven gebruikt een “Project Object Model” (POM) om de software onder constructie te duiden. In de POM staan verder de afhankelijkheden met andere modules en componenten, waaruit de volgorde van bouwen bepaald wordt. In de POM kunnen naast de gebruikelijke stappen als compileren en samenvoegen voor distributie, extra acties gedefinieerd worden die het ontwikkel proces kunnen ondersteunen. Voorbeelden hiervan zijn automatisch testen, (statische) code verificatie en analyse van code coverage door de testen.
Een belangrijk aspect van Maven is de zogenaamde “repository” waarin verschillende versies van componenten opgeslagen zijn. Dit kunnen componenten zijn waarvan de te bouwen software rechtstreeks afhankelijk is. Ook kunnen dit componenten zijn die het bouwproces zelf ondersteunen. Maven biedt ondersteuning om de repository automatisch te vullen met versies die op het internet aangeboden worden, via Apache en ander organisaties.

Installeren
Download de laatste Apache Maven2 versie hier: http://maven.apache.org/download.html
Pak de zip uit in D:\Java

Configureren
Voeg MV2_HOME toe aan de omgevingsvariabelen met de waarde “D:\Java\ apache-maven-*.*.*”. (vervang de ‘*’ ) Voeg vervolgens %MV2_HOME%\bin toe aan het einde van de PATH omgevingsvariabelen.
 

Eclipse
Eclipse is een open-source framework van de Eclipse Foundation voor software-ontwikkelomgevingen. De bekendste toepassing is het gebruik als Integrated development environment (IDE) voor de programmeertaal Java. Het product wordt echter ook steeds meer aangewend voor het bouwen van applicaties bovenop het Eclipseplatform.

Installeren
Download de laatste “Eclipse IDE for Java EE Developers” hier: http://www.eclipse.org/downloads/
Pak de zip uit in D:\Java en maak een snelkoppeling van D:\Java\eclipse\eclipse.exe naar het bureaublad. In dit document wordt Eclipse

 

Installeer Eclipse plug-ins
De te gebruiken plug-ins zijn allemaal open source.
Plug-ins worden geïnstalleerd vanuit Eclipse! In deze sectie gaan we van uit dat u Eclipse opgestart heeft zonder foutmeldingen.
Om een plugin te installeren ga naar “Help” in het hoofdmenu en selecteer “Install New Software”.
Klik op de knop “Add” en vul de locatie in met een url klik vervolgens op de knop “OK”. Wacht tot “Pending” verdwijnt, selecteer de gewenste onderdelen en klik op de knop “Next”. Klik nog eens op “Next”, accepteer de licentie overeenkomst en klik op “Finish”.

Findbugs
Findbugs is een statische code analyse plug-in.
url: http://findbugs.cs.umd.edu/eclipse/
Onderdelen: Alles

Subclipse
subclipse is een subversion plug-in.
url: http://subclipse.tigris.org/update_1.6.x/
Onderdelen: Alles

Maven2
url: http://m2eclipse.sonatype.org/update/
Onderdelen: Maven Integration

EclEmma
EclEmma is een code coverage plug-in. Deze test de coverage van de unittesten.
url: http://update.eclemma.org/
Onderdelen: Alles

Checkstyle
Checkstyle is een code style checker plug-in.
url: http://eclipse-cs.sourceforge.net/update
Onderdelen: Checkstyle plugin version 5 of hoger.

 Tip: Checkstyle en Findbugs moet per project worden aangezet!

 

Opzetten van een Eclipse project
Maak een standaard project directory aan “D:\Projecten\<projectnaam>”. Maar in deze directory de 2 volgende directories aan “D:\Projecten\<projectnaam>\workspace” en “D:\Projecten\<projectnaam>\maven2”.
Gebruik de directory “D:\Projecten\<projectnaam>\workspace” voor eclipse en gebruik de directory “D:\Projecten\<projectnaam>\maven2” voor maven. Om er voor te zorgen dat maven deze directory gebruikt moet men een maven configuratie bestand aanmaken. Creer het bestand “D:\Projecten\<projectnaam>\maven2_settings.xml” en vul deze met de volgende gegevens:

<settings xmlns=”http://maven.apache.org/POM/4.0.0” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance
      xsi:schemaLocation=”
http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd“>

      <localRepository>D:\Projecten\<projectnaam>\maven2</localRepository>

</settings>

Configureer Eclipse
Start Eclipse met als workspace “D:\Projecten\<projectnaam>\workspace”.

Zet encoding op UTF-8
Ga in het menu naar “Window->Preferences”. Zoek naar “Encoding”, zet alle encoding op UTF-8 en klik op de knop “Apply”.

Zet alle Java Warnings aan
Ga in het menu naar “Window->Preferences” en navigeer naar “Java->Compiler->Errors/Warnings”.
Verander alle “Ignore” naar “Warning”, behalve “Non-externalized strings(missing/unused $NON-NLS$ tag):”.
Tip: Zet “Include constructor or setter method parameters” niet aan!

Gebruik maven in Eclipse
Ga in het menu naar “Window->Preferences” en navigeer naar “Maven->Installtions”. Klik op de “Add” knop en selecteer de “D:\Java\ apache-maven-*.*.*” directory. Selecteer “Extrenal D:\Java\ apache-maven-*.*.*”, verander de “User settings” in “D:\Projecten\<projectnaam>\maven2_settings.xml” en klik op de knop “OK”.

Gebruik ant in Eclipse
Ga in het menu naar “Window->Preferences” en navigeer naar “Ant->Runtime. Klik op de “Ant Home” knop en selecteer de “D:\Java\ apache-ant-*.*.*” directory.

Importeren van de JCN settings
Download de volgende bestanden van de site http://java.sogeti.nl/styleguide.html en sla deze op in de map “D:\Java\jcn”:

  • Code Templates
  • Code Formatter settings
  • Code Clean Up settings
  • Checkstyle configuration

Ga in het menu naar “Window->Preferences” en navigeer naar “Java->Code Style->Cleanup”, klik op de knop “import” en selecteer “D:\Java\jcn\ jcn-styleguide-3.0-eclipse-cleanup.xml”.
Ga in het menu naar “Window->Preferences” en navigeer naar “Java->Code Style->Code Template”, klik op de knop “import” en selecteer “D:\Java\jcn\ jcn-styleguide-3.0-eclipse-codetemplates.xml”.
Ga in het menu naar “Window->Preferences” en navigeer naar “Java->Code Style->Formatter”, klik op de knop “import” en selecteer “D:\Java\jcn\ jcn-styleguide-3.0-eclipse-formatter.xml”. Klik op de knop “Edit”, ga naar het tabblad “Comments”, deselecteer “Enable block comment formatting” en klik op de knop “OK”.
Ga in het menu naar “Window->Preferences” en navigeer naar “Checkstyle”, klik op de knop “new”.
Selecteer als Type: “External Configuration File”, vul als naam “jcn” in en selecteer als lokatie “D:\Java\jcn\ jcn-styleguide-3.0-checkstyle.xml”.

Save actions
Save actions zoals het al zegt, zijn actie die uitgevoerd worden op het moment dat een file gesaved word. Ga in het menu naar “Window->Preferences” en navigeer naar “Java->Editor->Save Actions”, vink alle opties aan en selecteer “Format all lines”. Klik daarna op “Configure”.

  1. In het tabblad “Code Organizing” vink “Correct indentation” en “Remove trailing whitespaces” aan en selecteer “All lines”.
  2. In het tabblad “Code Style” vink “Use blocks in if/while/for/do statements” aan en selecteer “Always”. Vink “Convert for loops to enhanced” alleen aan, als het project Java 5 of hoger gebruikt.
  3. En als laatste vink “Use parentheses in expressions” aan en selecteer “Always”.
  4. In het tabblad “Member Accesses” vink alle opties aan en selecteer in beide gevallen “Always”.
  5. In het tabblad “Missing Code” vink alle opties aan.
  6. In het tabblad “Unnecessary Code” vink “Remove unused imports”, “Remove unnecesary cast” en “Remove unnecesary ‘$NON-NLS$’ tags” aan.

 

Heb je vragen of opmerking, laat het mij weten!

Ron Lievens (ron.lievens@sogeti.nl)

© 2020 Java Competence Network. All Rights Reserved.