PDE Good Practices

PDE Good Practices Ankur Sharma Eclipse PDE co-lead @ankur_sharma http://blog.ankursharma.org

#1 Separation of Concerns
A plug-in is used to group your code into a modular, extendable and sharable unit.
Do not create monolithic plug-ins
Separate the platform/locale code into fragments
Separate Core, UI, Doc, etc

#2 bundle-localization
Externalize bundle strings
‘Usage of non-externalized strings’ preference

#3 Lazy-loading
Prefer to have lazy loading plug-ins
Helps reduce memory footprint
Every plug-in loads with a dependency baggage
Judiciously make plug-ins reusable

#3 Singletons
Prefer singleton plug-ins
but there is a cost involved
singleton plug-ins can not be dynamically installed

#4 Use startup code carefully
Plug-in startup and constructor
org.eclipse.ui.startup extension

#5 Prefer target over workspace
Prefer adding the required plug-ins to Target Platform
Adding them to workspace makes it difficult to track and manage.

#6 Share target definitions

#7 Keep build.properties synced
Export wizard and headless build uses build.properties
Use build preferences to keep it in sync with classpath
This helps avoid “ …but it was working in my workspace! ” situations.

#8 EE and Java compliance
Set the Execution Environments to the lowest required JRE version.
Set the appropriate Java Compiler preferences

#9 Use proper version ranges
Use proper version restrictions
Also helps in catching API breakages

#10 Versions are not for marketing
Version numbering is very important
Version numbers are not meant for marketing
Stick to major.minor.micro-qualifier
Bump up the correct number in version on releases.

#11 Define API carefully
Put classes in correct packages
Public, internal and x-friends
Don’t re-export everything
An Eclipse API is forever

#12 Use API Tools
API Tools will help you with
#9 Use proper version ranges
#10 Versions are not for marketing
#11 Define API carefully

thank you

PDE Good Practices

by Ankur Sharma on May 11, 2011

Accessibility

Categories

Tags

Upload Details

Usage Rights

2 Embeds 44

Statistics

PDE Good Practices — Presentation Transcript

http://www.eclipseday.in	43
url_unknown	1