Things to check while Code Review in Java



Code review is important part of any application. Some time we avoid doing it due to time constraints or lack of resource availability but if we do it in practice it pays off very well in terms of quality & maintainability of code.

    We have to look for couple of things while code review & i will try to explain most of them here.

Functionality 
This is most important part in code review that code is functional as required. Requirement is completely addressed by code or not.

Logging & readability
Code should be readable. It should be formatted properly like indentations & space should be proper and as matches as per set convention.proper comment should in place to understand code as well as for debugging perspective.

Naming & other java as well client as Standards
you should follow naming standards as prescribed in java.Apart from industry standards we should take care of client coding standards if there are any.

Performance
Performance checking is difficult to measure but its important to review code performance while code review Do we have any SLA to follow or non functional requirement about any piece of code.Are we able to do some task in required time.Below could be some parameter.
Response Time : Time taken between providing response & request.
Latency : delay in serving request or to reach request to server.
Throughput : per second request handling.
Scalability : How will system behave if we try to scale horizontally or vertically. 

Unwanted code & library                                          Check if any unwanted code or library exist in your code.Any unused import should also be get removed. 

Simplicity & Optimization
We should check for code if it can be simplified as Normally a task can be done multiple ways and i believe we should go for simplest code if possible. Along with simplicity we should for optimization of code as well.
if we can write code with less lines without introducing much complexity. 

Concurrency
You should check code of it is thread safe or not.If it is a multi threaded code we should check if shared resources & method synchronized properly or not.Make sure excess synchronization is not present because it affect performance & leads to dead lock as well. 

Security
here we should check for security aspect like if we are not saving sensitive data. Are we not logging sensitive information.use prepared statement in spite of normal statement.check for sql injection & other security breaches.Using SSL if required.check for  different kind of authentication mechanism.Follow all security best practices.


Exception Handling
We should check if we are handling exceptions in our code properly.We may get exception due to unexpected inputs or getting unexpected response if we are connecting from other external system etc.
Some common exception scenarios  could be
  • Invalid format values
  • Null objects
  • Boundary conditions
  • Empty objects

Resource release
We should check for resource release like Streams, connections etc after its use.







Comments

Popular posts from this blog

Conversion from Clob To String in java and Vice versa

Portable Java 8/ JDK8 setup without admin rights

Multi Threading , Producer consumer problem in Java