如何从 Kotlin 的资源中读取文本文件？

Question

我想用 Kotlin 编写一个 Spek 测试。测试应该从src/test/resources 文件夹中读取一个HTML 文件。怎么做？

class MySpec : Spek({

    describe("blah blah") {

        given("blah blah") {

            var fileContent : String = ""

            beforeEachTest {
                // How to read the file file.html in src/test/resources/html
                fileContent = ...  
            }

            it("should blah blah") {
                ...
            }
        }
    }
})

Answer 1

val fileContent = MySpec::class.java.getResource("/html/file.html").readText()

Answer 2

不知道为什么这么难，但我发现的最简单的方法（无需引用特定类）是：

fun getResourceAsText(path: String): String? =
    object {}.javaClass.getResource(path)?.readText()

如果找不到具有此名称的资源 (as documented)，则返回 null。

然后传入一个绝对网址，例如

val html = getResourceAsText("/www/index.html")!!

Answer 3

另一个稍微不同的解决方案：

@Test
fun basicTest() {
    "/html/file.html".asResource {
        // test on `it` here...
        println(it)
    }

}

fun String.asResource(work: (String) -> Unit) {
    val content = this.javaClass::class.java.getResource(this).readText()
    work(content)
}

Answer 4

稍微不同的解决方案：

class MySpec : Spek({
    describe("blah blah") {
        given("blah blah") {

            var fileContent = ""

            beforeEachTest {
                html = this.javaClass.getResource("/html/file.html").readText()
            }

            it("should blah blah") {
                ...
            }
        }
    }
})

Answer 5

Kotlin + Spring 方式：

@Autowired
private lateinit var resourceLoader: ResourceLoader

fun load() {
    val html = resourceLoader.getResource("classpath:html/file.html").file
        .readText(charset = Charsets.UTF_8)
}

Answer 6

使用谷歌 Guava 库Resources class:

import com.google.common.io.Resources;

val fileContent: String = Resources.getResource("/html/file.html").readText()

Answer 7

private fun loadResource(file: String) = {}::class.java.getResource(file).readText()

Answer 8

val fileContent = javaClass.getResource("/html/file.html").readText()

Answer 9

这是我喜欢的方式：

fun getResourceText(path: String): String {
    return File(ClassLoader.getSystemResource(path).file).readText()
}

Answer 10

这个顶级的 kotlin 函数无论如何都可以完成这项工作

fun loadResource(path: String): URL {
    return Thread.currentThread().contextClassLoader.getResource(path)
}

或者如果你想要更强大的功能

fun loadResource(path: String): URL {
    val resource = Thread.currentThread().contextClassLoader.getResource(path)
    requireNotNull(resource) { "Resource $path not found" }
    return resource
}

Answer 11

仅供参考：在所有上述情况下。 getResource() 是使用 nullable 的不安全方式。

没有在本地尝试过，但我更喜欢这种方式：

fun readFile(resourcePath: String) = String::class.java.getResource(resourcePath)?.readText() ?: "<handle default. or handle custom exception>"

甚至作为自定义数据类型函数

private fun String.asResource() = this::class.java.getResource(resourcePath)?.readText() ?: "<handle default. or handle custom exception>"

然后您可以直接在路径上调用，例如：

// For suppose
val path = "/src/test/resources"
val content = path.asResource()

Answer 12

您可能会发现 File 类很有用：

import java.io.File

fun main(args: Array<String>) {
  val content = File("src/main/resources/input.txt").readText()
  print(content)
}