NB-SpringBoot

NetBeans IDE plugin supporting programming with Spring Boot.

Requirements and Installation

This plugin requires NetBeans 8.1 or above running on JDK 7 or above.

The plugin is available in the Plugin Portal Update Center thus it can be downloaded and installed trough Tools > Plugins > Available Plugins. Please note that new releases become available on the Update Center after they are verified by the folks at the NetBeans Plugin Portal. You can check the verification status looking at the plugin page on the portal.

To perform a manual install download the desired nbm package from the releases page , go to Tools > Plugins > Downloaded and click the Add Plugins... button. Choose the downloaded nbm package file then click Install.

Features

• New Spring Boot Maven project wizards:
  • Basic project
  • Project generated by Spring Initializr service
• Specific editor for configuration properties files with:
  • extended syntax highlighting (dot separated keys, array notation)
  • error highlighting for: syntax errors, duplicate properties, data type mismatches and unknown properties
  • completion and documentation of configuration properties names
  • completion and documentation of configuration properties values (hints in configuration metadata)
• Java editor error highlighting and fixes for missing starter dependencies:
  • @ConfigurationProperties annotation without spring-boot-configuration-processor dependency
  • Imports of Spring MVC annotations and Spring Data interfaces without relevant starter dependencies (e.g. JpaRepository without spring-boot-starter-data-jpa dependency)
• Spring Boot file templates:
  • CommandlineRunner annotated classes
  • ApplicationRunner annotated classes
  • application.properties files
  • ConfigurationProperties annotated classes
  • additional-spring-configuration-metadata.json files
• Additional Spring Framework file templates:
  • Component annotated classes
  • Configuration annotated classes
  • Service annotated classes
  • Controller annotated classes (Spring MVC)
  • RestController annotated classes (Spring MVC)
  • interfaces extending Repository (Spring Data)
• Additional code generators in pom.xml files:
  • Add Spring Boot dependencies (dependency metadata is taken from the Spring Initializr web service)
  • Add basic Spring Boot setup
• Toolbar button to trigger Spring Boot devtools reload
• Specific Spring Boot project properties page to:
  • Specify command line run arguments and launch VM options
  • Enable/disable manual devtools reload trigger
  • Toggle debug mode and color output
  • Assisted override of configuration properties at launch
• Additional navigator panel to show request URL mappings of a Controller / RestController class

Issues and Documentation

Bug tracking: GitHub Issues

Documentation: GitHub Wiki

License

The plugin and its source code are licensed under Apache 2.0 license.

Acknowledgements

Completion of Spring Boot configuration properties feature is based on Keevosh plugin.

Template and code generator were inspired by those found on Spring Boot Tools 4 NetBeans.

Requestmappings navigator panel feature contributed by Michael Simons.

Changelog

• 1.6.1 (Oct 2017): Hints and quick fixes

  • Java editor hints:
    • Warning and fix on use of @ConfigurationProperties annotation without spring-boot-configuration-processor dependency
    • Warning and fixes on import of annotations/interfaces of Spring MVC/Spring Data without relevant dependencies
  • Quick fixes:
    • Removal of deprecated,unknown or duplicate properties
    • Substitution of deprecated properties with replacement (if present in metadata)
  • Error highlighting in configuration properties editor:
    • Added highlighting for deprecated properties according to their level in metadata
    • Relaxed configuration properties name variants are recognized
  • Upgrade to Spring Boot 1.5.8
  • List of closed issues

• 1.6 (Jul 2017): Configuration properties highlighting

  • Error highlighting in configuration properties editor for:
    • Syntax errors
    • Duplicate properties
    • Data type mismatches (see documentation for limitations)
    • Unknown properties
  • Upgrade to Spring Boot 1.5.4
  • Manage deprecation error level in configuration properties metadata
  • New plugin options for customizing error higlighting severity
  • New plugin options for configuration properties lists used in completion and override on launch:
    • Include deprecated properties with level error
    • Show all deprecated properties last
  • Style of configuration properties items in lists is more uniform
  • The application.properties file wizard allows to choose between main and test resource folders
  • List of closed issues

• 1.5.1 (May 2017): Another round of fixes

  • Upgrade to Spring Boot 1.5.3
  • Projects wizard now open pom.xml instead of main class after generation
  • Internal reworkings to improve plugin initialization and reaction to project build and configuration properties changes
  • Focus filter textfield in Add Spring Boot Dependencies dialog
  • List of closed issues

• 1.5 (Apr 2017): Dependencies management and configuration properties editor

  • Configuration properties files:
    • Custom icon
    • Specific editor with extended syntax highlighting (dot separated keys and array notation)
  • The Spring Initializr project wizard now supports documentation links recently added to the Spring Initializr web service
  • The old code generators for Maven pom.xml files have been superseded by a new code generator for adding a set of Spring Boot dependencies exploiting the Spring Initializr service metadata
  • New code generator for Maven pom.xml to add a basic Spring Boot project setup to generic Maven projects
  • Project wizards open the main class and trigger async download of dependencies after creation
  • Metadata downloaded from the Spring Initializr web service are now cached
  • Upgrade to Spring Boot 1.5.2
  • List of closed issues

• 1.4 (January 2017): Better application launch

  • Improved project properties panel:
    • Override of Spring Boot configuration properties at application launch
    • Checkboxes for enabling debug mode and toggling color output
    • Specify Java VM options and add launch optimizations
  • Default launch options for newly created projects in global plugin settings
  • Updated project content for Basic Spring Boot project wizard
  • List of closed issues

• 1.3.1 (November 2016): General fixes

  • File templates ignored a per project custom license
  • Reload action renamed to restart and shorcut changed to avoid conflict with new Paste as Lines command in editor multicaret
  • Visual improvements to request mappings navigator panel
  • Properly handle Ctrl + Enter configuration properties completion to overwrite the current property name
  • Initializr project wizard: removed option to add Spring Boot configuration processor as now it can be chosen in the Dependencies page and checked by default the 'Run/Debug with spring boot maven plugin' option
  • Restart action now exploits an environment variable instead of a command line argument. You may see an unexpected --spring.devtools.restart.trigger-file argument on old projects after upgrade
  • List of closed issues

• 1.3 (October 2016): Devtools and request mappings

  • Upgrade to Spring Boot version 1.4.1
  • Action to trigger devtools reload (trough toolbar button or Ctrl + Shift + L keyboard shortcut)
  • Spring boot dedicated panel in project properties dialog for specifying command line arguments and enabling devtools reload trigger
  • Moved some file templates to the default Spring Framework category
  • Navigator panel showing request URL mappings of a Controller / RestController class (contribution by Michael Simons)
  • List of closed issues

• 1.2 (August 2016): File templates improvements

  • Upgrade to Spring Boot version 1.4
  • The file templates wizards that generate Java classes now use the standard NetBeans widgets (better name proposal, choice of source/test location and destination package)
  • The wizards for application.properties files, additional configuration metadata and Spring Data repository interfaces now offer specific customization options
  • The file templates are now shown only if the relevant dependencies are present (e.g. REST Controller Class is shown only if there is a dependency on spring-boot-starter-web)
  • Devtools restart and reload now work when the project is run/debugged trough the spring maven plugin
  • Fixed some UI glitches
  • Enhanced Controller and RestController templates
  • List of closed issues

• 1.1 (June 2016): Refinements

  • Added missing @Component annotation to CommandLineRunner and ApplicationRunner file templates
  • No more NetBeans module implementation dependencies, this allows the plugin to be available from the Update Center
  • Improvements to New project wizard Spring Boot project (from Initializr):
    • Asynchronous querying of the web service
    • More paramenter validation
    • Filtering of dependencies
    • Show required boot version in tooltips of disabled dependencies
    • Options to remove the maven wrapper, add the spring configuration processor dependency and run/debug trough the maven spring plugin
  • List of closed issues

• 1.0 (May 2016): Initial public release