Maven 3 - 如何添加注释处理器依赖？

时间：2013-01-14 16:52:24

标签： java maven jpa-2.0 maven-3 annotation-processing

我需要在项目的源代码上运行注释处理器。注释处理器不应该成为项目的传递依赖项，因为它只需要注释处理而不需要其他内容。

这是我用于此的完整（非工作）测试pom：

<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现在可以正确处理多个编译器参数，所以我宁愿使用后者。

7 个答案:

答案 0 :(得分：20)

将依赖项添加为optional dependency（<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>。这既可以防止依赖性传递，也可以包含在模块生成的工件中。

答案 1 :(得分：11)

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插件也会选择此选项。

答案 2 :(得分：8)

问题实际上是maven-compiler-plugin的 3。* 版本。它与 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 :(得分：4)

请查看jpa-metamodels-with-maven

对于更多访问者，我发现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>

答案 4 :(得分：2)

不确定您遇到了什么样的构建错误，但这是我的情况： 我在Idea中遇到以下编译错误： Annotation processor 'org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor' not found error

但是，从Maven编译时，一切都很好。

所以，我的问题是，我在Idea设置中的配置错误。特别是，似乎Idea以某种方式检测到处理器并将其置于模块处理器配置文件的设置中。 It is discussed here.

我将其修复如下：

  1. 转到Idea＆gt;设置＆gt;注释处理器。
  2. 对于每个处理器配置文件，请确保：
    • 启用注释处理是;
    • 右侧列表中没有关于（e.i。＆＃34; JPAMetaModelEntityProcessor＆＃34;）错误的注释处理器FQ名称。如果它列在那里，只需选择并点击＆＃39; - ＆＃39;减去按钮以将其删除。

答案 5 :(得分：2)

对于JDK 10，我真的必须有点疯狂才能使其正常工作，希望有人发现它有用

<jaxb.version>2.3.0</jaxb.version>
<maven.hibernate.version>5.3.2.Final</maven.hibernate.version>

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>${maven.compiler.version}</version>
    <goals>
        <goal>compile</goal>
    </goals>
    <configuration>
        <outputDirectory>${project.build.directory}/generated-sources/annotations</outputDirectory>
        <annotationProcessorPaths>
            <annotationProcessorPath>
                <groupId>org.hibernate</groupId>
                <artifactId>hibernate-jpamodelgen</artifactId>
                <version>${maven.hibernate.version}</version>
            </annotationProcessorPath>
            <annotationProcessorPath>
                <groupId>javax.xml.bind</groupId>
                <artifactId>jaxb-api</artifactId>
                <version>${jaxb.version}</version>
            </annotationProcessorPath>
        </annotationProcessorPaths>
        <annotationProcessors>
            <annotationProcessor>org.hibernate.jpamodelgen.JPAMetaModelEntityProcessor</annotationProcessor>
        </annotationProcessors>
        <compilerArgs>
            <arg>-AaddGeneratedAnnotation=false</arg>
        </compilerArgs>
        <compilerArguments>
            <AaddGeneratedAnnotation>false</AaddGeneratedAnnotation>
            <Adebug>true</Adebug>
        </compilerArguments>
        <failOnError>true</failOnError>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-jpamodelgen</artifactId>
            <version>${maven.hibernate.version}</version>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>javax.xml.bind</groupId>
            <artifactId>jaxb-api</artifactId>
            <version>2.3.0</version>
            <type>jar</type>
        </dependency>
    </dependencies>
</plugin>

答案 6 :(得分：0)

我认为这是在配置文件中包含此类依赖项以解决此类问题的更好方法。

<profile>
    <id>XXX-profile</id>
    <dependencies>
         <dependency>
             // XXX artifact path
         </dependency>
    </dependencies>
</profile>
相关问题
最新问题