ImageIO PSD库插件无法在jar内运行

时间:2018-12-29 13:21:13

标签: java maven javax.imageio

我正在使用ImageIO,正在尝试将代码打包到JAR中,但是,我(在进行一些调试后)发现打包的JAR内没有PSD插件

由于这个答案中的代码,我发现了: Add/remove ImageReader from jar to ImageIO-registry

在我的pom.xml中,我具有以下ImageIO依赖项:

   <dependency>
        <groupId>com.twelvemonkeys.imageio</groupId>
        <artifactId>imageio-bmp</artifactId>
        <version>3.4</version>
    </dependency>
    <dependency>
        <groupId>com.twelvemonkeys.imageio</groupId>
        <artifactId>imageio-psd</artifactId>
        <version>3.4</version>
    </dependency>
    <dependency>
        <groupId>com.twelvemonkeys.imageio</groupId>
        <artifactId>imageio-core</artifactId>
        <version>3.4</version>
    </dependency>
    <dependency>
        <groupId>com.twelvemonkeys.imageio</groupId>
        <artifactId>imageio-metadata</artifactId>
        <version>3.4</version>
    </dependency>

我使用的maven命令是:

clean compile assembly:single

请注意我用来调试的代码:

        ImageIO.scanForPlugins()
        IIORegistry.getDefaultInstance().registerApplicationClasspathSpis()
        val ir = ImageIO.getImageReadersByFormatName("PSD")
        while (ir.hasNext())
        {
            val r = ir.next() as ImageReader
            println(r)
        }

在IDE中打印的内容:

com.twelvemonkeys.imageio.plugins.psd.PSDImageReader@1963006a

当从命令行运行jar时,它不会打印任何内容,这使我相信PSD插件无法在JAR内运行,但是如何呢?

1 个答案:

答案 0 :(得分:3)

问题是目标assembly:single将您自己项目中的“所有内容”和所有引用的JAR合并到一个JAR中,但会跳过那里已经存在的文件。

ImageIO依靠Java的SPI /服务加载器机制,因此,插件将通过META-INF\services\javax.imageio.spi.ImageReaderSpi加载。但是,当使用这样的文件使用多个JAR并使用assembly:single时,将跳过其中一个“ wins”文件和来自其他JAR的文件。在您的项目中,imageio-bmpimageio-psd都确实有这样的文件,并且在生成的JAR中第一个“获胜”。 (似乎IDE会以其他顺序加载这些文件,并且正确的版本“ wins”,但这只是一个猜测。)

解决方案:Maven应该将所有META-INF\services\javax.imageio.spi.ImageReaderSpi文件合并到生成的JAR文件中的一个文件中。为此,Maven需要其他配置信息。

  1. 将文件descriptor.xml添加到项目的根目录,如下所示:
<?xml version="1.0" encoding="UTF-8"?>
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0" 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
    <!-- copied from jar-with-dependencies (http://maven.apache.org/plugins/maven-assembly-plugin/descriptor-refs.html#jar-with-dependencies) -->
    <id>jar-with-deps-merge-services</id>
    <formats>
        <format>jar</format>
    </formats>
    <includeBaseDirectory>false</includeBaseDirectory>
    <containerDescriptorHandlers>
        <containerDescriptorHandler>
            <handlerName>metaInf-services</handlerName>
        </containerDescriptorHandler>
    </containerDescriptorHandlers>
    <dependencySets>
        <dependencySet>
            <outputDirectory>/</outputDirectory>
            <useProjectArtifact>true</useProjectArtifact>
            <unpack>true</unpack>
            <scope>runtime</scope>
        </dependencySet>
    </dependencySets>
</assembly>

重要的部分是metaInf-services设置,用于合并META-INF\services中的文件。

  1. 在您的descriptor.xml中添加对pom.xml的引用:
[...]
<build>
    <plugins>
        <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>2.2.1</version>
            <configuration>
                <archive>
                    <manifest>
                        <mainClass>your.main.MainClass</mainClass>
                    </manifest>
                </archive>
                <descriptors>
                    <descriptor>descriptor.xml</descriptor>
                </descriptors>
            </configuration>
        </plugin>
    </plugins>
</build>

重要说明:

  • maven-assembly-plugin版本应为2.2.1,因为当前的3.x版本似乎不起作用。但是,如果确实需要,您可以尝试更新的2.2.x或2.x版本。我只尝试过2.2.1,它可以工作。
  • 如果需要,必须根据您的主类名称更改主类块。
  • 可以将描述符文件放置在项目中的其他目录中,但随后必须更改pom中的引用(相对于maven项目的根目录)。
  • 如果您的构建配置中有jar-with-dependencies,则应将其删除,因为描述符文件中包含该设置。

即使我在一个示例项目上尝试了此方法,该解决方案也可能并不完美,您可以根据需要进行调整,但是我希望这是一个合适的起点。