Запросы Querydsl против JPA Criteria, часть 6: Руководство по обновлению до Spring Boot 3.2 для проекта Spring Data JPA и Querydsl

Учебники
Hibernate

В прошлом году я написал статью “Руководство по обновлению до Spring Boot 3.0 для Spring Data JPA и Querydsl” для обновления до Spring Boot 3.0.x. Теперь у нас есть Spring Boot 3.2. Давайте рассмотрим два возможных вопроса, с которыми вы можете столкнуться при обновлении до Spring Boot 3.2.2.

Технологии, используемые в проекте SAT:

  1. Spring Boot 3.2.2 и Spring Framework 6.1.3
  2. Hibernate + генератор модели JPA 6.4.1 Final
  3. Spring Data JPA 3.2.2
  4. Querydsl 5.0.0.

Изменения

Все изменения в Spring Boot 3.2 описаны в Заметках о выпуске Spring Boot 3.2 и Что нового в версии 6.1 для Spring Framework 6.1.

Последние изменения в Spring Boot 3.2.2 можно найти на GitHub.

Обнаруженные проблемы

  • A different treatment of Hibernate dependencies due to the changed hibernate-jpamodelgen behavior for annotation processors
  • Unpaged класс был переработан.

Давайте начнем с зависимостей Hibernate.

Интеграция генерации статической метамодели

Самым большим изменением является зависимость hibernate-jpamodelgen, которая генерирует статическую метамодель. В Hibernate 6.3 подход к зависимостям был изменен для уменьшения транзитивных зависимостей. Spring Boot 3.2.0 обновил зависимость hibernate-jpamodelgen до версии 6.3 (см. Обновления зависимостей). К сожалению, новая версия вызывает ошибки компиляции (см. ниже).

Примечание: Здесь используется Spring Boot 3.2.2, который уже использует Hibernate 6.4 с таким же поведением.

Ошибка компиляции

Из-за этого изменения компиляция нашего проекта (сборка Maven) с Spring Boot 3.2.2 завершается ошибкой, как это:

Plain Text

  

[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  3.049 s
[INFO] Finished at: 2024-01-05T08:43:10+01:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.11.0:compile (default-compile) on project sat-jpa: Compilation failure: Compilation failure: 
[ERROR]   on the class path. A future release of javac may disable annotation processing
[ERROR]   unless at least one processor is specified by name (-processor), or a search
[ERROR]   path is specified (--processor-path, --processor-module-path), or annotation
[ERROR]   processing is enabled explicitly (-proc:only, -proc:full).
[ERROR]   Use -Xlint:-options to suppress this message.
[ERROR]   Use -proc:none to disable annotation processing.
[ERROR] <SAT_PATH>\sat-jpa\src\main\java\com\github\aha\sat\jpa\city\CityRepository.java:[3,41] error: cannot find symbol
[ERROR]   symbol:   class City_
[ERROR]   location: package com.github.aha.sat.jpa.city
[ERROR] <SAT_PATH>\sat-jpa\src\main\java\com\github\aha\sat\jpa\city\CityRepository.java:[3] error: static import only from classes and interfaces
...
[ERROR] <SAT_PATH>\sat-jpa\src\main\java\com\github\aha\sat\jpa\country\CountryCustomRepositoryImpl.java:[4] error: static import only from classes and interfaces
[ERROR] java.lang.NoClassDefFoundError: net/bytebuddy/matcher/ElementMatcher
[ERROR] 	at org.hibernate.jpamodelgen.validation.ProcessorSessionFactory.<clinit>(ProcessorSessionFactory.java:69)
[ERROR] 	at org.hibernate.jpamodelgen.annotation.AnnotationMeta.handleNamedQuery(AnnotationMeta.java:104)
[ERROR] 	at org.hibernate.jpamodelgen.annotation.AnnotationMeta.handleNamedQueryRepeatableAnnotation(AnnotationMeta.java:78)
[ERROR] 	at org.hibernate.jpamodelgen.annotation.AnnotationMeta.checkNamedQueries(AnnotationMeta.java:57)
[ERROR] 	at org.hibernate.jpamodelgen.annotation.AnnotationMetaEntity.init(AnnotationMetaEntity.java:297)
[ERROR] 	at org.hibernate.jpamodelgen.annotation.AnnotationMetaEntity.create(AnnotationMetaEntity.java:135)
[ERROR] 	at org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor.handleRootElementAnnotationMirrors(JPAMetaModelEntityProcessor.java:360)
[ERROR] 	at org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor.processClasses(JPAMetaModelEntityProcessor.java:203)
[ERROR] 	at org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor.process(JPAMetaModelEntityProcessor.java:174)
[ERROR] 	at jdk.compiler/com.sun.tools.javac.processing.JavacProcessingEnvironment.callProcessor(JavacProcessingEnvironment.java:1021)
[ER...
[ERROR] 	at org.codehaus.plexus.classworlds.launcher.Launcher.main(Launcher.java:348)
[ERROR] Caused by: java.lang.ClassNotFoundException: net.bytebuddy.matcher.ElementMatcher
[ERROR] 	at java.base/java.net.URLClassLoader.findClass(URLClassLoader.java:445)
[ERROR] 	at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:593)
[ERROR] 	at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:526)
[ERROR] 	... 51 more
[ERROR] -> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException

Это происходит из-за измененного подхода к генерации статической метамодели, описанного в руководстве по миграции Hibernate (см. Интеграция генерации статической метамодели и исходную проблему HHH-17362). Их объяснение такого изменения следующее:

“… в предыдущих версиях Hibernate ORM вы незаметно проникали зависимостями от hibernate-jpamodelgen в свой компиляционный classpath. С Hibernate ORM 6.3 теперь вы можете столкнуться с ошибкой компиляции во время обработки аннотаций, связанной с отсутствующими классами Antlr.”

Изменения зависимостей

Как видно на скриншотах ниже, зависимости Hibernate действительно изменились.

  • Spring Boot 3.1.6:

  • Spring Boot 3.2.2:

Объяснение

Как указано в руководстве по миграции, нам нужно изменить наш pom.xml с простой зависимости Maven на пути обработчика аннотаций плагина Maven компилятора (см. документацию).

Решение

Мы можем удалить зависимости Maven hibernate-jpamodelgen и querydsl-apt (в нашем случае), как рекомендовано в последней статье. Вместо этого pom.xml должен определять статические генераторы метамоделей через maven-compiler-plugin следующим образом:

XML

  

<plugins>
	<plugin>
		<groupId>org.apache.maven.plugins</groupId>
		<artifactId>maven-compiler-plugin</artifactId>
		<configuration>
			<annotationProcessorPaths>
				<path>
					<groupId>org.hibernate.orm</groupId>
					<artifactId>hibernate-jpamodelgen</artifactId>
					<version>${hibernate.version}</version>
				</path>
				<path>
					<groupId>com.querydsl</groupId>
					<artifactId>querydsl-apt</artifactId>
					<version>${querydsl.version}</version>
					<classifier>jakarta</classifier>
				</path>
				<path>
					<groupId>org.projectlombok</groupId>
					<artifactId>lombok</artifactId>
					<version>${lombok.version}</version>
				</path>
			</annotationProcessorPaths>
		</configuration>
	</plugin>
</plugins>

См. связанные изменения в проекте SAT на GitHub.

Так как мы вынуждены использовать этот подход из-за hibernate-jpamodelgen, нам нужно применить его ко всем зависимостям, тесно связанным с обработкой аннотаций (querydsl-apt или lombok). Например, когда lombok не используется таким образом, мы получаем ошибку компиляции, подобную этой:

Plain Text

  

[INFO] -------------------------------------------------------------
[ERROR] COMPILATION ERROR : 
[INFO] -------------------------------------------------------------
[ERROR] <SAT_PATH>\sat-jpa\src\main\java\com\github\aha\sat\jpa\city\CityService.java:[15,30] error: variable repository not initialized in the default constructor
[INFO] 1 error
[INFO] -------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  4.535 s
[INFO] Finished at: 2024-01-08T08:40:29+01:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.11.0:compile (default-compile) on project sat-jpa: Compilation failure
[ERROR] <SAT_PATH>\sat-jpa\src\main\java\com\github\aha\sat\jpa\city\CityService.java:[15,30] error: variable repository not initialized in the default constructor

То же самое относится и к querydsl-apt. В этом случае мы можем увидеть ошибку компиляции, подобную этой:

Plain Text

  

[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  5.211 s
[INFO] Finished at: 2024-01-11T08:39:18+01:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.11.0:compile (default-compile) on project sat-jpa: Compilation failure: Compilation failure: 
[ERROR] <SAT_PATH>\sat-jpa\src\main\java\com\github\aha\sat\jpa\country\CountryRepository.java:[3,44] error: cannot find symbol
[ERROR]   symbol:   class QCountry
[ERROR]   location: package com.github.aha.sat.jpa.country
[ERROR] <SAT_PATH>\sat-jpa\src\main\java\com\github\aha\sat\jpa\country\CountryRepository.java:[3] error: static import only from classes and interfaces
[ERROR] <SAT_PATH>\sat-jpa\src\main\java\com\github\aha\sat\jpa\country\CountryCustomRepositoryImpl.java:[3,41] error: cannot find symbol
[ERROR]   symbol:   class QCity
[ERROR]   location: package com.github.aha.sat.jpa.city
[ERROR] <SAT_PATH>\sat-jpa\src\main\java\com\github\aha\sat\jpa\country\CountryCustomRepositoryImpl.java:[3] error: static import only from classes and interfaces
[ERROR] <SAT_PATH>\sat-jpa\src\main\java\com\github\aha\sat\jpa\country\CountryCustomRepositoryImpl.java:[4,44] error: cannot find symbol
[ERROR]   symbol:   class QCountry
[ERROR]   location: package com.github.aha.sat.jpa.country
[ERROR] <SAT_PATH>\sat-jpa\src\main\java\com\github\aha\sat\jpa\country\CountryCustomRepositoryImpl.java:[4] error: static import only from classes and interfaces
[ERROR] -> [Help 1]

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

Переработанный Unpaged

Второй незначительный вопрос связан с изменением класса Unpaged. Сериализация PageImpl библиотекой Jackson была затронута изменением Unpaged с enum на class (см. spring-projects/spring-data-commons#2987).

  • Spring Boot 3.1.6:
Java

  

public interface Pageable {

	static Pageable unpaged() {
		return Unpaged.INSTANCE;
	}

	...
}

enum Unpaged implements Pageable {

	INSTANCE;

	...
}

  • Spring Boot 3.2.2:
Java

  

public interface Pageable {

	static Pageable unpaged() {
		return unpaged(Sort.unsorted());
	}

	static Pageable unpaged(Sort sort) {
		return Unpaged.sorted(sort);
	}

	...
}
	
final class Unpaged implements Pageable {

	private static final Pageable UNSORTED = new Unpaged(Sort.unsorted());

	...

}

Когда используется new PageImpl<City>(cities) (как мы привыкли его использовать), то выбрасывается эта ошибка:

Plain Text

  

2024-01-11T08:47:56.446+01:00  WARN 5168 --- [sat-elk] [           main] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.http.converter.HttpMessageNotWritableException: Could not write JSON: (was java.lang.UnsupportedOperationException)]

MockHttpServletRequest:
      HTTP Method = GET
      Request URI = /api/cities/country/Spain
       Parameters = {}
          Headers = []
             Body = null
    Session Attrs = {}

Handler:
             Type = com.github.aha.sat.elk.city.CityController
           Method = com.github.aha.sat.elk.city.CityController#searchByCountry(String, Pageable)

Async:
    Async started = false
     Async result = null

Resolved Exception:
             Type = org.springframework.http.converter.HttpMessageNotWritableException

Обходной путь — использовать конструктор со всеми атрибутами, как:

Java

  

new PageImpl<City>(cities, ofSize(PAGE_SIZE), cities.size())

Вместо:

Java

  

new PageImpl<City>(cities)

Примечание: Это должно быть исправлено в Spring Boot 3.3 (см. комментарий к этому вопросу).

Заключение

В этой статье рассмотрены найденные проблемы при обновлении до последней версии Spring Boot 3.2.2 (на момент написания статьи). Статья началась с рассмотрения обработки аннотационных процессоров из-за изменений в управлении зависимостями Hibernate. Далее объясняется изменение класса Unpaged и обходной путь для использования PageImpl.

Все изменения (вместе с некоторыми другими изменениями) можно увидеть в PR #64. Полный исходный код, продемонстрированный выше, доступен в моем GitHub репозитории.

Source:
https://dzone.com/articles/upgrade-guide-to-spring-boot-32-for-spring-data-jp