Framework Design Guidelines
Conventions, Idioms, and Patterns for Reusable .NET Libraries
Published on 6. October 2005
Book
Mixed media product
384 pages
978-0-321-24675-2 (ISBN)
Description
A new edition of this title is available, ISBN-10: 0321545613 ISBN-13: 9780321545619
"This book is an absolute must-read for all .NET developers. It gives clear do and don't guidance on how to design class libraries for .NET. It also offers insight into the design and creation of .NET that really helps developers understand the reasons why things are the way they are. This information will aid developers designing their own class libraries and will also allow them to take advantage of the .NET class library more effectively."
--Jeffrey Richter, author/trainer/consultant, Wintellect
"Framework Design Guidelines will help you in two important ways. First, any .NET developer will benefit from a greater understanding of the design principles that govern the .NET Base Class Library. Second, a deeper understanding of these principles will help you to create software that integrates well with the .NET environment. Quite frankly, this book should be on every .NET developer's bookshelf."
--Bill Wagner, founder and consultant, SRT Solutions, author of Effective C#
"Not since Brooks' The Mythical Man Month has the major software maker of its time produced a book so full of relevant advice for the modern software developer. This book has a permanent place on my bookshelf and I consult it frequently."
--George Byrkit, senior software engineer, Genomic Solutions
"This book is a must-read for all architects and software developers thinking about frameworks. The book offers insight into some driving factors behind the design of the .NET Framework. It should be considered mandatory reading for anybody tasked with creating application frameworks."
--Peter Winkler, senior software engineer, Balance Technology Inc.
"Frameworks are valuable but notoriously difficult to construct: Your every decision must be geared towards making them easy to be used correctly and difficult to be used incorrectly. This book takes you through a progression of recommendations that will eliminate many of those downstream 'I wish I'd known that earlier' moments. I wish I'd read it earlier."
--Paul Besly, principal technologist, QA
"Filled with information useful to developers and architects of all levels, this book provides practical guidelines and expert background information to get behind the rules. Framework Design Guidelines takes the already published guidelines to a higher level, and it is needed to write applications that integrate well in the .NET area."
--Cristof Falk, software engineer
Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries teaches developers the best practices for designing system frameworks and reusable libraries for use with the Microsoft .NET Framework and WinFX. This book focuses on the design issues that directly affect the programmability of a framework, specifically its publicly accessible APIs.
This book can improve the work of any .NET developer producing code that other developers will use. An added benefit is a collection of annotations to the guidelines by various members of the Microsoft .NET Framework and WinFX teams, which provide a lively discussion of the motives behind the guidelines, along with examples of good reasons for breaking the guidelines.
Microsoft architects Krzysztof Cwalina and Brad Abrams offer guidelines for framework design from the top down. From their long experience and deep insight, you will learn
The general philosophy of framework design
Principles and guidelines that are fundamental to overall framework design
Naming guidelines for the various parts of a framework, such as namespaces, types, and members
Guidelines for the design of types and members of types
Issues and guidelines that are important to ensure appropriate extensibilityin your framework
Guidelines for working with exceptions, the preferred error reporting mechanism in the .NET Framework and WinFX
Guidelines for extending and using types that commonly appear in frameworks
Guidelines for and examples of common framework design patterns
Guidelines in this book come in four major forms: Do, Consider, Avoid, and Do not. In general, a Do guideline should almost always be followed, a Consider guideline should generally be followed, an Avoid guideline indicates that something is generally not a good idea, and a Do not guideline indicates something you should almost never do. Every guideline includes a discussion of its applicability, and most guidelines include a code example.
A companion DVD includes the Designing .NET Class Libraries video series, instructional presentations by the authors on design guidelines for developing classes and components that extend the .NET Framework. A sample API specification and other useful resources are also included.
"This book is an absolute must-read for all .NET developers. It gives clear do and don't guidance on how to design class libraries for .NET. It also offers insight into the design and creation of .NET that really helps developers understand the reasons why things are the way they are. This information will aid developers designing their own class libraries and will also allow them to take advantage of the .NET class library more effectively."
--Jeffrey Richter, author/trainer/consultant, Wintellect
"Framework Design Guidelines will help you in two important ways. First, any .NET developer will benefit from a greater understanding of the design principles that govern the .NET Base Class Library. Second, a deeper understanding of these principles will help you to create software that integrates well with the .NET environment. Quite frankly, this book should be on every .NET developer's bookshelf."
--Bill Wagner, founder and consultant, SRT Solutions, author of Effective C#
"Not since Brooks' The Mythical Man Month has the major software maker of its time produced a book so full of relevant advice for the modern software developer. This book has a permanent place on my bookshelf and I consult it frequently."
--George Byrkit, senior software engineer, Genomic Solutions
"This book is a must-read for all architects and software developers thinking about frameworks. The book offers insight into some driving factors behind the design of the .NET Framework. It should be considered mandatory reading for anybody tasked with creating application frameworks."
--Peter Winkler, senior software engineer, Balance Technology Inc.
"Frameworks are valuable but notoriously difficult to construct: Your every decision must be geared towards making them easy to be used correctly and difficult to be used incorrectly. This book takes you through a progression of recommendations that will eliminate many of those downstream 'I wish I'd known that earlier' moments. I wish I'd read it earlier."
--Paul Besly, principal technologist, QA
"Filled with information useful to developers and architects of all levels, this book provides practical guidelines and expert background information to get behind the rules. Framework Design Guidelines takes the already published guidelines to a higher level, and it is needed to write applications that integrate well in the .NET area."
--Cristof Falk, software engineer
Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries teaches developers the best practices for designing system frameworks and reusable libraries for use with the Microsoft .NET Framework and WinFX. This book focuses on the design issues that directly affect the programmability of a framework, specifically its publicly accessible APIs.
This book can improve the work of any .NET developer producing code that other developers will use. An added benefit is a collection of annotations to the guidelines by various members of the Microsoft .NET Framework and WinFX teams, which provide a lively discussion of the motives behind the guidelines, along with examples of good reasons for breaking the guidelines.
Microsoft architects Krzysztof Cwalina and Brad Abrams offer guidelines for framework design from the top down. From their long experience and deep insight, you will learn
The general philosophy of framework design
Principles and guidelines that are fundamental to overall framework design
Naming guidelines for the various parts of a framework, such as namespaces, types, and members
Guidelines for the design of types and members of types
Issues and guidelines that are important to ensure appropriate extensibilityin your framework
Guidelines for working with exceptions, the preferred error reporting mechanism in the .NET Framework and WinFX
Guidelines for extending and using types that commonly appear in frameworks
Guidelines for and examples of common framework design patterns
Guidelines in this book come in four major forms: Do, Consider, Avoid, and Do not. In general, a Do guideline should almost always be followed, a Consider guideline should generally be followed, an Avoid guideline indicates that something is generally not a good idea, and a Do not guideline indicates something you should almost never do. Every guideline includes a discussion of its applicability, and most guidelines include a code example.
A companion DVD includes the Designing .NET Class Libraries video series, instructional presentations by the authors on design guidelines for developing classes and components that extend the .NET Framework. A sample API specification and other useful resources are also included.
More details
Language
English
Place of publication
New Jersey
United States
Publishing group
Pearson Education (US)
Target group
College/higher education
Dimensions
Height: 243 mm
Width: 188 mm
Thickness: 32 mm
Weight
990 gr
ISBN-13
978-0-321-24675-2 (9780321246752)
Copyright in bibliographic data and cover images is held by Nielsen Book Services Limited or by the publishers or by their respective licensors: all rights reserved.
Schweitzer Classification
Other editions
New editions
Krzysztof Cwalina | Brad Abrams
Framework Design Guidelines
Conventions, Idioms, and Patterns for Reusable .NET Libraries
Book
10/2008
2nd Edition
Addison Wesley
€59.39
Article exhausted; check for reprint
Persons
Krzysztof Cwalina is a Program Manager on the Common Language Runtime team at Microsoft Corporation. He began his career at Microsoft designing APIs for the first release of the .NET Framework. He has been responsible for several namespaces in the Framework, including System.Collections, System.Diagnostics, System.Messaging, and others. He was also one of the original members of the FxCop team. Currently, he is leading a companywide effort to develop, promote, and apply the design guidelines to the .NET Framework and WinFX. Krzysztof graduated with a B.S. and an M.S. in computer science from the University of Iowa.
Brad Abrams was a founding member of both the Common Language Runtime and .NET Framework teams at Microsoft, where he is currently a Lead Program Manager. Brad has been involved with WinFX and Windows Vista efforts from the beginning. His primary role is to ensure consistency and developer productivity of the .NET Framework through Vista and beyond. His popular blog can be found at http://blogs.msdn.com/BradA/.
Brad Abrams was a founding member of both the Common Language Runtime and .NET Framework teams at Microsoft, where he is currently a Lead Program Manager. Brad has been involved with WinFX and Windows Vista efforts from the beginning. His primary role is to ensure consistency and developer productivity of the .NET Framework through Vista and beyond. His popular blog can be found at http://blogs.msdn.com/BradA/.
Content
Figures xiii Acknowledgments xxv
About the Authors xxvii
Tables xv Foreword xvii
Preface xix
Chapter 1: Introduction 1
1.1 Qualities of a Well-Designed Framework 3
1.1.1 Well-Designed Frameworks Are Simple 3
1.1.2 Well-Designed Frameworks Are Expensive to Design 3
1.1.3 Well-Designed Frameworks Are Full of Trade-Offs 4
1.1.4 Well-Designed Frameworks Borrow from the Past 5
1.1.5 Well-Designed Frameworks Are Designed to Evolve 5
1.1.6 Well-Designed Frameworks Are Integrated 5
1.1.7 Well-Designed Frameworks Are Consistent 6
Chapter 2: Framework Design Fundamentals 7 2.1 Progressive Frameworks 9
2.2 Fundamental Principles of Framework Design 12
2.2.1 The Principle of Scenario-Driven Design 13
2.2.2 The Principle of Low Barrier to Entry 19
2.2.3 The Principle of Self-Documenting Object Models 23
2.2.4 The Principle of Layered Architecture 29
2.3 Summary 31
Chapter 3: Naming Guidelines 33 3.1 Capitalization Conventions 34
3.1.1 Capitalization Rules for Identifiers 34
3.1.2 Capitalizing Acronyms 36
3.1.3 Capitalizing Compound Words and Common Terms 39
3.1.4 Case Sensitivity 41
3.2 General Naming Conventions 41
3.2.1 Word Choice 42
3.2.2 Using Abbreviations and Acronyms 43
3.2.3 Avoiding Language-Specific Names 44
3.2.4 Naming New Versions of Existing APIs 46
3.3 Names of Assemblies and DLLs 48
3.4 Names of Namespaces 49
3.4.1 Namespaces and Type Name Conflicts 51
3.5 Names of Classes, Structs, and Interfaces 54
3.5.1 Names of Generic Type Parameters 56
3.5.2 Names of Common Types 57
3.5.3 Naming Enumerations 59
3.6 Names of Type Members 60
3.6.1 Names of Methods 60
3.6.2 Names of Properties 61
3.6.3 Names of Events 63
3.6.4 Naming Fields 64
3.7 Naming Parameters 64
3.8 Naming Resources 65
3.9 Summary 66
Chapter 4: Type Design Guidelines 67 4.1 Types and Namespaces 69
4.1.1 Standard Subnamespace Names 73
4.2 Choosing Between Class and Struct 74
4.3 Choosing Between Class and Interface 77
4.4 Abstract Class Design 83
4.5 Static Class Design 85
4.6 Interface Design 86
4.7 Struct Design 89
4.8 Enum Design 91
4.8.1 Designing Flag Enums 97
4.8.2 Adding Values to Enums 100
4.9 Nested Types 101
4.10 Summary 104
Chapter 5: Member Design 105 5.1 General Member Design Guidelines 105
5.1.1 Member Overloading 105
5.1.2 Implementing Interface Members Explicitly 111
5.1.3 Choosing Between Properties and Methods 115
5.2 Property Design 120
5.2.1 Indexed Property Design 122
5.2.2 Property Change Notification Events 124
5.3 Constructor Design 125
5.3.1 Type Constructor Guidelines 131
5.4 Event Design 132
5.4.1 Custom Event Handler Design 138
5.5 Field Design 139
5.6 Operator Overloads 141
5.6.1 Overloading Operator == 146
5.6.2 Conversion Operators 146
5.7 Parameter Design 148
5.7.1 Choosing Between Enum and Boolean Parameters 150
5.7.2 Validating Arguments 152
5.7.3 Parameter Passing 155
5.7.4 Members with Variable Number of Parameters 157
5.7.5 Pointer Parameters 161
5.8 Summary 162
Chapter 6: Designing for Extensibility 163 6.1 Extensibility Mechanisms 163
6.1.1 Unsealed Classes 164
6.1.2 Protected Members 165
6.1.3 Events and Callbacks 166
6.1.4 Virtual Members 168
6.1.5 Abstractions (Abstract Types and Interfaces) 170
6.2 Base Classes 172
6.3 Sealing 174
6.4 Summary 177
Chapter 7: Exceptions 179 7.1 Exception Throwing 183
7.2 Choosing the Right Type of Exception to Throw 189
7.2.1 Error Message Design 189
7.2.2 Exception Handling 191
7.2.3 Wrapping Exceptions 195
7.3 Using Standard Exception Types 197
7.3.1 Exception and SystemException 197
7.3.2 ApplicationException 197
7.3.3 InvalidOperationException 198
7.3.4 ArgumentException, ArgumentNullException, and ArgumentOutOfRangeException 198
7.3.5 NullReferenceException, IndexOutOfRangeException, and AccessViolationException 199
7.3.6 StackOverflowException 200
7.3.7 OutOfMemoryException 200
7.3.8 ComException, SEHException, and other CLR Exceptions 201
7.3.9 ExecutionEngineException 201
7.4 Designing Custom Exceptions 202
7.5 Exceptions and Performance 203
7.5.1 Tester-Doer Pattern 203
7.5.2 Try-Parse Pattern 204
7.6 Summary 205
Chapter 8: Usage Guidelines 207 8.1 Arrays 207
8.2 Attributes 209
8.3 Collections 211
8.3.1 Collection Parameters 213
8.3.2 Collection Properties and Return Values 214
8.3.3 Choosing Between Arrays and Collections 218
8.3.4 Implementing Custom Collections 219
8.4 ICloneable 221
8.5 IComparable and IEquatable 222
8.6 IDisposable 223
8.7 Object 224
8.7.1 Object.Equals 224
8.7.2 Object.GetHashCode 225
8.7.3 Object.ToString 227
8.8 Uri 228
8.8.1 System.Uri Implementation Guidelines 229
8.9 System.Xml Usage 230
8.10 Equality Operators 231
8.10.1 Equality Operators on Value Types 232
8.10.2 Equality Operators on Reference Types 232
Chapter 9: Common Design Patterns 235 9.1 Aggregate Components 235
9.1.1 Component-Oriented Design 237
9.1.2 Factored Types 240
9.1.3 Aggregate Component Guidelines 240
9.2 The Async Pattern 243
9.2.1 Async Pattern Basic Implementation Example 247
9.3 Dispose Pattern 248
9.3.1 Basic Dispose Pattern 251
9.3.2 Finalizable Types 256
9.4 Factories 260
9.5 Optional Feature Pattern 264
9.6 Template Method 267
9.7 Timeouts 269
9.8 And in the End ... 271
Appendix A: C# Coding Style Conventions 273 A.1 General Style Conventions 274
A.1.1 Brace Usage 274
A.1.2 Space Usage 275
A.1.3 Indent Usage 276
A.2 Naming Conventions 277
A.3 Comments 277
A.4 File Organization 278
Appendix B: Using FxCop to Enforce the Design Guidelines 281 B.1 What Is FxCop? 281
B.2 The Evolution of FxCop 282
B.3 How Does It Work? 283
B.4 FxCop Guideline Coverage 284
B.4.1 FxCop Rules for the Naming Guidelines 284
B.4.2 FxCop Rules for the Type Design Guidelines 293
B.4.3 FxCop Rules for Member Design 296
B.4.4 FxCop Rules for Designing for Extensibility 302
B.4.5 FxCop Rules for Exceptions 303
B.4.6 FxCop Rules for Usage Guidelines 305
B.4.7 FxCop Rules for Design Patterns 309
Appendix C: Sample API Specification 311 Glossary 319 Suggested Reading List 323 Index 327
About the Authors xxvii
Tables xv Foreword xvii
Preface xix
Chapter 1: Introduction 1
1.1 Qualities of a Well-Designed Framework 3
1.1.1 Well-Designed Frameworks Are Simple 3
1.1.2 Well-Designed Frameworks Are Expensive to Design 3
1.1.3 Well-Designed Frameworks Are Full of Trade-Offs 4
1.1.4 Well-Designed Frameworks Borrow from the Past 5
1.1.5 Well-Designed Frameworks Are Designed to Evolve 5
1.1.6 Well-Designed Frameworks Are Integrated 5
1.1.7 Well-Designed Frameworks Are Consistent 6
Chapter 2: Framework Design Fundamentals 7 2.1 Progressive Frameworks 9
2.2 Fundamental Principles of Framework Design 12
2.2.1 The Principle of Scenario-Driven Design 13
2.2.2 The Principle of Low Barrier to Entry 19
2.2.3 The Principle of Self-Documenting Object Models 23
2.2.4 The Principle of Layered Architecture 29
2.3 Summary 31
Chapter 3: Naming Guidelines 33 3.1 Capitalization Conventions 34
3.1.1 Capitalization Rules for Identifiers 34
3.1.2 Capitalizing Acronyms 36
3.1.3 Capitalizing Compound Words and Common Terms 39
3.1.4 Case Sensitivity 41
3.2 General Naming Conventions 41
3.2.1 Word Choice 42
3.2.2 Using Abbreviations and Acronyms 43
3.2.3 Avoiding Language-Specific Names 44
3.2.4 Naming New Versions of Existing APIs 46
3.3 Names of Assemblies and DLLs 48
3.4 Names of Namespaces 49
3.4.1 Namespaces and Type Name Conflicts 51
3.5 Names of Classes, Structs, and Interfaces 54
3.5.1 Names of Generic Type Parameters 56
3.5.2 Names of Common Types 57
3.5.3 Naming Enumerations 59
3.6 Names of Type Members 60
3.6.1 Names of Methods 60
3.6.2 Names of Properties 61
3.6.3 Names of Events 63
3.6.4 Naming Fields 64
3.7 Naming Parameters 64
3.8 Naming Resources 65
3.9 Summary 66
Chapter 4: Type Design Guidelines 67 4.1 Types and Namespaces 69
4.1.1 Standard Subnamespace Names 73
4.2 Choosing Between Class and Struct 74
4.3 Choosing Between Class and Interface 77
4.4 Abstract Class Design 83
4.5 Static Class Design 85
4.6 Interface Design 86
4.7 Struct Design 89
4.8 Enum Design 91
4.8.1 Designing Flag Enums 97
4.8.2 Adding Values to Enums 100
4.9 Nested Types 101
4.10 Summary 104
Chapter 5: Member Design 105 5.1 General Member Design Guidelines 105
5.1.1 Member Overloading 105
5.1.2 Implementing Interface Members Explicitly 111
5.1.3 Choosing Between Properties and Methods 115
5.2 Property Design 120
5.2.1 Indexed Property Design 122
5.2.2 Property Change Notification Events 124
5.3 Constructor Design 125
5.3.1 Type Constructor Guidelines 131
5.4 Event Design 132
5.4.1 Custom Event Handler Design 138
5.5 Field Design 139
5.6 Operator Overloads 141
5.6.1 Overloading Operator == 146
5.6.2 Conversion Operators 146
5.7 Parameter Design 148
5.7.1 Choosing Between Enum and Boolean Parameters 150
5.7.2 Validating Arguments 152
5.7.3 Parameter Passing 155
5.7.4 Members with Variable Number of Parameters 157
5.7.5 Pointer Parameters 161
5.8 Summary 162
Chapter 6: Designing for Extensibility 163 6.1 Extensibility Mechanisms 163
6.1.1 Unsealed Classes 164
6.1.2 Protected Members 165
6.1.3 Events and Callbacks 166
6.1.4 Virtual Members 168
6.1.5 Abstractions (Abstract Types and Interfaces) 170
6.2 Base Classes 172
6.3 Sealing 174
6.4 Summary 177
Chapter 7: Exceptions 179 7.1 Exception Throwing 183
7.2 Choosing the Right Type of Exception to Throw 189
7.2.1 Error Message Design 189
7.2.2 Exception Handling 191
7.2.3 Wrapping Exceptions 195
7.3 Using Standard Exception Types 197
7.3.1 Exception and SystemException 197
7.3.2 ApplicationException 197
7.3.3 InvalidOperationException 198
7.3.4 ArgumentException, ArgumentNullException, and ArgumentOutOfRangeException 198
7.3.5 NullReferenceException, IndexOutOfRangeException, and AccessViolationException 199
7.3.6 StackOverflowException 200
7.3.7 OutOfMemoryException 200
7.3.8 ComException, SEHException, and other CLR Exceptions 201
7.3.9 ExecutionEngineException 201
7.4 Designing Custom Exceptions 202
7.5 Exceptions and Performance 203
7.5.1 Tester-Doer Pattern 203
7.5.2 Try-Parse Pattern 204
7.6 Summary 205
Chapter 8: Usage Guidelines 207 8.1 Arrays 207
8.2 Attributes 209
8.3 Collections 211
8.3.1 Collection Parameters 213
8.3.2 Collection Properties and Return Values 214
8.3.3 Choosing Between Arrays and Collections 218
8.3.4 Implementing Custom Collections 219
8.4 ICloneable 221
8.5 IComparable and IEquatable 222
8.6 IDisposable 223
8.7 Object 224
8.7.1 Object.Equals 224
8.7.2 Object.GetHashCode 225
8.7.3 Object.ToString 227
8.8 Uri 228
8.8.1 System.Uri Implementation Guidelines 229
8.9 System.Xml Usage 230
8.10 Equality Operators 231
8.10.1 Equality Operators on Value Types 232
8.10.2 Equality Operators on Reference Types 232
Chapter 9: Common Design Patterns 235 9.1 Aggregate Components 235
9.1.1 Component-Oriented Design 237
9.1.2 Factored Types 240
9.1.3 Aggregate Component Guidelines 240
9.2 The Async Pattern 243
9.2.1 Async Pattern Basic Implementation Example 247
9.3 Dispose Pattern 248
9.3.1 Basic Dispose Pattern 251
9.3.2 Finalizable Types 256
9.4 Factories 260
9.5 Optional Feature Pattern 264
9.6 Template Method 267
9.7 Timeouts 269
9.8 And in the End ... 271
Appendix A: C# Coding Style Conventions 273 A.1 General Style Conventions 274
A.1.1 Brace Usage 274
A.1.2 Space Usage 275
A.1.3 Indent Usage 276
A.2 Naming Conventions 277
A.3 Comments 277
A.4 File Organization 278
Appendix B: Using FxCop to Enforce the Design Guidelines 281 B.1 What Is FxCop? 281
B.2 The Evolution of FxCop 282
B.3 How Does It Work? 283
B.4 FxCop Guideline Coverage 284
B.4.1 FxCop Rules for the Naming Guidelines 284
B.4.2 FxCop Rules for the Type Design Guidelines 293
B.4.3 FxCop Rules for Member Design 296
B.4.4 FxCop Rules for Designing for Extensibility 302
B.4.5 FxCop Rules for Exceptions 303
B.4.6 FxCop Rules for Usage Guidelines 305
B.4.7 FxCop Rules for Design Patterns 309
Appendix C: Sample API Specification 311 Glossary 319 Suggested Reading List 323 Index 327