传递较少可变参数时的运行时错误字符串（格式：）

Question

最近在firebase crashlytics中我们发现了以下问题：

let a = "1-> %@" // Strings are located in Localized.strings, we already know them
let b = "1-> %@, 2-> %@" 

let aStr = String(format: a, "hello") // Works fine
let bStr = String(format: b, "hello") // Run time error on certain machine (M1, physical device)

看起来当将较少的可变参数传递给String(format:) 时，您会在 M1 和物理设备上遇到运行时崩溃。

我想知道是否有任何方法可以避免来自 localised.strings 的字符串出现这些运行时错误。

最好在编译时捕捉到这一点。 您将如何面对这个问题？

Answer 1

没有为格式字符串提供足够的参数将导致未定义的行为（它可能会崩溃，也可能不会 - 没有办法知道）。 这是一个编程错误，但由于它们的动态特性，您目前不会收到编译时警告。

但是，如果没有提供足够的格式参数，我们可以编写一个小帮助程序确定性地崩溃。 请注意，这不是一个完美的实现，可能需要根据您的要求进行调整。

extension String {

    // https://en.wikipedia.org/wiki/Printf_format_string
    private static var formatCharacters: Set<Character> {
        "@diufFeEgGxXoscpaAn".reduce(into: []) { $0.insert($1) }
    }

    static func safely(format template: String, _ params: CVarArg...) -> String {
        var potentialPattern = false
        var patternCount = 0
        for char in template {
            switch char {
            case "%":
                // %% or %
                potentialPattern.toggle()
            case let x where formatCharacters.contains(x) && potentialPattern:
                patternCount += 1
                potentialPattern = false
            case let x where !x.isWhitespace:
                potentialPattern = false
            default:
                break
            }
        }
        assert(
            patternCount <= params.count,
            "Not enough parameters passed to format String. Found \(params.count), expected at least \(patternCount)."
        )
        return String(format: template, arguments: params)
    }
    
}

如果没有提供足够的参数，我们就会崩溃：

let f = String.safely(format: "%@ %@", "nice")
// Assertion failed: Not enough parameters passed to format String. Found 1, expected at least 2.