Maven 3 - Как добавить зависимость от процессора аннотаций?
Мне нужно запустить обработчик аннотаций в моих источниках проекта. Обработчик аннотации не должен становиться транзитивной зависимостью проекта, поскольку он необходим только для обработки аннотаций и ничего больше.
Вот полный (нерабочий) тест, который я использую для этого:
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>test</groupId>
<artifactId>test</artifactId>
<packaging>jar</packaging>
<version>1.0-SNAPSHOT</version>
<name>Test annotations</name>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<hibernate-jpamodelgen.version>1.2.0.Final</hibernate-jpamodelgen.version>
</properties>
<dependencies>
<dependency>
<groupId>javax</groupId>
<artifactId>javaee-api</artifactId>
<version>6.0</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.0</version>
<configuration>
<annotationProcessors>
<annotationProcessor>
org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor</annotationProcessor>
</annotationProcessors>
<debug>true</debug>
<optimize>true</optimize>
<source>1.6</source>
<target>1.6</target>
<compilerArguments>
<AaddGeneratedAnnotation>true</AaddGeneratedAnnotation>
<Adebug>true</Adebug>
</compilerArguments>
</configuration>
<dependencies>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-jpamodelgen</artifactId>
<version>${hibernate-jpamodelgen.version}</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
Я явно определил org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor
как обработчик аннотации в конфигурации плагина для тестов, и я знаю, что это не обязательно.
Проблема, с которой я сталкиваюсь, заключается в том, что зависимость hibernate-jpamodelgen
не добавляется в путь к компилятору, поэтому обработчик аннотации не найден и сборка не выполняется.
В соответствии с этим answer, я попытался добавить зависимость как расширение сборки (не уверен, что я понимаю, что это должно быть!) вот так:
<extensions>
<extension>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-jpamodelgen</artifactId>
<version>${hibernate-jpamodelgen.version}</version>
</extension>
</extensions>
Это также не добавляет hibernate-jpamodelgen
в путь к компилятору.
Единственное, что я нашел, которое работает до сих пор, заключается в добавлении зависимости к проекту в разделе <dependencies>
. Это приводит к неудачному побочному эффекту добавления hibernate-jpamodelgen
в качестве транзитивной зависимости впоследствии, чего я хочу избежать.
Моя предыдущая рабочая настройка использует плагин maven-processor-plugin
для достижения того, чего я хочу. Однако этот плагин не поддерживается eclipse m2e, и последняя версия maven-compiler-plugin
теперь обрабатывает несколько аргументов компилятора, поэтому я предпочел бы использовать последний.
Ответы
Ответ 1
Добавьте зависимость как дополнительную зависимость (<optional>true</optional>
). Это добавит зависимость при компиляции, но предотвратит ее транзитивную зависимость:
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-jpamodelgen</artifactId>
<version>${hibernate-jpamodelgen.version}</version>
<optional>true</optional>
</dependency>
Если вы создаете артефакт в этом модуле со всеми вашими зависимостями в нем (например..war), вы можете использовать <scope>provided</scope>
вместо этого. Это предотвращает переход транзитивности и включается в артефакт, который производит модуль.
Ответ 2
Проблема действительно в версии 3. * maven-compiler-plugin
. Он немного отличается от версии 2. *. В частности, кажется, что maven-compiler-plugin
3. * не добавляет своих зависимостей и не строит расширения для пути к классам, поскольку использует инструменты javax.tools для запуска процесса компиляции. Чтобы вернуть прежнее поведение для maven-compiler-plugin
, вы должны использовать новое свойство конфигурации forceJavacCompilerUse
:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.1</version>
<configuration>
<forceJavacCompilerUse>true</forceJavacCompilerUse>
</configuration>
....
</plugin>
Ответ 3
Параметр annotationProcessorPaths может использоваться в последних версиях подключаемого модуля компилятора Maven:
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.6.1</version>
<configuration>
<annotationProcessorPaths>
<annotationProcessorPath>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-jpamodelgen</artifactId>
<version>5.2.6.Final</version>
</annotationProcessorPath>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</pluginManagement>
Таким образом, процессор отделен от фактических зависимостей проекта. Этот параметр также подбирается подключаемым модулем Eclipse M2E, если для проекта включена обработка аннотаций.
Ответ 4
Для других посетителей я обнаружил, что в maven-compiler-plugin версии 3.x есть существенные изменения.
Вот как я это делаю. (Я тот, с кем вы связались)
Дело в том, что мое решение не работает с этими 3.x сериями maven-compiler-plugin.
<project ...>
<build>
<extensions>
<extension>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-jpamodelgen</artifactId>
<version>1.3.0.Final</version>
</extension>
</extensions>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>2.5.1</version> <!-- See this? -->
</plugin>
</plugins>
</build>
</project>
Ответ 5
Не уверен, какая ошибка сборки у вас есть, но вот мой случай:
Я получил следующую компиляционную ошибку в Idea:
Annotation processor 'org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor' not found error
Но, когда он был составлен из Maven, все было в порядке.
Итак, моя проблема заключалась в том, что я как-то ошибался в настройках Idea. В частности, оказалось, что Idea каким-то образом обнаружила процессор и ввела в настройки профили процессора модуля. Здесь обсуждается.
Я исправил его следующим образом:
- Перейдите в раздел Идея > Настройки > Обработчики аннотации.
- Для каждого профиля процессора убедитесь, что:
- Включить обработку аннотаций: Да;
- Нет имени FQ процессора аннотаций, в котором вы указали ошибку (e.i. "JPAMetaModelEntityProcessor" ) в списке справа. Если он указан там, просто выберите и нажмите кнопку "-" минус, чтобы удалить его.
Ответ 6
Я думаю, что это лучший способ содержать такие зависимости в профилях для решения таких проблем.
<profile>
<id>XXX-profile</id>
<dependencies>
<dependency>
// XXX artifact path
</dependency>
</dependencies>
</profile>