Download to read offline
![Ez18n - Big picture
Messages
+loveMeTender() : String [ 1]
+doYouLove( name : String [ 1] ) : S tring [1]
MessagesMobile Bundle MessagesDe sktopBundle
MessagesMobileBundle() MessagesDesktopBundle()
getMessage( key : String [ 1] , params : Object [1] ) : String [ 1] getMessage( key : String [ 1] , params : Object [1] ) : String [ 1]
loveMeTender() : String [1] loveMeTender() : String [1]
doYouLove( name : S tring [1] ) : String [1] doYouLove( name : S tring [1] ) : String [1]
«annotate» «annotate»
«inject » «inject »
-delegate -delegate 1
1
Mobile BundleFactory Re sourceBundle De sktop
<S >get ( service, annotation )
Mars JUG 2013](https://image.slidesharecdn.com/smartannotationprocessing2013-130111113732-phpapp02/75/Smart-Annotation-Processing-Marseille-JUG-29-2048.jpg)
More Related Content
Similar to Smart Annotation Processing - Marseille JUG
![[BDD 2025 - Mobile Development] Exploring Apple’s On-Device FoundationModels](https://cdn.slidesharecdn.com/ss_thumbnails/md-exploringappleson-devicefoundationmodels-251124030840-d690542c-thumbnail.jpg?width=640&height=640&fit=bounds)
![[BDD 2025 - Mobile Development] Crafting Immersive UI with E2E and AGSL Shade...](https://cdn.slidesharecdn.com/ss_thumbnails/md-craftingimmersiveuiwithe2eandagslshaderveronicaputrianggraini-251124030840-0c677f44-thumbnail.jpg?width=640&height=640&fit=bounds)
![[BDD 2025 - Full-Stack Development] The Modern Stack: Building Web & AI Appli...](https://cdn.slidesharecdn.com/ss_thumbnails/fs-themodernstackbuildingwebaiapplicationswithserverless-251124030844-388cf04f-thumbnail.jpg?width=640&height=640&fit=bounds)
Smart Annotation Processing - Marseille JUG
- 1. Smart Use ofAnnotation Processing - APT @gdigugli @dbaeli Mars JUG 2013
- 2. Speakers @dbaeli - DimitriBAELI @gdigugli - Gilles Di Guglielmo • Java developer since 1999 • Java developer since 1999 • R&D Team Mentor at • Software architect at • Coder, DevOps, Agile Coach • ILOG - IBM – From idea to production 2D graphic toolkit • eXo Platform Rule engine • VP Quality • Prima-Solutions Services platform for J2EE Domain models code generators Mars JUG 2013 2
- 3. Content Display Management MarsJUG 2013
- 4. The story Effective ContentDisplay using APT Tooling • Content Management • APT Engine Labels • APT Processors Layout & images Generate technical code • Clean code Generate reports Strong Quality Generate patterns Easy Maintenance based on i18n • @Message • @MessageBundle • Dedicated APT Processors https://github.com/lesfurets/ez18n Mars JUG 2013
- 5. Improved i18n for text display Mars JUG 2013
- 6. Java i18n pattern •The JDK default tooling to: Dynamically bind the content Usable for Texts, but also CSS and images (urls) • Tooling : java.util.ResourceBundle : for .properties reading java.util.MessageFormat : tiny templating .properties files with naming pattern Mars JUG 2013
- 7. java.util.ResourceBundle • The .propertiesloader for a given Locale • Key / Value in .properties • Naming convention for the storage Messages_en_EN.properties Language Country Mars JUG 2013
- 8. java.util.MessageFormat • Tiny templating • format(“<pattern>”, args) • Date, numbers are formatted according to the Locale • Options, conditional values easy to use Mars JUG 2013
- 9. .properties issues • Lowquality control – Keys are strings in the code – Poor IDE support • No warning on unused or wrong keys – Encoding Hell • use uxxxx or you’re in trouble • Forces you to maintain two files in sync – key declaration / value in .properties – Key usage in the .java files Mars JUG 2013
- 10.
- 11. Ez18n : improvedi18n • Interfaces representing each .properties • The methods acts as keys Messages.java Messages.properties Mars JUG 2013
- 12. Annotations and Codegeneration • Same pattern as in GWT, but for J2SE • New Annotations in the code : @MessageBundle to mark interfaces represents a ResourceBundle @Message to mark methods represents a localization key • Generate : .properties file (for ‘default’) A ResourceBundle for each .properties Manage other languages out-side your code Mars JUG 2013
- 13. Improved i18n benefits •Now you can Refactor your keys Maintain the ‘default’ in Java Never change a .properties file for default locale • And use it with other libs: GWT (done on GitHub) Even JQuery, Dojo, CoffeeScript (planned) We called that ez18n Mars JUG 2013
- 14. APT to generate .properties and ResourceBundle classes from annotations Mars JUG 2013
- 15. Behind the scene How APT works Mars JUG 2013
- 16. APT basics • APT - Annotation Processing Tool • Kind of old-school pre-processing • Standard in JDK6+ (JSR 269) • No runtime overload • Based on annotations in source code • Standard since JDK 1.6 (available in Sun JDK 1.5) Mars JUG 2013
- 17. APT annotations • Use@Retention, @Target Mars JUG 2013
- 18. APT Processors • javax.annotation.processing.Processor •Code parsing similar to Reflection No need of compiled code Some limitations • 2 key elements : @SupportedAnnotationTypes to declare the matching annotations FileObject : the future generated file Mars JUG 2013
- 19. Similarities with java.lang.reflect Java.lang.reflect Javax.annotation.processing java.lang.Class TypeElement Constructor ExecutableElement Field, Parameter VariableElement Method ExecutableElement java.lang.Package PackageElement • NO Class.newInstance() • NO instanceOf, NO isAssignable() • NO getConstructor, getMethod, … • Weak inheritance support Mars JUG 2013
- 20. Processor code sample Processor declaration Use a FileObject to generate the content Mars JUG 2013
- 21. APT command line javac -cp $CLASSPATH -proc:only Or -proc:none -encoding UTF-8 -processor $PROCESSOR processors fqcn list -d $PROJECT_HOMEtargetclasses -s $PROJECT_HOMEtargetgenerated-sourcesapt -sourcepath $SOURCE_PATH -verbose $FILES optional Mars JUG 2013
- 22. APT tooling • Mavenintegration maven-processor-plugin (google-code) • Ant integration javac • IDE integration Extend the JDK compilation options Mars JUG 2013
- 23. APT usages • Generaterequired repetitive code : Not always possible at runtime Unit tests, JMX declarations Utility code with coverage and debug • Build your reports on your code Your metrics without runtime overload Even fail the build if you want ! Mars JUG 2013
- 24. One or Twophase compilation • One phase : APT runs during the compilation Generated code is directly produced as bytecode (.class) Harder to debug (no .java created) Two phases : “proc:only” javac with proc:only then with proc:none Creates .java files in the sourcepath Mars JUG 2013
- 25. Problems with APT •Beware of the “Generate” golden hammer generate needed code • APT Processors can be tricky: hard to test / maintain bad error management (hidden errors !) Not really (well) documented • No built-in templating mechanism • Enforced file path creation • Beware of maven parallel builds Because javac is not thread safe Mars JUG 2013
- 26. It’s time toconvince your team • APT parses the source code to generate Java Files & .class, Reports (.csv, …) Build log information or even build failures • It allows you to have a source level DSL Annotate your code & Generate the plumbing Compile / Debug the generated code • APT framework is compact Mars JUG 2013
- 27. Go deep inAPT usage with Ez18n Mars JUG 2013
- 28. Demo • The Stock-watcheravailable on – http://github.com/lesfurets/ez18n – In the ez18n-webapp module – Derived from a GWT Sample • With a desktop browser • With a mobile browser Mars JUG 2013
- 29. Ez18n - Bigpicture Messages +loveMeTender() : String [ 1] +doYouLove( name : String [ 1] ) : S tring [1] MessagesMobile Bundle MessagesDe sktopBundle MessagesMobileBundle() MessagesDesktopBundle() getMessage( key : String [ 1] , params : Object [1] ) : String [ 1] getMessage( key : String [ 1] , params : Object [1] ) : String [ 1] loveMeTender() : String [1] loveMeTender() : String [1] doYouLove( name : S tring [1] ) : String [1] doYouLove( name : S tring [1] ) : String [1] «annotate» «annotate» «inject » «inject » -delegate -delegate 1 1 Mobile BundleFactory Re sourceBundle De sktop <S >get ( service, annotation ) Mars JUG 2013
- 30. Ez18n - APTchaining • 5 APT processors to obtain the default pattern • Optional CSV files for analysis/tooling Mars JUG 2013
- 31. From Messages toDesktopMessages.properties • One property file per interface with @MessageBundle • One property entry per method with @Message Mars JUG 2013
- 32. From Messages to MessagesDesktopBundle.java (1/2) Mars JUG 2013
- 33. From Messages to MessagesDesktopBundle.java (2/2) Mars JUG 2013
- 34. From Messages to META-INF/services/org.ez18n.sample.Messages • Using META-INF/services to inject the mobile & desktop implementation • The two implementations could be filtered at runtime using annotations and java.util.ServiceLoader @Mobile @Desktop Mars JUG 2013
- 35. A factory forthe Messages implementations • Using java.util.ServiceLoader to inject the interface with @MessageBundle • @Desktop and @Mobile used to filter the injection result Mars JUG 2013
- 36. Client code samplewith JUnit • Some basic JUnit test using the API The unit tests are generated using APT too BundleFactory.get(…) usage in the test @Before to retrieve the bundle implementation Mars JUG 2013
- 37. Ez18n - Summary Maven, javac Injection & APT Mars JUG 2013
- 38. If you’d like a JSR for ez18n please tell us ! Ez18n = @Message @MessageBundle Set of Processors Mars JUG 2013
- 39. APT Adoption “As thelead engineer on JSR 269 in JDK 6, I'd be heartened to see greater adoption and use of annotation processing by Java developers.” Joseph D. Darcy (Oracle) Mars JUG 2013
- 40. APT JDK 8 •possibilité d’ajouter une annotation sur les types d’objets (JSR 308) • possibilité de répéter une annotation sur une déclaration (JEP 120) • portage de l’API “javax.lang.model” au runtime pour qu’elle ne soit pas disponible uniquement à la compilation (JEP 119) • Voir les notes : http://blog.soat.fr/2012/11/devoxx-2012-jsr- 308-annotations-on-java-types/ Mars JUG 2013
- 41. JavaOne 2012 APT virtual mini-track • Sessions – Advanced Annotation Processing with JSR 269 • Jaroslav Tulach – Build Your Own Type System for Fun and Profit • Werner Dietl and Michael Ernst – Annotations and Annotation Processing: What’s New in JDK 8? • Joel Borggrén-Franck – Hack into Your Compiler! • Jaroslav Tulach – Writing Annotation Processors to Aid Your Development Process • Ian Robertson • Thanks to – Joseph D. Darcy (APT spec lead) - https://blogs.oracle.com/darcy/ Mars JUG 2013
- 42. Thank you ! Ez18n is on GitHub Just fork it ! https://github.com/lesfurets/ez18n Mars JUG 2013 42