|
|
| Line 1: |
Line 1: |
| <p>Code Reuse - This page describes what is code reuse, how to achieve it and discusses the advantages and disadvantages of code reuse.</p>
| |
|
| |
|
| == Definition ==
| |
| Code reuse is the way in which an existing code can be used to perform a specific service regardless of the application in which it is used.<ref name = wiki_code_reuse/> It involves the use of some previously constructed [http://en.wikipedia.org/wiki/Software software] artifacts like source code, library, components, etc. An example of it can be the design patterns in a new context or in a new development project.
| |
|
| |
| Software reuse is the process of creating software systems from existing software rather than building software systems from scratch.<ref name = "definition_software_reuse" />
| |
|
| |
| == Overview <ref name = wiki_code_reuse/>==
| |
| Code reuse is the idea that a partial computer program written at one time can be, should be, or is being used in another program written at a later time. The reuse of programming code is a common technique which attempts to save time and energy by reducing redundant work.
| |
|
| |
| The software library is a good example of code reuse.
| |
|
| |
| Programmers may decide to create internal [http://en.wikipedia.org/wiki/Abstraction_%28computer_science%29 abstractions] so that certain parts of their program can be reused, or may create custom libraries for their own use.
| |
|
| |
| The general practice of using a prior version of an extant program as a starting point for the next version, is also a form of code reuse.
| |
|
| |
| Some so-called code "reuse" involves simply copying some or all of the code from an existing program into a new one. While organizations can realize time to market benefits for a new product with this approach, they can subsequently be saddled with many of the same code duplication problems caused by [http://en.wikipedia.org/wiki/Cut_and_paste_programming cut and paste programming].
| |
|
| |
| Many researchers have worked to make reuse faster, easier, more systematic, and an integral part of the normal process of programming. These are some of the main goals behind the invention of [http://en.wikipedia.org/wiki/Object-oriented_programming object-oriented programming], which became one of the most common forms of formalized reuse.
| |
|
| |
| A somewhat later invention is [http://en.wikipedia.org/wiki/Generic_programming generic programming].
| |
|
| |
| Another, newer means is to use software "[http://en.wikipedia.org/wiki/Source_code_generation generators]", programs which can create new programs of a certain type, based on a set of parameters that users choose. Fields of study about such systems are [http://en.wikipedia.org/wiki/Generative_programming generative programming] and [http://en.wikipedia.org/wiki/Meta_programming meta programming].
| |
|
| |
| == History ==
| |
| [http://en.wikipedia.org/wiki/Ad_hoc Ad hoc] code reuse has been practiced from the earliest days of programming. Programmers have always reused sections of code, templates, functions, and [http://en.wikipedia.org/wiki/Procedure_%28computer_science%29 procedures]. Software reuse as a recognized area of study in software engineering, however, dates only from 1968 when [http://en.wikipedia.org/wiki/Douglas_McIlroy Douglas McIlroy] of [http://en.wikipedia.org/wiki/Bell_Labs Bell Laboratories] proposed basing the software industry on reusable components. <ref name = wiki_code_reuse/>
| |
|
| |
| There are many dimensions along which we can trace the history of reuse: <ref name = history_pros_cons/>
| |
| * [http://en.wikipedia.org/wiki/Software_Development_Life_Cycle Software Development Life Cycle] (SDLC) Model
| |
| * [http://en.wikipedia.org/wiki/Prototyping Prototyping], Iterative, ESP, etc.
| |
| * Requirements/Specification Method
| |
| * Business Model
| |
| * Implementation technology
| |
|
| |
| === History of software reuse based on implementation technology dimension <ref name = history_pros_cons/>===
| |
| * Mid 1980’s - Mature Third Generation Programming Languages -
| |
| Third generation languages were more portable than the earlier machine specific languages; even though source code still had to be language, [http://en.wikipedia.org/wiki/Operating_system OS] and platform specific. However they did achieve limited source code reuse for high value. e.g. math libraries.
| |
|
| |
| * Late 1980’s - Early Object Oriented Languages and SQL DB -
| |
| Introduction of object oriented languages like [http://en.wikipedia.org/wiki/Common_Lisp_Object_System Common Lisp Object System (CLOS)], C++ interpreter, etc provided encapsulation and packaging technology.Packaging and common object models promoted development of language “bindings”. Systematic and repeatable object oriented development processes were also introduced during this time. Although most [http://en.wikipedia.org/wiki/Portability_%28computer_science%29 portability] constraints remained as they were, some reuse success was achieved in the form of high value data structure libraries (e.g. GRACE and Booch parts). The first successful reusable service of SQL [http://en.wikipedia.org/wiki/Relational_database_management_system RDBMS] was developed during this period.
| |
|
| |
| * Early 1990’s - Mature OO Languages, Source Code Libraries -
| |
| This era saw development of mature OO languages like [http://en.wikipedia.org/wiki/Smalltalk Smalltalk], ANSI [http://en.wikipedia.org/wiki/CLOS CLOS], C++ compilers, [http://en.wikipedia.org/wiki/GUI GUI] and [http://en.wikipedia.org/wiki/Event_driven_programming Event Driven Programming] Libraries and portable compiled software packages like Shared Libraries, Dynamic Link Libraries, etc. Significant reuse research was carried out during this period(e.g. SPC CoE for Reuse/ARPA contract) which gave birth to early software reuse driven processes and reuse libraries (like management systems, not just content)
| |
|
| |
| * Mid 1990’s - Early DIAE Component Packaging -
| |
| Dynamically Integrable Autonomously Executable Components that are compiled and linked separately, integrate at run time, and run independent of each other were developed during this period. (e.g. COM and CORBA). Distributed systems which formed the foundation for [http://en.wikipedia.org/wiki/Web_services Web Services] and [http://en.wikipedia.org/wiki/Component-based_development Component Based development processes] were introduced.
| |
| Advances like these also gave rise to commercially successful code generators like Netron, Frame Technology and reusable component vendors like [http://en.wikipedia.org/wiki/Infragistics Infragistics].
| |
|
| |
| * Late 1990’s - Mature DIAE Components, Cross-Protocol Bridges -
| |
| Along with introduction of Cross Protocol Bridges which allow [http://en.wikipedia.org/wiki/COM_%28hardware_interface%29 COM] and [http://en.wikipedia.org/wiki/Cobra_%28programming_language%29 CORBA] systems to participate in the same system, Light weight integration protocols like [http://en.wikipedia.org/wiki/SOAP SOAP] were introduced in this period. New reusable component packaging mechanisms were invented. Reuse based development processes matured with time and specialized reusable component market got established.
| |
|
| |
| * 2000-2005 - Early [http://en.wikipedia.org/wiki/Service_Oriented_Architecture Service Oriented Architecture] Products -
| |
| This era saw rise of Service Oriented Architecture and rediscovery of reuse research like Software Reuse (Asset) Management Systems, Domain Specific Reuse, Domain Languages (Software Factories), etc.
| |
| It was understood that reuse must reuse more than just code and it would require drastic process changes. [http://en.wikipedia.org/wiki/Design_pattern_%28computer_science%29 Design patterns] were also created during this time.
| |
| Reuse Successes during time include - Microsoft .Net Framework, SRMS: Flashline and LogicLibrary.
| |
|
| |
| == Techniques <ref name = techniques/>==
| |
| In re-using code, we have several levels of granularity
| |
|
| |
| === Single lines of code ===
| |
| For example, in [http://en.wikipedia.org/wiki/Ruby_%28programming_language%29 Ruby] to print an array containing 5 elements we simply use the following
| |
| <pre>
| |
| [ 'Sam', 'John', 'Gita' ].each {|name| print name, " " }
| |
| </pre>
| |
| outputs :
| |
| Sam John Gita.
| |
|
| |
| === Procedures, Macros ===
| |
| Procedures and macros are the low level code reuse techniques
| |
| A macro is a group of repetitive instructions in a program which are codified only once and can be used as many times
| |
| as necessary.
| |
| <pre>
| |
| Position MACRO Row, Column
| |
| PUSH AX
| |
| PUSH BX
| |
| PUSH DX
| |
| MOV AH, 02H
| |
| MOV DH, Row
| |
| MOV DL, Column
| |
| MOV BH, 0
| |
| INT 10H
| |
| POP DX
| |
| POP BX
| |
| POP AX
| |
| ENDM
| |
| </pre>
| |
| A procedure is a collection of instructions to which we can direct the flow of our program, and once the execution of these instructions is over control is given back to the next line to process of the code which called on the procedure.
| |
| <pre>
| |
|
| |
| Adding Proc Near ; Declaration of the procedure
| |
| Mov Bx, 0 ; Content of the procedure
| |
| Mov B1, Ah
| |
| Mov Ah, 00
| |
| Add Bx, Ax
| |
| Ret ; Return directive
| |
| Add Endp ; End of procedure declaration
| |
|
| |
| </pre>
| |
|
| |
| === Functions/methods ===
| |
| For example, in Ruby a method can be written as follows
| |
| <pre>
| |
| def convert_to_farenhite(temperature_in_celcius)
| |
| result = temperature_in_celcius * (9/5) +32
| |
| return result
| |
| end
| |
| </pre>
| |
|
| |
| === Components ===
| |
| When you are building software, objects are created in code, and reusable objects that perform specific services in different circumstances are called components.
| |
| When you use Microsoft® Office to build custom applications, you write code that leverages the power of Office components. Using an Office component means you are not only excused from writing the code yourself, but you are using a component that has been tested and found reliable in different conditions.
| |
|
| |
| === Object orientation <ref name = Object_orinetation />===
| |
| High level languages also come with effective abstractions to build and share "abstract data types" and other "reusable libraries". Source code components are generally intended to be used as black-boxes: a public interface of usage is announced, formally or not (ruby has not equivalent of java interfaces, for example), while the realization of this interface is kept hidden (or at least intended to be). Think to C libraries, java's .jars, python's modules, ruby's gems, and so on. In many languages, "find a component, download it, and go" has become a reality!
| |
|
| |
| ==== Packages ====
| |
| A Java package is a mechanism for organizing Java classes into namespaces similar to the modules of Modula. Java packages can be stored in compressed files called [http://en.wikipedia.org/wiki/JAR_%28file_format%29 JAR] files, allowing classes to download faster as a group rather than one at a time. Programmers also typically use packages to organize classes belonging to the same category or providing similar functionality.
| |
| A package provides a unique namespace for the types it contains.
| |
| Classes in the same package can access each other's package-access members.
| |
|
| |
| ==== Modules ====
| |
| Modules are a way of grouping together methods, classes, and constants. An example of a Ruby module is as follows
| |
| <pre>
| |
| module Trig
| |
| PI = 3.141592654
| |
| def Trig.sin(x)
| |
| # ..
| |
| end
| |
| def Trig.cos(x)
| |
| # ..
| |
| end
| |
| </pre>
| |
|
| |
| ====[http://en.wikipedia.org/wiki/Inheritance_%28computer_science%29 Inheritance] ====
| |
| In object-oriented programming (OOP), inheritance is a way to reuse code of existing objects, or to establish a subtype from an existing object, or both, depending upon programming language support. In classical inheritance where objects are defined by classes, classes can inherit attributes and behavior from pre-existing classes called base classes, [http://en.wikipedia.org/wiki/Superclass_%28computer_science%29#Subclasses_and_superclasses superclasses], parent classes or ancestor classes. The resulting classes are known as derived classes, subclasses or child classes. The relationships of classes through inheritance gives rise to a hierarchy. The basic mechanism of subclassing is simple. The child inherits all of the capabilities of its parent class — all the parent’s instance methods are available in instances of the child. Let’s look at a trivial example and then later build on it.
| |
|
| |
| Here’s a definition of a parent class: <pre>
| |
| class Parent
| |
| def say_hello
| |
| puts "Hello from #{self}"
| |
| end
| |
| end
| |
|
| |
| p = Parent.new
| |
| p.say_hello
| |
|
| |
| </pre>
| |
| Output:
| |
| Hello from #<Parent:0x0a40c4>
| |
|
| |
| and a child class that inherits from it:
| |
| <pre>
| |
| # Subclass the parent...
| |
| class Child < Parent
| |
| end
| |
| c = Child.new
| |
| c.say_hello
| |
|
| |
| </pre>
| |
|
| |
| Output:
| |
| Hello from #<Child:0x0a3d68>
| |
|
| |
| The parent class defines a single instance method, say_hello. We call it by creating a new
| |
| instance of the class and store a reference to that instance in the variable p.
| |
| We then create a subclass using class Child < Parent. The < notation means we’re creating a
| |
| subclass of the thing on the right; the fact that we use less-than presumably signals that the
| |
| child class is supposed to be a specialization of the parent.
| |
| Note that the child class defines no methods, but when we create an instance of it, we can
| |
| call say_hello. That’s because the child inherits all the methods of its parent. Note also that
| |
| when we output the value of self — the current object - it shows that we’re in an instance of
| |
| class Child, even though the method we’re running is defined in the parent.
| |
|
| |
| ===Generators<ref name = generators/>===
| |
| Source code generation is the act of generating source code based on an [http://en.wikipedia.org/wiki/Ontology_%28information_science%29 ontological] model such as a template and is accomplished with a programming tool such as a template processor or an [http://en.wikipedia.org/wiki/Integrated_development_environment IDE]. These tools allow the generation of source code through any of various means. A macro processor, such as the C preprocessor, which replaces patterns in source code according to relatively simple rules, is a simple form of source code generator. [http://en.wikipedia.org/wiki/Parser Parser] generators (lex & yacc, antlr, rats!, treetop, pyPEG, and so on.) are probably the best-known examples of application generators. Other examples include [http://en.wikipedia.org/wiki/Wizard_%28software%29 wizards] that one can find in Integrated Development Environments (to design and generate code of user interfaces, for example), tools that generate classes from UML class diagrams, generators of database schemas, report generators, etc.
| |
|
| |
| ===Software architectures===
| |
| Software architectures are large-grain software frameworks. In contrast with source code components which are often black-boxes, software architecture are designed as grey-boxes: they are intended to be extended and provide specific extension points for this. We have a lot of reusable frameworks nowadays. Probably the most common are web frameworks (Ruby on Rails, django, ASP.net, ...), integrated development environment (IDE, Eclipse is worth mentioning due to its architecture), service oriented architectures (SOA), and so on.
| |
|
| |
| ===Design and code scavenging===
| |
| Design and code scavenging is simply a form of "find, copy-paste, adapt". The well-known [http://en.wikipedia.org/wiki/Software_design_pattern design patterns] provide an organized form of design scavenging, by providing catalogs for applying such kind of reuse. Even if invented in the context of the object-oriented programming, design patterns had a great impact far beyond that programming [http://en.wikipedia.org/wiki/Paradigm paradigm].
| |
|
| |
| Code scavenging is less organized as few such catalogs exists. Every day however, the web gives users better ways to apply reuse techniques such as google code search, github's gist, pastie, and so on.
| |
|
| |
| ===Transformational systems===
| |
| Transformational systems are the holy grail of computer science, nothing less! In that paradigm, software developers actually describe the behavior of the software using a high-level specification language (related to VHLL described before). In a second phase, the specifications are transformed in order to produce an executable system. The transformations are meant to enhance efficiency without changing the semantics.
| |
|
| |
| Transformational systems emphasizes the what instead of the how. They actually bet on the concision of declarative statements over procedural ones to achieve effective reuse. While general purpose transformation systems remain mostly research topics, notable results have been achieved in some specific domains: relational systems come with effective query optimizers, some rapid prototyping approaches using transformations from high-level descriptions down to code, etc.
| |
|
| |
| ===Very High Level Languages (VHLL)===
| |
| Very High Level Languages, also known as executable specification languages, are languages with very high level of abstraction. They are somewhat difficult to capture precisely and may lead to software reuse that is very specific to specialized domains. However, the recent advent of [http://en.wikipedia.org/wiki/Domain_specific_languages Domain Specific Languages] (DSLs) and good support for them in dynamic languages (ruby, python, clojure, ...) and can be seen as promoting and helping building VHLLs.
| |
|
| |
| == Best practices <ref name = best_practices />==
| |
| Here are some of the best practices to be followed to make sure that the code that is being written is reusable.
| |
|
| |
| * The first consideration is to write code that uses a consistent naming convention, that is formatted properly, and that contains useful comments.
| |
| * Examine the code to make sure that all the procedures have a single, specific purpose. Make sure that the procedure can be describedin a short, plain sentence. For example, "This procedure accept two numbers and calculates the product of those two numbers". If a procedure can not be described simply and clearly in a sentence, then it probably does too many things. Break down complicated procedures into smaller ones that do one thing each. Procedures should contain only code that clearly belongs together.
| |
| * Avoid making specific reference to named application objects.
| |
| * Try to minimize the number of arguments in a procedure and pass in only what is actually required by the procedure. In addition, make sure the procedures use all the arguments passed to them.
| |
| * Group related procedures and the constants they use together in the same module, and where appropriate, consider grouping related procedures together in a class module with a clearly defined interface.
| |
| * Keep procedures in standard modules and not in modules behind forms or documents. The code in form modules should be only the code that is tied directly to the form itself and the code required for calling general procedures stored in standard modules.
| |
| * Communicate between procedures by passing data as arguments to the procedures. Persist data by writing it to disk. Avoid using a procedure to write to a global variable so another procedure can read data from that global variable. Avoid communicating with another procedure by passing data out of the application, for example, using one procedure to write data to a disk file so another procedure can read that data.
| |
|
| |
| == Advantages <ref name = history_pros_cons/>==
| |
| * '''Efficiency''' - Software reuse increases the software productivity and decreases the time required for the development of a software by reducing the time spent in designing or in coding
| |
| * '''Standardization''' - By using the technique of software reuse, a company can improve software system interoperability and needs less people for software development. This provides a competitive advantage for the company and helps to produce better quality software and standardized software.
| |
| * '''Consistency''' - Reuse of UI [http://en.wikipedia.org/wiki/Software_widget widgets] in MacOS and Win32 leads to common “look-and-feel” between applications
| |
| * '''Debugging''' -
| |
| * '''Reliability''' - Systems that incorporate a high level of reusable components are more reliable and more easily constructed. Reused design/code is often tested design/code.
| |
| * '''Profit!''' - Software reuse technique helps the company to reduce the costs involved in software development and maintenance.
| |
| * '''Reduced Risk''' - Software reuse also reduces the risk involved in software development process.
| |
| * '''Component Market''' - Reuse can lead to a market for component software. Real-world examples: [http://en.wikipedia.org/wiki/Activex ActiveX] components, Hypercard stacks, Java packages, even software tools, such as xerces and xalan from xml.apache.org (they are often included in other software systems)
| |
|
| |
| == Trade-offs for code reuse at various levels of components <ref name=trade_offs/>==
| |
| Different types of application code require varying levels of investment to achieve successful reuse
| |
|
| |
| * Reusable GUI objects reduce development time and improve quality and consistency but provide only modest payback in terms of overall application development costs.
| |
| * Server-side components that constitute reusable business logic can provide significant payback but require extensive up-front analysis and design. They also require an architectural foundation but may experience a short shelf life.
| |
| * Infrastructure components and services frameworks are generic services for transactions, messaging, security, and [http://en.wikipedia.org/wiki/Database database] connectivity. They eliminate the need to repeatedly build infrastructure that all applications use, but require extensive analysis and design, and complex programming. These standards-based components can often be purchased off-the-shelf.
| |
| * High-level patterns allow organizations to achieve design reuse and identify components with high reuse potential, but developers must build or acquire the components.
| |
| * Packaged applications provide the only guaranteed form of reuse, letting user companies acquire functionality for significantly less than the cost of building it themselves. However, these applications may not offer the exact functionality an organization needs; the subsequent customization that's required will add to the cost.
| |
|
| |
| == Practical problems <ref name = history_pros_cons/>==
| |
| Although software reuse provides many benefits for the developers, there are some disadvantages.
| |
|
| |
| === Disadvantages for developers who reuse the code ===
| |
| * Mismatch - Reused code or design may not completely match the situation, in that case, reusing the code may incur additional time and effort.
| |
| * Non-functional characteristics of code may not match the situation - Consider a database that can scale to 10,000s of items, but you need it to scale to 100,000s of items.
| |
| * Expense - Some components may be too expensive for the project’s budget. For instance, [http://en.wikipedia.org/wiki/SGML SGML] (a precursor to [http://en.wikipedia.org/wiki/Html HTML] and [http://en.wikipedia.org/wiki/Xml XML]) tools sell for 5000 dollars a license!
| |
|
| |
| === Disadvantages for developers who develop reusable code ===
| |
| * Building reusable objects requires extensive analysis and design. The developer needs to understand and take into consideration all the generalities while coding the reusable module.
| |
| * The developer needs to invest extra time in testing and [http://en.wikipedia.org/wiki/Quality_assurance quality assurance], optimization, and documentation. All this takes time and labor, which increases the cost of the code.
| |
| * IT departments must also add to the payback equation the cost of tools to support reuse, such as version control and repositories.
| |
| * The cost of administering an ongoing reuse program must be considered.
| |
| With all these elements, it becomes apparent that reuse doesn't come cheap.
| |
|
| |
| == Conclusion ==
| |
| The only way you can avoid code depreciation is through reuse but you need to be disciplined and follow a strict process. Reuse enables you to do more with less.
| |
|
| |
| ==See also==
| |
| *[http://en.wikipedia.org/wiki/Don%27t_repeat_yourself Don't repeat yourself]
| |
| *[http://en.wikipedia.org/wiki/Single_Source_of_Truth Single Source of Truth]
| |
| *[http://en.wikipedia.org/wiki/International_Conference_on_Software_Reuse International_Conference_on_Software_Reuse|ICSR]
| |
| *[http://en.wikipedia.org/wiki/Language_binding Language binding]
| |
| *[http://en.wikipedia.org/wiki/Reuse_metrics Reuse metrics]
| |
| *[http://en.wikipedia.org/wiki/Software_framework Software framework]
| |
| *[http://en.wikipedia.org/wiki/Type_polymorphism Type polymorphism|Polymorphism]
| |
| *[http://en.wikipedia.org/wiki/Virtual_inheritance Virtual inheritance]
| |
|
| |
| == References ==
| |
| <references>
| |
|
| |
| <ref name = techniques> http://www.revision-zero.org/reuse</ref>
| |
| <ref name = definition_software_reuse> http://www.biglever.com/papers/Krueger_AcmReuseSurvey.pdf </ref>
| |
| <ref name = history_pros_cons> http://www.cs.colorado.edu/~kena/classes/3308/f04/lectures/lecture10.pdf </ref>
| |
| <ref name = wiki_code_reuse> http://en.wikipedia.org/wiki/Code_reuse </ref>
| |
| <ref name = trade_offs> http://www.informationweek.com/708/08iuhid.htm </ref>
| |
| <ref name = best_practices> http://msdn.microsoft.com/en-us/library/office/aa189298%28v=office.10%29 </ref>
| |
| <ref name = Object_orinetation> http://en.wikipedia.org/wiki/Object-oriented_programming </ref>
| |
| <ref name = generators> http://en.wikipedia.org/wiki/Generative_programming </ref>
| |
|
| |
| </references>
| |