Support for Spring Data repositories

[aleksey-stukalov]

By using DataManager under the hood.

CUBA Prototype: https://github.com/cuba-rnd/cuba-jpa-repositories
https://www.cuba-platform.com/blog/spring-query-interfaces-in-cuba/

Done

• (2d)Analyse, discuss
• (1w)Move code to Jmix, make it work.
• (3d) Refactor, move tests.
• (1w3d) Deal with JpqlQueryGenerator implementaion.
• (1w)Get rid of limitations (see readme in cuba-jpa-repositories).
• (2d)Paging support
• (2d)Finish test coverage
• (3d)Packages/modules refactoring, UI dependency from data.
• (1d+) Class Annotation to use UnsafeDataManagerImpl instead of DataManagerImpl
• (2d) Implement repository proxy post processor in order to pass method metadata to CRUD repositories
• (2d) Rework @Unsafe into @ApplyConstraints with spring-like logic
• (summ: 2d) Improvements
  • (4h) Improve javadocs
  • (1d) Add boot autoconfiguration like org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration

Unfinished:

• (4h)Use @FetchPlan for repository class to set default fetch plan. Extracted into issue Use @FetchPlan for repository class to set default fetch plan #186
• (summ:1w)Jmix-features support
  • (2d)Dynamic attributes support in repository API. Extracted into issue: Support dynamic attributes configuration for Jmix Data Repositories #183
  • (2d)Soft deletion support in repository API. Extracted into issue: Support soft deletion configuration for Jmix Data Repositories #184
  • (?) LoadContext#cacheable (To be discussed: rework through hints in Jmix and implement as other features?) Extracted into issue Enable query cache for Jmix Data Repositories #185

Usage:

Create interface that extends JmixDataRepository and add query methods you need:

• use keywords from documentation to build your query name;
• use io.jmix.core.repository.Query to explicitly specify jpql query:
  • named and positional parameters allowed,
  • special parameters like Pageable and Sort are not counted at positional parameters resolving process;
• use io.jmix.core.repository.FetchPlan to specify fetch plan for loaded entities;

Example:

see data model at: https://github.com/Haulmont/jmix-data/tree/master/eclipselink/src/test/java/test_support/entity/repository
Repository:

public interface OrderRepository extends JmixDataRepository<SalesOrder, UUID> {

    List<SalesOrder> findByCustomerNameAndCustomerAddressCity(String name, String city);

    long countSalesOrdersByCustomer(Customer customer);

    boolean existsSalesOrdersByCustomerAddressCity(String city);

    void removeSalesOrdersByCustomerAddressCity(String city);

    List<SalesOrder> findSalesOrderByDateBeforeOrderByDateAsc(Date date);

    Page<SalesOrder> findByDateAfterAndNumberIn(Date date, Pageable pageable, List<String> numbers);

    @Query("select o from repository$SalesOrder o where (o.date> ?1 and o.number in ?2)")
    List<SalesOrder> findByQuery(Sort sort, Date date, List<String> numbers);

    @Query("select o from repository$SalesOrder o where (o.date> :date and o.number in :numbers)")
    Page<SalesOrder> findByQueryWithPaging(@Param("date") Date date,
                                                @Param("numbers") List<String> numbers,
                                                Pageable pageable);

    @FetchPlan("SalesOrder.full")
    List<SalesOrder> findByCustomerNotNullOrderByCustomerAddressCityAscDateAsc();
}