java - 如何在库初始化时设计与用户无关的错误状态？

Question

我正在制作一个最小的库，用于处理查找 Steam 并处理其在用户磁盘上的(多个)安装。

我的库所做的第一件事是在初始化时自动查找 steam 文件夹(基于操作系统)，如下所示:

val steam = Steam()

但是，如果找不到该文件夹​​会怎样？我应该抛出异常吗？返回空？

在我的例子中，类 init 抛出异常很奇怪，因为没有用户向构造函数提供参数。用 try block 包围类 init 也很糟糕。

所以我尝试将文件夹位置功能移动到一个单独的函数，如下所示:

class SteamFind(filepath: String? = null) {
    var location: File? = filepath?.let { File(it) } // probably better off as a string

    val `cool property`: String by lazy {
        require(location != null)
        "cool"
    }

    fun locateSteam() {
        location = File(steamLocator.findSteamFolder())
    }

    fun `does cool stuff`() {
        require(location != null) { "Steam location must not be null" }
    }
}

现在我已将故障点从构造函数移至函数，但这引入了其自身的问题。首先，如果我想要在代码中使用变量属性，我必须对所有属性都设置为 nullable，因为它们必须在某个时刻进行初始化，而惰性属性不适用于变量属性。 (我可能可以通过扩展惰性来解决这个问题，但这并不可取)其次，我必须将 require() 放在任何地方，这也是不可取的。第三，抛出错误仍然是一个好主意吗？ (当然我可以将 try 附加到函数名称后面)。实际上，我通过返回一个受歧视的联合来修复它:

fun tryLocateSteam(): Either<String> {
        val result = attempt { steamLocator.findSteamFolder() }
        return when (result) {
            is Either.Success -> {
                location = File(result.value)
                result
            }
            is Either.Error -> result
        }
    }

意味着用户可以选择忽略异常或检查异常并手动指定路径

val s = SteamFind().apply { tryLocateSteam() }
// or
val s = SteamFind()
when (s.tryLocateSteam()) {
    is Either.Success -> //stuff
    is Either.Error -> //Manually assign the location property
}

所以，问题是:有没有更好的方法来完成我想做的事情，大概不需要检查“位置”的可空性、使变量可以为空，并且易于用户使用和理解？

Answer 1

In my case throwing exceptions is weird on class init because there are no user supplied params to the constructor.

老实说，我的答案是:那又怎样？此外，您可以添加用户提供的位置作为参数(null 表示库将尝试自动定位它):

class Steam(path: String? = null) {
    val location: File = if (path != null) {
        checkSteamIsThere(path) // throws if it isn't
        File(path)
    } else {
        locateSteam() // throws an exception if it can't locate Steam
    }
}

然后你可以这样做，例如，

val steam = try { 
    Steam() 
} catch(e: SteamNotFoundException) { 
    val path = // ask user to enter path somehow 
    Steam(path)
}