Java hibernate order by

Сортировка с помощью Hibernate

В этой статье показанhow to Sort with Hibernate с использованием как языка запросов Hibernate (HQL), так и API критериев.

Дальнейшее чтение:

Hibernate: сохранить, сохранить, обновить, объединить, saveOrUpdate

Краткое и практическое руководство по методам записи Hibernate: сохранение, сохранение, обновление, объединение, saveOrUpdate.

Удаление объектов с помощью Hibernate

Краткое руководство по удалению сущности в Hibernate.

Hibernate Перехватчики

Краткое и практическое руководство по созданию перехватчиков Hibernate.

2. Сортировка с HQL

Сортировка с помощью Hibernate HQL так же проста, как добавление предложенияOrder By в строку запроса HQL:

String hql = "FROM Foo f ORDER BY f.name"; Query query = sess.createQuery(hql);

После выполнения этого кода Hibernate сгенерирует следующий SQL-запрос:

Hibernate: select foo0_.ID as ID1_0_, foo0_.NAME as NAME2_0_ from FOO foo0_ order by foo0_.NAME

Направление сортировки по умолчанию — восходящее. Вот почему условие порядкаasc не включается в сгенерированный SQL-запрос.

2.1. Использование явного порядка сортировки

Чтобы указать порядок сортировки вручную, вам необходимо указать направление сортировки в строке запросаHQL:

String hql = "FROM Foo f ORDER BY f.name ASC"; Query query = sess.createQuery(hql);

В этом примере установка предложенияasc в HQL была включена в сгенерированный запрос SQL:

Hibernate: select foo0_.ID as ID1_0_, foo0_.NAME as NAME2_0_ from FOO foo0_ order by foo0_.NAME ASC

2.2. Сортировка по более чем одному атрибуту

К предложениюOrder By в строке запроса HQL можно добавить несколько атрибутов вместе с необязательным порядком сортировки:

String hql = "FROM Foo f ORDER BY f.name DESC, f.id ASC"; Query query = sess.createQuery(hql);

Сгенерированный запрос SQL изменится соответственно:

Hibernate: select foo0_.ID as ID1_0_, foo0_.NAME as NAME2_0_ from FOO foo0_ order by foo0_.NAME DESC, foo0_.ID ASC

2.3. Установка приоритета сортировки нулевых значений

По умолчанию, когда атрибут для сортировки имеет значенияnull, решение о приоритете принимает RDMS. Эту процедуру по умолчанию можно изменить, поместивa NULLS FIRST or NULLS LAST clause in the HQL query string.

Этот простой пример помещает любые нули в конец списка результатов:

String hql = "FROM Foo f ORDER BY f.name NULLS LAST"; Query query = sess.createQuery(hql);

Давайте посмотрим предложениеis null then 1 else 0 вgenerated SQL query:

Hibernate: select foo0_.ID as ID1_1_, foo0_.NAME as NAME2_1_, foo0_.BAR_ID as BAR_ID3_1_, foo0_.idx as idx4_1_ from FOO foo0_ order by case when foo0_.NAME is null then 1 else 0 end, foo0_.NAME

2.4. Сортировка отношений один ко многим

Давайте проанализируем сложный случай сортировки:sorting entities in a one to many relation —Bar, содержащий набор сущностейFoo.

Мы сделаем это, аннотируя коллекцию с помощьюthe Hibernate @OrderBy annotation; мы укажем поле, по которому производится заказ, а также направление:

@OrderBy(clause = "NAME DESC") Set fooList = new HashSet();

Обратите внимание на аргументclause аннотации. Это уникально для@OrderBy Hibernate по сравнению с аналогичной аннотацией JPA@OrderBy. Еще одна характеристика, которая отличает этот подход от его эквивалента в JPA, заключается в том, что аргументclause указывает, что сортировка выполняется на основе столбцаNAME таблицыFOO, а неname атрибутFoo.

Теперь давайте посмотрим на фактическую сортировкуBars иFoos:

String hql = "FROM Bar b ORDER BY b.id"; Query query = sess.createQuery(hql);

resulting SQL statement показывает, что отсортированныеFoo’s помещаются вfooList:

Hibernate: select bar0_.ID as ID1_0_, bar0_.NAME as NAME2_0_ from BAR bar0_ order by bar0_.ID Hibernate: select foolist0_.BAR_ID as BAR_ID3_0_0_, foolist0_.ID as ID1_1_0_, foolist0_.ID as ID1_1_1_, foolist0_.NAME as NAME2_1_1_, foolist0_.BAR_ID as BAR_ID3_1_1_, foolist0_.idx as idx4_1_1_ from FOO foolist0_ where foolist0_.BAR_ID=? order by foolist0_.NAME desc

Следует иметь в виду, что этоnot possible to to sort Lists, как в случае с JPA. Документация Hibernate гласит:

«В настоящее время Hibernate игнорирует @OrderBy в @ElementCollection, например, в List . Порядок элементов такой же, как и в базе данных, не определен ».

В качестве примечания, можно было бы обойти это ограничение, используя устаревшую конфигурацию XML для Hibernate и заменив элемент на элемент .

3. Сортировка по критериям гибернации

API объекта критериев предоставляет классOrder в качестве основного API для управления сортировкой.

3.1. Установка порядка сортировки

У классаOrder есть два метода для установки порядка сортировки:

• *asc*(String attribute): сортирует запрос поattribute в порядке возрастания.
• *desc*(String attribute): сортирует запрос поattribute в порядке убывания.

Начнем с простого примера — сортировки по одному атрибутуid:

Criteria criteria = sess.createCriteria(Foo.class, "FOO"); criteria.addOrder(Order.asc("id"));

Обратите внимание, что аргумент методаasc чувствителен к регистру и должен соответствоватьname атрибута для сортировки.

Object API Hibernate Criteria явно устанавливает направление сортировки, и это отражается в операторе SQL, сгенерированном кодом:

Hibernate: select this_.ID as ID1_0_0_, this_.NAME as NAME2_0_0_ from FOO this_ order by this_.ID sac

3.2. Сортировка по более чем одному атрибуту

Для сортировки по нескольким атрибутам требуется только добавить объектOrder к экземпляруCriteria, как в примере ниже:

Criteria criteria = sess.createCriteria(Foo.class, "FOO"); criteria.addOrder(Order.asc("name")); criteria.addOrder(Order.asc("id"));

Запрос, который генерируется в SQL:

Hibernate: select this_.ID as ID1_0_0_, this_.NAME as NAME2_0_0_ from FOO this_ order by this_.NAME asc, this_.ID sac

3.3. Установка приоритета сортировки нулевых значений

По умолчанию, когда атрибут для сортировки имеет значенияnull, решение о приоритете принимает RDMS. Hibernate Criteria Object API упрощает изменение этого значения по умолчанию иplace nulls at the end в возрастающем упорядоченном списке:

Criteria criteria = sess.createCriteria(Foo.class, "FOO"); criteria.addOrder(Order.asc("name").nulls(NullPrecedence.LAST));

Вот базовый запросSQL — с предложениемis null then 1 else 0:

Hibernate: select this_.ID as ID1_1_1_, this_.NAME as NAME2_1_1_, this_.BAR_ID as BAR_ID3_1_1_, this_.idx as idx4_1_1_, bar2_.ID as ID1_0_0_, bar2_.NAME as NAME2_0_0_ from FOO order by case when this_.NAME is null then 1 else 0 end, this_.NAME asc

В качестве альтернативы мы также можемplace the nulls at the beginning упорядоченного по убыванию списка:

Criteria criteria = sess.createCriteria(Foo.class, "FOO"); criteria.addOrder(Order.desc("name").nulls(NullPrecedence.FIRST));

Соответствующий запрос SQL следует с предложениемis null then 0 else 1:

Hibernate: select this_.ID as ID1_1_1_, this_.NAME as NAME2_1_1_, this_.BAR_ID as BAR_ID3_1_1_, this_.idx as idx4_1_1_, bar2_.ID as ID1_0_0_, bar2_.NAME as NAME2_0_0_ from FOO order by case when this_.NAME is null then 0 else 1 end, this_.NAME desc

Отметим, чтоif the attribute to sort by is a primitive type like an int, a PresisitenceException will thrown.

Например, если значениеf.anIntVariable равно нулю, то выполнение запроса:

String jql = "Select f from Foo as f order by f.anIntVariable desc NULLS FIRST"; Query sortQuery = entityManager.createQuery(jql);

javax.persistence.PersistenceException: org.hibernate.PropertyAccessException: Null value was assigned to a property of primitive type setter of com.cc.jpa.example.Foo.anIntVariable

4. Заключение

В этой статье рассматривается сортировка с помощью Hibernate — использование доступных API-интерфейсов для простых сущностей, а также для сущностей в отношении «один ко многим».

Реализацию этого руководства по сортировке Hibernate можно найти вthe github project — это проект на основе Eclipse, поэтому его должно быть легко импортировать и запускать как есть.

Источник

JPA — Using @OrderBy Annotation

The annotation @OrderBy Specifies the ordering of the elements of a collection valued association or element collection at the point when the association or collection is retrieved.

This annotation can be used with @ElementCollection or @OneToMany / @ManyToMany relationships.

When @OrderBy used with @ElementCollection

If the collection is of basic type, then ordering will be by the value of the basic objects. For example following will arrange phoneNumbers in their natural ordering:

@ElementCollection @OrderBy private List phoneNumbers;

If the collection is of @Embeddable type, the dot («.») notation is used to refer to an attribute within the embedded attribute. For example following will arrange addresses by country names.

@ElementCollection @OrderBy("city.country DESC") private List addresses;

Where Address is defined as:

@Embeddable public class Address

ASC | DESC can be used to specify whether ordering is ascending or descending. Default is ASC.

When @OrderBy used with a relationship

@OrderBy only works with direct properties if used with a relationship ( @OneToMany or @ManyToMany ). For example:

@ManyToMany @OrderBy("supervisor") private List tasks;

Dot («.») access doesn’t work in case of relationships. Attempting to use a nested property e.g. @OrderBy(«supervisor.name») will end up in a runtime exception.

If the ordering element is not specified for an entity association (i.e. the annotation is used without any value), ordering by the primary key of the associated entity is assumed. For example:

@ManyToMany @OrderBy private List tasks;

In above case tasks collection will be ordered by Task#id.

@OrderBy vs @OrderColumn

The order specified by @OrderBy is only applied during runtime when a query result is retrieved.
Whereas, the usage of @OrderColumn (last tutorials ) results in a permanent ordering of the related data. In this case a dedicated database column is used to maintain the ordering.

Example

Entities

@Entity public class Employee < @Id @GeneratedValue private long id; private String name; @ElementCollection @OrderBy//order by strings private ListphoneNumbers; @ManyToMany(cascade = CascadeType.ALL) @OrderBy("supervisor")//order by task.supervisor (employee.id) private List tasks; @ElementCollection @OrderBy("city.country DESC")//desc order by address.city.country private List addresses; . >

@Embeddable public class Address
@Embeddable public class City

Table mappings

Let’s see our entities are mapped to what database tables:

public class TableMappingMain < private static EntityManagerFactory entityManagerFactory = Persistence.createEntityManagerFactory("example-unit"); public static void main(String[] args) < try < nativeQuery("SHOW TABLES"); nativeQuery("SHOW COLUMNS FROM EMPLOYEE"); nativeQuery("SHOW COLUMNS FROM EMPLOYEE_PHONENUMBERS"); nativeQuery("SHOW COLUMNS FROM EMPLOYEE_TASK"); nativeQuery("SHOW COLUMNS FROM TASK"); nativeQuery("SHOW COLUMNS FROM EMPLOYEE_ADDRESSES"); >finally < entityManagerFactory.close(); >> public static void nativeQuery(String s) < EntityManager em = entityManagerFactory.createEntityManager(); System.out.printf("'%s'%n", s); Query query = em.createNativeQuery(s); List list = query.getResultList(); for (Object o : list) < if (o instanceof Object[]) < System.out.println(Arrays.toString((Object[]) o)); >else < System.out.println(o); >> em.close(); > >

'SHOW TABLES'
[EMPLOYEE, PUBLIC]
[EMPLOYEE_ADDRESSES, PUBLIC]
[EMPLOYEE_PHONENUMBERS, PUBLIC]
[EMPLOYEE_TASK, PUBLIC]
[TASK, PUBLIC]
'SHOW COLUMNS FROM EMPLOYEE'
[ID, BIGINT(19), NO, PRI, NULL]
[NAME, VARCHAR(255), YES, , NULL]
'SHOW COLUMNS FROM EMPLOYEE_PHONENUMBERS'
[EMPLOYEE_ID, BIGINT(19), NO, , NULL]
[PHONENUMBERS, VARCHAR(255), YES, , NULL]
'SHOW COLUMNS FROM EMPLOYEE_TASK'
[EMPLOYEE_ID, BIGINT(19), NO, , NULL]
[TASKS_ID, BIGINT(19), NO, , NULL]
'SHOW COLUMNS FROM TASK'
[ID, BIGINT(19), NO, PRI, NULL]
[NAME, VARCHAR(255), YES, , NULL]
[SUPERVISOR_ID, BIGINT(19), YES, , NULL]
'SHOW COLUMNS FROM EMPLOYEE_ADDRESSES'
[EMPLOYEE_ID, BIGINT(19), NO, , NULL]
[COUNTRY, VARCHAR(255), YES, , NULL]
[NAME, VARCHAR(255), YES, , NULL]
[STREET, VARCHAR(255), YES, , NULL]

Retrieval of collections

public class ExampleMain < private static EntityManagerFactory entityManagerFactory = Persistence.createEntityManagerFactory("example-unit"); public static void main(String[] args) < try < persistEmployees(); findEmployees(); >finally < entityManagerFactory.close(); >> public static void persistEmployees() < Task task1 = Task.create("Development"); Task task2 = Task.create("Documentation"); Task task3 = Task.create("Designing"); Task task5 = Task.create("Refactoring"); Task task6 = Task.create("Testing"); Employee employee1 = Employee.create("Diana", Arrays.asList(task1, task2, task6), Arrays.asList(Address.create("111 Round Drive", "Papineau", "Sundland"), Address.create("2623 Elmwood Avenue", "Scottsdale", "Zwonga")), "111-111-111", "666-666-666", "222-222-222"); Employee employee2 = Employee.create("Denise", Arrays.asList(task2, task3), Arrays.asList(Address.create("23 Estate Avenue", "Papineau", "Ugrela"), Address.create("367 Rose Route", "Scottsdale", "Mreyton")), "444-444-444", "333-333-333"); Employee employee3 = Employee.create("Linda", Arrays.asList(task1, task5), Arrays.asList(Address.create("345 Little Way", "Fries", "Tospus"), Address.create("91 Vine Lane", "Binesville", "Oblijan")), "555-555-555"); EntityManager em = entityManagerFactory.createEntityManager(); task1.setSupervisor(employee2); task2.setSupervisor(employee1); task3.setSupervisor(employee3); task5.setSupervisor(employee1); task6.setSupervisor(employee3); em.getTransaction().begin(); em.persist(employee1); em.persist(employee2); em.persist(employee3); em.getTransaction().commit(); >private static void findEmployees() < EntityManager em = entityManagerFactory.createEntityManager(); Listemployees = em.createQuery("Select e from Employee e") .getResultList(); for (Employee employee : employees) < System.out.println("---"); System.out.println(employee); System.out.println("-- Tasks --"); for (Task task : employee.getTasks()) < System.out.println("task: " + task); System.out.println("supervisor: " + task.getSupervisor()); >System.out.println("-- addresses --"); employee.getAddresses().forEach(System.out::println); > > >

---
Employee 
-- Tasks --
task: Task 
supervisor: Employee 
task: Task 
supervisor: Employee 
task: Task 
supervisor: Employee 
-- addresses --
Address>
Address>
---
Employee 
-- Tasks --
task: Task 
supervisor: Employee 
task: Task 
supervisor: Employee 
-- addresses --
Address>
Address>
---
Employee 
-- Tasks --
task: Task 
supervisor: Employee 
task: Task 
supervisor: Employee 
-- addresses --
Address>
Address>

As seen above:
Each employee’s phoneNumbers collection elements are arranged in their natural ordering.
Each employee’s tasks collection elements are arranged by supervisor’s ids.
Each employee’s addresses collection elements are arranged in descending order by the country names.

Example Project

Dependencies and Technologies Used:

• h2 1.4.197: H2 Database Engine.
• hibernate-core 5.2.13.Final: The core O/RM functionality as provided by Hibernate.
  Implements javax.persistence:javax.persistence-api version 2.1
• JDK 1.8
• Maven 3.3.9

Источник