search feature:

improve code and bug fix

Author: PouyaPouryaie

README.md

@@ -19,6 +19,8 @@ this project, implement instance of basic feature, <br> you maybe want use for A
     - define your validation and use for model
 - decoupling layer
     - controller, service and repository layer for easy extend
+- flexible search
+    - use CriteriaQuery and CriteriaBuilder for search base on Entity 
 
 ## Run guide
 ### Run for develop and debug: <br>
@@ -45,4 +47,10 @@ this project, implement instance of basic feature, <br> you maybe want use for A
 1 - create your own validation type <br>
 2 - define your own validation process for entity <br>
 3 - use "@validator" annotation on field of entity for validate <br>
-4 - log for validation and save error-message in log file <br>
+4 - log for validation and save error-message in log file <br>
+
+### search feature
+1 - create your own search model <br>
+2 - use pagination for search <br>
+3 - create query dynamic base on search request <br>
+4 - use order and direction for sort data <br>

src/main/java/ir/bigz/springbootreal/controller/SampleController.java

@@ -63,10 +63,10 @@ public ResponseEntity<?> getAllUser() {
 
     @GetMapping(path = "/user/search", produces = MediaType.APPLICATION_JSON_VALUE)
     public ResponseEntity<?> getUserWithSearch(@RequestBody UserSearchDto userSearchDto,
-                                               @RequestParam(name = "sortorder") String sortOrder,
-                                               @RequestParam(name = "direction") String direction,
-                                               @RequestParam(name = "pagenumber") Integer pageNumber,
-                                               @RequestParam(name = "pagesize") Integer pageSize) {
+                                               @RequestParam(name = "sortorder", defaultValue = "id") String sortOrder,
+                                               @RequestParam(name = "direction", defaultValue = "desc", required = false) String direction,
+                                               @RequestParam(name = "pagenumber", defaultValue = "1") Integer pageNumber,
+                                               @RequestParam(name = "pagesize", defaultValue = "5") Integer pageSize) {
         Page<UserModel> userPageResult = userService.getUserSearchResult(userSearchDto, sortOrder, Sort.Direction.fromString(direction), pageNumber, pageSize);
         return ResponseEntity.ok(userPageResult);
     }

src/main/java/ir/bigz/springbootreal/dal/UserRepository.java

@@ -4,12 +4,13 @@
 import ir.bigz.springbootreal.viewmodel.search.UserSearchDto;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
+import org.springframework.data.domain.Sort;
 import org.springframework.stereotype.Repository;
 
 @Repository
 public interface UserRepository extends DaoRepository<User,Long> {
 
     User getUserWithNationalCode(String nationalCode);
 
-    Page<User> getUserSearchResult(UserSearchDto userSearchDto, Pageable pageable);
+    Page<User> getUserSearchResult(UserSearchDto userSearchDto, Sort.Order order, Pageable pageable);
 }

src/main/java/ir/bigz/springbootreal/dal/UserRepositoryImpl.java

@@ -5,15 +5,13 @@
 import ir.bigz.springbootreal.viewmodel.search.UserSearchDto;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
+import org.springframework.data.domain.Sort;
 import org.springframework.stereotype.Component;
 
-import javax.persistence.criteria.CriteriaQuery;
-import javax.persistence.criteria.Predicate;
-import javax.persistence.criteria.Root;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
-import java.util.Objects;
+import javax.persistence.criteria.*;
+import java.lang.reflect.Field;
+import java.sql.Timestamp;
+import java.util.*;
 import java.util.stream.Collectors;
 
 @Component
@@ -34,17 +32,41 @@ public User getUserWithNationalCode(String nationalCode) {
     }
 
     @Override
-    public Page<User> getUserSearchResult(UserSearchDto userSearchDto, Pageable pageable) {
+    public Page<User> getUserSearchResult(UserSearchDto userSearchDto, Sort.Order order, Pageable pageable) {
+
         CriteriaQuery<User> criteriaQuery = criteriaBuilder.createQuery(User.class);
         Root<User> userRoot = criteriaQuery.from(User.class);
-        Map<String, String> map = new ObjectMapper().convertValue(userSearchDto, Map.class);
-        List<Predicate> collect = map.keySet().stream().filter(s -> (Objects.nonNull(map.get(s)) && !(map.get(s).equals(""))))
-                .map(s -> criteriaBuilder.like(userRoot.get(s), "%"+map.get(s)+"%"))
-                .collect(Collectors.toList());
-        Predicate[] predicates = collect.stream().toArray(Predicate[]::new);
-        Predicate and = criteriaBuilder.and(predicates);
-        criteriaQuery.where(and);
+        List<Predicate> searchConditions = getSqlCondition(userSearchDto, criteriaBuilder, userRoot);
+        Predicate concatConditions = criteriaBuilder.and(searchConditions.stream().toArray(Predicate[]::new));
+        criteriaQuery.where(concatConditions);
+        if(order.getDirection().name().equals("ASC"))
+            criteriaQuery.orderBy(criteriaBuilder.asc(userRoot.get(order.getProperty())));
+        else
+            criteriaQuery.orderBy(criteriaBuilder.desc(userRoot.get(order.getProperty())));
         Page<User> users = genericSearch(criteriaQuery, pageable);
         return users;
     }
+
+    private <T,K> List<Predicate> getSqlCondition(T searchModel, CriteriaBuilder criteriaBuilder, Root<K> root){
+        List<Field> collect = Arrays.stream(searchModel.getClass().getDeclaredFields()).collect(Collectors.toList());
+        Map<String, String> map = new ObjectMapper().convertValue(searchModel, Map.class);
+
+        return map.keySet().stream()
+                .filter(s -> (Objects.nonNull(map.get(s)) && !(map.get(s).equals(""))))
+                .flatMap(s -> collect.stream().filter(field -> field.getName().equals(s)))
+                .map(field -> {
+                    if (field.getType().getName().contains("String"))
+                        return criteriaBuilder.like(root.get(field.getName()), "%" + map.get(field.getName()) + "%");
+                    else if (field.getType().getName().contains("Timestamp")){
+                        if(field.getName().contains("from") || field.getName().contains("start")){
+                            return criteriaBuilder.greaterThanOrEqualTo(root.get(field.getName()), map.get(field.getName()));
+                        }
+                        else
+                            return criteriaBuilder.lessThanOrEqualTo(root.get(field.getName()), map.get(field.getName()));
+                    }
+                    else
+                        return criteriaBuilder.equal(root.get(field.getName()), map.get(field.getName()));
+                })
+                .collect(Collectors.toList());
+    }
 }

src/main/java/ir/bigz/springbootreal/service/UserServiceImpl.java

@@ -122,7 +122,7 @@ public Page<UserModel> getUserSearchResult(UserSearchDto userSearchDto, String s
         try {
             Sort.Order order = new Sort.Order(direction, sortOrder);
             Pageable pageable = PageRequest.of(pageNumber, pageSize, Sort.by(order));
-            Page<User> users = userRepository.getUserSearchResult(userSearchDto, pageable);
+            Page<User> users = userRepository.getUserSearchResult(userSearchDto, order, pageable);
             List<UserModel> collect = users.get().map(userMapper::userToUserModel).collect(Collectors.toList());
             return new PageImpl<>(collect, pageable, users.getTotalElements());
         }catch (RuntimeException exception){

src/main/java/ir/bigz/springbootreal/viewmodel/search/UserSearchDto.java

@@ -1,5 +1,6 @@
 package ir.bigz.springbootreal.viewmodel.search;
 
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
@@ -11,6 +12,7 @@
 @Getter
 @Setter
 @ToString
+@JsonIgnoreProperties(ignoreUnknown = true)
 public class UserSearchDto implements Serializable {
 
     private String firstName;