Swift5中Bundle.main.url读取文件返回nil的问题咨询

我想写一个通用工具函数读取文件内容，但用Bundle.main.url时，file一直是nil；但如果创建类，用Bundle(for: xx).url(...)?.path的方式就能正常获取文件内容，这是什么问题？

相关代码 #

class ABC {

    func _getContentsByFileName(fileName: String, withExtension fileExt: String) -> String {
        guard let filePath = Bundle(for: ABC.self).url(forResource: fileName, withExtension: fileExt)?.path, 
              let content = try? String(contentsOfFile: filePath) else {
            print("Failed to read")
            return ""
        }
        return content
    }

    func readFile(fileName: String, withExtension fileExt: String) -> String {
        // 注：原代码中`_getContentsFromClass`应为笔误，推测是`_getContentsByFileName`
        return self._getContentsByFileName(fileName: "createSession", withExtension: "json")
    }
}

func getContentsByFileName(fileName: String, withExtension fileExt: String) -> String {
    // 注：原代码未声明`file`变量，且`String(decoding: file, as: UTF8.self)`用法错误
    let file = Bundle.main.url(forResource: fileName, withExtension: fileExt, subdirectory: "Data") // file is nil
    return file != nil ? (try? String(contentsOf: file!)) ?? "" : ""
}


let instance = ABC()
print(instance.readFile(fileName: "fileName", withExtension: "txt") )

print(getContentsByFileName(fileName: "fileName", withExtension: "txt"))

原因分析与解决办法 #

1. Bundle来源的核心差异

Bundle.main指向的是主应用程序的Bundle，而Bundle(for: ABC.self)获取的是当前类所在的Bundle（如果你的类是放在自定义Framework里，这个Bundle就是框架的Bundle）。

• 如果你的文件是添加到Framework的资源里，主Bundle根本找不到这些文件，只有类所在的框架Bundle才能访问到。
• 解决：如果工具函数要读取Framework里的文件，就用Bundle(for: 当前工具类.self)或者Bundle.module（Swift Package Manager环境下）来获取正确的Bundle。

2. 路径参数不匹配

工具函数里额外指定了subdirectory: "Data"，但类方法里没有这个参数。如果你的文件实际并不在主Bundle的Data子目录下，Bundle.main自然找不到文件。

• 解决：要么去掉工具函数里的subdirectory参数（和类方法保持一致），要么确认文件确实放在主Bundle的Data文件夹下，并且已经添加到项目的Copy Bundle Resources构建阶段。

3. 工具函数的语法错误

原工具函数存在两处明显错误：

• 未声明file变量就直接赋值；
• 直接用String(decoding: file, as: UTF8.self)转换URL是错误的，应该用String(contentsOf: URL)方法并处理异常。

修正后的通用工具函数示例 #

// 读取当前函数所在Bundle的文件（适合Framework环境）
func getContentsByFileName(fileName: String, withExtension fileExt: String) -> String {
    // 用当前工具函数所在的Bundle（如果是在类里就用Bundle(for: Self.self)）
    guard let fileURL = Bundle(for: type(of: self)).url(forResource: fileName, withExtension: fileExt) else {
        print("找不到指定文件")
        return ""
    }
    do {
        return try String(contentsOf: fileURL)
    } catch {
        print("文件读取失败：\(error.localizedDescription)")
        return ""
    }
}

// 如果确定要读取主Bundle的文件
func getMainBundleContents(fileName: String, withExtension fileExt: String, subdirectory: String? = nil) -> String {
    guard let fileURL = Bundle.main.url(forResource: fileName, withExtension: fileExt, subdirectory: subdirectory) else {
        print("主Bundle中找不到文件")
        return ""
    }
    do {
        return try String(contentsOf: fileURL)
    } catch {
        print("读取失败：\(error.localizedDescription)")
        return ""
    }
}

内容的提问来源于stack exchange，提问作者jacobcan118