JPA-Search

JPA Search offers a solution based on JPA that simplify database search from an API with pagination and sorting.

Description 🔍

Jpa-Search simplifies specific entity searches with JPA, including :

• Modular filters
• Multiple filters
• Modular sorts
• Multiple sorts (following each other)
• Various operations (you can add yours)
• Complete pagination

This search is designed to be efficient, since it operates at a low level, as close as possible to SQL, thanks to the CriteriaBuilder provided by jakarta.persistence.

A search works with a configuration file where you define each possible filter, its associated operation (e.g.: name equals value) and where to fetch the field in DB. Once a filter has been defined, it is possible to filter by this ascending or descending field.

The search function takes as input a list of query params in the form of a Map<String, String> (also containing a page and size field for pagination if it's not a key filter), a List<String> sort list, the type of entity searched for Class<T> and the type of search configuration enumeration Class<E>. In return, this function returns a Page<T> containing the number of elements requested and the number of total elements.

How to use it ? 🤔

To configure a search, you need to create a configuration criteria enum described like below:

@Getter
@AllArgsConstructor
public enum ApiKeyCriteria implements ISearchCriteriaConfig<Apikey> {
    ID(sorterConfig.of("id", ObjectFilterOperation.EQUAL, "id")),
    ACCOUNT_TYPE(FilterConfig.of("accountType", ObjectFilterOperation.EQUAL, "account.accountType.key")),
    PROFILE_TYPE(FilterSorterConfig.of("profileType", ObjectFilterOperation.EQUAL, "account.accountType.profile.key")),
    ACCOUNT_FILES_NAME(FilterConfig.of("accountFilesName", ObjectFilterOperation.EQUAL, "account.files[name]")),
    ACCOUNT_LABEL(FilterConfig.of("accountLabel", ObjectFilterOperation.EQUAL, "account.label")),
    TYPE(FilterConfig.of("type", ObjectFilterOperation.EQUAL, "type")),
    EXTERNAL_ID(FilterSorterConfig.of("externalId", StringFilterOperation.CONTAIN_IGNORE_CASE, "externalId")),
    CREATION_DATE(FilterConfig.of("creationDate", ListComparableFilterOperation.BETWEEN, "creationDate")),
    END_DATE(FilterSorterConfig.of("endDate", ListComparableFilterOperation.BETWEEN, "endDate")),
    EXPIRATION_DATE(FilterConfig.of("expirationDate", ListComparableFilterOperation.BETWEEN, "expirationDate")),
    LABEL(FilterConfig.of("label", StringFilterOperation.CONTAIN_IGNORE_CASE_IGNORE_ACCENT, "label", "account.label")),
    YEAR(GroupFilterConfig.of("year", CREATION_DATE.getFilterConfig(), END_DATE.getFilterConfig())),
    MULTI_ACCOUNT_LABEL(MultiFilterConfig.of("multiAccountLabel", ACCOUNT_LABEL.getFilterConfig(), "account"));

    final ISearchConfig<ApiKey> searchConfig;

    @Override
    public OrderCriteria getDefaultOrderCriteria() {
        return new OrderCriteria(ID.getKey(), SortDirection.ASC);
    }

    @Override
    public Class<ApiKey> getRootClass() {
        return ApiKey.class;
    }

}

The idea here is to associate in FilterConfig.of(...) an operation, a query param name and an entity field name.

Taking ACCOUNT_TYPE as an example, we're looking for an ApiKey that is associated with a particular account type, in this case equality.

FilterOperation

The FilterOperation is used to describe the operation to be performed on the filter, many of which are already available and applicable to different types:

You can easily create an other enum which inherits from IFilterOperation, like :

Page<EntityInList> entityInList = searchCriteriaRepository.search(EntityCriteria.class, params, sorts, EntityInList::new, "NameOfTheEntityGraph");

System.setProperty("UNACCENT_FUNCTION_PATH", "dbo.unaccent");