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
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
Michael Maximilien, better known as max or Dr. Max, is a computer scientist with IBM. At IBM Research Triangle Park, he was a principal engineer for the worldwide industry point-of-sale standard: JavaPOS. At IBM Research, some highlights include pioneering research on semantic Web services, mashups, and cloud computing, and platform-as-a-service. He joined the IBM Cloud Labs in 2014 and works closely with Pivotal Inc., to help make the Cloud Found the best PaaS.
As data explodes in quantity, importance and from new sources, the need for managing and protecting data residing across physical, virtual, and cloud environments grow with it. Managing data includes protecting it, indexing and classifying it for true, long-term management, compliance and E-Discovery. Commvault can ensure this with a single pane of glass solution – whether in a private cloud, a Service Provider delivered public cloud or a hybrid cloud environment – across the heterogeneous enter...
Cloud-enabled transformation has evolved from cost saving measure to business innovation strategy -- one that combines the cloud with cognitive capabilities to drive market disruption. Learn how you can achieve the insight and agility you need to gain a competitive advantage. Industry-acclaimed CTO and cloud expert, Shankar Kalyana presents. Only the most exceptional IBMers are appointed with the rare distinction of IBM Fellow, the highest technical honor in the company. Shankar has also receive...
"We view the cloud not as a specific technology but as a way of doing business and that way of doing business is transforming the way software, infrastructure and services are being delivered to business," explained Matthew Rosen, CEO and Director at Fusion, in this SYS-CON.tv interview at 18th Cloud Expo (http://www.CloudComputingExpo.com), held June 7-9 at the Javits Center in New York City, NY.
The Founder of NostaLab and a member of the Google Health Advisory Board, John is a unique combination of strategic thinker, marketer and entrepreneur. His career was built on the "science of advertising" combining strategy, creativity and marketing for industry-leading results. Combined with his ability to communicate complicated scientific concepts in a way that consumers and scientists alike can appreciate, John is a sought-after speaker for conferences on the forefront of healthcare science,...
WebRTC is great technology to build your own communication tools. It will be even more exciting experience it with advanced devices, such as a 360 Camera, 360 microphone, and a depth sensor camera. In his session at @ThingsExpo, Masashi Ganeko, a manager at INFOCOM Corporation, introduced two experimental projects from his team and what they learned from them. "Shotoku Tamago" uses the robot audition software HARK to track speakers in 360 video of a remote party. "Virtual Teleport" uses a multip...
Data is the fuel that drives the machine learning algorithmic engines and ultimately provides the business value. In his session at Cloud Expo, Ed Featherston, a director and senior enterprise architect at Collaborative Consulting, discussed the key considerations around quality, volume, timeliness, and pedigree that must be dealt with in order to properly fuel that engine.
In his session at Cloud Expo, Alan Winters, U.S. Head of Business Development at MobiDev, presented a success story of an entrepreneur who has both suffered through and benefited from offshore development across multiple businesses: The smart choice, or how to select the right offshore development partner Warning signs, or how to minimize chances of making the wrong choice Collaboration, or how to establish the most effective work processes Budget control, or how to maximize project result...
"Akvelon is a software development company and we also provide consultancy services to folks who are looking to scale or accelerate their engineering roadmaps," explained Jeremiah Mothersell, Marketing Manager at Akvelon, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
IoT is rapidly becoming mainstream as more and more investments are made into the platforms and technology. As this movement continues to expand and gain momentum it creates a massive wall of noise that can be difficult to sift through. Unfortunately, this inevitably makes IoT less approachable for people to get started with and can hamper efforts to integrate this key technology into your own portfolio. There are so many connected products already in place today with many hundreds more on the h...
DXWorldEXPO LLC announced today that ICC-USA, a computer systems integrator and server manufacturing company focused on developing products and product appliances, will exhibit at the 22nd International CloudEXPO | DXWorldEXPO. DXWordEXPO New York 2018, colocated with CloudEXPO New York 2018 will be held November 11-13, 2018, in New York City. ICC is a computer systems integrator and server manufacturing company focused on developing products and product appliances to meet a wide range of ...
JETRO showcased Japan Digital Transformation Pavilion at SYS-CON's 21st International Cloud Expo® at the Santa Clara Convention Center in Santa Clara, CA. The Japan External Trade Organization (JETRO) is a non-profit organization that provides business support services to companies expanding to Japan. With the support of JETRO's dedicated staff, clients can incorporate their business; receive visa, immigration, and HR support; find dedicated office space; identify local government subsidies; get...
René Bostic is the Technical VP of the IBM Cloud Unit in North America. Enjoying her career with IBM during the modern millennial technological era, she is an expert in cloud computing, DevOps and emerging cloud technologies such as Blockchain. Her strengths and core competencies include a proven record of accomplishments in consensus building at all levels to assess, plan, and implement enterprise and cloud computing solutions. René is a member of the Society of Women Engineers (SWE) and a m...
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 Archi...
In his general session at 19th Cloud Expo, Manish Dixit, VP of Product and Engineering at Dice, discussed how Dice leverages data insights and tools to help both tech professionals and recruiters better understand how skills relate to each other and which skills are in high demand using interactive visualizations and salary indicator tools to maximize earning potential. Manish Dixit is VP of Product and Engineering at Dice. As the leader of the Product, Engineering and Data Sciences team at D...
Personalization has long been the holy grail of marketing. Simply stated, communicate the most relevant offer to the right person and you will increase sales. To achieve this, you must understand the individual. Consequently, digital marketers developed many ways to gather and leverage customer information to deliver targeted experiences. In his session at @ThingsExpo, Lou Casal, Founder and Principal Consultant at Practicala, discussed how the Internet of Things (IoT) has accelerated our abilit...
Organizations planning enterprise data center consolidation and modernization projects are faced with a challenging, costly reality. Requirements to deploy modern, cloud-native applications simultaneously with traditional client/server applications are almost impossible to achieve with hardware-centric enterprise infrastructure. Compute and network infrastructure are fast moving down a software-defined path, but storage has been a laggard. Until now.
Digital Transformation is much more than a buzzword. The radical shift to digital mechanisms for almost every process is evident across all industries and verticals. This is often especially true in financial services, where the legacy environment is many times unable to keep up with the rapidly shifting demands of the consumer. The constant pressure to provide complete, omnichannel delivery of customer-facing solutions to meet both regulatory and customer demands is putting enormous pressure on...
The best way to leverage your CloudEXPO | DXWorldEXPO presence as a sponsor and exhibitor is to plan your news announcements around our events. The press covering CloudEXPO | DXWorldEXPO will have access to these releases and will amplify your news announcements. More than two dozen Cloud companies either set deals at our shows or have announced their mergers and acquisitions at CloudEXPO. Product announcements during our show provide your company with the most reach through our targeted audienc...