Spring Integration Groovy 支持教程

概述

Spring Integration 的 Groovy 支持允许开发者使用 Groovy 脚本语言实现集成逻辑，为路由、转换等集成场景提供灵活的动态脚本能力。本教程将循序渐进介绍如何在 Spring Integration 中使用 Groovy 脚本。

为何选择 Groovy？

• 动态性：无需编译即可修改脚本逻辑
• 简洁语法：相比 Java 减少样板代码
• 无缝集成：与 Spring 生态完美融合
• 性能优化：支持静态编译提升效率

---

环境配置

添加依赖

在 build.gradle.kts 中添加依赖：

dependencies {
    implementation("org.springframework.integration:spring-integration-groovy:6.5.1")
}

NOTE

从 Spring Integration 6.0 开始，官方提供了 Groovy DSL 用于定义集成流，这是更现代的配置方式

---

Groovy 基础配置

脚本过滤器示例

将 XML 配置转换为 Kotlin DSL：

@Configuration
class GroovyIntegrationConfig {

    @Bean
    fun filterFlow() = integrationFlow("referencedScriptInput") {
        filter<String>({ payload ->
            script("""
                // Groovy 脚本逻辑
                return payload == 'good'
            """.trimIndent())
        })
    }
}

重要区别

• 使用 int-groovy 命名空间而非通用脚本支持
• 不再需要 lang 属性指定语言类型
• 支持内联脚本和外部脚本文件

实际应用场景

订单验证流程：使用 Groovy 脚本动态验证订单数据

// 验证订单金额大于100且状态为NEW
return payload.amount > 100 && payload.status == 'NEW'

---

Groovy 对象自定义

使用 GroovyObjectCustomizer

通过自定义 GroovyObjectCustomizer 增强脚本能力：

@Configuration
class GroovyCustomizationConfig {

    @Bean
    fun groovyCustomizer() = GroovyObjectCustomizer { groovyObject ->
        // 注册自定义方法到 MetaClass
        groovyObject.metaClass.customMethod = { arg -> 
            "Processed: $arg" 
        }
    }

    @Bean
    fun serviceFlow() = integrationFlow("groovyChannel") {
        handle<Any>(script("""
            // 使用自定义方法
            customMethod(payload)
        """.trimIndent()) {
            customizer("groovyCustomizer")
        }
    }
}

访问 Spring Bean

直接在脚本中使用 Spring 管理的 Bean：

@Bean
fun entityManagerFlow() = integrationFlow {
    handle<Any>(script("""
        // 直接使用 EntityManager
        entityManager.persist(payload)
        payload
    """.trimIndent()))
}

IMPORTANT

脚本中使用的 entityManager 必须是 Spring 容器中已存在的 Bean

---

Groovy 脚本编译优化

静态编译 (@CompileStatic)

启用静态编译提升性能：

@Bean
@CompileStatic
fun staticCompiledFilter() = integrationFlow {
    filter<Map<String, Any>>(script("""
        // 必须通过 binding 访问变量
        binding.variables.headers.type == 'good'
    """.trimIndent())) {
        compileStatic = true
    }
}

编译前后性能对比

// 编译前 (动态)
headers.type == 'good'

// 编译后 (静态)
@CompileStatic
String filter(Map headers) {
    headers.type == 'good'
}
filter(headers)

高级编译器配置

自定义编译器设置：

@Bean
fun compilerConfig() = CompilerConfiguration().apply {
    // 添加静态编译转换
    compilationCustomizers.add(ASTTransformationCustomizer(CompileStatic))
    
    // 添加自定义导入
    addCompilationCustomizers(new ImportCustomizer().apply {
        addImports("com.example.CustomType")
    })
}

@Bean
fun customCompilerFlow() = integrationFlow {
    transform(script("""
        // 使用自定义类型
        new CustomType(payload)
    """.trimIndent())) {
        compilerConfiguration = "compilerConfig"
    }
}

注意事项

1. 自定义 compilerConfiguration 会覆盖 compileStatic 设置
2. 静态编译下必须通过 binding.variables 访问动态变量
3. 刷新检查 (refresh-check-delay) 与静态编译兼容

---

最佳实践与常见问题

推荐实践

推荐方式

// 通过绑定传递变量
script("""
    binding.variables['customVar'] = 'value'
    // 使用变量
""") {
    variables("customVar" to "value")
}

传统方式

// 直接使用未声明变量 (不推荐)
script("customVar = 'value'") 

常见问题解决

CAUTION

问题：脚本修改后未生效
解决方案：设置 refresh-check-delay 属性

script("file:/path/to/script.groovy") {
    refreshDelay = 5000 // 5秒刷新检查
}

CAUTION

问题：静态编译后变量访问失败
解决方案：使用 binding.variables 访问

// 错误方式
headers.type 

// 正确方式
binding.variables.headers.type 

---

总结

Spring Integration 的 Groovy 支持为集成解决方案提供了强大的动态脚本能力：

✅ 快速原型：无需编译即时修改脚本逻辑
✅ 无缝集成：直接访问 Spring 上下文中的 Bean
✅ 性能优化：通过静态编译接近 Java 性能
✅ 灵活扩展：支持自定义编译器和元编程

// 完整示例：Groovy 路由
@Bean
fun groovyRouterFlow() = integrationFlow {
    route<Message<*>>(script("""
        // 根据消息头路由
        if (headers.type == 'A') 'channelA'
        else 'channelB'
    """.trimIndent())) {
        compileStatic = true
    }
}

通过本教程，您已掌握在 Spring Integration 中使用 Groovy 脚本的核心技术。建议结合 Groovy 官方文档深入探索更多高级特性。