regex - 使用正则表达式在 Kotlin 中进行 URL 解析

Question

如何匹配字符串中的secret_code_data:

xeno://soundcloud/?code=secret_code_data#

我试过了

val regex = Regex("""xeno://soundcloud/?code=(.*?)#""")
field = regex.find(url)?.value ?: ""

没有运气。我猜测 ？在代码可能成为问题之前，我应该以某种方式逃避它。你能帮忙吗？

Answer 1

这里有三个选项，第一个提供一个很好的正则表达式来满足你的需求，另外两个用于解析 URL，使用正则表达式的替代方法，它可以正确处理 URL 组件编码/解码。

使用正则表达式解析

注意: Regex 方法在大多数用例中是不安全的，因为它不能正确地将 URL 解析为组件，然后分别解码每个组件。通常，您无法将整个 URL 解码为一个字符串然后安全地解析，因为某些编码字符可能会在以后混淆 Regex。这类似于使用正则表达式(如 described here)解析 XHTML。请参阅下面的 Regex 替代方法。

这是一个清理过的正则表达式，作为一个单元测试用例，可以安全地处理更多 URL。这篇文章的最后是一个单元测试，您可以对每种方法使用。

private val SECRET_CODE_REGEX = """xeno://soundcloud[/]?.*[\?&]code=([^#&]+).*""".toRegex()
fun findSecretCode(withinUrl: String): String? =
        SECRET_CODE_REGEX.matchEntire(withinUrl)?.groups?.get(1)?.value

这个正则表达式处理这些情况:

• 路径中有和没有尾随 /
• 有和没有片段
• 参数作为参数列表中的第一个、中间或最后一个参数
• 参数作为唯一参数

请注意，在 Kotlin 中创建正则表达式的惯用方法是 someString.toRegex() .它和其他扩展方法可以在 Kotlin API Reference 中找到。 .

使用 UriBuilder 或类似类解析

这是一个使用 UriBuilder 的示例来自 Klutter library for Kotlin .此版本处理 encoding/decoding包括 Java 标准 URI 类未处理的更现代的 JavaScript unicode 编码(它有很多问题)。这是安全、简单的，您无需担心任何特殊情况。

实现:

fun findSecretCode(withinUrl: String): String? {
    fun isValidUri(uri: UriBuilder): Boolean = uri.scheme == "xeno"
                    && uri.host == "soundcloud"
                    && (uri.encodedPath == "/" || uri.encodedPath.isNullOrBlank())
    val parsed = buildUri(withinUrl)
    return if (isValidUri(parsed)) parsed.decodedQueryDeduped?.get("code") else null
}

Klutter uy.klutter:klutter-core-jdk6:$klutter_version 工件很小，并且包括一些其他扩展，包括现代化的 URL 编码/解码。 (对于 $klutter_version 使用 most current release )。

使用 JDK URI 类解析

这个版本有点长，说明需要自己解析原始查询字符串，解析后解码，然后找到查询参数:

fun findSecretCode(withinUrl: String): String? {
    fun isValidUri(uri: URI): Boolean = uri.scheme == "xeno"
            && uri.host == "soundcloud"
            && (uri.rawPath == "/" || uri.rawPath.isNullOrBlank())

    val parsed = URI(withinUrl)
    return if (isValidUri(parsed)) {
        parsed.getRawQuery().split('&').map {
            val parts = it.split('=')
            val name = parts.firstOrNull() ?: ""
            val value = parts.drop(1).firstOrNull() ?: ""
            URLDecoder.decode(name, Charsets.UTF_8.name()) to URLDecoder.decode(value, Charsets.UTF_8.name())
        }.firstOrNull { it.first == "code" }?.second
    } else null
}

这可以写为 URI 类本身的扩展:

fun URI.findSecretCode(): String? { ... }

在正文中删除 parsed 变量并使用 this 因为您已经有了 URI，那么您就是 URI。然后调用:

val secretCode = URI(myTestUrl).findSecretCode()

单元测试

鉴于上述任何功能，运行此测试以证明其有效:

class TestSo34594605 {
    @Test fun testUriBuilderFindsCode() {
        // positive test cases

        val testUrls = listOf("xeno://soundcloud/?code=secret_code_data#",
                "xeno://soundcloud?code=secret_code_data#",
                "xeno://soundcloud/?code=secret_code_data",
                "xeno://soundcloud?code=secret_code_data",
                "xeno://soundcloud?code=secret_code_data&other=fish",
                "xeno://soundcloud?cat=hairless&code=secret_code_data&other=fish",
                "xeno://soundcloud/?cat=hairless&code=secret_code_data&other=fish",
                "xeno://soundcloud/?cat=hairless&code=secret_code_data",
                "xeno://soundcloud/?cat=hairless&code=secret_code_data&other=fish#fragment"
        )

        testUrls.forEach { test ->
            assertEquals("secret_code_data", findSecretCode(test), "source URL: $test")
        }

        // negative test cases, don't get things on accident

        val badUrls = listOf("xeno://soundcloud/code/secret_code_data#",
                "xeno://soundcloud?hiddencode=secret_code_data#",
                "http://www.soundcloud.com/?code=secret_code_data")

        badUrls.forEach { test ->
            assertNotEquals("secret_code_data", findSecretCode(test), "source URL: $test")
        }
    }