用maven animal sniffer plugin检查一个自己的API

Question

我想用动物嗅探器检查一个 class 与我自己的 API，它只包含一个 class 和一个方法：

package sniffertestapi;

public class MainInterface
{
    public static void testMethod(String testString)
    {
        System.out.println(testString);
    }
}

以下简单的 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/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>TestAPI</groupId>
    <artifactId>TestAPI</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <build>
        <plugins>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>
                <configuration>
                    <source>1.7</source>
                    <target>1.7</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>animal-sniffer-maven-plugin</artifactId>
                <version>1.13</version>
                <executions>
                    <execution>
                        <id>default</id>
                        <phase>package</phase>
                        <goals>
                            <goal>build</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <javaHome>C:\Program Files\Java\jdk1.7.0_51</javaHome>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

构建运行良好，它将 TestAPI-0.0.1-SNAPSHOT.signature 和 jar 安装到我的 Maven 存储库中。

接下来我想添加 TestAPI 作为依赖项并使用来自另一个项目的 testMethod。

package sniffertest;

import sniffertestapi.MainInterface;

public class Tester
{
    public Tester()
    {
        MainInterface.testMethod("Hi");
    }
}

在这个项目中我添加了另一个目标的动物嗅探器插件：

<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/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>TestTester</groupId>
    <artifactId>TestTester</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <build>
        <plugins>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.1</version>
                <configuration>
                    <source>1.7</source>
                    <target>1.7</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>animal-sniffer-maven-plugin</artifactId>
                <version>1.13</version>
                <configuration>
                    <signature>
                        <groupId>TestAPI</groupId>
                        <artifactId>TestAPI</artifactId>
                        <version>0.0.1-SNAPSHOT</version>
                    </signature>
                </configuration>
                <executions>
                    <execution>
                        <id>default</id>
                        <phase>test</phase>
                        <goals>
                            <goal>check</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    <dependencies>
        <dependency>
            <groupId>TestAPI</groupId>
            <artifactId>TestAPI</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

这个构建运行当然也成功了。现在我将 testMethod 更改为具有两个参数：

public static void testMethod(String testString, String testString2)
{
    System.out.println(testString);
}

并从第二个项目中使用它：

    MainInterface.testMethod("Hell", "o");

这次我预计第二个项目的构建会失败，因为签名已更改。它与保存在签名文件中的那个不同。但是构建结果成功并且 animal-sniffer-plugin 仅输出这两行：

[INFO] --- animal-sniffer-maven-plugin:1.13:check (default) @ TestTester ---
[INFO] Checking unresolved references to TestAPI:TestAPI:0.0.1-SNAPSHOT

即使我调用了 API 中未定义的内容，构建也会成功（调用 mvn test），例如：

MainInterface.undefinedMethod(1,2,3,4,5);

我的用例是错误的还是因为 POM 配置错误？

Answer 1

感谢@user944849 的提示。插件将其配置打印到调试日志：

[DEBUG] -----------------------------------------------------------------------
[DEBUG] Goal:          org.codehaus.mojo:animal-sniffer-maven-plugin:1.13:check (default-cli)
[DEBUG] Style:         Regular
[DEBUG] Configuration: <?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <ignoreDependencies default-value="true"/>
  <localRepository>${localRepository}</localRepository>
  <outputDirectory>${project.build.outputDirectory}</outputDirectory>
  <project>${project}</project>
  <signature>
    <groupId>TestAPI</groupId>
    <artifactId>TestAPI</artifactId>
    <version>0.0.1-SNAPSHOT</version>
  </signature>
  <skip default-value="false">${animal.sniffer.skip}</skip>
</configuration>
[DEBUG] =======================================================================

结果是依赖项被忽略了，因为有一个设置 <ignoreDependencies default-value="true"/>。将 <ignoreDependencies>true</ignoreDependencies> 放入 pom 的插件配置中解决了我的问题。

我还必须将修改后的 API-项目重新安装到存储库中（跳过签名的构建）以避免编译错误。

用maven animal sniffer plugin检查一个自己的API

Check an own API with maven animal sniffer plugin

java

maven

animal-sniffer