Download as KEY, PPTX
Coding and naming conventions
- 1. ColdFusion coding and naming conventions
- 2. Who Am I? StevenPeeters Adobe Certified Instructor / consultant at Silver Lining • Adobe Flex, AIR, Flash Catalyst & ColdFusion Certified Instructor • Adobe Community Professional • ColdFusion User Group Manager • 15 years of development experience • Flex & AIR since 2004, ColdFusion since 2009 • Author for Friends of ED Email: steven@silver-lining.be LinkedIn: www.linkedin.com/in/stevenpeeters Twitter: @aikisteve Blog: www.flexpert.be Website: www.silver-lining.be
- 3. Agenda 3 sections • Codingconventions • Naming conventions • Performance considerations
- 4. Conventions • These conventionsare just that: conventions • Not mandatory for ColdFusion to work • Lots of them are just common sense
- 5. Why do weneed this? • Collaboration • Maintenance • Structure
- 6.
- 7.
- 8. Use the application.cfc •Use Application.cfc instead of Application.cfm
- 9. Use the application.cfc •Use Application.cfc instead of Application.cfm • Better structured
- 10. Use the application.cfc •Use Application.cfc instead of Application.cfm • Better structured • Can be extended
- 11. Use the application.cfc •Use Application.cfc instead of Application.cfm • Better structured • Can be extended • Generic handling of events
- 12.
- 13. onError event handler • Application.cfc has onError handler
- 14. onError event handler • Application.cfc has onError handler • Capture errors at highest level
- 15. onError event handler • Application.cfc has onError handler • Capture errors at highest level • Both system and user errors
- 16. onError event handler • Application.cfc has onError handler • Capture errors at highest level • Both system and user errors • Use only as last resort/failsafe
- 17.
- 18. ColdFusion Components (CFC) •Use CFCs as much as possible for
- 19. ColdFusion Components (CFC) •Use CFCs as much as possible for • Business logic
- 20. ColdFusion Components (CFC) •Use CFCs as much as possible for • Business logic • Services
- 21. ColdFusion Components (CFC) •Use CFCs as much as possible for • Business logic • Services • Internal operations (e.g. calculations)
- 22.
- 23. Custom Tags • UsingCFCs does not mean custom tags are deprecated
- 24. Custom Tags • UsingCFCs does not mean custom tags are deprecated • Use custom tags for reusable output formatting
- 25.
- 26. Reuse existing code •Reuse existing code as much as possible
- 27. Reuse existing code •Reuse existing code as much as possible • CFCs
- 28. Reuse existing code •Reuse existing code as much as possible • CFCs • Custom tags
- 29. Reuse existing code •Reuse existing code as much as possible • CFCs • Custom tags • User Defined Functions (UDF)
- 30.
- 31. <cfqueryparam> • Always use<cfqueryparam> in queries, even when the parameters are not from user input.
- 32. <cfqueryparam> • Always use<cfqueryparam> in queries, even when the parameters are not from user input. • Query gets cached (prepared statement)
- 33. <cfqueryparam> • Always use<cfqueryparam> in queries, even when the parameters are not from user input. • Query gets cached (prepared statement) • Parameter type is checked
- 34. <cfqueryparam> • Always use<cfqueryparam> in queries, even when the parameters are not from user input. • Query gets cached (prepared statement) • Parameter type is checked • Values get escaped
- 35. <cfqueryparam> • Always use<cfqueryparam> in queries, even when the parameters are not from user input. • Query gets cached (prepared statement) • Parameter type is checked • Values get escaped • Helps to prevent SQL Injection attacks!
- 36. <cfproperty> • Use the<cfproperty> tag to define CFC properties • accessors = “true” will automatically generate getters and setters
- 37.
- 38. <cfproperty> • Disable generationof getter method
- 39. <cfproperty> • Disable generationof getter method • <cfproperty getter=”false”>
- 40. <cfproperty> • Disable generationof getter method • <cfproperty getter=”false”> • Disable generation of setter method
- 41. <cfproperty> • Disable generationof getter method • <cfproperty getter=”false”> • Disable generation of setter method • <cfproperty setter=”false”>
- 42.
- 43. Encapsulate functionality • Notall methods of a CFC need to be accessed by others
- 44. Encapsulate functionality • Notall methods of a CFC need to be accessed by others • Encapsulation ensures only the necessary functionality can be executed by other components
- 45.
- 46. Encapsulate functionality • Use“access” attribute of <cffunction> tag to determine encapsulation level
- 47. Encapsulate functionality • Use“access” attribute of <cffunction> tag to determine encapsulation level • 4 encapsulation levels
- 48. Encapsulate functionality • Use“access” attribute of <cffunction> tag to determine encapsulation level • 4 encapsulation levels • Private
- 49. Encapsulate functionality • Use“access” attribute of <cffunction> tag to determine encapsulation level • 4 encapsulation levels • Private • Protected
- 50. Encapsulate functionality • Use“access” attribute of <cffunction> tag to determine encapsulation level • 4 encapsulation levels • Private • Protected • Public
- 51. Encapsulate functionality • Use“access” attribute of <cffunction> tag to determine encapsulation level • 4 encapsulation levels • Private • Protected • Public • Remote
- 52. Keep order inyour CFC
- 53. Keep order inyour CFC • Always use the same order of defining properties and methods
- 54. Keep order inyour CFC • Always use the same order of defining properties and methods • Easier collaboration
- 55. Keep order inyour CFC • Always use the same order of defining properties and methods • Easier collaboration • Easier maintenance
- 56. Keep order inyour CFC • Always use the same order of defining properties and methods • Easier collaboration • Easier maintenance • Logical structure
- 57. Keep order inyour CFC
- 58. Keep order inyour CFC • Properties
- 59. Keep order inyour CFC • Properties • Constructor / init method
- 60. Keep order inyour CFC • Properties • Constructor / init method • Methods
- 61. Keep order inyour CFC • Properties • Constructor / init method • Methods • Remote
- 62. Keep order inyour CFC • Properties • Constructor / init method • Methods • Remote • Public
- 63. Keep order inyour CFC • Properties • Constructor / init method • Methods • Remote • Public • Protected
- 64. Keep order inyour CFC • Properties • Constructor / init method • Methods • Remote • Public • Protected • Private
- 65. Keep order inyour CFC • Properties • Constructor / init method • Methods • Remote • Public • Protected • Private
- 66. Use exact nameswhen referring types
- 67. Use exact nameswhen referring types • ColdFusion will search for the proper CFC in a general reference
- 68. Use exact nameswhen referring types • ColdFusion will search for the proper CFC in a general reference • Takes longer to find the type
- 69. Use exact nameswhen referring types • ColdFusion will search for the proper CFC in a general reference • Takes longer to find the type • Could lead to conflicts or wrong type being referred
- 70. Use exact nameswhen referring types • ColdFusion will search for the proper CFC in a general reference • Takes longer to find the type • Could lead to conflicts or wrong type being referred • Can take a long time to find the problem
- 71. Use exact nameswhen referring types • ColdFusion will search for the proper CFC in a general reference • Takes longer to find the type • Could lead to conflicts or wrong type being referred • Can take a long time to find the problem • Immediately clear where to find it with fully qualified CFC name
- 72. Use exact nameswhen referring types
- 73. Use exact nameswhen referring types • General reference
- 74. Use exact nameswhen referring types • General reference • e.g. BookingRecord
- 75. Use exact nameswhen referring types • General reference • e.g. BookingRecord • Fully qualified reference
- 76. Use exact nameswhen referring types • General reference • e.g. BookingRecord • Fully qualified reference • e.g. be.silverlining.models.BookingRecord
- 77. Methods with optionalparameters
- 78. Methods with optionalparameters • Default parameters
- 79. Methods with optionalparameters • Default parameters • Default value when not filled out
- 80. Methods with optionalparameters • Default parameters • Default value when not filled out • Mandatory parameters first
- 81. Exception handling • Surroundexception prone code with <cftry>...<cfcatch> • Database • Webservice • File system access • ... • One <cftry> can have multiple <cfcatch> blocks
- 82.
- 83. Exception handling • Exceptionsshould be handled as quickly as possible
- 84. Exception handling • Exceptionsshould be handled as quickly as possible • User should be informed about the exception
- 85. Exception handling • Exceptionsshould be handled as quickly as possible • User should be informed about the exception • Problem solving
- 86. Exception handling • Exceptionsshould be handled as quickly as possible • User should be informed about the exception • Problem solving • Bug reports
- 87. Exception handling • Exceptionsshould be handled as quickly as possible • User should be informed about the exception • Problem solving • Bug reports • Helpdesk
- 88.
- 89. Closing tags • Ingeneral, ColdFusion tags do not need to be closed with “/>”
- 90. Closing tags • Ingeneral, ColdFusion tags do not need to be closed with “/>” • In some cases, closing a tag can result in unexpected behaviour (e.g. custom tags)
- 91.
- 92. Black box components •Components should be written as black boxes with an “API” for setting and retrieving values
- 93. Black box components •Components should be written as black boxes with an “API” for setting and retrieving values • Other components do not have to have knowledge of the component’s internal workings
- 94. Black box components •Components should be written as black boxes with an “API” for setting and retrieving values • Other components do not have to have knowledge of the component’s internal workings • Allows for better reusability in all circumstances
- 95.
- 96. External CSS file •Place all CSS styling in one or more external CSS files
- 97. External CSS file •Place all CSS styling in one or more external CSS files • Centralized styling rules
- 98. External CSS file •Place all CSS styling in one or more external CSS files • Centralized styling rules • Easier maintenance
- 99. Use source versioning •You should always use a source versioning system, even when you’re working alone • Keep track of changes • Easily revert changes • Merge changes • Branching for release • ...
- 100.
- 101. Comment your commits •When committing changes to the repository
- 102. Comment your commits •When committing changes to the repository • Always provide a comment
- 103. Comment your commits •When committing changes to the repository • Always provide a comment • Provide tracking number when using a task/ issue tracker
- 104. Comment your commits •When committing changes to the repository • Always provide a comment • Provide tracking number when using a task/ issue tracker • Easy to find related files for a change
- 105. Do not commitbroken code
- 106. Do not commitbroken code • Any code that is committed to the central repository MUST function properly
- 107. Do not commitbroken code • Any code that is committed to the central repository MUST function properly • Committing broken code will hinder other developers
- 108. Do not commitbroken code • Any code that is committed to the central repository MUST function properly • Committing broken code will hinder other developers • Development could come to a full stop!
- 109.
- 110. Test TEST TEST TEST
- 111.
- 112. Comment your code •Code should have ample comments about its functionality
- 113. Comment your code •Code should have ample comments about its functionality • Don’t need to understand code to understand its purpose
- 114. Comment your code •Code should have ample comments about its functionality • Don’t need to understand code to understand its purpose • Easier collaboration
- 115. Comment your code •Code should have ample comments about its functionality • Don’t need to understand code to understand its purpose • Easier collaboration • Easier on yourself
- 116.
- 117. Comment you code •use <!--- ... ---> to comment your code
- 118. Comment you code •use <!--- ... ---> to comment your code • ColdFusion style comment
- 119. Comment you code •use <!--- ... ---> to comment your code • ColdFusion style comment • Not visible in generated HTML
- 120. Comment you code •use <!--- ... ---> to comment your code • ColdFusion style comment • Not visible in generated HTML • Not visible to end user
- 121. Organise code inpackages • Structure your code files by placing components in different packages • In CF, package = directory • Easier to maintain • Easier to find the right file
- 122.
- 123. Use a framework •Frameworks help organise your project
- 124. Use a framework •Frameworks help organise your project • Frameworks help structure your code
- 125. Use a framework •Frameworks help organise your project • Frameworks help structure your code • Most common CF frameworks
- 126. Use a framework •Frameworks help organise your project • Frameworks help structure your code • Most common CF frameworks • Fusebox
- 127. Use a framework •Frameworks help organise your project • Frameworks help structure your code • Most common CF frameworks • Fusebox • ColdBox
- 128. Know when notto use a framework Sometimes, with smaller projects, using a framework generates more overhead than you get back from structuring the code.
- 129.
- 130.
- 131. Packages • Use reversedomain name package structure
- 132. Packages • Use reversedomain name package structure • Package names are always lowercase
- 133. Packages • Use reversedomain name package structure • Package names are always lowercase • e.g. be.silverlining.hotels.models.BookingRecord
- 134.
- 135. Group assets • Usean “assets” package to organise all your assets
- 136. Group assets • Usean “assets” package to organise all your assets • fonts
- 137. Group assets • Usean “assets” package to organise all your assets • fonts • images
- 138. Group assets • Usean “assets” package to organise all your assets • fonts • images • sounds
- 139. Group assets • Usean “assets” package to organise all your assets • fonts • images • sounds • logos
- 140. Group assets • Usean “assets” package to organise all your assets • fonts • images • sounds • logos • ...
- 141. Use plural forpackage names
- 142. Use plural forpackage names • Package/directory names should always be plural
- 143. Use plural forpackage names • Package/directory names should always be plural • In 99,999% you will place multiple components, assets or configuration files in 1 directory
- 144. Use plural forpackage names • Package/directory names should always be plural • In 99,999% you will place multiple components, assets or configuration files in 1 directory • e.g. models, services, components, views...
- 145.
- 146. Naming CFCs • ColdFusioncomponents should always be a noun
- 147. Naming CFCs • ColdFusioncomponents should always be a noun • The name should always be singular
- 148. Naming CFCs • ColdFusioncomponents should always be a noun • The name should always be singular • Represents 1 object
- 149. Naming CFCs • ColdFusioncomponents should always be a noun • The name should always be singular • Represents 1 object • Camelcase/titlecase with first letter uppercase
- 150. Naming CFCs • ColdFusioncomponents should always be a noun • The name should always be singular • Represents 1 object • Camelcase/titlecase with first letter uppercase • e.g. BookingRecord
- 151.
- 152. What is camelcase/titlecase? •Multiple words stitched together into 1 word
- 153. What is camelcase/titlecase? •Multiple words stitched together into 1 word • Every word-part begins with uppercase letter
- 154. What is camelcase/titlecase? •Multiple words stitched together into 1 word • Every word-part begins with uppercase letter • First letter uppercase or lowercase
- 155.
- 156. Naming methods • ColdFusionmethods should always contain an active verb
- 157. Naming methods • ColdFusionmethods should always contain an active verb • Name should represent its purpose
- 158. Naming methods • ColdFusionmethods should always contain an active verb • Name should represent its purpose • Descriptive
- 159. Naming methods • ColdFusionmethods should always contain an active verb • Name should represent its purpose • Descriptive • Camelcase/titlecase with first letter lowercase
- 160. Naming methods • ColdFusionmethods should always contain an active verb • Name should represent its purpose • Descriptive • Camelcase/titlecase with first letter lowercase • e.g. getBookingRecord
- 161.
- 162. Naming properties • ColdFusionproperties should always be a noun
- 163. Naming properties • ColdFusionproperties should always be a noun • Name can be singular or plural
- 164. Naming properties • ColdFusionproperties should always be a noun • Name can be singular or plural • Singular for 1 object
- 165. Naming properties • ColdFusionproperties should always be a noun • Name can be singular or plural • Singular for 1 object • Plural for lists, arrays...
- 166. Naming properties • ColdFusionproperties should always be a noun • Name can be singular or plural • Singular for 1 object • Plural for lists, arrays... • Name should be descriptive
- 167.
- 168. Naming properties • Camelcase/titlecasewith first letter lowercase
- 169. Naming properties • Camelcase/titlecasewith first letter lowercase • Use underscore at end for properties used for multi-language/dynamic labels
- 170. Naming properties • Camelcase/titlecasewith first letter lowercase • Use underscore at end for properties used for multi-language/dynamic labels • e.g. firstName, zipCode, travelGuide, firstName_, ...
- 171.
- 172.
- 173. isDefined() • Cautiously usethe isDefined() method
- 174. isDefined() • Cautiously usethe isDefined() method • Starts a fuzzy search on all relevant scopes
- 175. isDefined() • Cautiously usethe isDefined() method • Starts a fuzzy search on all relevant scopes • Replace with structKeyExists()
- 176. isDefined() • Cautiously usethe isDefined() method • Starts a fuzzy search on all relevant scopes • Replace with structKeyExists() • Use scope in isDefined()
- 177.
- 178. evaluate() • Evaluate dynamicvariables (e.g. array loops)
- 179. evaluate() • Evaluate dynamicvariables (e.g. array loops) • Should be avoided at all costs
- 180. evaluate() • Evaluate dynamicvariables (e.g. array loops) • Should be avoided at all costs • e.g. evaluate(“form.field#i#”)
- 181.
- 182. Comparing items • Compare1 variable with multiple values
- 183. Comparing items • Compare1 variable with multiple values • listFind
- 184. Comparing items • Compare1 variable with multiple values • listFind • listFindNoCase
- 185. Comparing items • Compare1 variable with multiple values • listFind • listFindNoCase • check if result equals 0
- 186. Comparing items • Compare1 variable with multiple values • listFind • listFindNoCase • check if result equals 0 • e.g. <cfif listFindNoCase(“a,b,c”,x) IS NOT 0>
- 187.
- 188. Query caching • Usecaching on queries that don’t change often
- 189. Query caching • Usecaching on queries that don’t change often • cachedWithin
- 190. Query caching • Usecaching on queries that don’t change often • cachedWithin • cachedAfter
- 191. Query caching • Usecaching on queries that don’t change often • cachedWithin • cachedAfter • Conserves bandwidth between servers
- 192. Query caching • Usecaching on queries that don’t change often • cachedWithin • cachedAfter • Conserves bandwidth between servers • Executes faster once it’s cached
- 193.
- 194. <cfcache> • Use <cfcache>for caching complete page results
- 195. <cfcache> • Use <cfcache>for caching complete page results • Caches on disk
- 196. <cfcache> • Use <cfcache>for caching complete page results • Caches on disk • Timespan definition
- 197. <cfcache> • Use <cfcache>for caching complete page results • Caches on disk • Timespan definition • Use primarily on “static” pages
- 198.
- 199. createObject() vs <cfinvoke> •<cfinvoke> creates new objects on each call
- 200. createObject() vs <cfinvoke> •<cfinvoke> creates new objects on each call • createObject() gives you instantiated object
- 201. createObject() vs <cfinvoke> •<cfinvoke> creates new objects on each call • createObject() gives you instantiated object • Cache in scopes for reuse
- 202. createObject() vs <cfinvoke> •<cfinvoke> creates new objects on each call • createObject() gives you instantiated object • Cache in scopes for reuse • Smaller memory footprint
- 203. createObject() vs <cfinvoke> •<cfinvoke> creates new objects on each call • createObject() gives you instantiated object • Cache in scopes for reuse • Smaller memory footprint • Reusability
- 204. createObject() vs <cfinvoke> •<cfinvoke> creates new objects on each call • createObject() gives you instantiated object • Cache in scopes for reuse • Smaller memory footprint • Reusability • Faster execution time
- 205.
- 206. Multi threading • Use<cfthread> to start separate thread
- 207. Multi threading • Use<cfthread> to start separate thread • Use it for asynchronous processes
- 208. Multi threading • Use<cfthread> to start separate thread • Use it for asynchronous processes • Use named locks for synchronising certain steps
- 209. Multi threading • Use<cfthread> to start separate thread • Use it for asynchronous processes • Use named locks for synchronising certain steps • e.g. database reads, news feeds, sending email...
- 210. Avoid <cfoutput> forstatic content
- 211. Avoid <cfoutput> forstatic content • Use only for dynamic content
- 212. Avoid <cfoutput> forstatic content • Use only for dynamic content • Searches static content
- 213. Avoid <cfoutput> forstatic content • Use only for dynamic content • Searches static content • Searching takes time
- 214. Avoid <cfoutput> forstatic content • Use only for dynamic content • Searches static content • Searching takes time • Multiple <cfoutput> blocks is better!
- 215.
- 216. Using pound signs(#) #
- 217. Using pound signs(#) • Use # signs around variables #
- 218. Using pound signs(#) • Use # signs around variables • In strings #
- 219. Using pound signs(#) • Use # signs around variables • In strings # • Between quotes
- 220. Using pound signs(#) • Use # signs around variables • In strings # • Between quotes • In <cfoutput>
- 221. Do not usepound signs (#)
- 222. Do not usepound signs (#) #
- 223. Do not usepound signs (#) • Do not use # around variables #
- 224. Do not usepound signs (#) • Do not use # around variables • In code #
- 225. Do not usepound signs (#) • Do not use # around variables • In code # • In conditional statements
- 226. Do not usepound signs (#) • Do not use # around variables • In code # • In conditional statements • Calculations
- 227. Do not usepound signs (#) • Do not use # around variables • In code # • In conditional statements • Calculations • Parameters
- 228. Twitter: Blog: @aikisteve www.flexpert.be Email: Company website: steven@silver-lining.be www.silver-lining.be
Editor's Notes
- #2 \n
- #3 \n
- #4 \n
- #5 \n
- #6 \n
- #7 \n
- #8 \n
- #9 \n
- #10 \n
- #11 \n
- #12 \n
- #13 \n
- #14 \n
- #15 \n
- #16 \n
- #17 \n
- #18 \n
- #19 \n
- #20 \n
- #21 \n
- #22 \n
- #23 \n
- #24 \n
- #25 \n
- #26 \n
- #27 \n
- #28 \n
- #29 \n
- #30 \n
- #31 \n
- #32 \n
- #33 \n
- #34 \n
- #35 \n
- #36 \n
- #37 \n
- #38 \n
- #39 \n
- #40 \n
- #41 \n
- #42 \n
- #43 \n
- #44 \n
- #45 \n
- #46 \n
- #47 \n
- #48 \n
- #49 \n
- #50 \n
- #51 \n
- #52 \n
- #53 \n
- #54 \n
- #55 \n
- #56 \n
- #57 \n
- #58 \n
- #59 \n
- #60 \n
- #61 \n
- #62 \n
- #63 \n
- #64 \n
- #65 \n
- #66 \n
- #67 \n
- #68 \n
- #69 \n
- #70 \n
- #71 \n
- #72 \n
- #73 \n
- #74 \n
- #75 \n
- #76 \n
- #77 \n
- #78 \n
- #79 \n
- #80 \n
- #81 \n
- #82 \n
- #83 \n
- #84 \n
- #85 \n
- #86 \n
- #87 \n
- #88 \n
- #89 \n
- #90 \n
- #91 \n
- #92 \n
- #93 \n
- #94 \n
- #95 \n
- #96 \n
- #97 \n
- #98 \n
- #99 \n
- #100 \n
- #101 \n
- #102 \n
- #103 \n
- #104 \n
- #105 \n
- #106 \n
- #107 \n
- #108 \n
- #109 \n
- #110 \n
- #111 \n
- #112 \n
- #113 \n
- #114 \n
- #115 \n
- #116 \n
- #117 \n
- #118 \n
- #119 \n
- #120 \n
- #121 \n
- #122 \n
- #123 \n
- #124 \n
- #125 \n
- #126 \n
- #127 \n
- #128 \n
- #129 \n
- #130 \n
- #131 \n
- #132 \n
- #133 \n
- #134 \n
- #135 \n
- #136 \n
- #137 \n
- #138 \n
- #139 \n
- #140 \n
- #141 \n
- #142 \n
- #143 \n
- #144 \n
- #145 \n
- #146 \n
- #147 \n
- #148 \n
- #149 \n
- #150 \n
- #151 \n
- #152 \n
- #153 \n
- #154 \n
- #155 \n
- #156 \n
- #157 \n
- #158 \n
- #159 \n
- #160 \n
- #161 \n
- #162 \n
- #163 \n
- #164 \n
- #165 \n
- #166 \n
- #167 \n
- #168 \n
- #169 \n
- #170 \n
- #171 \n
- #172 \n
- #173 \n
- #174 \n
- #175 \n
- #176 \n
- #177 \n
- #178 \n
- #179 \n
- #180 \n
- #181 \n
- #182 \n
- #183 \n
- #184 \n
- #185 \n
- #186 \n
- #187 \n
- #188 \n
- #189 \n
- #190 \n
- #191 \n
- #192 \n
- #193 \n
- #194 \n
- #195 \n
- #196 \n
- #197 \n
- #198 \n
- #199 \n
- #200 \n
- #201 \n
- #202 \n
- #203 \n
- #204 \n
- #205 \n
- #206 \n
- #207 \n
- #208 \n
- #209 \n
- #210 \n
- #211 \n
- #212 \n
- #213 \n
- #214 \n
- #215 \n
- #216 \n
- #217 \n
- #218 \n
- #219 \n
- #220 \n
- #221 \n
- #222 \n
- #223 \n
- #224 \n
- #225 \n
- #226 \n
- #227 \n
- #228 \n
- #229 \n
- #230 \n
- #231 \n
- #232 \n