此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Integration 6.5.1! |
Zip 支持
此 Spring Integration 模块提供 Zip(非)压缩支持。 压缩算法实现基于 ZeroTurnaround ZIP 库。 提供以下组件:
项目需要此依赖项:
-
Maven
-
Gradle
<dependency>
<groupId>org.springframework.integration</groupId>
<artifactId>spring-integration-zip</artifactId>
<version>7.0.0-SNAPSHOT</version>
</dependency>
compile "org.springframework.integration:spring-integration-zip:7.0.0-SNAPSHOT"
命名空间支持
Spring Integration Zip 模块中的所有组件都提供命名空间支持。 为了启用命名空间支持,您需要导入 Spring Integration Zip 模块的模式。 以下示例显示了典型的设置:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:int="http://www.springframework.org/schema/integration"
xmlns:int-zip="http://www.springframework.org/schema/integration/zip"
xsi:schemaLocation="http://www.springframework.org/schema/beans
https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/integration
https://www.springframework.org/schema/integration/spring-integration.xsd
http://www.springframework.org/schema/integration/zip
https://www.springframework.org/schema/integration/zip/spring-integration-zip.xsd">
</beans>
(解)拉链转换器
这ZipTransformer
为这些类型的输入实现压缩功能payload
:File
,String
,byte[]
和Iterable
.
在输入中,数据类型可以作为Iterable
.
例如,压缩包含字符串、字节数组和文件的集合应该很容易。
重要的是要注意,目前不支持嵌套的可迭代对象。
这ZipTransformer
可以通过设置多个属性进行自定义:
-
compressionLevel
- 设置压缩级别。 默认值为Deflater#DEFAULT_COMPRESSION
. -
useFileAttributes
- 指定文件名是否应用于 zip 条目。 -
fileNameGenerator
- 用于根据请求消息生成原始文件名。 默认为DefaultFileNameGenerator
. 这.zip
扩展名添加到目标 zip 文件名的此名称中。 除非它已经作为该生成器的结果而存在。
此外,一个ZipHeaders.ZIP_ENTRY_FILE_NAME
和ZipHeaders.ZIP_ENTRY_LAST_MODIFIED_DATE
可以为 zip 条目的名称及其lastmodified
属性。
如果未提供,则条目名称是fileNameGenerator
和lastmodified
回退到当前日期和时间。
如果请求消息的有效负载是Iterable
,则此条目名称将修改为索引,以1
.
例如,要压缩一个简单的test.txt
文件转换为test.txt.zip
,只有这个配置就足够了:
-
Java DSL
-
Kotlin DSL
-
Groovy DSL
-
Java
-
XML
@Bean
public IntegrationFlow zipFlow() {
return IntegrationFlow
.from("zipChannel")
.transform(new ZipTransformer())
.get();
}
@Bean
fun zipFlow() =
integrationFlow("zipChannel") {
transform(ZipTransformer())
}
@Bean
zipFlow() {
integrationFlow 'zipChannel',
{
transform new ZipTransformer()
}
}
@Transformer(inputChannel = "zipChannel")
@Bean
ZipTransformer zipTransformer() {
return new ZipTransformer();
}
<int-zip:zip-transformer input-channel="zipChannel"/>
看ZipTransformer
Javadocs 了解更多信息。
一UnZipTransformer
支持这些输入payload
:File
,byte[]
和InputStream
.
解压缩数据时,一个expectSingleResult
属性。
如果设置为true
并且超过1
zip 条目,则MessagingException
将被提高。
此属性还会影响有效负载的返回类型。
如果设置为false
(默认),则有效负载将是SortedMap
如果true
,但是,将返回实际的 zip 条目。
可以在UnZipTransformer
:
-
deleteFiles
- 如果有效负载是File
,则此属性指定是否在转换后删除 File。 默认值为false
. -
ZipResultType
- 定义转换后返回的数据的格式。 可用选项包括:File
,byte[]
. -
workDirectory
- 当ZipResultType
设置为ZipResultType.FILE
. 默认情况下,此属性设置为包含子目录的系统临时目录ziptransformer
.
例如,要压缩一个简单的test.zip
文件到其条目的映射中,只有这个配置就足够了:
-
Java DSL
-
Kotlin DSL
-
Groovy DSL
-
Java
-
XML
@Bean
public IntegrationFlow unzipFlow() {
return IntegrationFlow
.from("unzipChannel")
.transform(new UnZipTransformer())
.get();
}
@Bean
fun unzipFlow() =
integrationFlow("unzipChannel") {
transform(UnZipTransformer())
}
@Bean
unzipFlow() {
integrationFlow 'unzipChannel',
{
transform new UnZipTransformer()
}
}
@Transformer(inputChannel = "unzipChannel")
@Bean
UnZipTransformer unzipTransformer() {
return new UnZipTransformer();
}
<int-zip:unzip-transformer input-channel="unzipChannel"/>
解压缩分离器
这UnZipResultSplitter
在 zip 文件包含1
进入。
从本质上讲,它必须用作上述之后集成流程的下一步UnZipTransformer
.
它仅支持Map
作为输入数据,并将每个条目发送到outputChannel
跟FileHeaders.FILENAME
和ZipHeaders.ZIP_ENTRY_PATH
头。
以下示例演示了拆分解压缩结果的简单配置:
-
Java DSL
-
Kotlin DSL
-
Groovy DSL
-
Java
-
XML
@Bean
public IntegrationFlow unzipSplitFlow(Executor executor) {
return IntegrationFlow
.from("unzipChannel")
.transform(new UnZipTransformer())
.split(new UnZipResultSplitter())
.channel(c -> c.executor("entriesChannel", executor))
.get();
}
@Bean
fun unzipFlow(executor: Executor) =
integrationFlow("unzipChannel") {
transform(UnZipTransformer())
split(UnZipResultSplitter())
channel { executor("entriesChannel", executor) }
}
@Bean
unzipFlow(Executor executor) {
integrationFlow 'unzipChannel',
{
transformWith {
ref new UnZipTransformer()
}
splitWith {
ref new UnZipResultSplitter()
}
channel { executor 'entriesChannel', executor }
}
}
@Transformer(inputChannel = "unzipChannel", outputChannel = "splitChannel")
@Bean
UnZipTransformer unzipTransformer() {
return new UnZipTransformer();
}
@Spitter(inputChannel = "splitChannel", outputChannel = "entriesChannel")
@Bean
UnZipResultSplitter unZipSplitter() {
return new UnZipResultSplitter();
}
@Bean
ExecutorChannel entriesChannel(Executor executor) {
return new ExecutorChannel(executor);
}
<int:chain input-channel="unzipChannel" output-channel="entriesChannel">
<int-zip:unzip-transformer/>
<int:splitter>
<bean class="org.springframework.integration.zip.splitter.UnZipResultSplitter"/>
</int:splitter>
</int:chain>
<int:channel id="entriesChannel">
<int:dispatcher task-executor="executor"/>
</int:channel>