feat: Generalizar a parte de filtros de pesquisa (#12).

Author: danielso2007

src/main/java/br/com/virtuallibrary/commons/IConstants.java

@@ -18,6 +18,7 @@ public interface IConstants {
 	String BLANK = "";
 	String SPACE = " ";
 	String SEMICOLON = ";";
+	String COLON = ":";
 	String DOT = ".";
 	String COMMA = ",";
 	String HIFEN = "-";
@@ -32,4 +33,16 @@ public interface IConstants {
 
 	String BOOKS = IConstants.ROOT_URL + IConstants.V1 + "books";
 	String RATINGS= IConstants.ROOT_URL + IConstants.V1 + "ratings";
+
+	// MONGODB
+	String $AND = "$and";
+	String $REGEX_CONTAINS = ".*%s.*";
+	
+	String $CONTAINS = "contains";
+	String $GREATER_THAN = "gt";
+	String $GREATER_THAN_OR_EQUAL = "gte";
+	String $LESS_THAN = "lt";
+	String $LESS_THAN_OR_EQUAL = "lte";
+	String $EQ = "eq";
 }
+

src/main/java/br/com/virtuallibrary/commons/controllers/IBaseController.java

@@ -5,6 +5,7 @@
 
 import javax.validation.Valid;
 
+import org.springframework.data.web.PagedResourcesAssembler;
 import org.springframework.hateoas.RepresentationModel;
 import org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport;
 import org.springframework.http.ResponseEntity;
@@ -26,6 +27,8 @@ public interface IBaseController<E extends BaseEntity, ID extends Serializable,
 
 	S getService();
 
+	PagedResourcesAssembler<E> getPagedResourcesAssembler();
+	
 	RepresentationModelAssemblerSupport<E, M> getModelAssembler();
 
 	ResponseEntity<M> find(ID id);

src/main/java/br/com/virtuallibrary/commons/controllers/impl/BaseController.java

@@ -5,6 +5,9 @@
 
 import javax.validation.Valid;
 
+import org.springframework.data.web.PagedResourcesAssembler;
+import org.springframework.hateoas.CollectionModel;
+import org.springframework.hateoas.PagedModel;
 import org.springframework.hateoas.RepresentationModel;
 import org.springframework.hateoas.server.mvc.RepresentationModelAssemblerSupport;
 import org.springframework.http.HttpStatus;
@@ -16,6 +19,7 @@
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.ResponseStatus;
 
 import br.com.virtuallibrary.commons.IConstants;
@@ -40,22 +44,56 @@ public class BaseController<
 
 	private final S service;
 	private final RepresentationModelAssemblerSupport<E, M> modelAssembler;
+	private final PagedResourcesAssembler<E> pagedResourcesAssembler;
 
-	public BaseController(S service, RepresentationModelAssemblerSupport<E, M> modelAssembler) {
+	public BaseController(S service, PagedResourcesAssembler<E> pagedResourcesAssembler, RepresentationModelAssemblerSupport<E, M> modelAssembler) {
 		this.service = service;
 		this.modelAssembler = modelAssembler;
+		this.pagedResourcesAssembler = pagedResourcesAssembler;
 	}
 
 	@Override
 	public final S getService() {
 		return service;
 	}
 
+	@Override
+	public PagedResourcesAssembler<E> getPagedResourcesAssembler() {
+		return pagedResourcesAssembler;
+	}
+
 	@Override
 	public RepresentationModelAssemblerSupport<E, M> getModelAssembler() {
 		return this.modelAssembler;
 	}
 
+	@ResponseStatus(HttpStatus.OK)
+	@GetMapping(produces = { IConstants.APPLICATION_JSON_UTF_8, IConstants.APPLICATION_XML_UTF_8 })
+	@Operation(summary = "Retorna a lista de registros paginado.", description =
+		      "O filtro padrão é o igual ($eq), mas você pode utilizar:<br/>"
+		    + "Contém - \"<b>contains</b>:valor\"<br/>"
+		    + "Igual - \"<b>eq</b>:valor\"<br/>"
+		    + "Maior que - \"<b>gt</b>:numerico\"<br/>"
+		    + "Menor que - \"<b>lt</b>:numerico\"<br/>"
+		    + "Maior ou igual - \"<b>gte</b>:numerico\"<br/>"
+		    + "Menor ou igual - \"<b>lte</b>:numerico\"<br/>"
+		    + "Também é possível combinar dois filtros - <b>gt</b>:numerico:<b>lt</b>:numerico")
+	@ApiResponses(value = {
+			@ApiResponse(responseCode = "200", description = "Registros listados com sucesso"),
+			@ApiResponse(responseCode = "400", description = "Erro na obtenção dos dados ou filtro"),
+			@ApiResponse(responseCode = "500", description = "Erro interno do servidor")})
+	public ResponseEntity<CollectionModel<M>> findAll(
+			@Parameter(description="Número da página.") @RequestParam(value = "page", required = false, defaultValue = IConstants.defaultPage) int page,
+			@Parameter(description="Quantidade de registros por página.") @RequestParam(value = "size", required = false, defaultValue = IConstants.defaultSize) int size,
+			@Parameter(description="Filtros de pesquisa conforme campos da entidade.") @RequestParam(required = false) Map<String,String> filters) {
+		
+		PagedModel<M> collModel = null;
+		
+		collModel = getPagedResourcesAssembler().toModel(getService().findPaginated(page, size, filters), getModelAssembler());
+		
+		return ResponseEntity.ok().body(collModel);
+	}
+	
 	@Override
 	@ResponseStatus(HttpStatus.OK)
 	@GetMapping(value = "/{id}", produces = { IConstants.APPLICATION_JSON_UTF_8, IConstants.APPLICATION_XML_UTF_8 })

src/main/java/br/com/virtuallibrary/commons/services/IBaseService.java

@@ -8,6 +8,7 @@
 import javax.validation.ValidationException;
 
 import org.springframework.data.domain.Page;
+import org.springframework.data.domain.Pageable;
 import org.springframework.data.mongodb.core.MongoTemplate;
 import org.springframework.data.mongodb.core.query.Criteria;
 import org.springframework.data.mongodb.core.query.Query;
@@ -20,39 +21,38 @@ public interface IBaseService<E extends BaseEntity, ID extends Serializable, R e
 
 	List<E> findAll();
 
-	/**
-	 * and – operador lógico AND
-	 * or – operador lógico OR
-	 * not – operador lógico NOT
-	 * gt = maior que
-	 * lt = menor que
-	 * gte = maior ou igual
-	 * lte = menor ou igual
-	 * ne = diferente de
-	 * in = todos os documentos cujo atributo possui um dos valores especificados (no SQL operador IN)
-	 * nin = todos os documentos cujo atributo não possui um dos valores especificados (no SQL operador NOT IN)
-	 * @param page A página a ser pesquisada.
-	 * @param size A quantidade de registro por página.
-	 * @return O resultado paginado.
-	 */
-	Page<E> findPaginated(int page, int size);
+	Page<E> findPaginated(final int page, final int size);
 
-	Optional<E> findById(ID id);
+	Page<E> findPaginated(int page, int size, Map<String, String> filters);
+	
+	Page<E> findAll(Query query, int page, int size);
+	
+	Page<E> findAll(Query query, int page, int size, List<Criteria> criterias);
+	
+	Page<E> getPage(List<E> results, Pageable pageable, Query query, List<Criteria> criterias);
+	
+	Optional<E> findById(final ID id);
 
 	Optional<E> save(E object);
 
-	void delete(ID id);
+	void delete(final ID id);
 
-	Optional<E> update(Map<String, String> updates, ID id) throws ValidationException, SecurityException, IllegalArgumentException, IllegalAccessException;
+	Optional<E> update(Map<String, String> updates, final ID id) throws ValidationException, SecurityException, IllegalArgumentException, IllegalAccessException;
 
-	Optional<E> update(E object, ID id);
+	Optional<E> update(E object, final ID id);
 
 	UserDetails getUser();
 
 	MongoTemplate getTemplate();
 
-	Criteria getCriteriaByFilter(Query query, String filter, Object value);
+	Map<String, String> getFilterValues(Map<String, String> filters);
 
-	Page<E> findAll(Query query, int page, int size);
+	Criteria getCriteriaByFilter(Criteria criteria, String filter, Object value);
+
+	Criteria getCriteriaByFilter(Criteria criteria, String filter, Object value, String regex);
+
+	Criteria createCriteriaByFilter(Query query, String field, String value, String regex);
+
+	Criteria createCriteriaByFilter(Query query, String field, String value);
 
 }