如何使类似插件的架构可运行?

How to make a plugin-like architecture runnable?

我们有几个遗留 Java 项目,我们将它们转换为 Maven 项目/模块。以前,所有项目都是 NetBeans 项目,没有真正的依赖项管理。外部依赖项存在于公司网络驱动器上,并作为 JAR 直接包含在每个模块的 NetBeans 项目中。对于内部依赖项,使用了简单的项目引用。构建所有内容是一件痛苦的事情,因为程序员必须以正确的顺序构建所有内容。

现在,我们可以打开IntelliJ IDEA和NetBeans中的所有Maven模块了。但是,我无法找出以特定方式组合不同模块和外部依赖项的最佳方式,这符合内部类似插件的结构。尤其是使用 NetBeans(必须可以使用两种 IDE 进行开发)。

这里是 git 存储库/项目结构的大致样子。模块的文件夹结构是每个模块的默认 Maven 结构。这个网站的列表功能太笨拙了,所以我把它作为截图...

我们有一个内部 Maven 存储库,可以使用 Maven 等进行构建。对于 Intellij IDEA,我可以 运行 并通过自定义 运行 配置为 customer1 调试最终产品,该配置将所需文件复制到所需结构中:

使用 IntelliJ IDEA,我可以调试软件,但我认为这种方法(我创建的自定义 IntelliJ 运行 配置,直接指向所有需要的 JAR 和文件)相当难看,对于 NetBeans 我找不到类似的“运行 配置”机制。

因此,我尝试通过创建一个新的“Customer1Runnable”Maven 项目来实现此构建过程,作为一种构建描述,它指向所有需要的 Maven 模块。基于此,我相信我可以实现并自动创建所需的软件结构。因此,使用 maven-assembly-plugin,将所有模块复制到插件文件夹中,并将模块的所有依赖项复制到 Customer1Runnable 项目内的 lib 文件夹中。

首先,我的假设是否正确,这是 maven-assembly-plugin 的可能用例?

项目本身没有任何源文件,只有一个pom.xml和assembly-config.xml描述符。我将 assembly-plugin 附加到 package 阶段。当 运行 使用 mvn package 命令构建所有连接的模块时,但是为了执行程序集插件,我得到以下输出:

对于初学者,我只尝试在程序集描述符中包含一个模块。这是它的 XML (opicom-assembly.xml):

<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.0"
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.0 http://maven.apache.org/xsd/assembly-2.1.0.xsd">
    <id>opicom-assembly</id>
    <formats>
        <format>dir</format>
    </formats>
    <includeBaseDirectory>false</includeBaseDirectory>
    <moduleSets>
        <moduleSet>
            <useAllReactorProjects>true</useAllReactorProjects>
                <includes>
                    <include>my.company.reporting:module1</include>
                </includes>
        </moduleSet>
    </moduleSets>
</assembly>
Customer1Runnable 项目的

pom.xml

 <?xml version="1.0" encoding="UTF-8"?>
<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>
    <version>1.6</version>
    <groupId>my.company.customer1</groupId>
    <artifactId>OpicomRunnable</artifactId>
    <packaging>pom</packaging>
    <name>OpicomRunnable</name>
    
    <repositories>
        <repository>
            <id>Company-Maven-Repo</id>
            <url>file:\\MyCompany\TFSDrop\MavenRepo</url>
        </repository>
    </repositories>
    
    <modules>
        <module>../my.company.customer1.module1</module>
        <module>../my.company.customer1.module2</module>
        .
        .
        .
        <module>../../MyCompany_Common/Report/my.company.reporting.module1</module>
    </modules>  
    <build>
        <plugins>
            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.3.0</version>
                <inherited>true</inherited>
                <executions>
                    <execution>
                        <id>copy-dependencies</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <descriptors>
                        <descriptor>opicom-assembly.xml</descriptor>
                    </descriptors>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

模块的 pom 如下所示:

<?xml version="1.0" encoding="UTF-8"?>
<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>

    <parent>
        <groupId>my.company</groupId>
        <artifactId>reporting</artifactId>
        <version>1.3</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <artifactId>module1</artifactId>
    <version>1.3</version>
    <packaging>jar</packaging>



    <dependencies>
        <!-- external dependencies -->
        <dependency>
            <groupId>commons-pool</groupId>
            <artifactId>commons-pool</artifactId>
            <version>1.6</version>
        </dependency>
        <dependency>
            <groupId>com.oracle.database.jdbc</groupId>
            <artifactId>ojdbc8</artifactId>
            <version>21.1.0.0</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.3.0</version>
                <configuration>
                    <finalName>my-company-${project.artifactId}</finalName>
                    <appendAssemblyId>false</appendAssemblyId>
                    <outputDirectory>../build</outputDirectory>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

感谢您对我在这里做错了什么/如何使用 Maven 实现这一点的任何意见。

编辑: 根据要求,这里有一个示例项目作为 ZIP 文件。 https://drive.google.com/drive/folders/1ilJeTrOPgYgUTdOP0J4BQcBnPT5fls0k?usp=sharing 父目录 ModuleGroupCustomer 和 ModuleGroupCommon 在真实场景中确实代表 git 个存储库。 relative module path 造成的,因为应该是我的“运行 config”的maven项目指向两个存储库中的maven项目。

也许我对 Maven 有一般性的误解?我从类似于 .Net nuget 包的依赖管理用例的角度来考虑它,但也像普通的 NetBeans/Intellij 项目一样作为“项目配置”。

在日常开发中坚持使用现有的 NetBeans 项目是否更好?

经过漫长而乏味的反复试验过程,我找到了适合我的解决方案。所以我决定在线分享解决方案,以防其他人 运行 遇到类似问题。这是包含工作示例项目的最终 zip 存档的 link => 文件 CustomerRunnable_RunningAssemblyPluginWhosebugExample.zip https://drive.google.com/drive/u/0/folders/1ilJeTrOPgYgUTdOP0J4BQcBnPT5fls0k

我的错误是我误解了程序集插件的工作原理。我在聚合器 pom (Custommer运行nable) 中执行插件的方法是错误的,因为这个 maven 项目仅作为父 pom 存在。

Custommer运行nable pom.xml 将所有客户插件引用为模块。这些模块没有 Custommer运行nable 作为父级,而是不同的 pom。然后我创建了一个单独的 Maven 项目“分发”。发行版的 pom.xml 将所有插件(需要的客户 maven 模块)定义为依赖项。它还具有 Custommer运行nable pom.xml 作为父项。因此,当我 运行 NetBeans 中的项目时,所有连接的模块也会构建(如果需要)。

它还配置了程序集插件。程序集插件附加到 Maven package-phase 并因此与它一起执行。它还使用自定义程序集描述符,将所有先前定义的插件复制到正确的文件夹中。这是通过使用包含和排除模式的 dependencySets 来完成的。 有关详细信息,请参阅 https://maven.apache.org/plugins/maven-assembly-plugin/advanced-descriptor-topics.html。 因此,一个 dependencySet 使用 include 模式将所有插件的所有 jar 文件复制到 /plugin 文件夹。然后把这个方法反过来,把所有外部依赖的jar文件拷贝到一个/lib文件夹下。

描述符还定义了一些要复制到特定位置的额外文件。 exec-maven-plugin,因此我可以轻松地从 NetBeans 启动客户软件。我还没有设法根据所需的类路径参数正确配置执行插件。

最终结果如下所示:

另外值得注意的是,NetBeans 中“Build project”、“运行 project”和“Debug project”的配置需要稍作修改。 (右击模块“分布”->“属性”->点“动作”