Refactor Code : Separate Query from Modifier

In this post we will learn about the one of the important code refactoring algorithm "Separate Query from Modifier".When you have a method that gives you a value and has no observable side effects, you have a lot less to worry. You can move the call to other places in this method freely. A good rule to follow is to say that any method that returns a value should not have other observable side effects. 

You have a method that returns a value but also changes the state of an object . Create two method, one for the query and one for the modification.

We first take the example of the below and will find out what is wrong with this code and refactor it.


In the above , method findMiscreant(List<Person> people) signifies that its responsibility will be to find miscreant only. But if we give clear look to the method , apart from finding Miscreant , it is sending some notification as  SendAlert() to other system .

Hence we can easily see that this method is doing two job as :

1) querying to find  miscreant
2) sending notification and may change state of the some object.

First principle of Single Responsibility  from S.O.L.I.D design principle  state that "every class or method should do only one job".

We can break the findMiscreant(List<Person> people)  into two method as SendMiscreantNotification(List<Person> people)  and  findMiscreant(List<Person> people) itself
where responsibility of each one will be to send notification and find miscreant respectively.

The code after refactoring will be as below :



Reference :

https://www.csie.ntu.edu.tw/~r95004/Refactoring_improving_the_design_of_existing_code.pdf


 It covers the "Separate Query from Modifier" concepts , if you have any issue or anything to add , please comment below .

Comments

  1. The_Sniper5 June 2021 at 08:34

    This comment has been removed by the author.

    ReplyDelete
  2. The_Sniper5 June 2021 at 08:35

    why are you calling sendAlert() again in findMiscreant() after refactor?!

    ReplyDelete

Post a Comment

Popular posts from this blog

Deploy standalone Spring MVC Application in Docker Container

Image
In this post we will deploy simple standalone spring mvc application in Docker container. If you want to deploy the spring boot application in docker container, you can check my post Containerize Spring Boot application using Docker   . We know that in spring boot application there is embed Tomcat application server and run our app on top of it but in case of standalone spring mvc application we don't have embed Tomcat server , hence we need to deploy the application in explicit tomcat standalone server. Process to deploy the spring mvc in docker container : 1) First we need to get the Tomcat image. 2) Second to deploy the war in tomcat we need to save it in tomcat webapps direcory. Create Docker file  FROM : Using docker FROM command we are fetching the tomcat image from the Docker Hub. COPY : In the second line we are copying the war file in tomcat webapp directory. Note :  Any war saved in the tomcat webapps folder will be installed on tomcat start up. Yo
Read more

ConcurrentHashMap Internal Working

Image
ConcurrentHashMap utilizes the same principles of HashMap, but is designed primarily for a multi-threaded application and hence it does not require explicit synchronization.   The only thread safe collection objects were Hashtable and synchronized Map prior to JDK 5. Before learning How ConcurrentHashMap works in Java , we need to look at why concurrentHashMap is added to the Java SDK. Why we need ConcurrentHashMap when we already had Hashtable ? Hashtable provides concurrent access to the Map.Entries objects by locking the entire map to perform any sort of operation (update,delete,read,create). Suppose we have a web application , the overhead created by Hashtable  (locking the entire map) can be ignored under normal load. But under heavy load , the overhead of locking the entire map may prove fatal and may lead to delay response time and   overtaxing of the server. This  is where ConcurrentHashMap comes to rescue. According to ConcurrentHashMap Oracle docs, ConcurrentHashMa
Read more