Difference between revisions of "NetBeans"

(Created page with "===Installation=== Download NetBeans from the official website: https://netbeans.org/ Take the '''NetBeans Java EE''' version. ====Linux==== * Download the NetBeans script...")
 
Line 12: Line 12:
 
./netbeans-7.4-javaee-linux.sh
 
./netbeans-7.4-javaee-linux.sh
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
====Installation process====
 +
On installation start you can choose to install or not some servers:
 +
*Glassfish 4 = full JEE server. It provides EJB, JSF and all the JEE stack. Your application can rely on it.
 +
*Tomcat 7 = servlet container. It can only display JSP. You have to provide the other library into your application.
 +
 +
[ I like to install them separately ]
 +
 +
Accept all license terms for both Java & jUnit.
 +
>> netbeans install 01 <<
 +
 +
Let the IDE check for update in background.
 +
>> netbeans install 02 <<
 +
 +
===JDK settings===
 +
====Adjust NetBeans' JDK====
 +
When you upgrade your JDK you might have a NetBeans error at startup. You have to edit the core configuration file.
 +
* Close NetBeans
 +
* edit: $NetBeans\etc\netbeans.conf
 +
<syntaxhighlight lang="apache">
 +
netbeans_jdkhome="C:\Program Files\Java\jdk1.7.0_21"
 +
</syntaxhighlight>
 +
* Adjust default JDK path
 +
 +
====Register new JDK into the application====
 +
Start NetBeans, go to “Tools > Java Platforms”
 +
* Add the new JDK
 +
* Remove the old one that doesn’t exist anymore
 +
 +
===Configuration===
 +
====Formatter====
 +
=====Remove trailing spaces and unused imports=====
 +
Tools > Options > Editor > OnSave
 +
 +
* All languages
 +
** enable 'remove trailing whitespaces from: 'ALL LINES'
 +
netbeans_config_01.png
 +
 +
* Java
 +
** Click on the 2 import checkboxes
 +
netbeans_config_02.png
 +
 +
=====Code generation=====
 +
Tools > Options > Editor > Formatting
 +
* Language: Java
 +
* Category: code generation
 +
 +
 +
====Display JavaDoc with code completion====
 +
To improve development comfort you can display the JavaDoc along with Code Completion.
 +
Tools > Options > Editor > Code Completion
 +
netbeans_config_03.png
 +
 +
 +
Increase terminal history (= console output buffer)
 +
Tools > Options > Miscellaneous > Terminal > Increase history to, at least, 80 000
 +
netbeans_config_04.png
 +
 +
Maven configuration
 +
Plugin configuration
 +
Tools > Options > Java > Maven
 +
·      adjust installation path
 +
·      Adjust JavaDoc and Source retrieval. I advise you to use 1st project only
 +
netbeans_config_05.png
 +
 +
Add Maven SkipTests build
 +
Tools > Options > Java > Maven > Edit Global Custom Goal Definitions
 +
·      ADD new "skipTests"
 +
·      Goals: clean install
 +
·      Set Properties: skipTests
 +
netbeans_config_06.png
 +
 +
Then, right click on project name > Custom > skipTests
 +
JavaFX Scene Builder
 +
http://www.oracle.com/technetwork/java/javafx/downloads/index.html
 +
Tools > Options > Java > JavaFX
 +
If you have installed the JavaFX Scene Builder you can specify the link here:
 +
netbeans_config_07.png
 +
 +
Add other JDKs
 +
Sometimes it’s useful to add an old JDK for legacy projects.
 +
Tools > Java Platforms > Add
 +
Just follow the wizard.
 +
To add a JDK just choose the JDK folder, example:  C:\Program Files\Java\jdk1.7.0_25
 +
 +
Ant home
 +
If you have your own ANT installation you can use it instead of the default one.
 +
Tools > Java > Ant
 +
 +
 +
 +
 +
 +
netbeans_config_08.png
 +
 +
 +
 +
NetBeans # plugins
 +
Jacoco code coverage
 +
Tools > Plugins > Available plugins
 +
Install:
 +
·      TikiOne JaCoCoverage Plugin
 +
·      TikiOne JaCoCo Reporting Libraries
 +
·      TikiOne JaCoCoverage Libraries
 +
·      JaCoCo Library
 +
netbeans_config_09.png
 +
 +
Click on install, accept the license, trust the packages and restart NetBeans.
 +
F For the plugin to work, you must use the default report file 'jacoco.exec' !!!
 +
    >> Adjust your project’s Maven Surefire plugin settings accordingly
 +
         
 +
 +
 +
Checkstyle
 +
Official Web site: http://www.sickboy.cz/checkstyle/download.html
 +
Add update center
 +
Checkstyle plugin is not available from the official list. You have to download it manualy.
 +
Tools Menu > Plugins > Settings
 +
… add a new update center
 +
netbeans_install_10.png
 +
 +
Just fill up the form:
 +
netbeans_install_11.png
 +
 +
For NetBeans 7.x the URL is:    http://www.sickboy.cz/checkstyle/autoupdate/autoupdate-3.xml
 +
Install plugin
 +
Now go to Tools > Plugins > Available plugins
 +
Install checkstyle
 +
netbeans_config_12.png
 +
 +
Checkstyle configuration
 +
Tools > Options > Miscellaneous > Checkstyle
 +
Set your configuration file
 +
netbeans_config_13.png
 +
 +
 +
NetBeans # shortcuts and Customization
 +
Official list of NetBeans shortcuts
 +
https://netbeans.org/project_downloads/www/shortcuts.pdf
 +
View packages as tree
 +
Right click on the Projects tab > View Java Packages as > Reduced Tree or Tree
 +
netbeans_custom_1.png
 +
Where is the current file? (= Eclipse “find in Editor”)
 +
You have to use the shortcuts:    Ctrl + Shift + 1 
 +
Find usage (= Eclipse Call Hierarchy)
 +
Use “ Alt + F7 ” shortcut
 +
Generate getters and setters
 +
Use “ Alt + insert ” shortcut
 +
Maximize / Minimize code window
 +
Use the “ Shift + Esc ” shortcut
 +
Useful windows (= Eclipse views)
 +
Window > Action item
 +
Window > Output > { Output + Test Results + Search Results }
 +
Window >Navigating > Navigator
 +
Window > Other > JavaDoc
 +
 +
 +
 +
NetBeans # server configuration
 +
This is not necessary if you installed Glassfish and/or Tomcat with NetBeans.
 +
GlassfishJEE server
 +
Tools > Server > Add a new server
 +
Select Glassfish server
 +
Choose your server location
 +
netbeans_GF.png
 +
 +
Let the default settings and click finish
 +
 +
Apache Tomcat servlet container
 +
Tools > Servers > Add Server…
 +
Select Apache Tomcat
 +
Choose your location and set a Tomcat user, as defined in $Tomcat/conf/tomcat-users.xml
 +
netbeans_tomcat7.png
 +
 +
Click finish

Revision as of 10:19, 25 November 2013

Installation

Download NetBeans from the official website: https://netbeans.org/

Take the NetBeans Java EE version.

Linux

  • Download the NetBeans script
  • Make the script executable and run it
chmod 755 netbeans-7.4-javaee-linux.sh
./netbeans-7.4-javaee-linux.sh

Installation process

On installation start you can choose to install or not some servers:

  • Glassfish 4 = full JEE server. It provides EJB, JSF and all the JEE stack. Your application can rely on it.
  • Tomcat 7 = servlet container. It can only display JSP. You have to provide the other library into your application.

[ I like to install them separately ]

Accept all license terms for both Java & jUnit. >> netbeans install 01 <<

Let the IDE check for update in background. >> netbeans install 02 <<

JDK settings

Adjust NetBeans' JDK

When you upgrade your JDK you might have a NetBeans error at startup. You have to edit the core configuration file.

  • Close NetBeans
  • edit: $NetBeans\etc\netbeans.conf
netbeans_jdkhome="C:\Program Files\Java\jdk1.7.0_21"
  • Adjust default JDK path

Register new JDK into the application

Start NetBeans, go to “Tools > Java Platforms”

  • Add the new JDK
  • Remove the old one that doesn’t exist anymore

Configuration

Formatter

Remove trailing spaces and unused imports

Tools > Options > Editor > OnSave

  • All languages
    • enable 'remove trailing whitespaces from: 'ALL LINES'
netbeans_config_01.png
  • Java
    • Click on the 2 import checkboxes
netbeans_config_02.png

Code generation

Tools > Options > Editor > Formatting

  • Language: Java
  • Category: code generation


Display JavaDoc with code completion

To improve development comfort you can display the JavaDoc along with Code Completion. Tools > Options > Editor > Code Completion

netbeans_config_03.png


Increase terminal history (= console output buffer) Tools > Options > Miscellaneous > Terminal > Increase history to, at least, 80 000

netbeans_config_04.png

Maven configuration Plugin configuration Tools > Options > Java > Maven · adjust installation path · Adjust JavaDoc and Source retrieval. I advise you to use 1st project only

netbeans_config_05.png

Add Maven SkipTests build Tools > Options > Java > Maven > Edit Global Custom Goal Definitions · ADD new "skipTests" · Goals: clean install · Set Properties: skipTests

netbeans_config_06.png
Then, right click on project name > Custom > skipTests

JavaFX Scene Builder http://www.oracle.com/technetwork/java/javafx/downloads/index.html Tools > Options > Java > JavaFX If you have installed the JavaFX Scene Builder you can specify the link here:

netbeans_config_07.png
Add other JDKs

Sometimes it’s useful to add an old JDK for legacy projects. Tools > Java Platforms > Add Just follow the wizard. To add a JDK just choose the JDK folder, example: C:\Program Files\Java\jdk1.7.0_25

Ant home If you have your own ANT installation you can use it instead of the default one. Tools > Java > Ant



netbeans_config_08.png


NetBeans # plugins Jacoco code coverage Tools > Plugins > Available plugins Install: · TikiOne JaCoCoverage Plugin · TikiOne JaCoCo Reporting Libraries · TikiOne JaCoCoverage Libraries · JaCoCo Library

netbeans_config_09.png

Click on install, accept the license, trust the packages and restart NetBeans. F For the plugin to work, you must use the default report file 'jacoco.exec' !!!

   >> Adjust your project’s Maven Surefire plugin settings accordingly
          


Checkstyle Official Web site: http://www.sickboy.cz/checkstyle/download.html Add update center Checkstyle plugin is not available from the official list. You have to download it manualy. Tools Menu > Plugins > Settings … add a new update center

netbeans_install_10.png

Just fill up the form: netbeans_install_11.png

For NetBeans 7.x the URL is: http://www.sickboy.cz/checkstyle/autoupdate/autoupdate-3.xml Install plugin Now go to Tools > Plugins > Available plugins Install checkstyle

netbeans_config_12.png

Checkstyle configuration Tools > Options > Miscellaneous > Checkstyle Set your configuration file netbeans_config_13.png


NetBeans # shortcuts and Customization Official list of NetBeans shortcuts https://netbeans.org/project_downloads/www/shortcuts.pdf View packages as tree Right click on the Projects tab > View Java Packages as > Reduced Tree or Tree netbeans_custom_1.png Where is the current file? (= Eclipse “find in Editor”) You have to use the shortcuts: Ctrl + Shift + 1 Find usage (= Eclipse Call Hierarchy) Use “ Alt + F7 ” shortcut Generate getters and setters Use “ Alt + insert ” shortcut Maximize / Minimize code window Use the “ Shift + Esc ” shortcut Useful windows (= Eclipse views) Window > Action item Window > Output > { Output + Test Results + Search Results } Window >Navigating > Navigator Window > Other > JavaDoc


NetBeans # server configuration This is not necessary if you installed Glassfish and/or Tomcat with NetBeans. GlassfishJEE server Tools > Server > Add a new server Select Glassfish server Choose your server location netbeans_GF.png

Let the default settings and click finish

Apache Tomcat servlet container Tools > Servers > Add Server… Select Apache Tomcat Choose your location and set a Tomcat user, as defined in $Tomcat/conf/tomcat-users.xml netbeans_tomcat7.png

Click finish