Ktlint 中字符串模板缩进与函数签名规则的冲突解析

在 Kotlin 代码格式化工具 Ktlint 的使用过程中，开发者可能会遇到字符串模板缩进(string-template-indent)与函数签名(function-signature)规则之间的冲突问题。本文将深入分析这一问题的成因，并提供临时解决方案。

问题现象

当开发者配置了 ktlint_function_signature_body_expression_wrapping = default 并尝试格式化包含多行字符串模板的函数时，Ktlint 会报告无法解决的格式冲突。典型的代码示例如下：

private fun buildSelectQuery(additionalWhereClause: String = "") =
    """
    SELECT
        $ID,
        $CREATED_AT,
        $CREATED_BY,
        $DELETED,
        $STATE
    FROM $SESSIONS
    WHERE $ID = :$ID
        AND $DELETED = false
        $additionalWhereClause
    """.trimIndent()

问题根源

这个冲突源于 Ktlint 内部两个格式化规则的优先级处理：

1. 函数签名规则：当函数体是单行表达式时，倾向于保持在同一行
2. 字符串模板缩进规则：要求多行字符串模板保持正确的缩进格式

在格式化过程中，这两个规则会相互影响，导致 Ktlint 无法确定应该优先应用哪个规则，从而产生格式化冲突。

临时解决方案

目前，开发者可以通过以下方式临时解决这个问题：

@Suppress("ktlint:standard:function-signature")
private fun buildSelectQuery(additionalWhereClause: String = "") =
    """
    SELECT
        $ID,
        $CREATED_AT,
        $CREATED_BY,
        $DELETED,
        $STATE
    FROM $SESSIONS
    WHERE $ID = :$ID
        AND $DELETED = false
        $additionalWhereClause
    """.trimIndent()

通过添加 @Suppress 注解，可以暂时禁用函数签名规则，让字符串模板缩进规则优先应用。

最佳实践建议

1. 对于包含多行字符串模板的函数，建议保持当前格式，即使需要添加 @Suppress 注解
2. 关注 Ktlint 的版本更新，这个问题已被识别为 bug 并将在未来版本修复
3. 在团队中统一格式化规则配置，避免因不同开发环境导致格式不一致

总结

Ktlint 作为 Kotlin 代码格式化工具，在大多数情况下能很好地处理代码格式问题。但在特定场景下，不同规则之间可能会产生冲突。理解这些冲突的成因并掌握临时解决方案，有助于开发者在等待官方修复的同时，保持代码的整洁和一致性。