[Swift] FileManager

이번 포스팅에서는 swift에서 기본적으로 제공하는 FileManager라는 클래스를 이용해서, 파일을 저장하고 불러오고, 삭제하는 걸 해보려고 해요. 일반적으로 로컬에 이미지, 음원, 텍스트 등 파일을 저장했다 불러왔다 할때는 FileManager를 통해 로컬에 파일을 저장하고, 파일 경로에 대한 정보를 CoreData 등을 통해서 관리하죠. 이 중에 로컬에 파일을 저장하는 단계를 해보려고 해요!

 

바로 시작할께요!

 

File Domain

먼저 macOS, iOS 등 apple의 파일 시스템은 기본적으로 domain으로 파일들의 위치를 결정해요. 이 domain은 기본적으로 user, local, network, system 4개의 domain을 제공해요. 아래 그림처럼요!

 

예를 들면, 터미널을 열면 최상단 루트에서 pwd를 치면 /Users/userName이 나오죠?? 즉 이건 사용자들은 기본적을 user domain에서 대부분의 작업을 수행하게 된다는 의미에요.

 

 

FileManager

위에서 간단히 설명했듯이, Swift에서 파일관리를 위해 제공하는 클래스입니다. default를 통해 싱글톤 인스턴스를 만들 수 있어요.

let fileManager = FileManager.default

urls 라는 메소드를 통해서, 요청하는 도메인에서 지정된 디렉토리에 대한 URL 배열을 가져올 수 있어요.

let documentUrl = fileManager.urls(for: .documentDirectory, in: .userDomainMask)[0]

for 파라미터는 SearchPathDirectory 타입이에요. enum타입으로 정의되어 있고, desktopDirectory, documentDirectory, downloadsDirectory 등 실제로 우리가 친숙히 사용하던 디렉토리를 의미합니다. 자세한 사항은 여기를 참고해주세요!

in 파라미터는 SearchPathDomainMask 타입으로 역시 enum으로 정의되어 있어요. 이게 바로 저 위에서 설명했던 4가지 Domain 중 어떤 도메인을 사용할건지 선택해주면 되요. 역시 자세한 사항은 여기를 참고해주세요!

 

documentsUrl을 출력해보면, 이렇게 실제로 User 도메인의 로컬의 어떤 주소공간을 나타내고 있어요. (Playground로 작성하는 거라 XCPGDevices 이런 것들이 보이네요 😂)

file:///Users/kyungtaekim/Library/Developer/XCPGDevices/5B2871C9-A4D8-492A-8048-71634DAAA618/data/Containers/Data/Application/9700E544-1347-4244-8AB0-F7C98086112E/Documents/

 

그럼 우리가 사용할 로컬 경로를 선택했으니, 그 경로에 여러 작업들을 시도해볼거에요.

 

먼저 폴더를 생성해볼게요.

let directoryPath = documentUrl.appendingPathComponent("NewDirectory")

appendingPathComponent(폴더/파일명) 메소드를 통해서, 우리가 위에서 정했던 저장 경로(documentUrl)에 만들 어떤 폴더/파일명을 정해줍니다. 그리고 directoryPath 이녀석을 출력해보면

 

documentsUrl/NewDirectory

이렇게 위에서 봤던 documentsUrl 하위에 경로 혹은 파일을 나타내고 있어요.

do {
    if !fileManager.fileExists(atPath: directoryPath.path) {
        try fileManager.createDirectory(atPath: directoryPath.path, withIntermediateDirectories: false, attributes: nil)
    }
} catch {
    print("create folder error. do something")
}

그 경로에 createDirectory 메소드를 통해 폴더를 만들 수 있어요. atPath 파라미터는 경로를 나타내고, withIntermediateDirectories 파라미터는 "중간 디렉토리들도 추가할거야?" 를 나타내고, attributes 파라미터는 해당 폴더로의 접근권한, 그룹 등의 폴더 속성이에요. 폴더는 새로 만들때 이미 존재하면 생성에 실패해서, catch문으로 진입해요. 그래서 fileExists() 메소드로 먼저 해당 경로에 존재하는지를 체크한 후에 만들어 줘야합니다.

 

그럼 우리가 만든 폴더에 파일을 추가해볼게요.

let filePath = directoryPath.appendingPathComponent("NewFile.txt")

동일하게 appendingPathComponent 메소드를 통해 파일명을 지정해줍니다. 여기서 중요한 점은 파일은 확장자를 같이 써줘야해요. 확장자를 써주지 않아도 저장은 되지만, 읽어올 수가 없어요 😭

let textString = NSString(string: "here is new file")

do {
    if !fileManager.fileExists(atPath: filePath.path) {
        try textString.write(to: filePath, atomically: true, encoding: String.Encoding.utf8.rawValue)
    }
} catch {
    print("create file error. do something")
}

textString에 "here is new file" 이라고 내용을 작성하고, 이 내용을 위에서 만들었던 "NewFile.txt"에 write 메소드를 통해서 작성해줄 수 있어요. 여기서 한가지 유의해야 할 점은, 위에서 폴더 생성할때는 이미 경로가 존재하면 폴더 생성에 실패한다고 했죠?? 근데 파일의 경우에는 이미 파일이 있어도 덮어쓰기를 해버리니, 상황에 따라 fileExists를 사용해 덮어쓰는 걸 막아 주는 것도 고려해보세요~!

 

터미널에서 지금 잘 되고 있는지 중간점검 한번 해볼게요~~~ 의도대로 잘 저장되고 있네요!! 👍

 

이제 파일 저장까지 했으니, 저장했던 파일을 읽어와볼게요!

do {
    if fileManager.fileExists(atPath: filePath.path) {
        let readString = try String(contentsOf: filePath, encoding: .utf8)
        print(readString) // here is new file
    }
} catch {
    print("read file error. do something")
}

이렇게 filePath에 있는 내용을 String으로 가져오면 됩니다. 이때 파일이 존재하지 않으면 catch 블럭으로 빠지게 되요. 역시 이번에도 파일이 존재하는지 먼저 체크를 해주는게 좋겠습니다 👍

 

마지막으로 우리가 만든 파일을 삭제해볼거에요.

do {
    if fileManager.fileExists(atPath: filePath.path) {
        try fileManager.removeItem(at: filePath)
    }
} catch {
    print("remove file error. do something")
}

이렇게 removeItem() 메소드를 통해서 삭제할 수 있어요. 이때도 파일이 해당 경로에 없으면 catch로 빠지니 파일이 존재하는지 먼저 체크를 해주도록 해요! 그리고 실제로 파일이 잘 삭제되었는지 확인도 해보구요~~ 👍

같은 방법으로 폴더도 삭제할 수 있어요!

do {
    if fileManager.fileExists(atPath: directoryPath.path) {
        try fileManager.removeItem(at: directoryPath)
    }
} catch {
    print("remove file error. do something")
}

역시나 잘 삭제되었는지 한번 확인 해주고요~~~ 모두 의도대로 잘 되었네요 👍👍

 

 

오늘은 이렇게 iOS의 기본적인 파일 구조에 대해서 알아보고, Swift에서 제공하는 FileManager 클래스를 이용해 폴더/파일을 로컬의 특정 경로에 추가/삭제하는 실습을 해봤습니다!

오늘도 누군가에게 도움이 되었길 바래요 🙏