Click here to close now.




















Welcome!

Adobe Flex Authors: Matthew Lobas, PR.com Newswire, Shelly Palmer, Kevin Benedict

Related Topics: Adobe Flex

Adobe Flex: Article

Code Reuse - Pros and Cons

Notes of a soldier from the oh-so-bloody front

Depending on the scope of your project, you may have the opportunity for code reuse. The reasons you might want to do so are two-fold. First, you reduce duplication of efforts. If you have already created a hyperlink enabled CellRenderer for your DataGrid once, why do it again? Second, you create, or build upon, an ever growing utility code base. While it may not be in the "utils" package per se, you'll soon end up with re-usable events, common GUI controls and widgets, and yes even utility classes. Whether by merely being in a different folder means the client doesn't own it is up to you or your sales team.

Duplication Killed on Sight
On the current project I'm on, we re-use a LOT. My eagle-eye boss the architect head-shots any duplication he sees. Thus, we the developers have been trained to quickly identify something we create for re-use if possible and either plan accordingly when building it, or go in search of "spare parts" from existing classes throughout the main code-base for re-use. Our main base consists of 3 company names, each containing at least 3 individual "products". The first question I ask my fellow developers, and they in return, when starting to build something new is, "Has this been done before?" Re-inventing the wheel has no place in a production cycle unless you can clearly point out how the original wheel design was flawed, can be done better, and done so in a reasonable time frame approved by the client.

This also helps ensure I don't code something similar to what has already been done. To the client's point of view, they already paid for a LoginForm...why should they have to pay for a new one when all they want is for it to be green instead of blue?

"Dan, the login form's blue by default, but the mockups I have here are green."

"That's because the View using it sets it to blue; it has a color property that is an inherited style; you can style it yourself, just do color='#yourcolor'."

"Oh... nice!"

Suddenly, I spend 10 minutes finding the file and including it, setting its color, registering for its login event, and building a test file to see it in action. This instead of 4 hours doing the same building a green one. Take how much you make per hour, multiply by 4, and then subtract what you make in 15 minutes. That difference is what you just saved the client by "asking a question." I've learned the hard way to ask a lot of questions to the point of being annoying and forcing people to repeat themselves.

The same goes for building more complex things that have to be unique to a point. The most common example which I already alluded to is the CellRenderer. This is a class commonly utilized in Flash and Flex development to customize what's showing in a DataGrid column; each row will render the custom class instead of the default and pass it an item to render. Since every DataGrid on a project is unique, you inevitably end up with a multitude of cellrenderer classes. These classes are, at least for me, notoriously hard to share so you attempt to make them as generic as possible so others can either use them as is, or do the most common thing and extend your base one to customize it to their needs.

This is an important point. The 30 or so lines of code that are required to setup a cellrenderer are suddenly already written for you, and the other developers on your team. This is a great place where inheritance really works and should be exploited. It doesn't stop there; some of the cellrenderers created could be used elsewhere as well. The only challenge is how they're designed from a visual standpoint. Styles can handle a lot, but most designers I have had the pleasure of working with have a knack of making something unique, and unique isn't always re-usable. You can either find a happy compromise with your designers, or respect their artistic integrity and recognize the fact that that they design is truly made specifically for a certain need and shouldn't be made re-usable.

Con of a Component Buffet
The first con to reusing already-built components hits the design side hardest. One of the biggest gripes people have had with any Flash/Flex component is styling and skinning. While CSS styling has come a long way in Flex 2, there are always those times where the artist (in you or beside you) goes, "It's just not right..." Sometimes extending the base component just for styling purposes is the best repose since the base component isn't muddied with application specific styling routines.

The second con which can really come to the forefront in teams is you just don't like the component. Any developer who isn't apprehensive about using a component they didn't write makes me nervous. You trust code you didn't write? Sometimes you don't have a choice or recognize the alternatives are unacceptable. We're all human, and have our coding styles, and even if notation and other rules are enforced on your team, you can still dislike the implementation of something. This should be in the back of your mind when creating code for reuse as well. How will my code be perceived? The base rules such as encapsulation should be followed, but obviously there are other esoteric and styles of implementation that can drastically impact your involvement to ensure others spend very little of theirs getting acclimated to how it works for example.

Sum Greater Than Its Parts
For components that are made up of other components via Composition, I'll ask my fellow developers if the pieces I need are already built. For example, if I'm creating a form, I'll re-use the extended TextInput's we have. For the above CellRenderer, if it has to display a Date, I'll set the labelFunction to utilize the DateUtils class we have which will take a regular Date object and make it look like, "Tue 5/23/2006". I didn't have to write the base class of the CellRenderer and I didn't have to write a class to format dates, I just had to use the class. I've been doing the same thing for a long time without really thinking about it. For example, I take for example I can just "use a DataGrid" and "extend it with a CellRenderer". Macromedia/Adobe spent a lot of time developing one that could be reusable. Naturally, there comes a point where something is coded to business rules or a certain design, and the pragmatist in me knows when to stop trying to overdo it.

Let's turn it up a notch, though. What if you've built a DataGrid that has custom cellrenders, text fields on the bottom to filter it, and is tied to a specific ValueObject it knows how to display, and display well? Can you re-use that? Absolutely! Just because you don't right now doesn't mean you won't later. You should typically design with the intention to do so, but not so much you don't ever actually complete anything beyond a pimped out skeleton. Adamantine ingots may have great potential, but are merely blocks of immobile metal until merged with, say, a regenerative Canadian supersoldier's skeleton. Put what you write to use sooner rather than later.

This is where code reuse really shines. You're near mini-application status component which does a lot is now re-used by your team. If the components within it follow normal styling rules and expose their innards to those who wish to extend it, your golden if certain custom styling needs to be applied. What could possibly be a con about this?

Package Structure
Package structure. Package structure, for those who don't know, is how code is organized into folders. Folders are called "packages" because they have code and other packages in them depending on how deeply you nest your code. Code is placed into class files (.as or .mxml) and placed into folders. The typical naming scheme goes deployment type, company, project, and then regular code. This can take the form of com.adobe.utils.DateUtils where you have a com folder that contains an adobe folder which in turn contains a utils folder which contains the DateUtils.as file. You then import the class or "package path" into your code and the class DateUtils, and your code will know what folder to look in from the import statement.

Some projects do get large enough where you do in fact have more than one project folder. Code re-use is typically thought of through Views of some sort client developers. There is however, no reason you cannot re-use Views across projects. You just reference the package path. The pros are, work effort utilized on a project can be re-used on other projects. Sometimes you can plan for this re-use, and sometimes it's a pleasant surprise.

Licenses
I suppose, depending on the license, that you could use it for different companies as well, but each license has specific rules on how code is used. Creative Commons is pretty simple; just keep the author's name in the code unless she/he says otherwise. From that point forward, you can modify and re-modify to your heart's content with no license fee. Others are a lot weirder. Some companies require you supply them source code. Some don't even know what source code is. Still others own everything you write while in their presence, thus preventing you from using any of your own re-usable stuff. A common tactic I've seen is to have your company's name next to the client's company name. All common views and utility classes are put in yours, and the custom developed work is put in the client's package path.

Global Ramifications
That last point is another important point. Code by residing in your company's folder its very nature has a very special, and important place; it's created for re-use. On the current project, or projects, it's re-used in many places. While all uses of it are immediately improved upon once you improve the base component, thus improving the whole project, this can have unforeseen consequences as well.

For example, you build your own List control to render extremely unique rows that animate instead of simply refreshing. In practice, you see that it is extremely slow, especially when multiple instances of it are used. You go in and re-factor it, finding many places in the code you can speed up. Suddenly, the entire app speeds up where those components are used.

One of these changes was to expose a method for updating one specific item versus all of them when a piece of data changes. This is accomplished via a new method. That's a bad thing. Suddenly all the classes that use it now have to update themselves just to access one of the new optimizations.

Touching a point I brought up earlier, sharing views between projects - the problem with that is that, if you change a view in one project, you've just affected the other one. Code that was seemingly "working" you just broke, and you didn't know it because you were never compiling, nor even involved in the other project. The important point here is: if you are going to identify something as re-usable, make it so, and put it into a global package such as your company's folder, or another aptly named common folder. Developers who go into the code in those packages know full well the ramifications of what their changes could do, for good or ill.

Tool Shed
When I got my first apartment, I had one screwdriver and one small Phillips head to my name. Now that I own a house, I have a small utility closet full of tools. I'm sure by the time I'm eighty, I'll need a tool shed to hold them all. The same can be said about your "common" code base: you'll find over time that it'll grow into an extremely useful and portable set of code. Remember, you don't have to write it all yourself, nor does your team. There's a lot of free code on the Net that you can test yourself, and then incorporate. This'll save you from having to create a hammer before you can use said hammer every project; going in, you'll be equipped to the teeth, and you'll come out with more ammo than you started with.

Summary
The greater the size of the project, and/or the more frequenct the projects,the more important reusing code becomes. Making the most of a developer's time spent coding is done this way, and allows many others to benefit from that work for months, even years to come. For example, I've been using the same preloader in Flash for 3 years, written in ActionScript 1 in Flash 5. I still customize the colors, though, every time.

With reuse comes great responsibility. If you are designating something as reusable, it can be quite frightening to realize that a lot of others are suddenly depending on this pinnacle piece of code. That is a risk worth taking, and a strength you should prey upon. As long as you recognize the dependencies, and reduce coupling, you'll start gaining a lot more efficiency from the time you and your team spend coding.

When I first learned about reuse, I could never get it to work in practice. I either ran out of time and copy-pasted or my original design was perceived to me as being "flawed" even though it worked perfectly fine. I was just being unreasonable. Keep it simple, and you'll do fine.

More Stories By Jesse Randall Warden

Jesse R. Warden, a member of the Editorial Board of Web Developer's & Designer's Journal, is a Flex, Flash and Flash Lite consultant for Universal Mind. A professional multimedia developer, he maintains a Website at jessewarden.com where he writes about technical topics that relate to Flash and Flex.

Comments (1) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


Most Recent Comments
SYS-CON India News Desk 07/17/06 10:44:08 AM EDT

Depending on the scope of your project, you may have the opportunity for code reuse. The reasons you might want to do so are two-fold. First, you reduce duplication of efforts. If you have already created a hyperlink enabled CellRenderer for your DataGrid once, why do it again? Second, you create, or build upon, an ever growing utility code base. While it may not be in the 'utils' package per se, you'll soon end up with re-usable events, common GUI controls and widgets, and yes even utility classes. Whether by merely being in a different folder means the client doesn't own it is up to you or your sales team.

@ThingsExpo Stories
SYS-CON Events announced today that HPM Networks will exhibit at the 17th International Cloud Expo®, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. For 20 years, HPM Networks has been integrating technology solutions that solve complex business challenges. HPM Networks has designed solutions for both SMB and enterprise customers throughout the San Francisco Bay Area.
For IoT to grow as quickly as analyst firms’ project, a lot is going to fall on developers to quickly bring applications to market. But the lack of a standard development platform threatens to slow growth and make application development more time consuming and costly, much like we’ve seen in the mobile space. In his session at @ThingsExpo, Mike Weiner, Product Manager of the Omega DevCloud with KORE Telematics Inc., discussed the evolving requirements for developers as IoT matures and conducted a live demonstration of how quickly application development can happen when the need to comply wit...
The Internet of Everything (IoE) brings together people, process, data and things to make networked connections more relevant and valuable than ever before – transforming information into knowledge and knowledge into wisdom. IoE creates new capabilities, richer experiences, and unprecedented opportunities to improve business and government operations, decision making and mission support capabilities.
Explosive growth in connected devices. Enormous amounts of data for collection and analysis. Critical use of data for split-second decision making and actionable information. All three are factors in making the Internet of Things a reality. Yet, any one factor would have an IT organization pondering its infrastructure strategy. How should your organization enhance its IT framework to enable an Internet of Things implementation? In his session at @ThingsExpo, James Kirkland, Red Hat's Chief Architect for the Internet of Things and Intelligent Systems, described how to revolutionize your archit...
MuleSoft has announced the findings of its 2015 Connectivity Benchmark Report on the adoption and business impact of APIs. The findings suggest traditional businesses are quickly evolving into "composable enterprises" built out of hundreds of connected software services, applications and devices. Most are embracing the Internet of Things (IoT) and microservices technologies like Docker. A majority are integrating wearables, like smart watches, and more than half plan to generate revenue with APIs within the next year.
Growth hacking is common for startups to make unheard-of progress in building their business. Career Hacks can help Geek Girls and those who support them (yes, that's you too, Dad!) to excel in this typically male-dominated world. Get ready to learn the facts: Is there a bias against women in the tech / developer communities? Why are women 50% of the workforce, but hold only 24% of the STEM or IT positions? Some beginnings of what to do about it! In her Opening Keynote at 16th Cloud Expo, Sandy Carter, IBM General Manager Cloud Ecosystem and Developers, and a Social Business Evangelist, d...
In his keynote at 16th Cloud Expo, Rodney Rogers, CEO of Virtustream, discussed the evolution of the company from inception to its recent acquisition by EMC – including personal insights, lessons learned (and some WTF moments) along the way. Learn how Virtustream’s unique approach of combining the economics and elasticity of the consumer cloud model with proper performance, application automation and security into a platform became a breakout success with enterprise customers and a natural fit for the EMC Federation.
The Internet of Things is not only adding billions of sensors and billions of terabytes to the Internet. It is also forcing a fundamental change in the way we envision Information Technology. For the first time, more data is being created by devices at the edge of the Internet rather than from centralized systems. What does this mean for today's IT professional? In this Power Panel at @ThingsExpo, moderated by Conference Chair Roger Strukhoff, panelists addressed this very serious issue of profound change in the industry.
Discussions about cloud computing are evolving into discussions about enterprise IT in general. As enterprises increasingly migrate toward their own unique clouds, new issues such as the use of containers and microservices emerge to keep things interesting. In this Power Panel at 16th Cloud Expo, moderated by Conference Chair Roger Strukhoff, panelists addressed the state of cloud computing today, and what enterprise IT professionals need to know about how the latest topics and trends affect their organization.
It is one thing to build single industrial IoT applications, but what will it take to build the Smart Cities and truly society-changing applications of the future? The technology won’t be the problem, it will be the number of parties that need to work together and be aligned in their motivation to succeed. In his session at @ThingsExpo, Jason Mondanaro, Director, Product Management at Metanga, discussed how you can plan to cooperate, partner, and form lasting all-star teams to change the world and it starts with business models and monetization strategies.
Converging digital disruptions is creating a major sea change - Cisco calls this the Internet of Everything (IoE). IoE is the network connection of People, Process, Data and Things, fueled by Cloud, Mobile, Social, Analytics and Security, and it represents a $19Trillion value-at-stake over the next 10 years. In her keynote at @ThingsExpo, Manjula Talreja, VP of Cisco Consulting Services, discussed IoE and the enormous opportunities it provides to public and private firms alike. She will share what businesses must do to thrive in the IoE economy, citing examples from several industry sectors.
There will be 150 billion connected devices by 2020. New digital businesses have already disrupted value chains across every industry. APIs are at the center of the digital business. You need to understand what assets you have that can be exposed digitally, what their digital value chain is, and how to create an effective business model around that value chain to compete in this economy. No enterprise can be complacent and not engage in the digital economy. Learn how to be the disruptor and not the disruptee.
Akana has released Envision, an enhanced API analytics platform that helps enterprises mine critical insights across their digital eco-systems, understand their customers and partners and offer value-added personalized services. “In today’s digital economy, data-driven insights are proving to be a key differentiator for businesses. Understanding the data that is being tunneled through their APIs and how it can be used to optimize their business and operations is of paramount importance,” said Alistair Farquharson, CTO of Akana.
Business as usual for IT is evolving into a "Make or Buy" decision on a service-by-service conversation with input from the LOBs. How does your organization move forward with cloud? In his general session at 16th Cloud Expo, Paul Maravei, Regional Sales Manager, Hybrid Cloud and Managed Services at Cisco, discusses how Cisco and its partners offer a market-leading portfolio and ecosystem of cloud infrastructure and application services that allow you to uniquely and securely combine cloud business applications and services across multiple cloud delivery models.
The enterprise market will drive IoT device adoption over the next five years. In his session at @ThingsExpo, John Greenough, an analyst at BI Intelligence, division of Business Insider, analyzed how companies will adopt IoT products and the associated cost of adopting those products. John Greenough is the lead analyst covering the Internet of Things for BI Intelligence- Business Insider’s paid research service. Numerous IoT companies have cited his analysis of the IoT. Prior to joining BI Intelligence, he worked analyzing bank technology for Corporate Insight and The Clearing House Payment...
"Optimal Design is a technology integration and product development firm that specializes in connecting devices to the cloud," stated Joe Wascow, Co-Founder & CMO of Optimal Design, in this SYS-CON.tv interview at @ThingsExpo, held June 9-11, 2015, at the Javits Center in New York City.
SYS-CON Events announced today that CommVault has been named “Bronze Sponsor” of SYS-CON's 17th International Cloud Expo®, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. A singular vision – a belief in a better way to address current and future data management needs – guides CommVault in the development of Singular Information Management® solutions for high-performance data protection, universal availability and simplified management of data on complex storage networks. CommVault's exclusive single-platform architecture gives companies unp...
Electric Cloud and Arynga have announced a product integration partnership that will bring Continuous Delivery solutions to the automotive Internet-of-Things (IoT) market. The joint solution will help automotive manufacturers, OEMs and system integrators adopt DevOps automation and Continuous Delivery practices that reduce software build and release cycle times within the complex and specific parameters of embedded and IoT software systems.
"ciqada is a combined platform of hardware modules and server products that lets people take their existing devices or new devices and lets them be accessible over the Internet for their users," noted Geoff Engelstein of ciqada, a division of Mars International, in this SYS-CON.tv interview at @ThingsExpo, held June 9-11, 2015, at the Javits Center in New York City.
Internet of Things is moving from being a hype to a reality. Experts estimate that internet connected cars will grow to 152 million, while over 100 million internet connected wireless light bulbs and lamps will be operational by 2020. These and many other intriguing statistics highlight the importance of Internet powered devices and how market penetration is going to multiply many times over in the next few years.