Question

我有一个多项目设置，使用Maven和Findbugs插件。我需要在其中一个子项目中排除一些文件，因此我将其添加到findbugs-exclude.xml。当我在子项目中构建时，这是有效的。

我的问题出现在我尝试建立顶级水平时。 Maven没有在子项目中找到findbugs-exclude.xml。所以它不会忽略我的错误，因为它们而失败。我可以将findbugs-exclude.xml放在顶级目录中，并且排除有效。但这会污染最高级别，并且不会受到好评。

有没有办法让Maven插件使用子目录中的findbugs-exclude.xml文件？最好在顶层几乎没有变化？

Answer 1

以下是我在当前项目中所做的事情，它将findbugs-exclude.xml放在父项目中（我知道你不想要），但它解决了在两个地方维护它的DRY问题。它比解包更简单，但要求整个项目结构是本地的。（我认为解包解决方案对于在许多项目中使用相同的配置非常有用，就像在企业环境中一样。）

我将我的findbugs配置存储在parent/src/main/resources/shared/findbugs-exclude.xml中，但只要它在父节点中，特定目录就无关紧要了。

然后我使用属性来描述'shared'目录的位置：

<properties>
  <myproject.parent.basedir>${project.parent.basedir}</myproject.parent.basedir>
  <myproject.parent.shared.resources>${myproject.parent.basedir}/src/main/resources/shared</myproject.parent.shared.resources>
</properties>

在父级中配置findbugs时引用这些属性：

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>findbugs-maven-plugin</artifactId>
    <configuration>
      <excludeFilterFile>${myproject.parent.shared.resources}/findbugs-exclude.xml</excludeFilterFile>
    </configuration>
    ...
</plugin>

所有直接子项目现在将运行findbugs，引用父项中的配置文件。如果您有多个级别的项目嵌套，则必须覆盖子父级中的myproject.parent.basedir。例如，如果你有父＆lt; - sub-parent＆lt; - child，你可以输入：

<properties>
    <myproject.parent.basedir>${project.parent.parent.basedir}</myproject.parent.basedir>
</properties>

Answer 2

对此的一个解决方案是创建一个包含findbugs-excludes.xml的单独项目，然后使用依赖插件解压缩并将其放置在本地所需的位置：

<profile>
    <id>static-analysis</id>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-dependency-plugin</artifactId>
                <executions>
                    <execution>
                        <id>unpack-findbugs</id>
                        <phase>process-resources</phase>
                        <goals>
                            <goal>unpack</goal>
                        </goals>
                        <configuration>
                            <artifactItems>
                                <artifactItem>
                                    <groupId>com.myproject</groupId>
                                    <artifactId>my-findbugs</artifactId>
                                    <version>0.1-SNAPSHOT</version>
                                    <type>jar</type>
                                    <overWrite>true</overWrite>
                                    <outputDirectory>src/main/findbugs/</outputDirectory>
                                </artifactItem>
                            </artifactItems>
                            <!-- other configurations here -->
                            <excludes>META-INF/</excludes>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>findbugs-maven-plugin</artifactId>
                <configuration>
                    <xmlOutput>true</xmlOutput>
                    <!-- Optional directory to put findbugs xdoc xml report -->
                    <xmlOutputDirectory>target/findbugs</xmlOutputDirectory>
                    <effort>Max</effort>
                    <threshold>Low</threshold>
                    <excludeFilterFile>src/main/findbugs/findbugs-excludes.xml</excludeFilterFile>
                </configuration>
                <executions>
                    <execution>
                        <id>findbugs-run</id>
                        <phase>compile</phase>
                        <goals>
                            <goal>check</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</profile>

使用这种方法，您可以在需要时跨项目共享此排除文件，这可能是好事还是坏事，具体取决于您如何看待它:) 另外，考虑到这一点，如果您有一个专门的findbugs项目，您可以使用分类器创建不同类型的排除项，并根据上下文使用特定的分类器。它并不完美但它对我有用。

HTH，詹姆斯

Answer 3

我正在使用spotbugs，因为findbugs已过时，不再受支持。我在项目中遇到了同样的问题。

我的maven项目多模块结构与此类似：

parent-module:
  |
  -- sub-module-1
  |     |
  |     -- ...
  |     |
  |     --pom.xml
  |
  -- sub-module-2
  |     |
  |     -- ...
  |     |
  |     --pom.xml
  |
  -- ...
  |
  -- sub-module-n
  |     |
  |     -- ...
  |     |
  |     --pom.xml
  |
  -- ...
  |
  -- exclude-filter.xml
  |
  --pom.xml

spotbugs的{{1}}配置：

parent-module

否，您无法从... <build> ... <plugins> ... <plugin> <groupId>com.github.spotbugs</groupId> <artifactId>spotbugs-maven-plugin</artifactId> <version>4.0.0</version> <dependencies> <dependency> <groupId>com.github.spotbugs</groupId> <artifactId>spotbugs</artifactId> <version>4.0.2</version> </dependency> </dependencies> <configuration> <effort>Max</effort> <threshold>Low</threshold> <includeTests>true</includeTests> <xmlOutput>true</xmlOutput> <excludeFilterFile>exclude-filter.xml</excludeFilterFile> </configuration> <executions> <execution> <id>analyze-compile</id> <phase>test-compile</phase> <goals> <goal>check</goal> </goals> </execution> </executions> </plugin> ... </plugins> ... </build> ...或任何mvn test-compile开始parent-project，它将由sub-project检查源代码和测试源代码的问题。

考虑示例：https://github.com/koresmosto/mif

Answer 4

更好的替代方法是使用 maven-remote-resources-plugin 。我喜欢詹姆斯＆＃39;方法但是你需要调整clean插件来删除src文件夹中的解压缩文件。

根据James＆＃39;建议创建一个单独的项目，其中包含findbugs-excludes.xml并将以下内容添加到其pom文件中：

  <build>
    <plugins>
        <plugin>
            <artifactId>maven-remote-resources-plugin</artifactId>
            <version>1.5</version>
            <executions>
                <execution>
                    <goals>
                        <goal>bundle</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <includes>
                    <include>**/*.*</include>
                </includes>
            </configuration>
        </plugin>
    </plugins>
</build>

更新包含findbugs插件的pom文件：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-remote-resources-plugin</artifactId>
    <version>1.5</version>
    <executions>
        <execution>
            <id>process-remote-resources</id>
            <goals>
                <goal>process</goal>
            </goals>
            <configuration>
                <resourceBundles>
                    <resourceBundle>com.myproject:myartifactid:version</resourceBundle>
                </resourceBundles>
            </configuration>
        </execution>
    </executions>
</plugin>
<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>findbugs-maven-plugin</artifactId>
    <configuration>
        ...
        ...
        <excludeFilterFile>${project.build.directory}/maven-shared-archive-resources/findbugs-exclude.xml</excludeFilterFile>
        ...        
    </configuration>
</plugin>

别忘了更改 com.myproject：myartifactid：version

maven-remote-resources-plugin将您的共享文件复制到目标文件夹，因此无需更改maven-clean-plugin的默认行为。

Answer 5

如果您没有要排除的大量文件/包，只需禁止一些警告 - 尝试使用@SuppressFBWarning注释。这应该适用于甚至多个模块项目，并且可以在需要的特定项目和文件中添加注释。

@SuppressFBWarning的依赖关系

    <dependency>
        <groupId>com.google.code.findbugs</groupId>
        <artifactId>annotations</artifactId>
        <version>3.0.1</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>com.google.code.findbugs</groupId>
        <artifactId>jsr305</artifactId>
        <version>3.0.1</version>
        <scope>provided</scope>
    </dependency>

Findbugs Maven插件 - findbugs-exclude包含多个项目

5 个答案: