Ingeniero

Spring Roo - Reference Documentation

1.2.1.RELEASE

Copyright © 2009, 2010, 2011 , , , ,

Copyright 2009, 2010, 2011 VMware, Inc. All Rights Reserved. Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print orelectronically.

Preface .... xi I. Welcome to Spring Roo .... 1 1. Introduction .... 2 1.1. What is Roo? .... 2 1.2. Why Use It .... 3 1.2.1. Higher Productivity .... 3 1.2.2. Stock-Standard Java .... 3 1.2.3. Usable and Learnable .... 4 1.2.4. No Engineering Trade-Offs .... 5 1.2.5. Easy Roo Removal .... 6 1.3. Installation .... 6 1.4. Optional ROO_OPTS Configuration .... 7 1.5. First Steps:Your Own Web App in Under 10 Minutes .... 8 1.6. Exploring the Roo Samples .... 10 1.7. Suggested Steps to Roo Productivity .... 10 2. Beginning With Roo: The Tutorial .... 12 2.1. What You'll Learn .... 12 2.2. Alternative Tutorial: The Wedding RSVP Application .... 12 2.3. Tutorial Application Details .... 13 2.4. Step 1: Starting a Typical Project .... 13 2.5. Step 2: Creating Entities andFields .... 15 2.6. Step 3: Integration Tests .... 18 2.7. Step 4: Using Your IDE .... 18 2.8. Step 5: Creating A Web Tier .... 20 2.9. Step 6: Loading the Web Server .... 20 2.10. Securing the Application .... 21 2.11. Customizing the Look & Feel of the Web UI .... 23 2.12. Selenium Tests .... 24 2.13. Backups and Deployment .... 24 2.14. Where To Next .... 25 3. Application Architecture .... 26 3.1.Architectural Overview .... 26 3.2. Critical Technologies .... 26 3.2.1. AspectJ .... 26 3.2.2. Spring .... 29 3.3. Entity Layer .... 30 3.4. Web Layer .... 31 3.5. Optional Services Layer .... 32 3.6. Goodbye DAOs .... 32 3.7. Maven .... 34 3.7.1. Packaging .... 34 3.7.2. Multi-Module Support .... 35 4. Usage and Conventions .... 38 4.1. Usability Philosophy .... 38 4.2. Shell Features .... 394.3. IDE Usage .... 41 4.4. Build System Usage .... 42 4.5. File System Conventions .... 43 4.6. Add-On Installation and Removal .... 43

1.2.1.RELEASE

ii

Spring Roo - Reference Documentation 4.7. Recommended Practices .... 43 4.8. Managing Roo Add-Ons .... 44 5. Existing Building Blocks .... 49 5.1. Existing Projects .... 49 5.2. Existing Databases .... 49 6. Removing Roo .... 50 6.1. HowRoo Avoids Lock-In .... 50 6.2. Pros and Cons of Removing Roo .... 51 6.3. Step-by-Step Removal Instructions .... 52 6.3.1. Step 1: Push-In Refactor .... 52 6.3.2. Step 2: Annotation Source Code Removal .... 52 6.3.3. Step 3: Annotation JAR Removal .... 53 6.4. Reenabling Roo After A Removal .... 53 II. Base Add-Ons .... 54 7. Base Add-On Overview .... 55 8. Persistence Add-On .... 57 8.1. JPAsetup command .... 57 8.2. Entity JPA command .... 59 8.3. Field commands .... 62 9. Incremental Database Reverse Engineering (DBRE) Add-On .... 65 9.1. Introduction .... 65 9.1.1. What are the benefits of Roo's incremental reverse engineering? .... 65 9.1.2. How does DBRE work? .... 65 9.2. Installation .... 66 9.3. DBRE Add-On commands .... 67 9.4. The @RooDbManaged annotation .... 68 9.5.Supported JPA 2.0 features .... 69 9.5.1. Simple primary keys .... 69 9.5.2. Composite primary keys .... 70 9.5.3. Entity relationships .... 71 9.5.4. Other fields .... 73 9.5.5. Existing fields .... 73 9.6. Troubleshooting .... 73 10. Application Layering .... 75 10.1. The Big Picture .... 75 10.2. Persistence Layers .... 75 10.2.1. JPA Entities (Active Record style) .... 76 10.2.2. JPA Repository ....76 10.2.3. MongoDB Persistence .... 77 10.3. Service Layer .... 79 11. Web MVC Add-On .... 81 11.1. Controller commands .... 81 11.2. Application Conversion Service .... 84 11.3. JSP Views .... 85 12. JavaServer Faces (JSF) Add-On .... 90 12.1. JSF commands .... 90 12.2. The @RooJsfManagedBean annotation .... 91 12.3. The @RooJsfConverter annotation .... 91

1.2.1.RELEASE

iii

Spring Roo...