docs/guides/application_architecture/README.md

   1 # MVC Architecture
   2
   3 Large client side applications have always been hard to write, hard to organize and hard to maintain. They tend to quickly grow out of control as you add more functionality and developers to a project. Ext JS 4 comes with a new application architecture that not only organizes your code but reduces the amount you have to write.
   4
   5 Our application architecture follows an MVC-like pattern with Models and Controllers being introduced for the first time. There are many MVC architectures, most of which are slightly different from one another. Here's how we define ours:
   6
   7 * *Model* is a collection of fields and their data (e.g. a User model with username and password fields). Models know how to persist themselves through the data package, and can be linked to other models through associations. Models work a lot like the Ext JS 3 Record class, and are normally used with [Stores](#/api/Ext.data.Store) to present data into grids and other components
   8
   9 * *View* is any type of component - grids, trees and panels are all views.
  10
  11 * *Controllers* are special places to put all of the code that makes your app work - whether that's rendering views, instantiating Models, or any other app logic.
  12
  13 In this guide we'll be creating a very simple application that manages User data. By the end you will know how to put simple applications together using the new Ext JS 4 application architecture.
  14
  15 The application architecture is as much about providing structure and consistency as it is about actual classes and framework code. Following the conventions unlocks a number of important benefits:
  16
  17 * Every application works the same way so you only have to learn it once
  18 * It's easy to share code between apps because they all work the same way
  19 * You can use our build tools to create optimized versions of your applications for production use
  20
  21 ## File Structure
  22
  23 Ext JS 4 applications follow a unified directory structure that is the same for every app. Please check out the [Getting Started guide](#/guide/getting_started) for a detailed explanation on the basic file structure of an application. In MVC layout, all classes are placed into the `app` folder, which in turn contains sub-folders to namespace your models, views, controllers and stores. Here is how the folder structure for the simple example app will look when we're done:
  24
  25 {@img folderStructure.png Folder Structure}
  26
  27 In this example, we are encapsulating the whole application inside one folder called '`account_manager`'. Essential files from the [Ext JS 4 SDK](http://www.sencha.com/products/extjs/) are wrapped inside `ext-4.0` folder. Hence the content of our `index.html` looks like this:
  28
  29     <html>
  30     <head>
  31         <title>Account Manager</title>
  32
  33         <link rel="stylesheet" type="text/css" href="ext-4.0/resources/css/ext-all.css">
  34
  35         <script type="text/javascript" src="ext-4.0/ext-debug.js"></script>
  36
  37         <script type="text/javascript" src="app.js"></script>
  38     </head>
  39     <body></body>
  40     </html>
  41
  42 ## Creating the application in `app.js`
  43
  44 Every Ext JS 4 application starts with an instance of [Application](#/api/Ext.app.Application) class. The Application contains global settings for your application (such as the app's name), as well as maintains references to all of the models, views and controllers used by the app. An Application also contains a launch function, which is run automatically when everything is loaded.B
  45
  46 Let's create a simple Account Manager app that will help us manage User accounts. First we need to pick a global namespace for this application. All Ext JS 4 applications should only use a single global variable, with all of the application's classes nested inside it. Usually we want a short global variable so in this case we're going to use "AM":
  47
  48     Ext.application({
  49         name: 'AM',
  50
  51         appFolder: 'app',
  52
  53         launch: function() {
  54             Ext.create('Ext.container.Viewport', {
  55                 layout: 'fit',
  56                 items: [
  57                     {
  58                         xtype: 'panel',
  59                         title: 'Users',
  60                         html : 'List of users will go here'
  61                     }
  62                 ]
  63             });
  64         }
  65     });
  66
  67 There are a few things going on here. First we invoked `Ext.application` to create a new instance of Application class, to which we passed the name "`AM`". This automatically sets up a global variable `AM` for us, and registers the namespace to `Ext.Loader`, with the corresponding path of '`app`' set via the `appFolder` config option. We also provided a simple launch function that just creates a [Viewport](#/api/Ext.container.Viewport) which contains a single [Panel](#/api/Ext.panel.Panel) that will fill the screen.
  68
  69 {@img panelView.png Initial view with a simple Panel}
  70
  71 ## Defining a Controller
  72
  73 Controllers are the glue that binds an application together. All they really do is listen for events (usually from views) and take some actions. Continuing our Account Manager application, lets create a controller.  Create a file called `app/controller/Users.js` and add the following code:
  74
  75     Ext.define('AM.controller.Users', {
  76         extend: 'Ext.app.Controller',
  77
  78         init: function() {
  79             console.log('Initialized Users! This happens before the Application launch function is called');
  80         }
  81     });
  82
  83 Now lets add our newly created Users controller to the application config in app.js:
  84
  85     Ext.application({
  86         ...
  87
  88         controllers: [
  89             'Users'
  90         ],
  91
  92         ...
  93     });
  94
  95 When we load our application by visiting `index.html` inside a browser, the `Users` controller is automatically loaded (because we specified it in the Application definition above), and its `init` function is called just before the Application's `launch` function.
  96
  97 The `init` function is a great place to set up how your controller interacts with the view, and is usually used in conjunction with another Controller function - [control](#/api/Ext.app.Controller-method-control). The `control` function makes it easy to listen to events on your view classes and take some action with a handler function. Let's update our `Users` controller to tell us when the panel is rendered:
  98
  99     Ext.define('AM.controller.Users', {
 100         extend: 'Ext.app.Controller',
 101
 102         init: function() {
 103             this.control({
 104                 'viewport > panel': {
 105                     render: this.onPanelRendered
 106                 }
 107             });
 108         },
 109
 110         onPanelRendered: function() {
 111             console.log('The panel was rendered');
 112         }
 113     });
 114
 115 We've updated the `init` function to use `this.control` to set up listeners on views in our application. The `control` function uses the new ComponentQuery engine to quickly and easily get references to components on the page. If you are not familiar with ComponentQuery yet, be sure to check out the [ComponentQuery documentation](#/api/Ext.ComponentQuery) for a full explanation. In brief though, it allows us to pass a CSS-like selector that will find every matching component on the page.
 116
 117 In our init function above we supplied `'viewport > panel'`, which translates to "find me every Panel that is a direct child of a Viewport". We then supplied an object that maps event names (just `render` in this case) to handler functions. The overall effect is that whenever any component that matches our selector fires a `render` event, our `onPanelRendered` function is called.
 118
 119 When we run our application now we see the following:
 120
 121 {@img firstControllerListener.png Controller listener}
 122
 123 Not exactly the most exciting application ever, but it shows how easy it is to get started with organized code. Let's flesh the app out a little now by adding a grid.
 124
 125 ## Defining a View
 126
 127 Until now our application has only been a few lines long and only inhabits two files -  `app.js` and `app/controller/Users.js`. Now that we want to add a grid showing all of the users in our system, it's time to organize our logic a little better and start using views.
 128
 129 A View is nothing more than a Component, usually defined as a subclass of an Ext JS component. We're going to create our Users grid now by creating a new file called `app/view/user/List.js` and putting the following into it:
 130
 131     Ext.define('AM.view.user.List' ,{
 132         extend: 'Ext.grid.Panel',
 133         alias : 'widget.userlist',
 134
 135         title : 'All Users',
 136
 137         initComponent: function() {
 138             this.store = {
 139                 fields: ['name', 'email'],
 140                 data  : [
 141                     {name: 'Ed',    email: 'ed@sencha.com'},
 142                     {name: 'Tommy', email: 'tommy@sencha.com'}
 143                 ]
 144             };
 145
 146             this.columns = [
 147                 {header: 'Name',  dataIndex: 'name',  flex: 1},
 148                 {header: 'Email', dataIndex: 'email', flex: 1}
 149             ];
 150
 151             this.callParent(arguments);
 152         }
 153     });
 154
 155 Our View class is nothing more than a normal class. In this case we happen to extend the Grid Component and set up an alias so that we can use it as an xtype (more on that in a moment). We also passed in the [store](Ext.data.Store) configuration and the [columns](#/api/Ext.grid.Panel-cfg-columns) that the grid should render.
 156
 157 Next we need to add this view to our `Users` controller. Because we set an alias using the special `'widget.'` format, we can use 'userlist' as an xtype now, just like we had used `'panel'` previously.
 158
 159     Ext.define('AM.controller.Users', {
 160         extend: 'Ext.app.Controller',
 161
 162         views: [
 163             'user.List'
 164         ],
 165
 166         init: ...
 167
 168         onPanelRendered: ...
 169     });
 170
 171 And then render it inside the main viewport by modifying the launch method in `app.js` to:
 172
 173     Ext.application({
 174         ...
 175
 176         launch: function() {
 177             Ext.create('Ext.container.Viewport', {
 178                 layout: 'fit',
 179                 items: {
 180                     xtype: 'userlist'
 181                 }
 182             });
 183         }
 184     });
 185
 186 The only other thing to note here is that we specified `'user.List'` inside the views array. This tells the application to load that file automatically so that we can use it when we launch. The application uses Ext JS 4's new dynamic loading system to automatically pull this file from the server. Here's what we see when we refresh the page now:
 187
 188 {@img firstView.png Our first View}
 189
 190 ## Controlling the grid
 191
 192 Note that our `onPanelRendered` function is still being called. This is because our grid class still matches the `'viewport > panel'` selector. The reason for this is that our class extends Grid, which in turn extends Panel.
 193
 194 At the moment, the listeners we add to this selector will actually be called for every Panel or Panel subclass that is a direct child of the viewport, so let's tighten that up a bit using our new xtype. While we're at it, let's instead listen for double clicks on rows in the grid so that we can later edit that User:
 195
 196     Ext.define('AM.controller.Users', {
 197         extend: 'Ext.app.Controller',
 198
 199         views: [
 200             'user.List'
 201         ],
 202
 203         init: function() {
 204             this.control({
 205                 'userlist': {
 206                     itemdblclick: this.editUser
 207                 }
 208             });
 209         },
 210
 211         editUser: function(grid, record) {
 212             console.log('Double clicked on ' + record.get('name'));
 213         }
 214     });
 215
 216 Note that we changed the ComponentQuery selector (to simply `'userlist'`), the event name (to `'itemdblclick'`) and the handler function name (to `'editUser'`). For now we're just logging out the name of the User we double clicked:
 217
 218 {@img doubleClickHandler.png Double click handler}
 219
 220 Logging to the console is all well and good but we really want to edit our Users. Let's do that now, starting with a new view in `app/view/user/Edit.js`:
 221
 222     Ext.define('AM.view.user.Edit', {
 223         extend: 'Ext.window.Window',
 224         alias : 'widget.useredit',
 225
 226         title : 'Edit User',
 227         layout: 'fit',
 228         autoShow: true,
 229
 230         initComponent: function() {
 231             this.items = [
 232                 {
 233                     xtype: 'form',
 234                     items: [
 235                         {
 236                             xtype: 'textfield',
 237                             name : 'name',
 238                             fieldLabel: 'Name'
 239                         },
 240                         {
 241                             xtype: 'textfield',
 242                             name : 'email',
 243                             fieldLabel: 'Email'
 244                         }
 245                     ]
 246                 }
 247             ];
 248
 249             this.buttons = [
 250                 {
 251                     text: 'Save',
 252                     action: 'save'
 253                 },
 254                 {
 255                     text: 'Cancel',
 256                     scope: this,
 257                     handler: this.close
 258                 }
 259             ];
 260
 261             this.callParent(arguments);
 262         }
 263     });
 264
 265 Again we're just defining a subclass of an existing component - this time `Ext.window.Window`. Once more we used `initComponent` to specify the complex objects `items` and `buttons`. We used a `'fit'` layout and a form as the single item, which contains fields to edit the name and the email address. Finally we created two buttons, one which just closes the window, and the other that will be used to save our changes.
 266
 267 All we have to do now is add the view to the controller, render it and load the User into it:
 268
 269
 270     Ext.define('AM.controller.Users', {
 271         extend: 'Ext.app.Controller',
 272
 273         views: [
 274             'user.List',
 275             'user.Edit'
 276         ],
 277
 278         init: ...
 279
 280         editUser: function(grid, record) {
 281             var view = Ext.widget('useredit');
 282
 283             view.down('form').loadRecord(record);
 284         }
 285     });
 286
 287
 288 First we created the view using the convenient method `Ext.widget`, which is equivalent to `Ext.create('widget.useredit')`. Then we leveraged ComponentQuery once more to quickly get a reference to the edit window's form. Every component in Ext JS 4 has a `down` function, which accepts a ComponentQuery selector to quickly find any child component.
 289
 290 Double clicking a row in our grid now yields something like this:
 291
 292 {@img loadedForm.png Loading the form}
 293
 294 ## Creating a Model and a Store
 295
 296 Now that we have our edit form it's almost time to start editing our users and saving those changes. Before we do that though, we should refactor our code a little.
 297
 298 At the moment the `AM.view.user.List` component creates a Store inline. This works well but we'd like to be able to reference that Store elsewhere in the application so that we can update the data in it. We'll start by breaking the Store out into its own file - `app/store/Users.js`:
 299
 300     Ext.define('AM.store.Users', {
 301         extend: 'Ext.data.Store',
 302         fields: ['name', 'email'],
 303         data: [
 304             {name: 'Ed',    email: 'ed@sencha.com'},
 305             {name: 'Tommy', email: 'tommy@sencha.com'}
 306         ]
 307     });
 308
 309 Now we'll just make 2 small changes - first we'll ask our `Users` controller to include this Store when it loads:
 310
 311     Ext.define('AM.controller.Users', {
 312         extend: 'Ext.app.Controller',
 313         stores: [
 314             'Users'
 315         ],
 316         ...
 317     });
 318
 319 then we'll update `app/view/user/List.js` to simply reference the Store by id:
 320
 321     Ext.define('AM.view.user.List' ,{
 322         extend: 'Ext.grid.Panel',
 323         alias : 'widget.userlist',
 324
 325         //we no longer define the Users store in the `initComponent` method
 326         store: 'Users',
 327
 328         ...
 329     });
 330
 331 By including the stores that our `Users` controller cares about in its definition they are automatically loaded onto the page and given a [storeId](#/api/Ext.data.Store-cfg-storeId), which makes them really easy to reference in our views (by simply configuring `store: 'Users'` in this case).
 332
 333 At the moment we've just defined our fields (`'name'` and `'email'`) inline on the store. This works well enough but in Ext JS 4 we have a powerful `Ext.data.Model` class that we'd like to take advantage of when it comes to editing our Users. We'll finish this section by refactoring our Store to use a Model, which we'll put in `app/model/User.js`:
 334
 335     Ext.define('AM.model.User', {
 336         extend: 'Ext.data.Model',
 337         fields: ['name', 'email']
 338     });
 339
 340 That's all we need to do to define our Model, now we'll just update our Store to reference the Model name instead of providing fields inline, and ask the `Users` controller to get a reference to the model too:
 341
 342     //the Users controller will make sure that the User model is included on the page and available to our app
 343     Ext.define('AM.controller.Users', {
 344         extend: 'Ext.app.Controller',
 345         stores: ['Users'],
 346         models: ['User'],
 347         ...
 348     });
 349
 350     // we now reference the Model instead of defining fields inline
 351     Ext.define('AM.store.Users', {
 352         extend: 'Ext.data.Store',
 353         model: 'AM.model.User',
 354
 355         data: [
 356             {name: 'Ed',    email: 'ed@sencha.com'},
 357             {name: 'Tommy', email: 'tommy@sencha.com'}
 358         ]
 359     });
 360
 361
 362 Our refactoring will make the next section easier but should not have affected the application's current behavior. If we reload the page now and double click on a row we see that the edit User window still appears as expected. Now it's time to finish the editing functionality:
 363
 364 {@img loadedForm.png Loading the form}
 365
 366 ## Saving data with the Model
 367
 368 Now that we have our users grid loading data and opening an edit window when we double click each row, we'd like to save the changes that the user makes. The Edit User window that the defined above contains a form (with fields for name and email), and a save button. First let's update our controller's init function to listen for clicks to that save button:
 369
 370     Ext.define('AM.controller.Users', {
 371         init: function() {
 372             this.control({
 373                 'viewport > userlist': {
 374                     itemdblclick: this.editUser
 375                 },
 376                 'useredit button[action=save]': {
 377                     click: this.updateUser
 378                 }
 379             });
 380         },
 381
 382         updateUser: function(button) {
 383             console.log('clicked the Save button');
 384         }
 385     });
 386
 387 We added a second ComponentQuery selector to our `this.control` call - this time `'useredit button[action=save]'`. This works the same way as the first selector - it uses the `'useredit'` xtype that we defined above to focus in on our edit user window, and then looks for any buttons with the `'save'` action inside that window. When we defined our edit user window we passed `{action: 'save'}` to the save button, which gives us an easy way to target that button.
 388
 389 We can satisfy ourselves that the `updateUser` function is called when we click the Save button:
 390
 391 {@img saveHandler.png Seeing the save handler}
 392
 393 Now that we've seen our handler is correctly attached to the Save button's click event, let's fill in the real logic for the `updateUser` function. In this function we need to get the data out of the form, update our User with it and then save that back to the Users store we created above. Let's see how we might do that:
 394
 395     updateUser: function(button) {
 396         var win    = button.up('window'),
 397             form   = win.down('form'),
 398             record = form.getRecord(),
 399             values = form.getValues();
 400
 401         record.set(values);
 402         win.close();
 403     }
 404
 405 Let's break down what's going on here. Our click event gave us a reference to the button that the user clicked on, but what we really want is access to the form that contains the data and the window itself. To get things working quickly we'll just use ComponentQuery again here, first using `button.up('window')` to get a reference to the Edit User window, then `win.down('form')` to get the form.
 406
 407 After that we simply fetch the record that's currently loaded into the form and update it with whatever the user has typed into the form. Finally we close the window to bring attention back to the grid. Here's what we see when we run our app again, change the name field to `'Ed Spencer'` and click save:
 408
 409 {@img updatedGridRecord.png The record in the grid has been updated}
 410
 411 ### Saving to the server
 412
 413 Easy enough. Let's finish this up now by making it interact with our server side. At the moment we are hard coding the two User records into the Users Store, so let's start by reading those over AJAX instead:
 414
 415     Ext.define('AM.store.Users', {
 416         extend: 'Ext.data.Store',
 417         model: 'AM.model.User',
 418         autoLoad: true,
 419
 420         proxy: {
 421             type: 'ajax',
 422             url: 'data/users.json',
 423             reader: {
 424                 type: 'json',
 425                 root: 'users',
 426                 successProperty: 'success'
 427             }
 428         }
 429     });
 430
 431 Here we removed the `'data'` property and replaced it with a [Proxy](#/api/Ext.data.proxy.Proxy). Proxies are the way to load and save data from a Store or a Model in Ext JS 4. There are proxies for AJAX, JSON-P and HTML5 localStorage among others. Here we've used a simple AJAX proxy, which we've told to load data from the url `'data/users.json'`.
 432
 433 We also attached a [reader](#/api/Ext.data.reader.Reader) to the Proxy. The reader is responsible for decoding the server response into a format the Store can understand. This time we used a JSON reader, and specified the root and `successProperty` configurations (see the [Json Reader](#/api/Ext.data.reader.Json) docs for more on those configurations). Finally we'll create our `data/users.json` file and paste our previous data into it:
 434
 435     {
 436         success: true,
 437         users: [
 438             {id: 1, name: 'Ed',    email: 'ed@sencha.com'},
 439             {id: 2, name: 'Tommy', email: 'tommy@sencha.com'}
 440         ]
 441     }
 442
 443 The only other change we made to the Store was to set `autoLoad` to `true`, which means the Store will ask its Proxy to load that data immediately. If we refresh the page now we'll see the same outcome as before, except that we're now no longer hard coding the data into our application.
 444
 445 The last thing we want to do here is send our changes back to the server. For this example we're just using static JSON files on the server side so we won't see any database changes but we can at least verify that everything is plugged together correctly. First we'll make a small change to our new proxy to tell it to send updates back to a different url:
 446
 447     proxy: {
 448         type: 'ajax',
 449         api: {
 450             read: 'data/users.json',
 451             update: 'data/updateUsers.json'
 452         },
 453         reader: {
 454             type: 'json',
 455             root: 'users',
 456             successProperty: 'success'
 457         }
 458     }
 459
 460 We're still reading the data from `users.json`, but any updates will be sent to `updateUsers.json`. This is just so that we can return a dummy response so we know things are working. The `updateUsers.json` file just contains `{"success": true}`. The only other change we need to make is to tell our Store to synchronize itself after editing, which we do by adding one more line inside the updateUser function, which now looks like this:
 461
 462     updateUser: function(button) {
 463         var win    = button.up('window'),
 464             form   = win.down('form'),
 465             record = form.getRecord(),
 466             values = form.getValues();
 467
 468         record.set(values);
 469         win.close();
 470         this.getUsersStore().sync();
 471     }
 472
 473 Now we can run through our full example and make sure that everything works. We'll edit a row, hit the Save button and see that the request is correctly sent to `updateUser.json`
 474
 475 {@img postUpdatesToServer.png The record in the grid has been updated}
 476
 477 ## Deployment
 478
 479 The newly introduced Sencha SDK Tools ([download here](http://www.sencha.com/products/extjs/download/)) makes deployment of any Ext JS 4 application easier than ever. The tools allows you to generate a manifest of all dependencies in the form of a JSB3 (JSBuilder file format) file, and create a minimal custom build of just what your application needs within minutes.
 480
 481 Please refer to the [Getting Started guide](#/guide/getting_started) for detailed instructions.
 482
 483 ## Next Steps
 484
 485 We've created a very simple application that manages User data and sends any updates back to the server. We started out simple and gradually refactored our code to make it cleaner and more organized. At this point it's easy to add more functionality to our application without creating spaghetti code. The full source code for this application can be found in the Ext JS 4 SDK download, inside the examples/app/simple folder.
 486
 487 In the next guide, we'll look at advanced Controller usage and patterns that can make your application code smaller and easier to maintain.