从 FengNiao 中学习 Swift （五）

在从 FengNiao 中学习 Swift （一） 中介绍了 Swift Package Manager 的基本用法，然后创建了FengNiaoCopy 项目。
在从 FengNiao 中学习 Swift （二） 中主要介绍如何处理命令行的输入参数。
在从 FengNiao 中学习 Swift （三） 介绍 FengNiao 的字符串搜索规则和 swift 的 protocol 和 extension。
在从 FengNiao 中学习 Swift （四） 介绍 FengNiao 的图片资源搜索规则。
在这篇文章中主要介绍 FengNiao 如何取出项目中所有的资源字符串以及所有的图片资源，然后过滤掉未使用的图片资源。

查找字符串

在项目开发中，经常会在字符串中引用图片资源，为了避免出现误删除的情况，我们这里默认将所有代码文件中的字符串都当成图片资源来处理。在这里，我们将查找的结果存放在一个 Set 中。

    // 所有在使用的资源字符串
    func allUsedStringNames() -> Set {
        return usedStringNames(at: projectPath)
    }
    
    func usedStringNames(at path: Path) -> Set {
        guard let subPaths = try? path.children() else {
            print("Failed to get contents in path: \(path)".red)
            return []
        }
        
        var result = [String]()
        for subPath in subPaths {
            // 略过隐藏文件夹
            if subPath.lastComponent.hasPrefix(".") {
                continue
            }
            // 忽略的文件夹
            if excludedPaths.contains(subPath) {
                continue
            }
            // 对文件夹进行递归查找
            if subPath.isDirectory {
                result.append(contentsOf: usedStringNames(at: subPath))
            } else {
                // 是不是我们应该查找的文件，比如 .m .mm .swift
                let fileExt = subPath.extension ?? ""
                guard searchInFileExtensions.contains(fileExt) else {
                    continue
                }
                // 根据文件类型匹配合适的 searchRules
                let fileType = FileType(ext: fileExt)
                let searchRules = fileType?.searchRules(extensions: resourceExtensions) ??
                                  [PlainImageSearchRule(extensions: resourceExtensions)]
                
                let content = (try? subPath.read()) ?? ""
                result.append(contentsOf: searchRules.flatMap { $0.search(in: content) })
            }
        }
        
        return Set(result)
    }

查找图片资源

图片资源文件的查找主要是通过图片资源后缀名称来判断，遍历项目文件夹，查找合适的图片资源并以 [String: Set] 形式返回 ，key 是资源文件名字， value是文件路径。

    // 返回所有合适的资源文件,key 是资源文件名字 value是文件路径
    func allResourceFiles() -> [String: Set] {
        let find = ExtensionFindProcess(path: projectPath, extensions: resourceExtensions, excluded: excludedPaths)
        guard let result = find?.execute() else {
            print("Resource finding failed.".red)
            return [:]
        }
        
        var files = [String : Set]()
        fileLoop: for file in result {
            //跳过 bundle 里面的资源文件
            let dirPaths = regularDirExtensions.map{".\($0)/"}
            for dir in dirPaths where file.contains(dir) {
                continue fileLoop
            }
            //跳过一些有奇葩文件夹命名方式的文件，用非文件夹后缀的名字来命名文件夹，比如用 myfolder.png 来命名文件夹
            let filePath = Path(file)
            if let ext = filePath.extension, filePath.isDirectory && nonDirExtensions.contains(ext) {
                continue
            }
            
            let key = file.plainFileName(extensions: resourceExtensions)
            if let existing = files[key] {
                // Set 合并
                files [key] = existing.union([file])
            } else {
                files[key] = [file]
            }
        }
        
        return files
        
    }

过滤未使用的图片资源

有了所有的资源文件和所有的字符串，那么接下来就可以进行过滤了，凡是图片名字没有出现在字符串中的图片资源，我们基本可以认定图片资源是未被使用的。

  // 查找未使用的资源文件
    static func filterUnused(from all: [String: Set], used: Set) -> Set {
        let unusedPairs = all.filter { key,_ in
            return !used.contains(key) &&
                   !used.contains{$0.similarPatternWithNumberIndex(other: key) }
        }
        return Set( unusedPairs.flatMap{ $0.value })
    }
    
    // 查找未被使用的图片资源
    public func unusedFiles() throws -> [FileInfo] {
        // 参数判断
        guard !resourceExtensions.isEmpty else {
            throw FengNiaoError.noResourceExtension
        }
        
        guard !searchInFileExtensions.isEmpty else {
            throw FengNiaoError.noFileExtension
        }
        
        let allResources = allResourceFiles()
        let usedNames = allUsedStringNames()
        
        return FengNiaoCopy.filterUnused(from: allResources, used: usedNames).map( FileInfo.init )
    }

删除资源文件

找到了未被使用的图片资源，那么接下来就是删除这些图片文件了，删除之后还需要清理 project.pbxproj 里面的资源引用。

// 删除文件，保存删除成功文件的列表和删除失败文件的列表
    static public func delete(_ unusedFiles: [FileInfo]) -> (deleted: [FileInfo], failed :[(FileInfo, Error)]) {
        var deleted = [FileInfo]()
        var failed = [(FileInfo,Error)]()
        for file in unusedFiles {
            do {
                try file.path.delete()
                deleted.append(file)
            } catch {
                failed.append((file, error))
            }
        }
        return (deleted, failed)
    }
    // 删除 project.pbxproj 里面的资源引用
    static public func deleteReference(projectFilePath: Path, deletedFiles: [FileInfo]) {
        if let content: String = try? projectFilePath.read() {
            let lines = content.components(separatedBy: .newlines)
            var results:[String] = []
            // 逐行读取 project.pbxproj 文件，
            // 若是 line 包含 image reference 则 line 不再写回 project.pbxproj 文件
            for line in lines {
                var containImage = true
                outerLoop: for file in deletedFiles {
                    if line.contains(file.fileName) {
                        containImage = false
                        continue outerLoop
                    }
                }
                if containImage {
                    results.append(line)
                }
            }
            let resultString = results.joined(separator: "\n")
            do {
                try projectFilePath.write(resultString)
            } catch {
                print(error)
            }   
        }
    }

总结

FengNiao 项目的主体功能大概就是这些了，当然在这个项目功能完成之后，最最最重要的功能就是测试了，FengNiao 的 Tests 文件夹里面有很多测试用例，大家可以自己参考。其他细节，这里就不再累赘，大家可以自行参考 FengNiao 的项目主页 https://github.com/onevcat/FengNiao。

参考

1. https://github.com/onevcat/FengNiao