Pro ASP.NET MVC 5. Adam Freeman

Transcription

1 Pro ASP.NET MVC 5 Adam Freeman

2 Pro ASP.NET MVC 5 Copyright 2013 by Adam Freeman This work is subject to copyright. All rights are reserved by the Publisher, whether the whole or part of the material is concerned, specifically the rights of translation, reprinting, reuse of illustrations, recitation, broadcasting, reproduction on microfilms or in any other physical way, and transmission or information storage and retrieval, electronic adaptation, computer software, or by similar or dissimilar methodology now known or hereafter developed. Exempted from this legal reservation are brief excerpts in connection with reviews or scholarly analysis or material supplied specifically for the purpose of being entered and executed on a computer system, for exclusive use by the purchaser of the work. Duplication of this publication or parts thereof is permitted only under the provisions of the Copyright Law of the Publisher s location, in its current version, and permission for use must always be obtained from Springer. Permissions for use may be obtained through RightsLink at the Copyright Clearance Center. Violations are liable to prosecution under the respective Copyright Law. ISBN-13 (pbk): ISBN-13 (electronic): Trademarked names, logos, and images may appear in this book. Rather than use a trademark symbol with every occurrence of a trademarked name, logo, or image we use the names, logos, and images only in an editorial fashion and to the benefit of the trademark owner, with no intention of infringement of the trademark. The use in this publication of trade names, trademarks, service marks, and similar terms, even if they are not identified as such, is not to be taken as an expression of opinion as to whether or not they are subject to proprietary rights. While the advice and information in this book are believed to be true and accurate at the date of publication, neither the authors nor the editors nor the publisher can accept any legal responsibility for any errors or omissions that may be made. The publisher makes no warranty, express or implied, with respect to the material contained herein. President and Publisher: Paul Manning Lead Editor: Ewan Buckingham Technical Reviewer: Fabio Claudio Ferracchiati Editorial Board: Steve Anglin, Mark Beckner, Ewan Buckingham, Gary Cornell, Louise Corrigan, Jim DeWolf, Jonathan Gennick, Jonathan Hassell, Robert Hutchinson, Michelle Lowman, James Markham, Matthew Moodie, Jeff Olson, Jeffrey Pepper, Douglas Pundick, Ben Renow-Clarke, Dominic Shakeshaft, Gwenan Spearing, Matt Wade, Steve Weiss Coordinating Editor: Kevin Shea Copy Editor: Larissa Shmailo Compositor: SPi Global Indexer: SPi Global Artist: SPi Global Cover Designer: Anna Ishchenko Distributed to the book trade worldwide by Springer Science+Business Media New York, 233 Spring Street, 6th Floor, New York, NY Phone SPRINGER, fax (201) , orders-ny@springer-sbm.com, or visit Apress Media, LLC is a California LLC and the sole member (owner) is Springer Science + Business Media Finance Inc (SSBM Finance Inc). SSBM Finance Inc is a Delaware corporation. For information on translations, please rights@apress.com, or visit Apress and friends of ED books may be purchased in bulk for academic, corporate, or promotional use. ebook versions and licenses are also available for most titles. For more information, reference our Special Bulk Sales ebook Licensing web page at Any source code or other supplementary material referenced by the author in this text is available to readers at For detailed information about how to locate your book s source code, go to

3 Dedicated to my lovely wife, Jacqui Griffyth.

4

5 Contents at a Glance About the Author... xxv About the Technical Reviewer... xxvii Chapter 1: Putting ASP.NET MVC in Context...1 Chapter 2: Your First MVC Application...11 Chapter 3: The MVC Pattern...51 Chapter 4: Essential Language Features...67 Chapter 5: Working with Razor...95 Chapter 6: Essential Tools for MVC Chapter 7: SportsStore: A Real Application Chapter 8: SportsStore: Navigation Chapter 9: SportsStore: Completing the Cart Chapter 10: SportsStore: Mobile Chapter 11: SportsStore: Administration Chapter 12: SportsStore: Security & Finishing Touches Chapter 13: Deployment Chapter 14: Overview of MVC Projects Chapter 15: URL Routing Chapter 16: Advanced Routing Features Chapter 17: Controllers and Actions Chapter 18: Filters v

6 at a Glance Chapter 19: Controller Extensibility Chapter 20: Views Chapter 21: Helper Methods Chapter 22: Templated Helper Methods Chapter 23: URL and Ajax Helper Methods Chapter 24: Model Binding Chapter 25: Model Validation Chapter 26: Bundles Chapter 27: Web API and Single-page Applications Index vi

7 Contents About the Author... xxv About the Technical Reviewer... xxvii Chapter 1: Putting ASP.NET MVC in Context...1 Understanding the History of ASP.NET...1 What Is Wrong with ASP.NET Web Forms?... 2 Web Development Today...3 Web Standards and REST... 3 Agile and Test-Driven Development... 3 Ruby on Rails... 4 Node.js... 4 Key Benefits of ASP.NET MVC...5 MVC Architecture... 5 Extensibility... 5 Tight Control over HTML and HTTP... 6 Testability... 6 Powerful Routing System... 7 Built on the Best Parts of the ASP.NET Platform... 7 Modern API... 7 ASP.NET MVC Is Open Source... 8 What Do I Need to Know?...8 What Is the Structure of This Book?...8 Part 1: Introducing ASP.NET MVC Part 2: ASP.NET MVC in Detail... 8 vii

8 viii What s New in this Edition?...9 Where Can I Get the Example Code?...9 What Software Do I Need for This Book?...10 Credits...10 Summary...10 Chapter 2: Your First MVC Application...11 Preparing Visual Studio...11 Creating a New ASP.NET MVC Project...11 Adding the First Controller Understanding Routes Rendering Web Pages...19 Creating and Rendering a View Adding Dynamic Output Creating a Simple Data-Entry Application...25 Setting the Scene Designing a Data Model Linking Action Methods Building the Form Setting the Start URL Handling Forms Adding Validation Styling the Content Completing the Example Summary...49 Chapter 3: The MVC Pattern...51 The History of MVC...51 Understanding the MVC Pattern...51 Understanding the Domain Model The ASP.NET Implementation of MVC Comparing MVC to Other Patterns... 53

9 Building Loosely Coupled Components...56 Using Dependency Injection Using a Dependency Injection Container Getting Started with Automated Testing...60 Understanding Unit Testing Understanding Integration Testing Summary...66 Chapter 4: Essential Language Features...67 Preparing the Example Project...67 Adding the System.Net.Http Assembly Using Automatically Implemented Properties...69 Using Object and Collection Initializers...72 Using Extension Methods...74 Applying Extension Methods to an Interface Creating Filtering Extension Methods Using Lambda Expressions...80 Using Automatic Type Inference...84 Using Anonymous Types...84 Performing Language Integrated Queries...86 Understanding Deferred LINQ Queries Using Async Methods...91 Applying the async and await Keywords Summary...94 Chapter 5: Working with Razor...95 Preparing the Example Project...95 Defining the Model Defining the Controller Creating the View ix

10 Working with the Model Object...97 Working with Layouts...99 Creating the Layout Applying a Layout Using a View Start File Demonstrating Shared Layouts Using Razor Expressions Inserting Data Values Setting Attribute Values Using Conditional Statements Enumerating Arrays and Collections Dealing with Namespaces Summary Chapter 6: Essential Tools for MVC Preparing the Example Project Creating the Model Classes Adding the Controller Adding the View Using Ninject Understanding the Problem Adding Ninject to the Visual Studio Project Getting Started with Ninject Setting up MVC Dependency Injection Creating Chains of Dependency Specifying Property and Constructor Parameter Values Using Conditional Binding Setting the Object Scope Unit Testing with Visual Studio Creating the Unit Test Project Creating the Unit Tests x

11 Running the Unit Tests (and Failing) Implementing the Feature Testing and Fixing the Code Using Moq Understanding the Problem Adding Moq to the Visual Studio Project Adding a Mock Object to a Unit Test Creating a More Complex Mock Object Summary Chapter 7: SportsStore: A Real Application Getting Started Creating the Visual Studio Solution and Projects Installing the Tool Packages Adding References Between Projects Setting Up the DI Container Running the Application Starting the Domain Model Creating an Abstract Repository Making a Mock Repository Displaying a List of Products Adding a Controller Adding the Layout, View Start File and View Setting the Default Route Running the Application Preparing a Database Creating the Database Defining the Database Schema Adding Data to the Database Creating the Entity Framework Context Creating the Product Repository xi

12 Adding Pagination Displaying Page Links Improving the URLs Styling the Content Installing the Bootstrap Package Applying Bootstrap Styles to the Layout Creating a Partial View Summary Chapter 8: SportsStore: Navigation Adding Navigation Controls Filtering the Product List Refining the URL Scheme Building a Category Navigation Menu Correcting the Page Count Building the Shopping Cart Defining the Cart Entity Adding the Add to Cart Buttons Implementing the Cart Controller Displaying the Contents of the Cart Summary Chapter 9: SportsStore: Completing the Cart Using Model Binding Creating a Custom Model Binder Completing the Cart Removing Items from the Cart Adding the Cart Summary Submitting Orders Extending the Domain Model Adding the Checkout Process Implementing the Order Processor xii

13 Registering the Implementation Completing the Cart Controller Displaying Validation Errors Displaying a Summary Page Summary Chapter 10: SportsStore: Mobile Putting Mobile Web Development in Context Doing Nothing (Or As Little As Possible) Using Responsive Design Creating a Responsive Header Creating a Responsive Product List Creating Mobile Specific Content Creating a Mobile Layout Creating the Mobile Views Summary Chapter 11: SportsStore: Administration Adding Catalog Management Creating a CRUD Controller Creating a New Layout Implementing the List View Editing Products Creating New Products Deleting Products Summary Chapter 12: SportsStore: Security & Finishing Touches Securing the Administration Controller Creating a Basic Security Policy Applying Authorization with Filters Creating the Authentication Provider xiii

14 Creating the Account Controller Creating the View Image Uploads Extending the Database Enhancing the Domain Model Creating the Upload User Interface Elements Saving Images to the Database Implementing the GetImage Action Method Displaying Product Images Summary Chapter 13: Deployment Preparing Windows Azure Creating the Web Site and Database Preparing the Database for Remote Administration Creating the Schema Deploying the Application Summary Chapter 14: Overview of MVC Projects Working with Visual Studio MVC Projects Creating the Project Understanding MVC Conventions Debugging MVC Applications Preparing the Example Project Launching the Visual Studio Debugger Causing the Visual Studio Debugger to Break Using Edit and Continue Using Browser Link Summary xiv

15 Chapter 15: URL Routing Preparing the Example Project Creating the Example Controllers Creating the View Setting the Start URL and Testing the Application Introducing URL Patterns Creating and Registering a Simple Route Using the Simple Route Defining Default Values Using Static URL Segments Defining Custom Segment Variables Using Custom Variables as Action Method Parameters Defining Optional URL Segments Defining Variable-Length Routes Prioritizing Controllers by Namespaces Constraining Routes Constraining a Route Using a Regular Expression Constraining a Route to a Set of Specific Values Constraining a Route Using HTTP Methods Using Type and Value Constraints Defining a Custom Constraint Using Attribute Routing Enabling and Applying Attribute Routing Creating Routes with Segment Variables Applying Route Constraints Using a Route Prefix Summary xv

16 Chapter 16: Advanced Routing Features xvi Preparing the Example Project Simplifying the Routes Adding the Optimization Package Updating the Unit Test Project Generating Outgoing URLs in Views Using the Routing System to Generate an Outgoing URL Targeting Other Controllers Passing Extra Values Specifying HTML Attributes Generating Fully Qualified URLs in Links Generating URLs (and Not Links) Generating Outgoing URLs in Action Methods Generating a URL from a Specific Route Customizing the Routing System Creating a Custom RouteBase Implementation Creating a Custom Route Handler Working with Areas Creating an Area Populating an Area Resolving the Ambiguous Controller Issue Creating Areas with Attributes Generating Links to Actions in Areas Routing Requests for Disk Files Configuring the Application Server Defining Routes for Disk Files Bypassing the Routing System URL Schema Best Practices Make Your URLs Clean and Human-Friendly GET and POST: Pick the Right One Summary...450

17 Chapter 17: Controllers and Actions Preparing the Example Project Setting the Start URL Introducing the Controller Creating a Controller with IController Creating a Controller by Deriving from the Controller Class Receiving Request Data Getting Data from Context Objects Using Action Method Parameters Producing Output Understanding Action Results Returning HTML by Rendering a View Passing Data from an Action Method to a View Performing Redirections Returning Errors and HTTP Codes Summary Chapter 18: Filters Preparing the Example Project Setting the Start URL and Testing the Application Using Filters Introducing the Filter Types Applying Filters to Controllers and Action Methods Using Authorization Filters Applying the Custom Authorization Filter Using the Built-in Authorization Filter Using Authentication Filters Understanding the IAuthenticationFilter Interface Implementing the Authentication Check Combining Authentication and Authorization Filters Handling the Final Challenge Request xvii

18 Using Exception Filters Creating an Exception Filter Applying the Exception Filter Using a View to Respond to an Exception Using the Built-in Exception Filter Using Action Filters Implementing the OnActionExecuting Method Implementing the OnActionExecuted Method Using Result Filters Using the Built-in Action and Result Filter Class Using Other Filter Features Filtering Without Attributes Using Global Filters Ordering Filter Execution Overriding Filters Summary Chapter 19: Controller Extensibility Preparing the Example Project Setting the Start URL Creating a Custom Controller Factory Dealing with the Fallback Controller Instantiating Controller Classes Implementing the Other Interface Methods Registering a Custom Controller Factory Working with the Built-in Controller Factory Prioritizing Namespaces Customizing DefaultControllerFactory Controller Instantiation Creating a Custom Action Invoker xviii

19 Using the Built-in Action Invoker Using a Custom Action Name Using Action Method Selection Improving Performance with Specialized Controllers Using Sessionless Controllers Using Asynchronous Controllers Summary Chapter 20: Views Creating a Custom View Engine Preparing the Example Project Creating a Custom IView Creating an IViewEngine Implementation Registering a Custom View Engine Testing the View Engine Working with the Razor Engine Preparing the Example Project Understanding Razor View Rendering Configuring the View Search Locations Adding Dynamic Content to a Razor View Using Layout Sections Using Partial Views Using Child Actions Summary Chapter 21: Helper Methods Preparing the Example Project Setting the Start URL Testing the Example Application Creating Custom Helper Methods Creating an Inline Helper Method Creating an External Helper Method Managing String Encoding in a Helper Method xix

20 Using the Built-In Form Helper Methods Creating Form Elements Specifying the Route Used by a Form Using Input Helpers Creating Select Elements Summary Chapter 22: Templated Helper Methods Preparing the Example Project Using Templated Helper Methods Generating Label and Display Elements Using Whole-Model Templated Helpers Using Model Metadata Using Metadata to Control Editing and Visibility Using Metadata for Labels Using Metadata for Data Values Using Metadata to Select a Display Template Applying Metadata to a Buddy Class Working with Complex Type Properties Customizing the Templated View Helper System Creating a Custom Editor Template Creating a Generic Template Replacing the Built-in Templates Summary Chapter 23: URL and Ajax Helper Methods Preparing the Example Project Defining Additional CSS Styles Installing the NuGet Packages Creating Basic Links and URLs xx

21 Using MVC Unobtrusive Ajax Creating the Synchronous Form View Preparing the Project for Unobtrusive Ajax Creating an Unobtrusive Ajax Form Preparing the Controller Creating the Ajax Form Understanding How Unobtrusive Ajax Works Setting Ajax Options Ensuring Graceful Degradation Providing the User with Feedback While Making an Ajax Request Prompting the User Before Making a Request Creating Ajax Links Ensuring Graceful Degradation for Links Working with Ajax Callbacks Working with JSON Adding JSON Support to the Controller Processing JSON in the Browser Preparing Data for Encoding Detecting Ajax Requests in the Action Method Summary Chapter 24: Model Binding Preparing the Example Project Understanding Model Binding Using the Default Model Binder Binding to Simple Types Binding to Complex Types Binding to Arrays and Collections Manually Invoking Model Binding Dealing with Binding Errors xxi

22 Customizing the Model Binding System Creating a Custom Value Provider Creating a Custom Model Binder Registering the Custom Model Binder Summary Chapter 25: Model Validation Preparing the Example Project Creating the Layout Creating the Views Explicitly Validating a Model Displaying Validation Errors to the User Displaying Validation Messages Displaying Property-Level Validation Messages Using Alternative Validation Techniques Performing Validation in the Model Binder Specifying Validation Rules Using Metadata Defining Self-Validating Models Performing Client-Side Validation Enabling Client-Side Validation Using Client-Side Validation Understanding How Client-Side Validation Works Performing Remote Validation Summary Chapter 26: Bundles Preparing the Example Application Adding the NuGet Packages Creating the Model and Controller Creating the Layout and View xxii

23 Profiling Script and Style Sheet Loading Using Script and Style Bundles Adding the NuGet Package Defining the Bundles Applying Bundles Optimizing the JavaScript and CSS Files Summary Chapter 27: Web API and Single-page Applications Understanding Single-page Applications Preparing the Example Application Creating the Model Adding the NuGet Packages Adding the Controller Adding the Layout and Views Setting the Start Location and Testing the Example Application Using Web API Creating the Web API Controller Testing the API Controller Understanding How the API Controller Works Understanding API Controller Action Selection Mapping HTTP Methods to Action Methods Using Knockout for Single-page Applications Adding the JavaScript Libraries to the Layout Implementing the Summary Implementing the Create Feature Completing the Application Simplify the Home Controller Manage Content Visibility Summary Index xxiii

24

25 About the Author Adam Freeman is an experienced IT professional who has held senior positions in a range of companies, most recently serving as chief technology officer and chief operating officer of a global bank. Now retired, he spends his time writing and running. xxv

26

27 About the Technical Reviewer Fabio Claudio Ferracchiati is a senior consultant and a senior analyst/developer using Microsoft technologies. He works for Brain Force ( in its Italian branch ( He is a Microsoft Certified Solution Developer for.net, a Microsoft Certified Application Developer for.net, a Microsoft Certified Professional, and a prolific author and technical reviewer. Over the past 10 years, he s written articles for Italian and international magazines and coauthored more than 10 books on a variety of computer topics. xxvii