|By Jesse Randall Warden||
|July 17, 2006 10:15 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.
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'."
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, 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.
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.
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.
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.
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.
|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.
"Matrix is an ambitious open standard and implementation that's set up to break down the fragmentation problems that exist in IP messaging and VoIP communication," explained John Woolf, Technical Evangelist at Matrix, in this SYS-CON.tv interview at @ThingsExpo, held Nov 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA.
Oct. 20, 2016 08:00 PM EDT Reads: 8,870
SYS-CON Events announced today that Sheng Liang to Keynote at SYS-CON's 19th Cloud Expo, which will take place on November 1-3, 2016 at the Santa Clara Convention Center in Santa Clara, California.
Oct. 20, 2016 08:00 PM EDT Reads: 1,620
@ThingsExpo has been named the Top 5 Most Influential Internet of Things Brand by Onalytica in the ‘The Internet of Things Landscape 2015: Top 100 Individuals and Brands.' Onalytica analyzed Twitter conversations around the #IoT debate to uncover the most influential brands and individuals driving the conversation. Onalytica captured data from 56,224 users. The PageRank based methodology they use to extract influencers on a particular topic (tweets mentioning #InternetofThings or #IoT in this ...
Oct. 20, 2016 06:45 PM EDT Reads: 7,921
DevOps is being widely accepted (if not fully adopted) as essential in enterprise IT. But as Enterprise DevOps gains maturity, expands scope, and increases velocity, the need for data-driven decisions across teams becomes more acute. DevOps teams in any modern business must wrangle the ‘digital exhaust’ from the delivery toolchain, "pervasive" and "cognitive" computing, APIs and services, mobile devices and applications, the Internet of Things, and now even blockchain. In this power panel at @...
Oct. 20, 2016 06:15 PM EDT Reads: 1,774
November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Penta Security is a leading vendor for data security solutions, including its encryption solution, D’Amo. By using FPE technology, D’Amo allows for the implementation of encryption technology to sensitive data fields without modification to schema in the database environment. With businesses having their data become increasingly more complicated in their mission-critical applications (such as ERP, CRM, HRM), continued ...
Oct. 20, 2016 06:00 PM EDT Reads: 825
SYS-CON Events announced today that Streamlyzer will exhibit at the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Streamlyzer is a powerful analytics for video streaming service that enables video streaming providers to monitor and analyze QoE (Quality-of-Experience) from end-user devices in real time.
Oct. 20, 2016 05:30 PM EDT Reads: 837
The IoT has the potential to create a renaissance of manufacturing in the US and elsewhere. In his session at 18th Cloud Expo, Florent Solt, CTO and chief architect of Netvibes, discussed how the expected exponential increase in the amount of data that will be processed, transported, stored, and accessed means there will be a huge demand for smart technologies to deliver it. Florent Solt is the CTO and chief architect of Netvibes. Prior to joining Netvibes in 2007, he co-founded Rift Technologi...
Oct. 20, 2016 05:30 PM EDT Reads: 2,772
@ThingsExpo has been named the Top 5 Most Influential M2M Brand by Onalytica in the ‘Machine to Machine: Top 100 Influencers and Brands.' Onalytica analyzed the online debate on M2M by looking at over 85,000 tweets to provide the most influential individuals and brands that drive the discussion. According to Onalytica the "analysis showed a very engaged community with a lot of interactive tweets. The M2M discussion seems to be more fragmented and driven by some of the major brands present in the...
Oct. 20, 2016 05:15 PM EDT Reads: 11,004
Established in 1998, Calsoft is a leading software product engineering Services Company specializing in Storage, Networking, Virtualization and Cloud business verticals. Calsoft provides End-to-End Product Development, Quality Assurance Sustenance, Solution Engineering and Professional Services expertise to assist customers in achieving their product development and business goals. The company's deep domain knowledge of Storage, Virtualization, Networking and Cloud verticals helps in delivering ...
Oct. 20, 2016 03:45 PM EDT Reads: 883
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 Arch...
Oct. 20, 2016 03:00 PM EDT Reads: 5,883
SYS-CON Media announced today that @WebRTCSummit Blog, the largest WebRTC resource in the world, has been launched. @WebRTCSummit Blog offers top articles, news stories, and blog posts from the world's well-known experts and guarantees better exposure for its authors than any other publication. @WebRTCSummit Blog can be bookmarked ▸ Here @WebRTCSummit conference site can be bookmarked ▸ Here
Oct. 20, 2016 02:15 PM EDT Reads: 9,562
WebRTC defines no default signaling protocol, causing fragmentation between WebRTC silos. SIP and XMPP provide possibilities, but come with considerable complexity and are not designed for use in a web environment. In his session at @ThingsExpo, Matthew Hodgson, technical co-founder of the Matrix.org, discussed how Matrix is a new non-profit Open Source Project that defines both a new HTTP-based standard for VoIP & IM signaling and provides reference implementations.
Oct. 20, 2016 02:15 PM EDT Reads: 2,649
Virgil consists of an open-source encryption library, which implements Cryptographic Message Syntax (CMS) and Elliptic Curve Integrated Encryption Scheme (ECIES) (including RSA schema), a Key Management API, and a cloud-based Key Management Service (Virgil Keys). The Virgil Keys Service consists of a public key service and a private key escrow service.
Oct. 20, 2016 02:15 PM EDT Reads: 842
In his keynote at 19th Cloud Expo, Sheng Liang, co-founder and CEO of Rancher Labs, will discuss the technological advances and new business opportunities created by the rapid adoption of containers. With the success of Amazon Web Services (AWS) and various open source technologies used to build private clouds, cloud computing has become an essential component of IT strategy. However, users continue to face challenges in implementing clouds, as older technologies evolve and newer ones like Docke...
Oct. 20, 2016 01:45 PM EDT Reads: 2,152
You have great SaaS business app ideas. You want to turn your idea quickly into a functional and engaging proof of concept. You need to be able to modify it to meet customers' needs, and you need to deliver a complete and secure SaaS application. How could you achieve all the above and yet avoid unforeseen IT requirements that add unnecessary cost and complexity? You also want your app to be responsive in any device at any time. In his session at 19th Cloud Expo, Mark Allen, General Manager of...
Oct. 20, 2016 01:30 PM EDT Reads: 721
In his keynote at 18th Cloud Expo, Andrew Keys, Co-Founder of ConsenSys Enterprise, provided an overview of the evolution of the Internet and the Database and the future of their combination – the Blockchain. Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life sett...
Oct. 20, 2016 01:30 PM EDT Reads: 5,062
In the next five to ten years, millions, if not billions of things will become smarter. This smartness goes beyond connected things in our homes like the fridge, thermostat and fancy lighting, and into heavily regulated industries including aerospace, pharmaceutical/medical devices and energy. “Smartness” will embed itself within individual products that are part of our daily lives. We will engage with smart products - learning from them, informing them, and communicating with them. Smart produc...
Oct. 20, 2016 01:15 PM EDT Reads: 1,387
Just over a week ago I received a long and loud sustained applause for a presentation I delivered at this year’s Cloud Expo in Santa Clara. I was extremely pleased with the turnout and had some very good conversations with many of the attendees. Over the next few days I had many more meaningful conversations and was not only happy with the results but also learned a few new things. Here is everything I learned in those three days distilled into three short points.
Oct. 20, 2016 01:00 PM EDT Reads: 6,743
SYS-CON Events announced today that Coalfire will exhibit at the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Coalfire is the trusted leader in cybersecurity risk management and compliance services. Coalfire integrates advisory and technical assessments and recommendations to the corporate directors, executives, boards, and IT organizations for global brands and organizations in the technology, cloud, health...
Oct. 20, 2016 12:30 PM EDT Reads: 1,432
SYS-CON Events announced today that MathFreeOn will exhibit at the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. MathFreeOn is Software as a Service (SaaS) used in Engineering and Math education. Write scripts and solve math problems online. MathFreeOn provides online courses for beginners or amateurs who have difficulties in writing scripts. In accordance with various mathematical topics, there are more tha...
Oct. 20, 2016 12:00 PM EDT Reads: 831