java - 按 Artifact 版本向后兼容

Question

我正在开发一个包含三个 Maven 项目的 RESTful 网络应用程序。这是我的 Maven 设置(从一些细节中删除)

客户端(第二版):

<project>
    <groupId>com.mycompany.app</groupId>
    <artifactId>app-client</artifactId>
    <version>2.0</version>
    ...
    <dependency>
        <groupId>com.mycompany.app</groupId>
        <artifactId>app-model</artifactId>
        <version>2.0</version>
    </dependency>
</project>

模型(第二版):

<project>
    <groupId>com.mycompany.app</groupId>
    <artifactId>app-model</artifactId>
    <version>2.0</version>
</project>
...
<plugin>
    <groupId>org.jvnet.jaxb2.maven2</groupId>
    <artifactId>maven-jaxb2-plugin</artifactId>
    <configuration>
        <generatePackage>com.mycompany.app.model.v2</generatePackage>
    </configuration>
</plugin>

Webapp(第二版):

<project>
    <groupId>com.mycompany.app</groupId>
    <artifactId>app-webapp</artifactId>
    <version>2.0</version>
    ...
    <dependency>
        <groupId>com.mycompany.app</groupId>
        <artifactId>app-model</artifactId>
        <version>1.0</version>
    </dependency>
    <dependency>
        <groupId>com.mycompany.app</groupId>
        <artifactId>app-model</artifactId>
        <version>2.0</version>
    </dependency>
</project>

对于每个版本，我都会更新模型的包名称以确保类名唯一。

com.mycompany.app:app-model:1.0 中的 Foo 类

package com.mycompany.app.model.v1;

public class Foo {
    private String name;
}

com.mycompany.app:app-model:2.0 中的 Foo 类

package com.mycompany.app.model.v2;

public class Foo {
    private String name;
    private int age;
}

在第一个版本中一切正常，因为 webapp 只依赖于 com.mycompany.app:app-model:1.0。在第二个版本中，maven 决定只依赖于 com.mycompany.app:app-model:2.0。这是正常行为，我理解为什么这在正常情况下是一件好事。尽管如此。我的 Backwords 兼容性代码(在服务器中)想要使用 com.mycompany.app:app-model:1.0 中的类，因为在该版本中发布的客户端使用这些类。新客户端(2.0 版)的代码希望使用 com.mycompany.app:app-model:2.0 类。

我确定有一种方法可以欺骗 Maven 依赖于两者，但是如何呢？通常当我遇到这些情况时，我的脑海里就会响起警报，而且我解决问题的方式通常有问题。但我似乎无法在这里找到另一种方法，它不包括其他“更大”的缺点:(想法有人吗？

Answer 1

所以，为了回答我自己的问题，这就是我想出的。我认为它非常简单，开箱即用。

最初我有 3 个人工制品:

• com.mycompany.app:app-client
• com.mycompany.app:app-model
• com.mycompany.app:app-webapp

最后我又介绍了一件 Artifact :

• com.mycompany.app:app-depend

此 Artifact 唯一的工作是将所有已发布的模型 Artifact 捆绑到一个可靠的 Artifact 中。为此，我遵循了 Esko 的建议并使用了 maven 插件:

• org.apache.maven.plugins:maven-dependency-plugin

目标是打开。这会将所有 .class 文件放在 target 下的一个目录中，因为我确保每个模型发布都在一个独特的包中生成类，所以它运行良好，没有任何覆盖。我只包含了 .class 文件并省略了所有其他文件(MANIFEST.MF、pom.xml 和 pom.properties)

在那之后，trix 就很简单了。我所要做的就是向 Artifact 添加资源，因为它不包含任何其他来源，所以它成为了一个新的可靠 Artifact 。不错!

现在，为了让所有这些都按照我想要的方式工作，我将新 Artifact 声明为我的 webapp Artifact 中的依赖项，使我能够访问模型所有版本中的所有类。另一方面，客户端仍然只需要依赖模型，因为客户端只对最新的模型版本感兴趣(发布时)。

我还设法设计了 web 应用程序，以便如果来自版本 1 的客户端调用 web 应用程序，他会在模型版本 1 中得到响应，他理解这一点。同时，当版本 2 的客户端调用 webbap 时，他会在模型版本 2 中得到响应，这是他理解的。这一直是目标，我认为这将促进我的 api 的版本控制。

我应该提一下，webapp 有它自己的域模型(独立但类似于表示模型)，因此所有请求都会完成从域到表示的转换。对于第 1 版，这两个模型几乎相同，但在第 2 版中，域发生了变化，(最新的)演示文稿也发生了变化。 Web 应用程序最好将域转换为表示模型 1 和 2，但模型 1 可能没有所有信息。现在，如果域模型变化太大以至于尝试将其转换为表示模型 1 没有任何意义，我认为是时候停止支持该模型了...

依赖的 maven pom 最终看起来像这样(对于版本 2)

<project>

  <groupId>com.mycompany.app</groupId>
  <artifactId>app-depend</artifactId>
  <version>2.0</version>
  <packaging>jar</packaging>

  <build>
    <resources>
      <resource>
        <!-- this is where 'unpack' puts the files -->
        <directory>${project.build.directory}/dependency</directory>
        <filtering>false</filtering>
      </resource>
    </resources>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-dependency-plugin</artifactId>
        <version>2.5.1</version>
        <executions>
          <execution>
            <id>unpack</id>
            <!-- we must do the 'unpack' before the building the jar -->
            <phase>generate-sources</phase>
            <goals>
              <goal>unpack</goal>
            </goals>
            <configuration>
              <artifactItems>
                <artifactItem>
                  <groupId>com.mycompany.app</groupId>
                  <artifactId>app-model</artifactId>
                  <version>1.0</version>
                  <type>jar</type>
                  <includes>com/mycompany/app/model/v1/**</includes>
                </artifactItem>
                <artifactItem>
                  <groupId>com.mycompany.app</groupId>
                  <artifactId>app-model</artifactId>
                  <version>2.0</version>
                  <type>jar</type>
                  <includes>com/mycompany/app/model/v2/**</includes>
                </artifactItem>
                <!-- future releases will go here -->
              </artifactItems>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

</project>

这就是 IT 人员!