Skip to main content

The big three: Flexibility Extensibility Maintainability












[Time: 1 min 45 secs]


As we have said earlier, software is rarely ever made and forgotten. After the release, there will be change requests, there will be requests for new features, and bugs to be fixed. And why after the release, even when we are in the process of making software we have to interact with code that has already been written. It is with the goal of easing all of these, that we design software.

The design should enable flexibility, extensibility, and maintainability.













[Time: 9 mins]



FLEXIBILITY

  • What is flexibility?
  • Actions for change
    • Identify, Change, Test
  • Detractors of flexibility
    • Complex code
    • Lack of clear responsibilities for classes and methods
    • Unreadable code
    • Repetitions in code
    • Uncontained functionality
  • Design decisions that promote flexibility
    • DRY (Don't repeat yourself)
    • KISS (Keep it simple)
    • No tricks
    • Loose coupling
    • Encapsulation
    • Note: Minimize testing












[Time: 6 mins 25 secs]


EXTENSIBILITY

  • What is extensibility
  • Actions for extensions
    • Actions for change, adding classes
  • Detractors of extensibility
    • Same as detractors for flexibility (ideally we want to extend the software by adding new classes and not modifying existing classes)
  • Design decisions that promote extensibility
    • Loose coupling
    • Assigning proper responsibilities
    • Proper use of inheritance and polymorphism
    • Design patterns

MAINTAINABILITY:


  • Maintainability is flexibility + extensibility + bug fixes + refactorings

  • All design idioms for flexibility & extensibility apply to maintaibility also. Besides these design factors, some process factors like having proper test cases, and good documentation also apply. But since we are focussing on design in this section, we will not take any process related issues.
  • Remember "maintainability" is the ultimate goal of software design



Note: This post was originally posted on my blog at http://www.adaptivelearningonline.net
Labels:

Comments

Post a Comment

Popular posts from this blog

My HSQLDB schema inspection story

This is a simple story of my need to inspect the schema of an HSQLDB database for a participar FOREIGN KEY, and the interesting things I had to do to actually inspect it. I am using an HSQLDB 1.8 database in one of my web applications. The application has been developed using the Play framework , which by default uses JPA and Hibernate . A few days back, I wanted to inspect the schema which Hibernate had created for one of my model objects. I started the HSQLDB database on my local machine, and then started the database manager with the following command java -cp ./hsqldb-1.8.0.7.jar org.hsqldb.util.DatabaseManagerSwing When I tried the view the schema of my table, it showed me the columns and column types on that table, but it did not show me columns were FOREIGN KEYs. Image 1: Table schema as shown by HSQLDB's database manager I decided to search on StackOverflow and find out how I could view the full schema of the table in question. I got a few hints, and they all pointed to ...
Post a Comment
Read more

Commenting your code

Comments are an integral part of any program, even though they do not contribute to the logic. Appropriate comments add to the maintainability of a software. I have heard developers complain about not remembering the logic of some code they wrote a few months back. Can you imagine how difficult it can be to understand programs written by others, when we sometimes find it hard to understand our own code. It is a nightmare to maintain programs that are not appropriately commented. Java classes should contain comments at various levels. There are two types of comments; implementation comments and documentation comments. Implementation comments usually explain design desicisions, or a particularly intricate peice of code. If you find the need to make a lot of implementation comments, then it may signal overly complex code. Documentation comments usually describe the API of a program, they are meant for developers who are going to use your classes. All classes, methods and variables ...
Post a Comment
Read more

Inheritance vs. composition depending on how much is same and how much differs

I am reading the excellent Django book right now. In the 4th chapter on Django templates , there is an example of includes and inheritance in Django templates. Without going into details about Django templates, the include is very similar to composition where we can include the text of another template for evaluation. Inheritance in Django templates works in a way similar to object inheritance. Django templates can specify certain blocks which can be redefined in subtemplates. The subtemplates use the rest of the parent template as is. Now we have all learned that inheritance is used when we have a is-a relationship between classes, and composition is used when we have a contains-a relationship. This is absolutely right, but while reading about Django templates, I just realized another pattern in these relationships. This is really simple and perhaps many of you may have already have had this insight... We use inheritance when we want to allow reuse of the bulk of one object in other ...
3 comments
Read more