기록하레이

[ iOS ] Keychain 사용해보기

kybeen — Fri, 7 Jun 2024 00:38:12 +0900

Keychain

애플에서 사용자 데이터를 안전하게 저장할 수 있도록 제공하는 암호화된 데이터베이스

Keychain Service API를 사용하면 키체인 안에 사용자 데이터를 저장할 수 있습니다.

안전하게 저장해야 하는 작은 데이터를 저장할 때 사용 - ex) 비밀번호, 암호키, 인증키, 메모 등
SandBox 밖에 데이터가 저장되기 때문에 앱을 삭제해도 데이터가 남아있음
디바이스가 Lock/Unlock되면 키체인도 같이 Lock/Unlock됨
Secure Enclave라는 암호화 기능을 사용하는 하드웨어에서 키체인 데이터를 관리함
Keychain Sharing을 통해 동일한 개발자에 속한 서로 다른 앱 간 키체인 공유가 가능

출처 : 애플 공식 문서

UserDefaults와 비교

Keychain은 UserDefaults와 대체로 유사하지만 다른 점이 몇 가지 있습니다.

UserDefaults로 저장되는 데이터는 plist에 저장되기 때문에 보안에 취약함
UserDefaults에 저장된 데이터는 앱 삭제 시 같이 삭제됨
UserDefaults는 앱이 시작될 때 plist 파일이 로드되어 싱글톤 형태로 접근하기 때문에, 데이터가 클 수록 로드 시 성능 저하가 발생
UserDefaults는 App Group을 통해 Extension 간 데이터 공유가 가능

그렇기 때문에 유저의 로그인 정보와 같이 민감한 정보들은 UserDefaults가 아닌 Keychain에 저장해주는 것이 좋습니다.

Keychain Item

키체인에 데이터를 저장할 때는 Keychain Item이라는 형태로 저장하게 됩니다.

즉, Keychain Item은 키체인에 저장하는 Data의 단위라고 할 수 있습니다.

비밀번호, 암호화 키 같은 정보를 키체인에 저장하고 싶을 때 Keychain Item으로 패키징
Keychain Item으로 패키징하면 데이터 자체(data) 뿐만 아니라, item의 접근성을 제어하고 검색할 수 있도록 public하게 볼 수 있는 arribute들이 제공됨
키체인 서비스는 키체인에서 data, attribute 모두에 대해 데이터 암호화 및 저장을 처리
- 나중에 승인된 프로세스는 키체인 서비스를 사용하여 item을 찾고, 데이터를 복호화할 수 있습니다.

출처 : 애플 공식 문서

Keychain Item class의 key-value

Keychain item은 password(비밀번호), cryptographic key(암호화 키), certificate(인증서) 등과 같이 저장하려는 데이터의 종류에 따라 다양한 class로 제공됩니다. (Swift 문법적 의미의 class가 아님)

item이 어떤 class인지에 따라서 적용 가능한 attribute와, 시스템을 통한 데이터의 암호화 여부 등이 결정됩니다.

키체인에서 item에 대한 CRUD 작업이 이루어질 때는 딕셔너리 형태로 쿼리를 만들어줘야 합니다.

자세한 내용은 아래에서 더 설명할 예정입니다.

아무튼 이 쿼리를 생성할 때 kSecClass 라는 key에 대한 value로 5가지 class 중 하나를 지정해줍니다.

쿼리 딕셔너리에서 item class를 지정하기 위한 key

// item의 class를 value로 갖는 딕셔너리 Key
let kSecClass: CFString

쿼리 딕셔너리에서 item class의 value로 줄 수 있는 값 (kSecClass key의 value)

// generic password item을 가리키는 값
let kSecClassGenericPassword: CFString

// Internet password item을 가리키는 값
let kSecClassInternetPassword: CFString

// certificate item을 가리키는 값
let kSecClassCertificate: CFString

// cryptographic key item을 가리키는 값
let kSecClassKey: CFString

// identity item을 가리키는 값
let kSecClassIdentity: CFString

Keychain Item attribute의 key-value

Keychain Item에는 저장할 데이터 뿐만 아니라 attribute들도 포함된다고 위에서 설명드렸습니다.

attribute를 통해 데이터를 나중에 검색할 수 있도록 하거나, 데이터가 사용·공유되는 방식 등을 제어할 수 있습니다.

item class에 따라 적용 가능한 attribute가 다르기 때문에 사용하려는 class에 맞게 attribute를 구성할 수 있어야 합니다.

Kechain CRUD 메서드

키체인에서 keychain item의 CRUD 작업 시에는 아래 4가지 메서드를 사용합니다.

// MARK: - Create: 키체인에 비밀정보 추가하기
func SecItemAdd(_ attributes: CFDictionary, _ result: UnsafeMutablePointer<CFTypeRef?>?) -> OSStatus

// MARK: - Read: 키체인에 저장된 Keychain item 찾기
func SecItemCopyMatching(_ query: CFDictionary, _ result: UnsafeMutablePointer<CFTypeRef?>?) -> OSStatus

// MARK: - Update: 키체인에 저장된 정보 변경하기
func SecItemUpdate(_ query: CFDictionary, _ attributesToUpdate: CFDictionary) -> OSStatus

// MARK: - Delete:  키체인에 저장된 정보 삭제하기
func SecItemDelete(_ query: CFDictionary) -> OSStatus

결과 처리

위 메서드들은 OSStatus라는 타입으로 결과에 대한 값을 반환하는데, 해당 타입은 정수 형식으로 되어 있기 때문에 값을 그냥 출력하는 것으로는 어떤 에러인지 제대로 파악하기 힘듭니다.

print() 시에 아래 함수를 사용하면 유의미한 에러 메시지를 확인 가능합니다.

SecCopyErrorMessageString(status, nil)

Keychain을 통해 User Secrets 정보를 관리하는 예시

애플 공식 문서를 따라가며 실제로 Keychain을 어떻게 사용하여 유저의 민감한 정보를 관리할 수 있는지 확인해봅시다.

키체인 서비스는 암호화된 저장소로 쉽게 접근할 수 있도록 해주기 때문에 최소한의 상호작용으로 좋은 사용자 경험을 제공할 수 있습니다.

감이 잘 오지 않을 수도 있으니 사용 예시로 확인해보겠습니다.

아래 다이어그램은 인터넷 비밀번호를 Keychain Item으로 저장하는 경우의 플로우입니다.

출처 : 애플 공식 문서

공식 문서에서 키체인 사용 시 좋은 사용자 경험을 위해 3가지를 준수하라고 합니다.

필요할 때만 사용자를 참여시킬 것 (CREATE)
일반적인 상황에서 사용자를 괴롭히지 말 것 (READ)
변화를 깔쌈하게 처리할 것 (UPDATE, DELETE)

각각을 어떻게 준수해야 하는지 위 다이어그램의 흐름을 예시로 따라가며 설명하겠습니다.

필요할 때만 사용자를 참여시킬 것

CREATE와 관련된 내용입니다.

처음에 앱이 credential(자격증명)을 필요로 할 때는 password가 키체인에 저장되어 있지 않은 상태이기 때문에 다이어그램의 오른쪽 흐름과 같이 앱이 사용자에게 인증을 요청합니다.
사용자가 인증 후 credential을 제공하면 앱은 SecItemAdd(_:_:) 함수를 호출하여 credential을 키체인에 저장하게 됩니다.
이후 앱은 정기적인 네트워크 접속을 계속하면서, 나중에 서버가 재인증을 요구하게 되는 순간 사용자 대신 키체인에서 credential을 검색하여 제공해줄 수 있습니다.

다이어그램의 오른쪽 흐름

일반적인 상황에서 사용자를 괴롭히지 말 것

READ와 관련된 내용입니다.

다이어그램 상에서 가장 일반적인 경로는 사용자 상호 작용이 필요하지 않은 중앙 부분입니다.
예를 들면 사용자가 잠시 자리를 비운 후 앱을 다시 시작하게 될 경우, 정기적인 재인증이 필요할 수 있습니다.
이런 경우 앱은 SecItemCopyMatching(_:_:) 함수를 사용하여 키체인에서 password를 검색하게 됩니다.
키체인에서 password가 발견되어 앱이 성공적으로 인증하게 되면, 사용자가 귀찮은 재인증 과정을 직접 수행할 필요 없이 계속 앱 사용이 가능해집니다.

다이어그램의 중앙 흐름

변화를 쌈@뽕(Gracefully...의역)하게 처리할 것

UPDATE와 관련된 내용입니다.

어떨 때는 사용자가 앱의 통제 범위 밖에서 credential을 변경하게 될 수 있습니다. ex) 앱과 동일한 서비스의 웹 인터페이스를 통한 비밀번호 변경·재설정
이런 상황이 발생하고 나면 앱이 keychain item을 검색했을 때, 이전 password를 가져오게 되고 인증에 실패하게 됩니다.
그러면 앱은 다이어그램의 오른쪽 흐름과 같이 사용자에게 새로운 인증을 요청하게 되고, 새 credential을 검증한 뒤에 SecItemUpdate(_:_:) 함수를 호출하여 키체인에 있는 기존 정보를 수정하게 됩니다.

DELETE와 관련된 내용입니다.

로그아웃과 같이 사용자가 네트워크 서비스와 완전히 연결을 끊기로 결정할 경우에, 앱은 로그아웃 처리와 함께 credential도 제거해줘야 합니다.
이 때 SecItemDelete(_:) 함수를 사용하여 키체인에서 password를 제거해줍니다.

다이어그램의 왼쪽 흐름

예시 코드로 확인하기

이번에는 위에서 설명했던 흐름을 코드로 작성해보겠습니다.

Keychain에 password item 추가(저장)하기

먼저 앱 상의 메모리에 저장할 Credential에 대한 구조체를 정의해줍니다.

간단하게 username과 password 프로퍼티를 넣어줬습니다.

Credentials의 내용들을 키체인에 저장하고, 키체인에서 읽어올 예정입니다.

struct Credentials {
    var username: String
    var password: String
}

키체인 접근 시 에러 처리를 위한 에러 타입을 정의해줍니다.

enum KeychainError: Error {
    case noPassword
    case unexpectedPasswordData
    case unhandledError(status: OSStatus)
}

앱이 사용하는 서버의 주소를 static 상수로 정의해줍니다.

static let server = "www.example.com"

서버 주소가 필요한 이유?

keychain item을 저장할 때, account(계정)과 server(서버)에 대한 내용을 저장할 수 있는 attribute가 제공됩니다. 해당 attribute를 쿼리에 같이 작성해줌으로써 저장할 password에 대한 부수적인 정보들도 같이 넣어줄 수 있습니다.

이러한 attribute들을 잘 추가해서 나중에 키체인 아이템을 확실하게 검색할 수 있도록 구성해주어야 합니다.

자세한 내용은 아래 쿼리 작성 부분에서 설명드리겠습니다.

Add 쿼리 만들기

Credentials 구조체의 인스턴스와 위에서 정의해준 server 상수를 사용해서 add query를 만들 수 있습니다.

쿼리는 키체인 CRUD 함수에서 CFDictionary 형태로 변환되어야 하기 때문에 딕셔너리로 만들어줍니다.

위에서 설명한 것처럼 keychain item의 여러 attribute 중 Account와 Server에 대한 것들을 쿼리에 포함시켜줬습니다.

kSecAttrAccount : 계정에 대한 정보로 Credentials의 username 값을 넣어줍니다. 이렇게 하면 username과 password를 나눠서 저장할 필요가 없어집니다. 하나의 keychain item에 username과 password가 모두 들어가게 되는 것이죠.
kSecAttrServer : 해당 password가 관리되는 서버 정보를 명시하는데, 서버의 주소를 넣을 수 있습니다. 예시 코드에서는 실제 서버를 사용하지 않기 때문에 임의의 주소를 넣어줬습니다.

그리고 keychain item의 class를 지정하기 위한 attribute와, 저장하고자 하는 데이터에 대한 attribute를 추가해줍니다.

저장하는 데이터는 반드시 Data 타입이어야 하기 때문에 String 값을 Data로 인코딩해줍니다.

// KEY 역할
let account = credentials.username
// VALUE 역할 - data 타입이어야 한다.
let password = credentials.password.data(using: String.Encoding.utf8)!

// add 쿼리
let query: [String: Any] = [
    // item class 종류
    kSecClass as String: kSecClassInternetPassword,

    // 저장하고자 하는 정보
    kSecAttrAccount as String: account, // item의 계정 이름을 나타냄
    kSecAttrServer as String: server, // item의 서버를 나타냄

    // Data 인스턴스로 인코딩된 password
    kSecValueData as String: password // item의 데이터
]

kSecClass로 kSecClassInternetPassword를 지정해줬는데, 이와 비슷한 kSecClassGenericPassword도 있습니다. generic password는 internet password와 거의 비슷하지만, kSecAttrServer 같이 원격 액세스와 관련된 특정 attribute가 없습니다. 해당 예시에서는 kSecAttrServer를 키체인 아이템 검색 시 식별자처럼 사용할 예정입니다. 그래서 internet password를 사용하게 되었습니다.

kSecAttrServer가 없어도, kSecAttrAccount에 저장을 위한 값이 아닌 식별자로 사용할 값을 넣어줘도 됩니다. 그렇게 할 경우네는 internet password 말고 generic password를 사용해도 됩니다.

나중에 포스팅할 수도 있지만 실제 진행 중인 프로젝트에서 저는 kSecClassGenericPassword class의 keychain item을 저장하면서 kSecAttrAccount는 저장할 데이터를 나타내는 key값으로 활용했습니다.

ex) 파이어베이스 cloud function을 통한 원격 푸시 알림 사용 시 필요한 device token 값을 저장

var query: [String: Any] = [
    kSecClass as String: kSecClassGenericPassword,
    kSecAttrAccount as String: "deviceToken",
    kSecValueData as String: deviceTokenValue
]

Keychain item 추가(ADD)

작성된 add 쿼리를 SecItemAdd(_:_:) 함수에 넣어 호출해줍니다.

쿼리는 CFDictionary로 캐스팅해줘야 하고, 2번째 인자로 리턴 data를 참조할 수 있지만 무시해도 됩니다.

하지만 함수의 반환 결과는 반드시 확인해서 작업의 성공 여부에 따른 처리를 할 수 있어야 합니다. add 작업은 쿼리와 동일한 구성의 item이 이미 존재한다면 실패할 수 있습니다.

let status = SecItemAdd(query as CFDictionary, nil)
guard status == errSecSuccess else {
    throw KeychainError.unhandledError(status: status)
}

Keychain item 검색하기

위에서 작성한 것과 같이 쿼리 딕셔너리를 사용해 키체인 아이템을 검색할 수 있습니다.

쿼리 딕셔너리는 키체인 서비스에 어떤 item attribute를 찾아야 하고, item이 발견되면 무엇을 반환해야 하는지 알려줄 수 있어야 합니다.

그렇기 때문에 검색 쿼리 딕셔너리에는 검색 옵션을 매개변수로 지정해줄 수 있습니다. ex) 대소문자 구분 제어, 매칭되는 항목 수 제한 등...

Search 쿼리 만들기

add 쿼리 때와 비슷하게 작성할 수 있습니다.

하지만 검색 옵션을 위한 attribute들도 추가로 구성해줄 수 있습니다.

예시에서는 매칭되는 결과를 1개로 제한하는 옵션과, 검색된 item의 attribute와 data를 모두 받아오도록 설정해줬습니다.

let query: [String: Any] = [
    kSecClass as String: kSecClassInternetPassword,

    // 일종의 key의 역할 - server attribute가 매치되는 item을 찾게 됨
    kSecAttrServer as String: server,

    kSecMatchLimit as String: kSecMatchLimitOne, // result를 하나의 value로 한정짓는다.(원래 디폴트값임)

    // attribute와 data 둘 다 요청
    kSecReturnAttributes as String: true,
    kSecReturnData as String: true
]

kSecMatchLimit 검색 파라미터로 결과를 단일 값으로 제한해줍니다. 이렇게 하면 키체인에서 첫 번째로 매칭된 아이템만 받아오게 됩니다. (1개로 제한하지 않을 경우에는 배열 형식으로 반환)
이 쿼리는 위의 add 예시에서 password item을 추가할 때 사용한 server attribute와 매치되는 키체인 아이템을 찾게 됩니다. 위에서 설명했지만 server로 지정한 값을 검색 시 일종의 식별자로 사용하는 것이죠.
마지막으로 아이템의 attribute와 data를 모두 요청합니다. 왜냐하면 kSecAttrAccountattribute로 username 값도 저장했기 때문에 이를 불러오기 위함입니다. data에는 password를 저장했으니 당연히 요청해야겠죠.

Keychain item 검색(SEARCH)

작성된 search 쿼리를 SecItemCopyMatching(_:_:) 함수에 넣어 호출해줍니다.

add 때와 마찬가지로, 반환된 status를 통해 검색 결과를 체크하여 에러를 핸들링해줍니다.
함수의 2번째 파라미터를 통해 반환되는 결과를 참조할 수 있습니다.
정상적으로 검색이 완료되면 결과 Data를 통해 원하는 값을 추출해줍니다.

var item: CFTypeRef?
let status = SecItemCopyMatching(query as CFDictionary, &item)

guard status != errSecItemNotFound else {
    throw KeychainError.noPassword
}
guard status == errSecSuccess else {
    throw KeychainError.unhandledError(status: status)
}

// 검색 시 1개의 결과만 요청했으므로 단일 딕셔너리로 옴
guard let existingItem = item as? [String: Any],
      let passwordData = existingItem[kSecValueData as String] as? Data,
      let password = String(data: passwordData, encoding: .utf8),
      let account = existingItem[kSecAttrAccount as String] as? String
else {
    throw KeychainError.unexpectedPasswordData
}

let credentials = Credentials(username: account, password: password)

Keychain item 업데이트/삭제 하기

keychain item을 업데이트 하려면, 먼저 검색을 해야 합니다.

그래서 키체인 아이템의 업데이트 작업은 암시적으로 검색을 먼저 수행하게 됩니다.

이를 위해 업데이트 시에는 search 쿼리와 update 쿼리, 총 2개의 쿼리가 필요합니다.

Search 쿼리 만들기

// 업데이트 작업 수행 시에 암시적으로 검색을 먼저 해야 하기 때문에 검색할때와 같은 형식으로 쿼리 생성
let query: [String: Any] = [
    kSecClass as String: kSecClassInternetPassword,
    kSecAttrServer as String: server
]

Update 쿼리 만들기

업데이트하고자 하는 내용들을 딕셔너리로 지정해줍니다. item의 data 뿐만 아니라 attribute도 업데이트 가능합니다.

// 업데이트할 내용에 대한 쿼리 생성
let account = newCredentials.username
let password = newCredentials.password.data(using: .utf8)!
let attributes: [String: Any] = [
    kSecAttrAccount as String: account,
    kSecValueData as String: password
]

Update 수행

검색 쿼리와 새로운 attributes를 사용해서 SecItemUpdate(_:_:) 함수를 호출해줍니다.

함수 호출이 성공하면 제공한 attribute에 따라 일치하는 모든 item을 수정하게 됩니다.

let status = SecItemUpdate(query as CFDictionary, attributes as CFDictionary)
guard status != errSecItemNotFound else {
    throw KeychainError.noPassword
}
guard status == errSecSuccess else {
    throw KeychainError.unhandledError(status: status)
}

Delete 수행

item을 삭제하는 것은 검색용 쿼리 딕셔너리 하나만 필요하다는 점을 제외하면 업데이트와 매우 비슷합니다.

Update에서 사용한 것과 동일한 쿼리를 사용해서 SecItemDelete(_:) 함수를 호출해줍니다.

업데이트와 비슷하게 키체인 서비스는 검색 파라미터와 일치하는 모든 키체인 항목을 삭제합니다.

// 삭제할 item을 검색하기 위한 쿼리
let query: [String: Any] = [
    kSecClass as String: kSecClassInternetPassword,
    kSecAttrServer as String: server
]

let status = SecItemDelete(query as CFDictionary)
guard status == errSecSuccess || status == errSecItemNotFound else {
    throw KeychainError.unhandledError(status: status)
}

테스트 앱

https://github.com/kybeen/KeychainSample

GitHub - kybeen/KeychainSample: Keychain 공부용 샘플 앱

Keychain 공부용 샘플 앱. Contribute to kybeen/KeychainSample development by creating an account on GitHub.

github.com

아래처럼 간단하게 키체인의 CRUD 작업을 테스트할 수 있는 앱을 만들어봤습니다.

전체 코드는 좀 길기 때문에 깃허브 링크를 참고해주세요.

레퍼런스

https://developer.apple.com/documentation/foundation/userdefaults

https://developer.apple.com/documentation/security/keychain_services/keychain_items/using_the_keychain_to_manage_user_secrets

https://developer.apple.com/documentation/security/keychain_services

https://developer.apple.com/documentation/security/keychain_services/keychain_items/adding_a_password_to_the_keychain

https://developer.apple.com/documentation/security/keychain_services/keychain_items/searching_for_keychain_items

https://developer.apple.com/documentation/security/keychain_services/keychain_items/updating_and_deleting_keychain_items

[ iOS ] String에서 숫자 찾기 & 패턴 찾기

kybeen — Thu, 30 May 2024 17:57:09 +0900

사이드 프로젝트 개발을 하면서 문자열 String이 숫자를 포함하고 있는지 여부를 알고 싶었습니다.

이전 글에서 실시간 버스의 도착 정보에 대한 메세지가 총 4가지 종류로 제공된다고 했습니다.

1️⃣ "곧 도착"
2️⃣ "00분00초후[0번째 전]"
3️⃣ "운행종료"
4️⃣ "출발대기"

그리고 각각의 응답 메세지 형식에 따라서 아래와 같은 enum 타입으로 분류해준다고 했었죠.

enum ArrivalStatus: Comparable {
    case arriveSoon // 곧 도착
    case coming(remainingSecond: Int) // 운행중(남은시간(초))
    case waiting // 출발대기
    case finished // 운행종료
    case unknown // 알 수 없음
}

그렇기 때문에 적절한 ArrivalStatus로 변환할 수 있도록 String의 내용을 분석해줄 필요가 있었습니다.

2️⃣의 경우에는 유일하게 문자열에 숫자가 포함됩니다.

그리고 숫자가 포함된다면 문자열에서 00분00초의 패턴을 추출하여 남은 시간을 구해줘야 합니다. (.coming 케이스의 연관값으로 전달하기 위해)

저는 아래와 같이 동작하는 로직을 설계하게 되었습니다.

여기서 로직 구현이 필요한 부분은

숫자 포함 여부 확인
"00분00초" → 패턴 추출

이렇게 2가지가 됩니다.

각각의 로직을 어떻게 구현했는지 설명드리겠습니다.

String의 숫자 포함 여부 확인

숫자 포함 여부 확인에 저는 String의 rangeOfCharacter(from:options:range:) 메서드를 활용했습니다.

(Foundation 프레임워크를 임포트해야 사용 가능)

해당 메서드는 파라미터로 설정한 옵션에 따라 문자열을 탐색하며, 문자열의 주어진 범위 내에서 주어진 문자 집합에 해당하는 범위를 구해줍니다. 가장 먼저 발견한 곳의 range만 반환하게 되며, 반환 타입이 옵셔널이기 때문에 매칭되는 곳이 없으면 nil을 반환합니다.

파라미터는 from을 제외하고는 필수가 아니며, 저는 from 파라미터만 사용했습니다.

각각의 파라미터 용도는 이렇습니다.

from : 검색하고자 하는 문자를 나타내는 CharacterSet
options : 문자열 검색 옵션 (검색 방향 등을 설정할 수 있습니다.)
range : 검색할 범위 설정

어쨋든 해당 String 내부에 지정한 CharacterSet에 매칭되는 곳이 있다면 그 부분의 range값이 반환될 것이고, 저는 반환되는 값이 있는지 없는지만 확인하면 숫자 포함 여부를 구할 수 있습니다.

from 파라미터로 숫자에 대한 CharacterSet을 넘겨줘야 하는데, 저는 타입 프로퍼티로 기본적으로 제공되는 .decimalDigits를 사용했습니다.

이런 식으로 사용할 수 있습니다.

저는 String 익스텐션에 이렇게 메서드를 작성했습니다.

rangeOfCharacter의 결과가 nil인지 아닌지만 확인하고, Bool값으로 반환해줍니다.

// String이 숫자를 포함하는지 여부를 반환하는 메서드
func isContainsNumber() -> Bool {
    return self.rangeOfCharacter(from: .decimalDigits) != nil
}

String에서 특정 패턴 추출

이제 숫자 포함 여부는 확인할 수 있게 되었습니다.

이번에는 문자열에서 특정 패턴을 추출해야 합니다. 저의 경우는 "00분"과 "00초"의 패턴을 찾아서 분·초 값을 숫자로 뽑아내야 했죠.

사실 먼저 ChatGPT 선생님께 도움을 요청했고, 받은 코드를 다듬어서 String 익스텐션으로 아래의 메서드를 만들었습니다.

베끼기만 하는건 도움이 되지 않으니 어떻게 동작하는지를 살펴봅시다.

// 서울시 버스 도착 정보의 BusArrival에 있는 arrivalMessage로부터 남은 시간을 구해서 Int타입의 초 값으로 반환하는 메서드
func getSeoulBusRemainingSecond() -> Int {
    let minutePattern = "(\\d+)분"
    let secondPattern = "(\\d+)초"

    guard let minuteRegex = try? NSRegularExpression(pattern: minutePattern) else { return 0 }
    guard let secondRegex = try? NSRegularExpression(pattern: secondPattern) else { return 0 }

    var minutes = 0
    var seconds = 0

    // 분 추출
    if let minuteMatch = minuteRegex.firstMatch(in: self, range: NSRange(location: 0, length: count)) {
        if let range = Range(minuteMatch.range(at: 1), in: self) {
            minutes = Int(self[range]) ?? 0
        }
    }

    // 초 추출
    if let secondMatch = secondRegex.firstMatch(in: self, range: NSRange(location: 0, length: count)) {
        if let range = Range(secondMatch.range(at: 1), in: self) {
            seconds = Int(self[range]) ?? 0
        }
    }

    return (minutes * 60) + seconds
}

먼저 "O분"과 "O초" 에 대한 정규식 패턴을 정의해줍니다.

let minutePattern = "(\\d+)분"
let secondPattern = "(\\d+)초"

해당 패턴이 의미하는 바는 아래와 같습니다.

\\d : "\d"는 숫자 하나(digit)를 나타내는 정규표현식입니다. "\"는 정규표현식에서 특수한 의미를 갖기 때문에 백슬래시를 2개 사용해서 이스케이핑 처리를 해줬습니다. 숫자 하나
+ : 앞의 패턴이 하나 이상 반복될 수 있음을 의미합니다. 앞의 \\d패턴이 하나 이상 반복될 수 있다는 의미가 되겠죠. 하나 이상의 숫자가 올 수 있음
() : 캡처 그룹을 의미하며, 요구하는 숫자 패턴과 매칭되는 부분을 묶음처리한다고 생각해주면 됩니다.

결과적으로 이 정규표현식과 매칭되는 패턴은 이렇습니다.

하나 이상의 숫자 바로 뒤에 "분"이나 "초"라는 문자가 있음
ex) 15분, 3분, 40초, 3초...

이제 정규표현식을 사용하기 위해 NSRegularExpression 객체를 생성해줍니다. 앞서 정의한 패턴을 파라미터로 넘겨주고, 잘못된 정규표현식을 넘길 경우 에러가 발생하기 때문에 NSRegularExpression 객체 생성 시에는 try문을 사용해줍니다.

guard let minuteRegex = try? NSRegularExpression(pattern: minutePattern) else { return 0 }
guard let secondRegex = try? NSRegularExpression(pattern: secondPattern) else { return 0 }

이제 각각의 패턴을 찾아서 분과 초를 추출합니다.

NSRegularExpression의 firstMatch(in:options:range:) 메서드를 사용해줍니다.
- 이 메서드는 문자열에서 정규표현식 패턴과 일치하는 첫번째 문자열을 반환해줍니다.
minuteMatch.range(at: 1)는 캡처 그룹 1에 해당하는 범위를 가져오게 되는데,
- 정규표현식 "(\\d+)분"에서 숫자 부분 \d+를 나타냅니다.
마지막으로 매칭된 부분을 Range 객체로 변환하고, 문자열의 서브스트링에서 Int값을 추출해줍니다.

var minutes = 0
var seconds = 0

// 분 추출
if let minuteMatch = minuteRegex.firstMatch(in: self, range: NSRange(location: 0, length: count)) {
    if let range = Range(minuteMatch.range(at: 1), in: self) {
        minutes = Int(self[range]) ?? 0
    }
}

// 초 추출
if let secondMatch = secondRegex.firstMatch(in: self, range: NSRange(location: 0, length: count)) {
    if let range = Range(secondMatch.range(at: 1), in: self) {
        seconds = Int(self[range]) ?? 0
    }
}

이제 아래처럼 사용할 수 있게 됩니다.

import Foundation

let arrivalMessage1 = "14분30초후[6번째전]"
let arrivalMessage2 = "1분4초후[1번째전]"

extension String {
    func getSeoulBusRemainingSecond() -> Int {
        let minutePattern = "(\\d+)분"
        let secondPattern = "(\\d+)초"
        
        guard let minuteRegex = try? NSRegularExpression(pattern: minutePattern) else { return 0 }
        guard let secondRegex = try? NSRegularExpression(pattern: secondPattern) else { return 0 }
        
        var minutes = 0
        var seconds = 0
        
        // 분 추출
        if let minuteMatch = minuteRegex.firstMatch(in: self, range: NSRange(location: 0, length: count)) {
            if let range = Range(minuteMatch.range(at: 1), in: self) {
                minutes = Int(self[range]) ?? 0
            }
        }
        
        // 초 추출
        if let secondMatch = secondRegex.firstMatch(in: self, range: NSRange(location: 0, length: count)) {
            if let range = Range(secondMatch.range(at: 1), in: self) {
                seconds = Int(self[range]) ?? 0
            }
        }
        
        return (minutes * 60) + seconds
    }
}

arrivalMessage1.getSeoulBusRemainingSecond() // 870
arrivalMessage2.getSeoulBusRemainingSecond() // 64

실제 활용 코드

이제 실제로 프로젝트에서 사용한 코드를 보여드리겠습니다.

버스 도착 정보 메세지를 받아서 위의 메서드들을 활용하여 결과를 ArrivalStatus 타입으로 반환해주었습니다.

// 버스의 도착 상태를 구해서 BusArrivalStatus 타입 값을 반환하는 메서드
func getBusArrivalStatusFromSeoulBusStation(arrivalMessage: String) -> ArrivalStatus {
    if arrivalMessage.contains("출발대기") {
        return .waiting
    } else if arrivalMessage.contains("운행종료") {
        return .finished
    } else if arrivalMessage.contains("곧 도착") {
        return .arriveSoon
    } else if arrivalMessage.isContainsNumber() {
        return .coming(remainingSecond: arrivalMessage.getSeoulBusRemainingSecond())
    } else {
        return .unknown
    }
}

레퍼런스

https://tngusmiso.tistory.com/62

https://borabong.tistory.com/32

[ iOS ] Comparable 프로토콜을 사용하여 열거형 값을 비교하기

kybeen — Thu, 30 May 2024 03:31:17 +0900

사이드 프로젝트를 진행하면서

대중교통을 통해 갈 수 있는 경로들을 보여주면서, 각각의 경로에 대한 실시간 도착정보가 제공되도록 하려고 했습니다.

이를 위해 지하철과 버스의 실시간 도착 정보 API를 사용하게 되었고, 각각의 API를 통해 도착까지 남은 시간을 초 단위의 Int값으로 받아와서 앱 상에서는 남은 시간을 실시간으로 카운트하며 표시해주려고 했습니다.

그렇기 때문에 도착 정보에 대한 데이터 타입은 단순하게 남은 시간(초)를 나타내는 Int값이었습니다.

지하철 도착 정보 API의 경우 도착 정보로 도착까지 남은 시간을 초 단위의 숫자값으로 제공했기 때문에 Int타입으로 쉽게 변환하여 사용할 수 있었습니다.

하지만 버스 도착 정보 API는 조금 달랐습니다.

해당 API의 응답 데이터에서 도착까지 얼마나 남았는지를 알 수 있는 정보는 아래의 도착 메세지가 유일했습니다.

이 데이터는 문자열 값으로 제공되었고, 이 문자열을 가공해서 남은 시간을 추출해야 했습니다.

"arrmsg1": "11분54초후[4번째 전]", // 첫번째 도착예정버스의 도착정보메세지
"arrmsg2": "출발대기", // 두번째 도착예정버스의 도착정보메세지

처음에는 단순하게 "00분00초후"형식의 메세지에서남은 시간을 Int 형식의 값으로 뽑아오면 되겠지 싶었습니다.

하지만 API를 여러번 호출해보며 확인한 결과, 이 도착 메세지 형식의 종류는 크게 4가지로 나뉘어진다는 것을 알게 되었습니다.

"곧 도착"
"00분00초후[0번째 전]"
"운행종료"
"출발대기"

그렇기 때문에 도착 정보로 남은 시간의 Int값만 사용할 경우

"곧 도착" 형식의 응답은 정확하게 남은 시간을 카운트할 수 없었습니다. 도착까지 1분 미만의 시간이 남았을 때 "곧 도착" 메세지가 표시되는 것으로 보여졌기 때문에 임의로 60초가 남았다고 할 수도 없었고, 그냥 곧 도착한다는 메세지를 보여주는 것이 제일 좋아보였습니다.

또한 "운행종료"와 "출발대기" 형식으로 응답이 왔을 때에 대한 처리도 할 수 없었습니다.

그렇기 때문에 도착까지 남은 시간만 활용하기에는 무리가 있었고, 도착 정보를 표현하기 위한 타입을 아래와 같이 새로 정의하게 되었습니다.

남은시간을 숫자로 계산할 수 있는 경우에는 숫자값을 활용하지만, 그렇지 않은 경우에는 별도의 처리를 할 수 있도록 열거형 타입을 정의했습니다.

enum ArrivalStatus: Comparable {
    case arriveSoon // 곧 도착
    case coming(remainingSecond: Int) // 운행중(남은시간(초))
    case waiting // 출발대기
    case finished // 운행종료
    case unknown // 알 수 없음
}

이 타입을 보시면 열거형 타입이 Comparable 프로토콜을 채택한 것을 알 수 있습니다.

Comparable 프로토콜

Comparable 프로토콜은 이름대로 대소비교를 할 수 있도록 만들어주는 프로토콜입니다.

해당 프로토콜을 채택하게 되면 커스텀 타입에서도 <, >, <=, >= 연산자를 통한 대소비교가 가능해집니다.

Swift의 기본 타입인 Int, Double, String 등도 이 프로토콜을 채택하고 있었기 때문에 대소비교가 가능한 것입니다.

구조체나 클래스 같은 복합적인 타입에서는 비교의 기준을 무엇으로 할 지 명확하지 않기 때문에, Comparable 프로토콜 채택 시에 프로토콜 메서드를 구현해서 기준을 정해줘야 합니다.

프로토콜 채택만 하게 되면 에러가 발생합니다.

에러 메세지를 클릭해서 fix를 누르면 < 메서드를 작성하도록 만들어줍니다.

이 메서드의 내부에 비교 기준을 작성해주면 됩니다. < 메서드 하나만 작성해주면 이를 기준으로 나머지 연산자를 통한 비교도 모두 자동으로 처리됩니다.

짬을 더 많이 먹은 군인이 더 큰 값이 되도록 아래와 같이 구현해주면... 대소비교가 가능해집니다.

struct Soldier: Comparable {
    static func < (lhs: Soldier, rhs: Soldier) -> Bool {
        return lhs.zzam < rhs.zzam
    }
    
    var name = ""
    var zzam = 0
}

let eren = Soldier(name: "에렌예거", zzam: 10)
let levi = Soldier(name: "리바이", zzam: 500)
 
eren < levi // true
eren > levi // false

열거형의 경우

하지만 열거형의 경우는 조금 다릅니다.

Swift 5.3 미만 버전이라면 Comparable을 채택하고 구현도 해줘야 하지만,

Swift 5.3 이상의 버전에서는 연관값이 없거나 | 연관값이 모두 Comparable 프로토콜을 채택하고 있는 경우에는 Comparable을 채택하는 것만으로도 사용이 가능해집니다.

그렇기 때문에 위에서 제가 정의한 열거형 타입은 따로 구현을 해줄 필요가 없었습니다. 연관값으로 사용되는 건 Int값 하나 뿐이었는데, 이는 이미 프로토콜이 채택되어있기 때문이죠.

enum ArrivalStatus: Comparable {
    case arriveSoon // 곧 도착
    case coming(remainingSecond: Int) // 운행중(남은시간(초))
    case waiting // 출발대기
    case finished // 운행종료
    case unknown // 알 수 없음
}

그럼 대소비교의 기준은 어떻게 되냐?

별다른 구현이 없다면 열거형 case의 비교 기준은 아래로 갈수록 큰 값이 됩니다.

그렇기 때문에 ArrivalStatus 타입에서는 아래와 같은 대소관계가 성립하게 됩니다.

let a: ArrivalStatus = .arriveSoon // 곧 도착
let b: ArrivalStatus = .coming(remainingSecond: 10) // 10초 남음
let c: ArrivalStatus = .coming(remainingSecond: 16) // 16초 남음
let d: ArrivalStatus = .waiting // 출발대기
let e: ArrivalStatus = .finished // 운행종료
let f: ArrivalStatus = .unknown // 알 수 없음
// a < b < c < d < e < f

print(a<b) // true
print(a<c) // true
print(a<d) // true
print(a<e) // true
print(a<f) // true

print(b<c) // true
print(b<d) // true
print(b<e) // true
print(b<f) // true

print(c<d) // true
print(c<e) // true
print(c<f) // true

print(d<e) // true
print(d<f) // true

print(e<f) // true

✅ 직접 활용한 방식

위와 같은 대소관계가 성립하기 때문에 여러 개의 도착 정보가 배열에 들어있을 때,

정렬을 통해 가장 도착이 임박한 도착 정보를 맨 앞으로 가져올 수 있게 됩니다.
또한 현재 오고 있는 버스나 지하철이 없더라도, 출발대기>운행종료>알수없음 의 우선순위대로 적절한 메세지로 대체할 수 있게 됩니다.

버스의 도착 정보를 받기 위해 사용하는 API는 정류소 정보를 조회하는 API입니다.

그렇기 때문에 해당 정류소를 지나는 모든 노선에 대한 정보가 받아지게 됩니다.

버스의 경우 동일한 경로를 통하는 노선이 여러개일 수가 있기 때문에, 여러 노선의 도착 정보 중 도착이 가장 임박한 정보를 보여줄 수 있어야 했습니다.

ex) "불광역3.6호선" ~ "서대문역사거리.농협중앙회"의 동일한 경로를 지나는 버스노선은 총 3개 720, 741, 705

그렇기 때문에 "불광역3.6호선" 정류소를 지나는 모든 노선의 도착 정보에서 720, 741, 705의 것들만 필터링하고 3가지 노선 중 가장 도착이 임박한 정보를 보여줘야 한다.

전체 코드를 상세하게 설명하기에는 복잡하기 때문에 이 부분이 적용되는 코드를 살펴보면

// 서울시 정류소정보조회 API 호출
self.apiService.fetchSeoulRealtimeBusStationInfo(arsID: arsID) { result in
    switch result {
    case .success(let seoulRealtimeBusStationDTO):
        // 노선ID+노선명이 매칭되는 도착 정보들만 필터링
        let filteredArrivals = seoulRealtimeBusStationDTO.arrivals.itemList.filter {
            (routeIDs.contains($0.busRouteID)) && (routeNames.contains($0.busRouteName))
        }
        // 각 노선들에 대한 도착 정보에서 첫번째, 두번째 도착 메시지를 추출하고, ArrivalStatus의 우선순위가 높은(작은값) 순서대로 정렬
        let firstArrivals = filteredArrivals.map { self.getBusArrivalStatusFromSeoulBusStation(arrivalMessage: $0.arrivalMessage1) }.sorted(by: <)
        let secondArrivals = filteredArrivals.map { self.getBusArrivalStatusFromSeoulBusStation(arrivalMessage: $0.arrivalMessage2) }.sorted(by: <)

        // 가장 가까운 도착 정보를 튜플에 반영
        if let closestFirstArrival = firstArrivals.first {
            realtimeArrival.first = closestFirstArrival
        }
        if let closestSecondArrival = secondArrivals.first {
            realtimeArrival.second = closestSecondArrival
        }
        ...
	...
    }
}

정류소정보조회 API를 호출해서 응답을 받아옵니다.
필요한 노선들의 정보만 필터링하고, 응답 메세지를 ArrivalStatus 타입의 값으로 변환하여 이를 배열로 만들어줍니다.
sort 메서드로 정렬을 해주게 되면, firstArrivals와 secondArrivals 배열의 맨 앞(first)에 해당하는 원소에는 가장 도착이 임박한 데이터가 오게 되고, 이를 활용해줍니다.

레퍼런스

https://babbab2.tistory.com/150

Swift) Comparable에 대해 알아보자

안녕하세요 :) 소들입니다 일요일인데 포스팅 쓰러 카페에 왔습니다!!!!!! 제가 한 3주 정도 현업 때문에 정말 너무너무 바빴어서..;; 사실 풀 재택근무중인데 굳이 회사나가서 새벽까지 개발하면

babbab2.tistory.com

[iOS] SwiftUI의 TextField에 Clear Button 추가하기

kybeen — Tue, 28 May 2024 18:23:16 +0900

SwiftUI로 사이드 프로젝트 개발을 하다가 아래 사진처럼 TextField에 입력한 텍스트를 한번에 지울 수 있는 Clear Button을 추가하려고 했습니다.

애플의 HIG 문서에서는 Text fields 사용 시,
"사람들이 입력을 지울 수 있도록 텍스트 필드의 마지막 끝에 지우기 버튼을 표시하세요."
라고 하면서 Clear Button의 추가를 권장하고 있습니다.

출처 : https://developer.apple.com/design/human-interface-guidelines/text-fields

그렇기 때문에 UIKit의 UITextField에는 clear button 설정과 관련된 옵션이 기본적으로 제공되었고, SwiftUI의 TextField에도 당연히 clear button 관련 옵션이 있을 거라 생각했습니다.

하지만 찾아보니 SwiftUI에서는 기본적으로 제공되는 clear button이 없었습니다.

검색을 해보면 대체로 2가지 방법 중 하나를 사용하는 것으로 보였습니다.

UITextField를 가져와서 사용
ViewModifier를 활용한 커스텀 modifier 만들기

각각의 방법을 살펴 보겠습니다.

일단 기본적인 SwiftUI 뷰를 아래와 같이 구성해주었고,
이 뷰를 기반으로 Clear Button을 적용해보겠습니다.

import SwiftUI

struct ClearButtonSampleView: View {
    
    @State private var myText: String = ""
    
    var body: some View {
        VStack {
            Text("텍스트를 입력해주세요.")
                .font(.title)
                .bold()
            
            TextField(
                "텍스트 입력",
                text: $myText
            )
            .textFieldStyle(.roundedBorder)
        }
        .padding()
    }
}

TextField를 그냥 사용한 현재 상태에서는 텍스트를 입력해도 clear button이 적용되지 않습니다.

clear button 적용 ❌

1️⃣ UITextField를 가져와서 사용

UIKit UITextField의 appearance 객체를 통해 clearButtonMode 속성을 지정해주면 SwiftUI의 TextField 사용 시에도 똑같이 clear button이 적용됩니다.

View의 init()이나, .onAppear() 등에 아래의 코드만 추가해주면 clear button이 나타나는 것을 볼 수 있습니다.

UITextField.appearance().clearButtonMode = .whileEditing

clear button 적용 ✅

저 같은 경우는 이니셜라이저에 해당 코드를 넣어주었고, 전체 코드는 아래와 같습니다.

⚙️ 전체 코드 - UITextField를 가져와서 사용

import SwiftUI

// MARK: - UITextField 사용
struct ClearButtonSampleView: View {
    
    @State private var myText: String = ""
    
    init() {
        // UITextField의 clearButton 속성을 설정
        UITextField.appearance().clearButtonMode = .whileEditing
    }
    
    var body: some View {
        VStack {
            Text("텍스트를 입력해주세요.")
                .font(.title)
                .bold()
            
            TextField(
                "텍스트 입력",
                text: $myText
            )
            .textFieldStyle(.roundedBorder)
        }
        .padding()
    }
}

이 방법을 사용하면 굉장히 간단하게 clear button을 적용할 수 있습니다.

이는 TextField가 UITextField를 기반으로 구성되어 있기 때문에 가능한 방법이라고 합니다. TextField의 내부 코드까지는 공개되어 있지 않아서 확인할 수는 없었지만 그렇기 때문에 UITextField의 속성을 건드렸는데, TextField에 적용이 되는 것이라고 볼 수 있을 것 같습니다.

2️⃣ ViewModifier를 활용한 커스텀 modifier 만들기

1️⃣의 방법은 아주 간단하고 쉽지만, clear button의 모양과 기능을 직접 커스텀하는 것은 어렵습니다.
기본적으로 제공되는 모양과 기능을 그대로 써도 상관 없다면 괜찮지만, 그렇지 않은 경우에는 2️⃣의 방법을 사용하게 됩니다.

두번째 방법은 ViewModifier protocol을 활용해 커스텀 modifier를 만들어준 뒤, 이를 TextField에 적용시켜주는 방법입니다.
이 방법을 채택할 경우에는 clear button를 통해 더 상세한 동작 제어가 가능해집니다.
ex) clear button을 통해 없앤 텍스트를 다시 복구(undo), 버튼의 외형 커스텀

먼저 ViewModifier 프로토콜을 채택하는 ClearButton 구조체를 생성해줍니다. ViewModifier 프로토콜을 채택하고 해당 프로토콜에서 요구하는 body(content:) 메서드를 구현해주면, 커스텀 modifier가 적용될 content에 접근할 수 있게 됩니다.
- 그 후 some View 타입을 반환하면서 modifier가 적용된 뷰를 사용할 수 있게 됩니다.
TextField에서 입력한 텍스트를 받기 위한 바인딩 프로퍼티도 정의해줍니다.

struct ClearButton: ViewModifier {
    
    @Binding var text: String
    
    func body(content: Content) -> some View {
    
    }
}

이제 body(content:) 메서드 내부에 아래와 같이 내용을 작성해줍니다.

ZStack으로 content(modifier가 적용될 컴포넌트 - TextField)를 감싸줍니다.
trailing alignment를 적용해줍니다. (clear button을 뒤로 배치하기 위해)
입력된 text가 비어 있지 않을 때만 clear button이 표시되도록 해줍니다.
SF Symbol의 multiply.circle.fill을 사용해서 clear button을 만들어줍니다.
버튼 클릭 시에는 입력한 text를 빈 문자열로 만들어줍니다.

// 2. trailing alignment 적용
ZStack(alignment: .trailing) {
    // 1. ZStack으로 content를 감싸줌
    content

    // 3. 입력된 text가 비어 있지 않을 때만 clear button 표시
    if !text.isEmpty {
        // 4. 커스텀 clear button 구성
        Button {
            // 5. clear button 클릭 시 동작
            text = ""
        } label: {
            Image(systemName: "multiply.circle.fill")
                .foregroundStyle(.gray)
        }
        .padding(.trailing, 8)
    }
}

이제 clear button의 구성은 완료했고, 뷰에서 modifier를 적용할 수 있도록 메서드를 정의해줍니다.
View의 익스텐션으로 바인딩 text 프로퍼티를 전달해서 커스텀 modifier를 호출하는 메서드를 정의해줍니다.

extension View {
    func clearButton(text: Binding<String>) -> some View {
        modifier(ClearButton(text: text))
    }
}

물론 TextField에서 직접 .modifier(ClearButton(text: $myText))를 호출해줘도 되지만 이런 식으로 사용하는게 국룰이라고 합니다. 사용할 modifier의 목적도 더 명확하게 명시하면서 호출 시 코드도 간결해지겠죠?

이제 아래와 같이 코드를 작성해주면 텍스트필드에 clear button modifier가 적용됩니다.
.clearButton(text: $myText)를 통해 입력한 텍스트 프로퍼티를 ClearButton modifier로 전달하여 입력한 텍스트에 따라 clear button을 화면에 보여주거나 숨기도록 해줄 수 있습니다.

TextField(
    "텍스트 입력",
    text: $myText
)
.textFieldStyle(.roundedBorder)
.clearButton(text: $myText)

전체 코드는 아래와 같습니다.

⚙️ 전체 코드 - ViewModifier를 활용한 커스텀 modifier 사용

import SwiftUI

// MARK: - 커스텀 Modifier 사용
struct ClearButtonSampleView: View {
    @State private var myText: String = ""

    var body: some View {
        VStack {
            Text("텍스트를 입력해주세요.")
                .font(.title)
                .bold()
            
            TextField(
                "텍스트 입력",
                text: $myText
            )
            .textFieldStyle(.roundedBorder)
            .clearButton(text: $myText)
        }
        .padding()
    }
}

struct ClearButton: ViewModifier {
    
    @Binding var text: String
    
    func body(content: Content) -> some View {
        // 2. trailing alignment 적용
        ZStack(alignment: .trailing) {
            // 1. ZStack으로 content를 감싸줌
            content
            
            // 3. 입력된 text가 비어 있지 않을 때만 clear button 표시
            if !text.isEmpty {
                // 4. 커스텀 clear button 구성
                Button {
                    // 5. clear button 클릭 시 동작
                    text = ""
                } label: {
                    Image(systemName: "multiply.circle.fill")
                        .foregroundStyle(.gray)
                }
                .padding(.trailing, 8)
            }
        }
    }
}

extension View {
    func clearButton(text: Binding<String>) -> some View {
        modifier(ClearButton(text: text))
    }
}

clear button 적용 ✅

clear button 커스텀

이제 ClearButton modifier를 수정함으로써 clear button의 외형이나 동작을 커스텀할 수 있습니다.

한번 아래과 같이 수정해보았습니다.

버튼 모양을 변경
clear button 클릭 시 텍스트를 지우지 않고, 약올리는 문구 출력

if !text.isEmpty {
    Button {
        text = "안지워줄건데 ㅋ"
    } label: {
        Image(systemName: "delete.backward.fill").foregroundStyle(.orange.gradient.opacity(0.6))
    }
    .padding(.trailing, 8)
}

레퍼런스

https://www.devtechie.com/community/public/posts/231542-how-to-add-clear-button-in-textfield

How to add clear button in TextField

SwiftUI TextField provides many functionalities out of the box but if you are looking for clear button similar to what UIKit version of TextField provides, you will not find it as its not available. At least without adding extra bit of code. In this articl

www.devtechie.com

https://developer.apple.com/documentation/swiftui/viewmodifier

ViewModifier | Apple Developer Documentation

A modifier that you apply to a view or another view modifier, producing a different version of the original value.

developer.apple.com

[iOS] Build input file cannot be found: '~/Info.plist' 에러 발생 시

kybeen — Sun, 5 May 2024 16:40:33 +0900

에러 설명

Xcode로 개발을 하면서 Info.plist 파일의 위치를 옮기게 되면, 빌드 시에 아래와 같은 오류가 발생합니다.

Build input file cannot be found: '~/Info.plist'. Did you forget to declare this file as an output of a script phase or custom build rule which produces it?

빌드 인풋 파일로 Info.plist 파일이 필요한데 찾을 수 없다는 뜻입니다.

이는 해당 빌드 타겟에 지정된 Info.plist의 경로는 그대로인데 실제 Info.plist 파일의 경로는 달라서 이를 찾지 못하기 때문에 발생하는 문제입니다.

저같은 경우는 프로젝트 내부에 Resources 폴더를 만들어주고, 루트 경로에 있던 Info.plist 파일을 그 안으로 옮겨주었기 때문에 기존 경로와 매칭이 되지 않았습니다.

해결 방법

해결 방법은 간단합니다.

앱 타겟의 Build Settings로 들어가서 Info.plist 파일의 경로 설정을 현재 경로로 수정해주면 됩니다.

현재 경로에 맞게 수정해주었습니다.

이후 빌드를 하면 정상적으로 빌드가 될 것입니다.

[iOS] Core Location 테스트하기 (외부 의존성의 응답을 테스트하기)

kybeen — Fri, 3 May 2024 00:57:42 +0900

사이드 프로젝트를 진행하면서 Core Location을 사용해 현재 위치를 불러오는 기능을 구현하고, 이에 대한 테스트 코드를 작성하려고 했습니다.

LocationService 클래스 정의

위치 서비스 관련 동작을 처리하기 위해 LocationService라는 이름의 클래스를 정의해주었습니다.

해당 클래스는 Core Location의 CLLocationManager 인스턴스를 활용하여 위치 서비스 관련 메서드를 호출하고, CLLocationManagerDelegate를 채택하여 위치 서비스의 결과를 받아서 처리할 수 있습니다.

해당 프로젝트에서 필요한 동작은 현재 위치의 위도,경도값을 받아오는 것 하나 뿐이기 때문에 간단하게 필요한 내용을 아래와 같이 작성해주었습니다.

import CoreLocation

// MARK: - LocationService 정의

final class LocationService: NSObject {
    
    typealias LocationCallback = (CLLocation?) -> Void
    
    private let locationManager: CLLocationManager
    private var fetchLocationCallBack: LocationCallback?
    
    init(locationManager: CLLocationManager = CLLocationManager()) {
        self.locationManager = locationManager
        super.init()
        self.locationManager.delegate = self
    }
    
    // 현재 위치를 불러오기
    func fetchCurrentLocation(completion: @escaping LocationCallback) {
        fetchLocationCallBack = completion
        locationManager.requestLocation()
    }
}

// MARK: - CLLocationManagerDelegate 델리게이트 구현

extension LocationService: CLLocationManagerDelegate {
    
    func locationManagerDidChangeAuthorization(_ manager: CLLocationManager) {
        switch manager.authorizationStatus {
        case .authorizedWhenInUse:
            print("위치 서비스 사용 가능")
        case .restricted, .denied:
            print("위치 서비스 사용 불가")
            // TODO: - "위치 서비스를 사용하려면 승인이 필요합니다." 팝업 띄우기
        case .notDetermined:
            print("권한 설정 필요")
            locationManager.requestWhenInUseAuthorization() // 권한 요청
        default:
            break
        }
    }
    
    func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) {
        if let location = locations.last {
            fetchLocationCallBack?(location)
            fetchLocationCallBack = nil
        }
    }
    
    func locationManager(_ manager: CLLocationManager, didFailWithError error: Error) {
        fetchLocationCallBack?(nil)
        fetchLocationCallBack = nil
        // TODO: - 실패 시 UI처리 필요
    }
}

현재 위치를 받아오는 동작 코드를 더 자세하게 살펴보겠습니다.

LocationService 클래스의 fetchCurrentLocation(completion:) 메서드를 호출하면 파라미터로 넘겨준 탈출 클로저를 통해 위치 값을 받아올 수 있습니다.

Core Location에서 현재 위치를 받아오려면 CLLocationManagerDelegate를 채택한 델리게이트 객체의 locationManager(_:didUpdateLocations:) 메서드 내부에서 인자로 전달받은 locations 값을 통해 위치 정보를 추출해줘야 합니다.
이를 위해 CLLocation 타입의 위치 값을 전달할 콜백을 정의해주었고, fetchCurrentLocation(completion:)를 통해 전달받은 클로저를 해당 콜백에 할당해주었습니다. 그 후 CLLocationManager의 requestLocation() 메서드가 호출됩니다.

final class LocationService: NSObject {
    
		// 위치 값을 인자로 전달하는 콜백 타입
		typealias LocationCallback = (CLLocation?) -> Void
		
		private var fetchLocationCallBack: LocationCallback?
		
		// 현재 위치를 불러오기
		func fetchCurrentLocation(completion: @escaping LocationCallback) {
		    fetchLocationCallBack = completion
		    locationManager.requestLocation()
		}

}

CLLocationManager의 requestLocation() 메서드가 호출되면, CLLocationManagerDelegate의 델리게이트 메서드 내부에서 인자로 받은 locations 값을 콜백 클로저로 넘겨주게 됩니다. (실패 시에는 nil 전달)

extension LocationService: CLLocationManagerDelegate {
    
    func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) {
        if let location = locations.last {
            fetchLocationCallBack?(location)
            fetchLocationCallBack = nil
        }
    }
    
    func locationManager(_ manager: CLLocationManager, didFailWithError error: Error) {
        fetchLocationCallBack?(nil)
        fetchLocationCallBack = nil
    }
}

테스트 코드 작성

이 코드를 통해 테스트하고 싶은 것은 CLLocationManager가 위치 값을 제대로 반환하는지 입니다.

이를 검증하기 위한 테스트코드를 아래와 같이 작성해주었습니다.

import XCTest
import CoreLocation
@testable import Data

final class LocationServiceTests: XCTestCase {
    
    private var sut: LocationService!
    
    override func setUpWithError() throws {
        super.setUp()
        sut = LocationService()
    }
    
    override func tearDownWithError() throws {
        super.tearDown()
        sut = nil
    }
    
    func test_fetchCurrentLocation을_호출하면_위치정보를_얻음() {
        let expectedLocation = CLLocation(latitude: 37.6134436427887, longitude: 126.926493082645)
        let completionExpectation = expectation(description: "fetchCurrentLocation completion expectation")
        
        sut.fetchCurrentLocation { location in
            completionExpectation.fulfill()
            if let location = location {
                XCTAssertEqual(location.coordinate.latitude, expectedLocation.coordinate.latitude)
                XCTAssertEqual(location.coordinate.longitude, expectedLocation.coordinate.longitude)
            }
        }
        wait(for: [completionExpectation], timeout: 1)
    }
}

expectedLocation에 예상 결과값을 넣고, fetchCurrentLocation() 메서드를 호출하여 콜백으로 전달된 인자를 통해 값을 검증합니다.

func test_fetchCurrentLocation을_호출하면_위치정보를_얻음() {
    let expectedLocation = CLLocation(latitude: 37.6134436427887, longitude: 126.926493082645)
    let completionExpectation = expectation(description: "fetchCurrentLocation completion expectation")
    
    sut.fetchCurrentLocation { location in
        if let location = location {
            completionExpectation.fulfill()
            XCTAssertEqual(location.coordinate.latitude, expectedLocation.coordinate.latitude)
            XCTAssertEqual(location.coordinate.longitude, expectedLocation.coordinate.longitude)
        }
    }
    wait(for: [completionExpectation], timeout: 1)
}

하지만 이 테스트는 실패합니다.

왜냐하면 해당 테스트 동작 중에는 실제 기기의 위치값이 필요한데, 테스트 중에 그 값을 받아올(주입시킬) 방법이 없기 때문입니다.

그렇기 때문에 CoreLocation의 인터페이스를 직접적으로 사용하지 않으면서 테스트할 수 있도록 수정이 필요합니다.

Core Location 인터페이스 추상화

1. CLLocationManager의 인터페이스를 정의하여 추상화하기

먼저, 실제 동작 시 사용하는 CLLocationManager의 프로퍼티/메서드를 그대로 인터페이스 프로토콜로 정의해줍니다.

LocationManagerInterface 프로토콜을 생성한 뒤, LocationService 클래스에서 사용되는 CLLocationManager 객체와 동일한 프로퍼티와 메서드를 요구하도록 작성했습니다.

protocol LocationManagerInterface {
    var locationManagerDelegate: CLLocationManagerDelegate? { get set }
    func requestWhenInUseAuthorization()
    func requestLocation()
}

이제 LocationService 클래스에서 CLLocationManager에 대한 참조를 LocationManagerInterface의 참조로 변경해줍니다.

또한 델리게이트 지정을 delegate가 아닌, 인터페이스 프로토콜에 정의한 locationManagerDelegate로 해줍니다.

final class LocationService: NSObject {

    private var locationManager: LocationManagerInterface
    
    init(locationManager: LocationManagerInterface = CLLocationManager()) {
        self.locationManager = locationManager
        super.init()
        self.locationManager.locationManagerDelegate = self
    }
    
}

이렇게 함으로써 LocationService의 CLLocationManager에 대한 의존성을 끊어줄 수 있습니다.

하지만 아직 CLLocationManager가 인터페이스 프로토콜을 채택하지 않았기 때문에 프로토콜을 채택하도록 해줍니다.

프로토콜의 요구사항들은 어차피 CLLocationManager에 이미 정의된 내용이기 때문에 별도로 구현할 필요가 없습니다.

extension CLLocationManager: LocationManagerInterface {}

하지만 locationManagerDelegate를 아직 정의하지 않았기 때문에 이를 새로 정의해주어야 합니다.

2. CLLocationManagerDelegate의 인터페이스를 정의하여 추상화하기

LocationManagerInterface를 채택하는 과정에서 한 단계 작업을 더 해줘야 합니다.

왜냐하면 LocationService는 CLLocationManagerDelegate로 인해 CoreLocation 시스템 델리게이트에 아직 강하게 연결되어 있기 때문입니다.

이 의존성을 끊어주기 위해 LocationManagerDelegate 델리게이트를 새로 정의해줍니다.

CLLocationManagerDelegate에서 사용되는 메서드들과 형식을 맞춰서 정의해줍니다.

manager 파라미터의 타입은 CLLocationManager가 아닌 LocationManagerInterface가 됩니다.

protocol LocationManagerDelegate: AnyObject {
    func locationManagerAbstract(_ manager: LocationManagerInterface, didChangeAuthorization status: CLAuthorizationStatus)
    func locationManagerAbstract(_ manager: LocationManagerInterface, didUpdateLocations locations: [CLLocation])
    func locationManagerAbstract(_ manager: LocationManagerInterface, didFailWithError error: Error)
}

이제 CLLocationManager에서 locationManagerDelegate를 구현해줍니다.

CLLocationManager의 delegate로 접근할 수 있도록 타입캐스팅하는 코드를 접근자와 설정자에 작성해주었습니다.

이렇게 하면 locationManagerDelegate를 통해 CLLocationManager의 delegate로 접근하게 되고, LocationService의 CLLocationManagerDelegate에 대한 의존성을 끊어줄 수 있습니다.

CoreLocation의 시스템 델리게이트를 활용해 데이터를 받아올 수 있으면서도 delegate은 직접 접근하지 않게 되는 것이죠. 덕분에 CoreLocation을 직접 사용하지 않는 임의의 mock 클래스를 만들어 동작을 테스트할 수 있습니다.

protocol LocationManagerInterface {
    var locationManagerDelegate: LocationManagerDelegate? { get set }
    ...
}

extension CLLocationManager: LocationManagerInterface {
    var locationManagerDelegate: LocationManagerDelegate? {
        get {
            return delegate as? LocationManagerDelegate
        }
        set {
            delegate = newValue as? CLLocationManagerDelegate
        }
    }
}

3. 추상화된 델리게이트를 채택하는 코드로 수정

이제 CLLocationManager 프로토콜 정보를 새로 정의한 프로토콜로 변경해주어야 합니다.

1. 먼저 LocationService 클래스가 LocationManagerDelegate를 준수하도록 코드를 작성해줍니다.

기존에 CLLocationManagerDelegate를 채택하며 구현한 코드를 LocationManagerDelegate 형식에 맞게 옮겨줍니다.

extension LocationService: LocationManagerDelegate {
    
    func locationManagerAbstract(_ manager: LocationManagerInterface, didChangeAuthorization status: CLAuthorizationStatus) {
        switch status {
        case .authorizedWhenInUse:
            print("위치 서비스 사용 가능")
        case .restricted, .denied:
            print("위치 서비스 사용 불가")
            // TODO: - "위치 서비스를 사용하려면 승인이 필요합니다." 팝업 띄우기
        case .notDetermined:
            print("권한 설정 필요")
            locationManager.requestWhenInUseAuthorization() // 권한 요청
        default:
            break
        }
    }

    func locationManagerAbstract(_ manager: LocationManagerInterface, didUpdateLocations locations: [CLLocation]) {
        guard let location = locations.last else { return }
        fetchLocationCallBack?(location)
        fetchLocationCallBack = nil
    }

    func locationManagerAbstract(_ manager: LocationManagerInterface, didFailWithError error: Error) {
        fetchLocationCallBack?(nil)
        fetchLocationCallBack = nil
        // TODO: - 실패 시 UI처리 필요
    }
}

2. 기존의 CLLocationManagerDelegate의 델리게이트 메서드들이 각각 대응하는 LocationManagerDelegate의 메서드를 호출하도록 수정해줍니다.

extension LocationService: CLLocationManagerDelegate {
    
    func locationManagerDidChangeAuthorization(_ manager: CLLocationManager) {
        locationManagerAbstract(manager, didChangeAuthorization: manager.authorizationStatus)
    }
    
    func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) {
        locationManagerAbstract(manager, didUpdateLocations: locations)
    }
    
    func locationManager(_ manager: CLLocationManager, didFailWithError error: Error) {
        locationManagerAbstract(manager, didFailWithError: error)
    }
}

추상화된 인터페이스 기반의 테스트코드 작성

이제 LocationManagerInterface를 활용하여 직접 제어가 가능한 클래스를 사용할 수 있기 때문에 mock을 생성하고, 주입하고자 하는 값들을 넣어줄 수 있습니다.

CLLocationManager 대신 동작할 Mock 객체를 생성해주었습니다.

locationToReturn 클로저를 통해 임의의 위치값을 넘겨줍니다.

// CLLocationManager 대신 동작할 Mock 객체
struct LocationManagerMock: LocationManagerInterface {
    var locationManagerDelegate: LocationManagerDelegate?
    
    var locationToReturn: (() -> CLLocation)?
    
    func requestLocation() {
        guard let location = locationToReturn?() else { return }
        locationManagerDelegate?.locationManagerAbstract(self, didUpdateLocations: [location])
    }
    
    func requestWhenInUseAuthorization() {}
}

Mock 객체를 활용하여 테스트 코드를 아래와 같이 작성해주었습니다.

각 코드의 동작은 아래와 같습니다.

mock 인스턴스 생성
CLLocationManager의 requestLocation()메서드가 호출됐을 때 받아올 것이라고 기대되는 임의의 위치값을 전달해줍니다.
LocationService 인스턴스 생성 시 이니셜라이저를 통해 mock 인스턴스를 locationManager로 주입해줍니다.
- 특정 클래스가 아닌 인터페이스에 따라 locationManager를 만들어줌으로써 의존성이 역전됩니다.

func test_fetchCurrentLocation을_호출하면_위치정보를_얻음() {
    // 1
    var locationManagerMock = LocationManagerMock()
    
    // 2
    locationManagerMock.locationToReturn = {
        return CLLocation(latitude: 37.6134436427887, longitude: 126.926493082645)
    }
    
    // 3
    let sut = LocationService(locationManager: locationManagerMock)
    
    let expectedLocation = CLLocation(latitude: 37.6134436427887, longitude: 126.926493082645)
    let completionExpectation = expectation(description: "fetchCurrentLocation completion expectation")
    
    sut.fetchCurrentLocation { location in
        if let location = location {
            completionExpectation.fulfill()
            XCTAssertEqual(location.coordinate.latitude, expectedLocation.coordinate.latitude)
            XCTAssertEqual(location.coordinate.longitude, expectedLocation.coordinate.longitude)
        }
    }
    wait(for: [completionExpectation], timeout: 1)
}

이렇게 해준 뒤에는 테스트 코드가 통과하는 것을 확인할 수 있습니다.

CLLocationManager와 동일하게 동작하지만 실제 기기의 위치값을 받아올 필요가 없는 LocationManagerMock 클래스를 사용해서 위치 정보를 받았을 때 콜백으로 제대로 넘겨지는지를 테스트할 수 있게 되었습니다.

이와 동일한 방식으로 임의의 값을 넘겨주면서 인증, 에러 등의 다른 상황도 테스트할 수 있습니다.

리팩토링 후 최종 코드

테스트 코드 내용을 Given-When-Then 형식에 맞게 리팩토링하여 가독성을 높여주었고, 위치 정보 불러오기를 실패했을 경우를 테스트하는 코드를 추가적으로 작성해보았습니다.

LocationService 코드 수정

이를 위해 기존 LocationService의 콜백에서 CLLocation값과 Error 타입의 값을 인자로 넘겨주도록 수정했습니다.

커스텀 에러 타입인 LocationError를 정의하고, 콜백에 Error 타입의 인자를 추가해주었습니다.

enum LocationError: Error {
    case fetchFailed
}

final class LocationService: NSObject {
    
    typealias LocationCallback = (CLLocation?, Error?) -> Void // 위치 값을 인자로 전달하는 콜백 타입
	...
}

이에 맞게 LocationManagerDelegate 구현부에서 콜백으로 인자를 넘겨주는 부분을 수정해줍니다.
- 위치 정보 불러오기 성공 시에는 에러에 nil 값을 넘겨주고, 실패 시에는 새로 정의한 에러 타입의 값을 넘겨줍니다.

extension LocationService: LocationManagerDelegate {
    
    ...

    func locationManagerAbstract(_ manager: LocationManagerInterface, didUpdateLocations locations: [CLLocation]) {
        guard let location = locations.last else { return }
        fetchLocationCallBack?(location, nil)
        fetchLocationCallBack = nil
    }

    func locationManagerAbstract(_ manager: LocationManagerInterface, didFailWithError error: Error) {
        fetchLocationCallBack?(nil, LocationError.fetchFailed)
        fetchLocationCallBack = nil
    }
}

테스트 코드 수정

이제 다른 테스트도 추가하기 위해 테스트 코드를 수정해주겠습니다.

권한 상태에 따른 테스트를 위해 테스트 시 반환될 권한값도 정의해주었습니다. authorizationStatusToReturn
- requestWhenInUseAuthorization() 호출 시 해당 값을 넘겨주어 권한 상태에 따른 동작을 테스트할 수 있습니다.
locationToReturn의 반환값 유무에 따라 requestLocation()의 동작을 나눠주었습니다. 반환된 위치 정보가 없는 경우에 에러 처리 코드가 호출되는지 테스트할 수 있습니다.

// CLLocationManager 대신 동작할 Mock 객체
struct LocationManagerMock: LocationManagerInterface {
    var locationManagerDelegate: LocationManagerDelegate?
    
    var locationToReturn: (() -> CLLocation)? // 테스트 시 전달할 위치값
    var authorizationStatusToReturn: CLAuthorizationStatus = .notDetermined // 테스트 시 전달할 권한 상태
    
    func requestLocation() {
        if let location = locationToReturn?() {
            locationManagerDelegate?.locationManagerAbstract(self, didUpdateLocations: [location])
        } else {
            locationManagerDelegate?.locationManagerAbstract(self, didFailWithError: LocationError.fetchFailed)
        }
    }
    
    func requestWhenInUseAuthorization() {
        locationManagerDelegate?.locationManagerAbstract(self, didChangeAuthorization: authorizationStatusToReturn)
    }
}

위치 정보를 받아오지 못한 경우의 테스트 코드를 추가해주었습니다.

또한 테스트 코드 내용을 Given-When-Then 구조로 맞춰주었습니다.

final class LocationServiceTests: XCTestCase {
    
    private var sut: LocationService!
    
    override func setUpWithError() throws {
        super.setUp()
    }
    
    override func tearDownWithError() throws {
        super.tearDown()
        sut = nil
    }
  
    func test_fetchCurrentLocation을_호출시_위치가_반환됐을_때_위치정보가_제대로_전달되는지_확인() {
        // Given
        var locationManagerMock = LocationManagerMock()
        locationManagerMock.locationToReturn = {
            return CLLocation(latitude: 37.6134436427887, longitude: 126.926493082645) // locationManager가 반환할 위치값
        }
        sut = LocationService(locationManager: locationManagerMock)
        
        let expectedLocation = CLLocation(latitude: 37.6134436427887, longitude: 126.926493082645) // 기대값
        var result = CLLocation(latitude: 0.0, longitude: 0.0) // 반환 결과를 받을 변수
        let completionExpectation = expectation(description: "fetchCurrentLocation completion expectation")
        
        // When
        sut.fetchCurrentLocation { location, _ in
            if let location = location {
                result = location
                completionExpectation.fulfill()
            }
        }
        wait(for: [completionExpectation], timeout: 1)
        
        // Then
        XCTAssertEqual(result.coordinate.latitude, expectedLocation.coordinate.latitude)
        XCTAssertEqual(result.coordinate.longitude, expectedLocation.coordinate.longitude)
    }
    
    func test_fetchCurrentLocation을_호출시_위치가_반환되지_않으면_에러를_던지는지_확인() {
        // Given
        var locationManagerMock = LocationManagerMock()
        locationManagerMock.locationToReturn = {
            return nil
        }
        sut = LocationService(locationManager: locationManagerMock)
        var result: (location:CLLocation?, error:Error?)
        let completionExpectation = expectation(description: "fetchCurrentLocation completion expectation")
        
        // When
        sut.fetchCurrentLocation { location, error in
            result.location = location
            result.error = error
            completionExpectation.fulfill()
        }
        wait(for: [completionExpectation], timeout: 1)
        
        // Then
        XCTAssertNil(result.location)
        XCTAssertNotNil(result.error)
    }
}

추가 리팩토링

2개 테스트 코드의 Given 부분을 보면 중복되는 코드가 많습니다.

LocationService와 LocationManagerMock 인스턴스를 생성하는 부분은 setUpWithError() 에서 처리해주는 것이 좋을 것 같습니다.

Given 단계에서는 테스트 시 넘겨줄 값을 지정하기 위해 LocationManagerMock 인스턴스를 생성하고 locationToReturn에 값을 할당해줍니다. LocationService에서는 델리게이트 할당이 이니셜라이저에서 이루어지기 때문에 mock 인스턴스를 생성한 이후에, 그 mock 인스턴스를 LocationService의 이니셜라이저로 넘겨주면서 LocationService를 초기화해주어야 합니다.

그렇기 때문에 mock 인스턴스 생성 → sut 생성 의 순서로 코드를 작성할 수밖에 없습니다.

locationToReturn은 mock 객체에서 새로 정의한 프로퍼티이기 때문에 LocationService에서는 접근할 수가 없습니다. (LocationManagerInterface에서 요구하지 않는 프로퍼티임)

그렇다고 테스트 시에만 사용하는 locationToReturn 프로퍼티를 인터페이스 프로토콜에 추가로 정의해주는 것은 실제 동작 시에 불필요한 프로퍼티가 추가되는 것이기 때문에 불필요하다고 생각됩니다.

그래서 저는 mock 객체용 인터페이스를 추가적으로 정의해주었습니다.

새로운 인터페이스 프로토콜은 LocationManagerInterface 프로토콜을 상속받도록 구현했습니다.

protocol LocationManagerMockInterface: LocationManagerInterface {
    var locationToReturn: (() -> CLLocation?)? { get set }
    var authorizationStatusToReturn: CLAuthorizationStatus { get set }
}

그리고 mock 객체의 채택 프로토콜을 수정하고 타입도 struct → class로 변경해주었습니다. 이는 인스턴스의 참조를 사용하기 위해서인데, 자세한 이유는 아래에서 설명하겠습니다.

// CLLocationManager 대신 동작할 Mock 객체
class LocationManagerMock: LocationManagerMockInterface {
    ...
}

테스트 코드에서는 setUpWithError()에서 먼저 sut 인스턴스를 초기화해줍니다. 이니셜라이저를 통해 LocationManagerMock 인스턴스를 프로퍼티로 할당해줍니다.

sut 인스턴스의 초기화 이후에 mock 인스턴스를 할당해주면 델리게이트 지정이 되지 않습니다. 왜냐하면 델리게이트 할당이 sut(LocationService) 객체의 초기화 단계에서 이루지기 때문입니다.

setUpWithError()에서 인스턴스 초기화가 이루어지기 때문에 이제 각 테스트 코드의 Given 단계에서는 인스턴스를 생성할 필요 없이 반환값의 세팅만 해주면 됩니다.

override func setUpWithError() throws {
    super.setUp()
    sut = LocationService(locationManager: LocationManagerMock())
}

override func tearDownWithError() throws {
    super.tearDown()
    sut = nil
}

mock 객체의 locationToReturn 프로퍼티는 새로운 인터페이스 프로토콜의 요구사항이기 때문에 기존 locationManager로 바로 접근하게 되면 접근할 수가 없습니다. 그렇기 때문에 다운캐스팅을 진행해줍니다.

다운캐스팅 이후에는 locationToReturn 프로퍼티로 접근이 가능해집니다. 하지만 다운캐스팅된 locationManagerMock는if var 구문 내부에서만 사용할 수 있기 때문에 앞에서 mock 객체를 참조 타입인 클래스로 수정해준 것입니다. 이렇게 하면 if var 구문 내부에서의 수정이 locationManager 인스턴스에 반영됩니다.

func test_fetchCurrentLocation을_호출시_위치가_반환됐을_때_위치정보가_제대로_전달되는지_확인() {
    // Given
    if var locationManagerMock = sut.locationManager as? LocationManagerMockInterface {
        locationManagerMock.locationToReturn = {
            return CLLocation(latitude: 37.6134436427887, longitude: 126.926493082645) // locationManager가 반환할 위치값
        }
    }
    
    let expectedLocation = CLLocation(latitude: 37.6134436427887, longitude: 126.926493082645) // 기대값
    var result = CLLocation(latitude: 0.0, longitude: 0.0) // 반환 결과를 받을 변수
    let completionExpectation = expectation(description: "fetchCurrentLocation completion expectation")
    
    // When
    sut.fetchCurrentLocation { location, _ in
        if let location = location {
            result = location
            completionExpectation.fulfill()
        }
    }
    wait(for: [completionExpectation], timeout: 1)
    
    // Then
    XCTAssertEqual(result.coordinate.latitude, expectedLocation.coordinate.latitude)
    XCTAssertEqual(result.coordinate.longitude, expectedLocation.coordinate.longitude)
}

최종적으로 작성된 테스트 코드는 아래와 같습니다.

import XCTest
import CoreLocation
@testable import Data

protocol LocationManagerMockInterface: LocationManagerInterface {
    var locationToReturn: (() -> CLLocation?)? { get set }
    var authorizationStatusToReturn: CLAuthorizationStatus { get set }
}

// CLLocationManager 대신 동작할 Mock 객체
class LocationManagerMock: LocationManagerMockInterface {
    var locationManagerDelegate: LocationManagerDelegate?
    
    var locationToReturn: (() -> CLLocation?)? // 테스트 시 전달할 위치값
    var authorizationStatusToReturn: CLAuthorizationStatus = .notDetermined // 테스트 시 전달할 권한 상태
    
    func requestLocation() {
        if let location = locationToReturn?() {
            locationManagerDelegate?.locationManagerAbstract(self, didUpdateLocations: [location])
        } else {
            locationManagerDelegate?.locationManagerAbstract(self, didFailWithError: LocationError.fetchFailed)
        }
    }
    
    func requestWhenInUseAuthorization() {
        locationManagerDelegate?.locationManagerAbstract(self, didChangeAuthorization: authorizationStatusToReturn)
    }
}

final class LocationServiceTests: XCTestCase {
    
    private var sut: LocationService!
    
    override func setUpWithError() throws {
        super.setUp()
        sut = LocationService(locationManager: LocationManagerMock())
    }
    
    override func tearDownWithError() throws {
        super.tearDown()
        sut = nil
    }
  
    func test_fetchCurrentLocation을_호출시_위치가_반환됐을_때_위치정보가_제대로_전달되는지_확인() {
        // Given
        if var locationManagerMock = sut.locationManager as? LocationManagerMockInterface {
            locationManagerMock.locationToReturn = {
                return CLLocation(latitude: 37.6134436427887, longitude: 126.926493082645) // locationManager가 반환할 위치값
            }
        }
        
        let expectedLocation = CLLocation(latitude: 37.6134436427887, longitude: 126.926493082645) // 기대값
        var result = CLLocation(latitude: 0.0, longitude: 0.0) // 반환 결과를 받을 변수
        let completionExpectation = expectation(description: "fetchCurrentLocation completion expectation")
        
        // When
        sut.fetchCurrentLocation { location, _ in
            if let location = location {
                result = location
                completionExpectation.fulfill()
            }
        }
        wait(for: [completionExpectation], timeout: 1)
        
        // Then
        XCTAssertEqual(result.coordinate.latitude, expectedLocation.coordinate.latitude)
        XCTAssertEqual(result.coordinate.longitude, expectedLocation.coordinate.longitude)
    }
    
    func test_fetchCurrentLocation을_호출시_위치가_반환되지_않으면_에러를_던지는지_확인() {
        // Given
        if var locationManagerMock = sut.locationManager as? LocationManagerMockInterface {
            locationManagerMock.locationToReturn = {
                return nil
            }
        }
        
        var result: (location:CLLocation?, error:Error?)
        let completionExpectation = expectation(description: "fetchCurrentLocation completion expectation")
        
        // When
        sut.fetchCurrentLocation { location, error in
            result.location = location
            result.error = error
            completionExpectation.fulfill()
        }
        wait(for: [completionExpectation], timeout: 1)
        
        // Then
        XCTAssertNil(result.location)
        XCTAssertNotNil(result.error)
    }
}

테스트도 무사히 통과하게 되었습니다.

아쉬운 점

이렇게 수정하면서 결과적으로 각각의 테스트 코드 내부에서 인스턴스는 매번 생성하지 않게 되었습니다. 코드 길이도 같이 줄어들 것이라 기대했지만 타입 캐스팅 때문에 코드의 길이가 줄어들지는 않았습니다.
또한 위치 권한 상태에 따른 동작도 테스트해보려 했지만 Core Location에서 내부적으로 설정되어 있는 locationManagerDidChangeAuthorization(_ manager: CLLocationManager) 메서드의 호출 조건이 새로운 CLLocationManager 클래스 생성 시와 권한 상태가 변경됐을 때라서, 이를 mock 객체로 제어하는 방법이 떠오르지 않아 진행하지 못했습니다.

테스트코드를 처음 작성해봤는데, 처음부터 너무 어려운 테스트 코드를 시도한게 아닐까 싶은 생각이 들었습니다. 나름 자료를 찾아보면서 참고하며 작성한 코드지만 정말 테스트코드로서 의미가 있는건가에 대한 확신은 덜했던 것 같습니다.

그래도 이번 경험을 통해 어느 부분에서 테스트가 필요한 것인지, 어떻게 테스트하는 것인지 등을 어느 정도 짚고 넘어갈 수 있었다고 생각합니다.

이번에는 동작을 구현한 다음 테스트 코드로 검증을 했지만, 이후에는 TDD 기반으로 개발을 진행해보고 싶다는 생각이 들었습니다.

참고자료

https://dzone.com/articles/improving-testability-of-cllocationmanager

https://longlivedrgn-miro.tistory.com/61

[iOS] Core Location 사용해보기

kybeen — Tue, 23 Apr 2024 01:52:24 +0900

애플에서는 위치 관련 서비스를 위한 Core Location 이라는 프레임워크를 제공합니다.

Core Location 프레임워크를 사용하여 사용자의 위치 데이터를 받고 처리하는 방법을 알아보겠습니다.

Core Location이란?

Core Location을 사용하면 디바이스의 내장 수신 장치들을 활용하여 위치 데이터를 수집하고 처리할 수 있습니다.

CLLocationManager

Core Location 서비스를 구성-시작-종료 하기 위해서는 CLLocationManager 클래스 인스턴스를 사용해줍니다.

CLLocationManager는 아래와 같은 기능들을 지원하는데, 이번 글에서 주로 필요한 내용은 위치 변화 추적(Standard and significant location updates)이 되겠습니다.

위치 변화 추적(Standard and significant location updates)
지역 모니터링(Region monitoring)
비콘 감지(Beacon ranging)
나침반 관련 처리(Compass headlings)

권한 설정

Core Location에서 제공하는 위치 서비스 기능을 사용하려면 권한 설정이 필요합니다.

Info.plist에 usage description 작성

인증 요청 시 메세지에 표시할 내용을 작성해줍니다. Info.plist에 관련 key를 추가하여, string value로 앱이 위치 데이터에 액세스하려는 이유를 설명하는 내용을 작성해줍니다.

위치 데이터의 접근 수준에 따라 서로 다른 key를 설정해주어야 합니다.

Privacy - Location When In Use Usage Description : When in Use / Always 권한 모두 필요
Privacy - Location Always and When In Use Usage Description : Always일 때 필요
Privacy - Location Usage Description : macOS 앱일 경우 필요

Core Location은 2가지 접근 수준을 지원합니다. Always의 경우에는 내비게이션 같은 앱이 아닌 이상 배터리 효율을 위해 사용하지 않는 것이 좋습니다. 저는 When in Use 수준으로 사용할 것이기 때문에 Info.plist의 key로 Privacy - Location When In Use Usage Description만 추가해주었습니다.

When in Use : 앱을 사용할 때만 위치 업데이트를 사용
Always : 항상 위치 업데이트 사용 가능 (백그라운드에서도)

위치 서비스 권한 요청하기

실제 앱에서 코드로 권한을 요청하려면 앱의 현재 인증 상태를 확인하고, 필요한 경우에 인증 요청을 하는 것이 좋습니다.

CLLocationManager 객체의 authorizationStatus 프로퍼티를 통해 현재 앱의 인증 상태를 받아올 수 있고,

CLLocationManagerDelegate 프로토콜을 채택한 location manager 객체에서 locationManagerDidChangeAuthorization(_:) 메서드를 통해 인증 상태에 따른 처리를 할 수 있습니다. 해당 메서드는 앱이 location manager 객체를 생성했을 때와 인증 상태가 변경될 때마다 호출됩니다.

(코드 기반의 UIKit으로 작성된 코드입니다.)

뷰 컨트롤러에서 CLLocationManager 객체를 생성하고, 뷰 컨트롤러를 델리게이트로 지정해줍니다.

그리고 뷰 컨트롤에서 CLLocationManagerDelegate 프로토콜을 채택하고, locationManagerDidChangeAuthorization(_:) 메서드를 구현하여 인증 상태에 따른 처리 코드를 작성해줍니다.

When in Use 레벨의 승인을 요청할 때는 locationManager.requestWhenInUseAuthorization() 를 사용해 요청할 수 있습니다. (Always 레벨이라면 requestAlwaysAuthorization() 이겠죠?)

import CoreLocation

public final class MainViewController: UIViewController {
    ...
    let locationManager: CLLocationManager
    
    init() {
        print("locationManager 인스턴스 생성!!")
        locationManager = CLLocationManager()
        super.init(nibName: nil, bundle: nil)
    }
    
	...
    
    public override func viewDidLoad() {
        super.viewDidLoad()
        locationManager.delegate = self
    }
    
	...
}

extension MainViewController: CLLocationManagerDelegate {
    
    public func locationManagerDidChangeAuthorization(_ manager: CLLocationManager) {
        // CLLocationManager 객체의 athorizationStatus 프로퍼티를 통해 앱의 현재 인증 상태를 확인 가능
        switch manager.authorizationStatus {
        case .authorizedWhenInUse: // 위치 서비스를 사용 가능한 상태
            print("위치 서비스 사용 가능")
            break
        case .restricted, .denied: // 위치 서비스를 사용 가능하지 않은 상태
            print("위치 서비스 사용 불가")
            break
        case .notDetermined: // 권한 설정이 되어 있지 않은 상태
            print("권한 설정 필요")
            locationManager.requestWhenInUseAuthorization() // 권한 요청
            break
        default:
            break
        }
    }
}

위에서 설명했다시피 locationManagerDidChangeAuthorization(_:) 메서드는 location manager 객체가 생성되었을 때와 인증 상태가 변경될 때마다 호출됩니다.

그렇기 때문에 프로젝트를 실행하기 되면 해당 뷰 컨트롤러가 초기화될 때 CLLocationManager 클래스의 인스턴스인 locationManager 객체도 초기화되면서 델리게이트 메서드를 호출하여 인증 상태를 한 번 확인하게 됩니다. 이 때는 아직 권한 설정이 되어 있지 않기 때문에 "권한 설정 필요" 라는 메세지가 출력될 것입니다.

그 후 권한 요청 팝업이 뜨고, 권한을 설정하게 된다면 다시 한 번 델리게이트 메서드가 호출되며 설정된 인증 상태를 확인하게 됩니다. 만약 승인을 했다면 "위치 서비스 사용 가능" 이라고 메세지가 출력될 것입니다.

현재 유저의 위치 받아오기

이제 위치 데이터에 대한 접근 권한을 받았으니 위치 데이터를 활용하는 법을 알아보겠습니다.

Core Location은 여러 종류의 위치 서비스를 제공하는데, 앱에서 위치 데이터의 활용 용도와 배터리 효율을 고려하여 CLLocationManager 객체가 적절한 메서드를 호출하도록 구성해주어야 합니다.

CLLocationManager 객체에서 제공하는 Standard location service(표준 위치 서비스)와 관련된 메서드&프로퍼티는 아래와 같습니다.

func startUpdatingLocation() : 유저의 현재 위치를 보고하는 업데이트를 시작 (추적 시작)
func stopUpdatingLocation() : 위치 업데이트를 중단
func requestLocation() : 유저의 현재 위치를 1번 요청
var pausesLocationUpdatesAutomatically: Bool : location manager 객체가 위치 업데이트를 직접 일시 중지 할 수 있는지에 대한 프로퍼티
var allowsBackgroundLocationUpdates: Bool : 앱이 백그라운드에서도 위치 업데이트를 받을 수 있는지에 대한 프로퍼티
var showsBackgroundLocationIndicator: Bool : 앱이 백그라운드에서 위치 서비스를 사용하고 있을 때 상단 status 바에 표시할지 말지
var activityType: CLActivityType : 앱이 앱의 위치 세션에서 사용자가 일반적으로 수행할 것으로 기대하는 활동 유형.
enum CLActivityType : 위치 업데이트와 관련된 활동 유형

이번 포스팅에서는 간단하게 버튼을 누르면 현재 위치를 1번 받아와서 화면에 표시해주도록 구현해보려고 합니다. 그렇게 하기 위해서는 이 중에서 requestLocation() 메서드를 활용할 수 있습니다.

requeestLocation() 메서드

CLLocationManager 객체가 requestLocation() 메서드를 호출하면, 델리게이트 객체의 locationManager(_:didUpdateLocations:) 메서드를 통해 위치 데이터를 받아올 수 있습니다.

⚠️ requestLocation() 메서드 사용 시에는 아래 2가지 델리게이트 메서드를 반드시 구현해주어야 합니다.

locationManager(_:didUpdateLocations:)
locationManager(_:didFailWithError:)

화면의 버튼을 클릭했을 때 locationManager가 requestLocation()를 호출하고, 델리게이트 메서드에서는 위치 데이터를 받아서 화면에 표시하도록 코드를 작성해 보았습니다.

public final class MainViewController: UIViewController {
	...
    
    public override func viewDidLoad() {
        super.viewDidLoad()
        locationManager.delegate = self
        customView.locationButton.addTarget(self, action: #selector(loadUserLocation), for: .touchUpInside)
    }
    
	...
    
    @objc func loadUserLocation() {
        locationManager.requestLocation()
    }
}

extension MainViewController: CLLocationManagerDelegate {
	...
    
    public func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) {
        if let coordinate = locations.last?.coordinate {
            customView.locationLabel.text = "현재 위치 : \(coordinate.latitude), \(coordinate.longitude)"
        }
    }
    
    public func locationManager(_ manager: CLLocationManager, didFailWithError error: Error) {
        print("위치 정보를 받아오는 데 실패함")
    }
}

프로젝트를 빌드하면 아래와 같이 동작하게 됩니다.

전체 코드

ViewController

import UIKit
import CoreLocation

public final class MainViewController: UIViewController {
    
    let customView = MainView()
    let locationManager: CLLocationManager
    
    init() {
        print("locationManager 인스턴스 생성!!")
        locationManager = CLLocationManager()
        super.init(nibName: nil, bundle: nil)
    }
    
    required init?(coder: NSCoder) {
        fatalError("init(coder:) has not been implemented")
    }
    
    public override func viewDidLoad() {
        super.viewDidLoad()
        locationManager.delegate = self
        customView.locationButton.addTarget(self, action: #selector(loadUserLocation), for: .touchUpInside)
    }
    
    public override func loadView() {
        view = customView
    }
    
    @objc func loadUserLocation() {
        locationManager.requestLocation()
    }
}

extension MainViewController: CLLocationManagerDelegate {
    
    public func locationManagerDidChangeAuthorization(_ manager: CLLocationManager) {
        // CLLocationManager 객체의 athorizationStatus 프로퍼티를 통해 앱의 현재 인증 상태를 확인 가능
        switch manager.authorizationStatus {
        case .authorizedWhenInUse: // 위치 서비스를 사용 가능한 상태
            print("위치 서비스 사용 가능")
            break
        case .restricted, .denied: // 위치 서비스를 사용 가능하지 않은 상태
            print("위치 서비스 사용 불가")
            break
        case .notDetermined: // 권한 설정이 되어 있지 않은 상태
            print("권한 설정 필요")
            locationManager.requestWhenInUseAuthorization() // 권한 요청
            break
        default:
            break
        }
    }
    
    public func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) {
        if let coordinate = locations.last?.coordinate {
            customView.locationLabel.text = "현재 위치 : \(coordinate.latitude), \(coordinate.longitude)"
        }
    }
    
    public func locationManager(_ manager: CLLocationManager, didFailWithError error: Error) {
        print("위치 정보를 받아오는 데 실패함")
    }
}

View

import UIKit
import SnapKit

public final class MainView: UIView {
    
    lazy var locationLabel: UILabel = {
        let label = UILabel()
        label.textColor = .black
        label.text = "현재 위치 : "
        return label
    }()
    
    lazy var locationButton: UIButton = {
        let config = UIButton.Configuration.filled()
        let button = UIButton(configuration: config)
        button.setTitle("현재 위치 받아오기", for: .normal)
        return button
    }()
    
    init() {
        super.init(frame: .zero)
        setUI()
    }
    
    required init?(coder: NSCoder) {
        super.init(coder: coder)
    }
    
    func setUI() {
        self.backgroundColor = .white
        
        addSubview(locationLabel)
        locationLabel.snp.makeConstraints { make in
            make.center.equalToSuperview()
        }
        
        addSubview(locationButton)
        locationButton.snp.makeConstraints { make in
            make.centerX.equalToSuperview()
            make.top.equalTo(locationLabel.snp.bottom).offset(50)
        }
    }
}

Core Location의 공식 문서를 읽고 노션에 정리한 링크입니다.

https://healthy-degree-cc2.notion.site/Core-Location-a433acae3797473fba627f49f324d326?pvs=4

Core Location | Notion

Core Location 이란?

healthy-degree-cc2.notion.site

참고

https://developer.apple.com/documentation/corelocation

Core Location | Apple Developer Documentation

Obtain the geographic location and orientation of a device.

developer.apple.com

https://developer.apple.com/documentation/corelocation/configuring_your_app_to_use_location_services

Configuring your app to use location services | Apple Developer Documentation

Verify that location services are available and configure your app before you start collecting location data.

developer.apple.com

https://developer.apple.com/documentation/corelocation/requesting_authorization_to_use_location_services

Requesting authorization to use location services | Apple Developer Documentation

Obtain authorization to use location services and manage changes to your app’s authorization status.

developer.apple.com

https://developer.apple.com/documentation/corelocation/getting_the_current_location_of_a_device

Getting the current location of a device | Apple Developer Documentation

Start location services and provide information the system needs to optimize power usage for those services.

developer.apple.com

https://developer.apple.com/documentation/corelocation/cllocationmanager

CLLocationManager | Apple Developer Documentation

The object that you use to start and stop the delivery of location-related events to your app.

developer.apple.com

[iOS] 외국 밈(meme)에서 많이 쓰는 폰트 적용해보기 (SwiftUI)

kybeen — Thu, 18 Apr 2024 17:45:48 +0900

인터넷 유머에 익숙한 사람, 특히 외국 밈에 익숙한 사람이라면 아래와 같은 형식의 짤을 많이 봤을 것입니다.

출처 :&nbsp;https://www.vox.com/2015/7/26/9036993/meme-font-impact

대부분의 외국 밈 짤에서는 저렇게 두꺼운 흰색 글자에 검은색 테두리를 갖는 폰트가 사용됩니다.

당장 구글에 'meme'이라고만 검색해도 그 폰트를 잔뜩 볼 수 있습니다.

'meme' 검색 결과

토이 프로젝트를 하나 만들면서 이 폰트를 사용하고 싶어졌습니다.
해당 프로젝트는 SwiftUI로 진행할 것이기 때문에 SwiftUI로 이 폰트를 사용하는 법을 알아보겠습니다.

그래서 이 폰트가 뭔가요?

외국 밈에서 많이 사용하는 이 폰트의 이름은 'Impact(임팩트)'라고 합니다.
인터넷 밈에 자주 사용되기 때문에 생겨난지 얼마 되지 않은 폰트라고 생각될 수도 있는데, 1965년에 생겨난 매우 근본 있는 폰트라고 합니다.
사진 위에서도 명확하게 텍스트를 구분시켜주는 서체이기 때문에 밈에 자주 쓰이기 시작했다는 것 같습니다.

출처 : https://www.vox.com/2015/7/26/9036993/meme-font-impact

이 포스팅은 SwiftUI에서 사용하는 법을 다루는 것이 메인이기 때문에, Impact 폰트가 밈에서 많이 쓰이게 된 유래에 대한 설명은 아래 글을 참고해주시면 될 것 같습니다.
https://www.vox.com/2015/7/26/9036993/meme-font-impact

The reason every meme uses that one font

Why do all memes look so similar? There are a few very good reasons.

www.vox.com

Impact 폰트 다운로드

Impact 서체는 개인 및 상업적 용도로 무료로 사용하는 것이 가능하다고 합니다.
참고로 폰트는 '폰트 서체 자체'가 아니라 '디지털화한 파일 형식인 ttf'일 때 저작권법으로 보호받는다고 하네요. (참고)

SwiftUI에서 커스텀 폰트를 적용하려면 해당 폰트의 ttf 파일을 프로젝트에 추가해야 하기 때문에 다운받아주겠습니다.
저는 여기에서 다운받았습니다.

프로젝트에서 폰트 적용하기

Xcode 프로젝트에 폰트 파일을 추가해 주었습니다.
폰트 파일을 타겟에 추가해주지 않으면 폰트가 적용되지 않기 때문에 Add to targets에 체크를 해줍니다.

Add to targets 체크

그리고 Info.plist에 Fonts provided by application 항목을 추가하여 적용하려는 폰트들을 아이템으로 추가해줍니다.

Info.plist에 추가

Text에 폰트를 적용해주는 코드는 아래와 같습니다.

Text("WHY EVERY MEMES USE THIS FONT?")
    .foregroundStyle(.white)
    .font(.custom("impact", size: 30))

임팩트 폰트가 잘 적용된 것을 볼 수 있습니다.

하지만 뭔가 아쉽습니다.
왜냐하면 텍스트에 검은색 테두리가 빠져 있기 때문이죠

출처 :&nbsp;https://sproutsocial.com/glossary/meme/

검은색 테두리 적용하기

진짜 밈 서체가 되기 위해 검은색 테두리가 적용된 Text를 만들어보겠습니다.
애플 쪽에서 기본적으로 테두리가 적용된 텍스트를 지원하지는 않기 때문에 직접 테두리를 넣어줘야 합니다.

1. .bold()가 적용된 Text 깔아주기 - ❌

ZStack에서 같은 Text를 2개 겹치고, 더 뒤에 있는 Text에 검은색 서체와 .bold()를 적용해줘봤습니다.
하지만 원하던 모양이 나오지 않았습니다.

Text("WHY EVERY MEMES USE THIS FONT?")
    .foregroundStyle(.black)
    .font(.custom("impact", size: 30.5))
    .bold()
Text("WHY EVERY MEMES USE THIS FONT?")
    .foregroundStyle(.white)
    .font(.custom("impact", size: 30))

bold 텍스트 깔아주기

2. 주위로 offset을 적용한 Text 여러개 겹치기 - ✅

위의 방법이랑 비슷하지만 이번에는 bold 텍스트를 깔아주는 것이 아니라, Text의 주변 방향으로 offset만큼 이동시킨 Text들을 여러개 깔아주었습니다. OutlineText라는 이름의 커스텀 Text로 정의해주었습니다.
(여기 코드를 참고하여 만들었습니다.)

struct OutlineText: View {
    let text: String
    let width: CGFloat
    let color: Color
    
    var body: some View {
        ZStack{
            ZStack{
                Text(text).offset(x:  width, y:  width)
                    .font(.impactFont30)
                Text(text).offset(x: -width, y: -width)
                    .font(.impactFont30)
                Text(text).offset(x: -width, y:  width)
                    .font(.impactFont30)
                Text(text).offset(x:  width, y: -width)
                    .font(.impactFont30)

            }
            .foregroundColor(color)
            Text(text)
                .font(.impactFont30)
                .foregroundStyle(.white)
        }
    }
}

크기 30에 impact 폰트가 적용된 impactFont30 값을 Font 값의 익스텐션에서 정의해주었습니다.

extension Font {
    static let impactFont30: Font = .custom("impact", size: 30)
}

OutlineText를 적용한 모습은 아래와 같습니다.

struct TestView: View {
    var body: some View {
        ZStack {
            Color(.gray)
            OutlineText(text: "WHY EVERY MEMES USE THIS FONT?", width: 1, color: .black)
        }
    }
}

꽤나 괜찮은 것 같습니다.

3. shadow 효과가 적용된 커스텀 modifier 정의하기 - ✅

마지막으로 shadow 효과를 적용해주는 커스텀 modifier를 정의해주는 방법입니다.
(여기 코드를 참고하여 만들었습니다.)

ViewModifier 프로토콜을 채택한 ShadowOutlineModifier를 정의해줍니다.
body(content:) 메서드를 통해 modifier를 호출한 View의 body를 받아와서 원하는 처리가 가능합니다.
아래 modifier에서는 shadow 효과를 인자로 받은 lineWidth 값에 맞게 점점 넓게 적용해줍니다. 이렇게 하면 lineWidth 넓이 만큼 그림자가 지속적으로 진하게 적용됩니다.

View의 익스텐션으로 modifier를 정의해줍니다.
.modifier(ShadowOutlineModifier()) 형식으로 사용할 수도 있지만 편의를 위해 식별하기 쉬운 modifier 명으로 정의해줍니다.

struct ShadowOutlineModifier: ViewModifier {
    var color: Color
    var lineWidth: Int
    
    func body(content: Content) -> some View {
        var newContent = AnyView(content)
        for _ in 0..<lineWidth {
            newContent = AnyView(newContent.shadow(color: color, radius: 1))
        }
        return newContent
    }
    
}

extension View {
    func shadowOutline(color: Color, lineWidth: Int) -> some View {
        self.modifier(ShadowOutlineModifier(color: color, lineWidth: lineWidth))
    }
}

modifier를 적용하는 코드입니다.

struct TestView: View {
    var body: some View {
        ZStack {
            Color(.gray)
            Text("WHY EVERY MEMES USE THIS FONT?")
                .font(.impactFont30)
                .foregroundStyle(.white)
                .shadowOutline(color: .black, lineWidth: 3)
        }
    }
}

실제 짤 만들어보기

이제 impact 폰트에 진짜 사진도 같이 활용해서 실제 밈 짤처럼 만들어보겠습니다.

2. 커스텀 Text 사용 (offset 적용)

struct TestView: View {
    var body: some View {
        ZStack {
            Image("squirrel")
                .resizable()
                .aspectRatio(contentMode: .fit)
            OutlineText(text: "\n\n\n\n\nI DIDN'T STEAL IT!!!!", width: 2, color: .black)
        }
    }
}

3. 커스텀 modifier 사용 (그림자 효과)

struct TestView: View {
    var body: some View {
        ZStack {
            Image("squirrel")
                .resizable()
                .aspectRatio(contentMode: .fit)
            Text("\n\n\n\n\nI DIDN'T STEAL IT!!!!")
                .font(.impactFont30)
                .foregroundStyle(.white)
                .shadowOutline(color: .black, lineWidth: 5)
        }
    }
}

그럴싸하네요

참고

https://www.vox.com/2015/7/26/9036993/meme-font-impact
https://www.tosspayments.com/blog/articles/legal2-2
https://cofonts.net/impact-font/
https://stackoverflow.com/questions/57334125/how-to-make-text-stroke-in-swiftui
https://www.youtube.com/watch?v=MJLoKS1i1oQ

[iOS] M1 맥북 + Xcode 15 환경에서 SwiftLint 적용 시 오류 처리

kybeen — Wed, 28 Feb 2024 02:58:39 +0900

M1 맥북 + Xcode 15 환경에서 SwiftLint를 적용해보면서 겪은 문제에 대해 정리한 글입니다.

아래 설명된 오류처리와 함께 추가적인 설정과 SwiftLint 설치 및 적용 과정도 정리한 내용을 보고 싶다면 여기를 참고해주세요

SwiftLint 적용하기 | Notion

1. SwiftLint 설치

healthy-degree-cc2.notion.site

‼️ 만약 M1 이상 맥북 + Xcode 15 이상 버전의 개발 환경이라면 아래에서 소개드릴 2가지 문제를 반드시 해결해주어야 SwiftLint를 정상적으로 사용할 수 있는 것 같습니다.

Homebrew로 설치 시 Apple Silicon에서 SwiftLint를 찾지 못하는 문제

Apple Silicon(M1, M2 등)에서 Homebrew를 통해 SwiftLint를 설치하는 경우, 빌드 시에 아래와 같은 경고가 발생합니다.

warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint

이는 Apple Silicon에서 Homebrew가 기본적으로 /opt/homebrew/bin 폴더에 바이너리를 설치하는데, Xcode가 해당 경로를 몰라서 SwiftLint를 찾지 못하기 때문에 나타나는 경고입니다.

✅ Xcode 프로젝트의 Build Phases 옵션에서 추가해준 SwiftLint 실행 스크립트에서 PATH 환경 변수에 /opt/homebrew/bin 경로를 지정해주면 됩니다.

# 이 코드를 추가
if [[ "$(uname -m)" == arm64 ]]; then
    export PATH="/opt/homebrew/bin:$PATH"
fi

if which swiftlint > /dev/null; then
  swiftlint
else
  echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"
fi

Xcode 15에서 - Failed with a nonzero exit code 또는 error: Sandbox: swiftlint(19427) deny(1) file-read-data. 오류

SwiftLint의 깃허브를 살펴보니 해당 문제는 Xcode 15버전부터 발생하는 것 같습니다.

린트 설정 후 빌드를 하면 아래 사진처럼 스크립트 실행이 실패했다는 오류가 발생합니다.

이는 Xcode 15에서 ENABLE_USER_SCRIPT_SANDBOXING 이라는 빌드 설정의 기본값을 NO에서 YES로 변경했기 때문에 발생하는 오류입니다.

이 설정은 빌드 시스템에게 소스 파일이나 중간 빌드 개체에 액세스하는 scripts phases를 차단할지 여부에 대한 내용인데, 이 값이 YES로 되어 있어서 추가한 SwiftLint Script가 소스 파일에 접근하는 것이 차단되는 것입니다.
추가적으로 SwiftLint의 깃허브에서도 해당 변경사항으로 인한 문제를 언급하고 있는데, 여기서는 Failed with a nonzero exit code가 아닌 error: Sandbox: swiftlint(19427) deny(1) file-read-data. 라는 에러 메세지가 나올 것이라고 말해주고 있습니다.
어쨌든 두 가지 오류 모두 같은 방법으로 해결이 가능합니다.

✅ Xcode에서 ENABLE_USER_SCRIPT_SANDBOXING 설정값을 다시 NO로 변경해주면 됩니다.

아래 사진을 따라서 프로젝트 타겟의 Build Settings로 들어간 뒤, ENABLE_USER_SCRIPT_SANDBOXING 설정값을 NO로 변경해줍니다.

이렇게 해주면 정상적으로 빌드가 될 것입니다.

참고 사이트

SwiftLint 공식문서(깃허브) : https://github.com/realm/SwiftLint/blob/main/README_KR.md

https://github.com/realm/SwiftLint/issues/5130

SwiftLint Run Script Phase fails on Xcode 15 · Issue #5130 · realm/SwiftLint

New Issue Checklist Updated SwiftLint to the latest version I searched for existing GitHub issues Describe the bug Using SwiftLint on Xcode 15 Beta causes an error: "Command PhaseScriptExecution fa...

github.com

How to fix the "The file “.swiftlint.yml” couldn’t be opened because you don’t have permission to view it" issue

When we use swiftlint with Xcode 15 we can get the "The file “.swiftlint.yml” couldn’t be opened because you don’t have permission to view it" error. Here is how to fix it.

thisdevbrain.com

[ iOS ] CustomStringConvertible 프로토콜

kybeen — Tue, 13 Feb 2024 15:49:01 +0900

공식 문서

https://developer.apple.com/documentation/swift/customstringconvertible

CustomStringConvertible | Apple Developer Documentation

A type with a customized textual representation.

developer.apple.com

Swift의 CustomStringConvertible 프로토콜은 커스텀된 텍스트 표현을 사용할 수 있도록 해주는 프로토콜임

개요

CustomStringConvertible 프로토콜을 준수하는 타입은 인스턴스를 문자열로 변환할 때 그 타입만의 자체 표현을 제공할 수 있다.
만약 CustomStringConvertible 프로토콜을 준수하는 인스턴스가 String(describing:) 이니셜라이저나 print(_:) 함수의 인자로 전달되면 해당 이니셜라이저와 함수는 인스턴스의 description 프로퍼티를 사용한다.
(description 프로퍼티에 직접 접근하거나 CustomStringConvertible을 제네릭 타입 제약에 사용하는 것은 권장되지 않음)

즉, 타입 자체를 원하는 형식의 문자열로 바로 표현하고 싶을 때 사용할 수 있는 프로토콜인 것 같다.
description 프로퍼티에 직접 접근하는 것을 권장하지 않는 이유는 이렇게 사용할 경우 굳이 CustomStringConvertible 프로토콜을 채택할 필요 없이 그냥 연산 프로퍼티를 추가하면 되기 때뭉에 용도를 구분해주고자 그런게 아닐까 싶다.

CustomStringConvertible 프로토콜 준수하기

description 프로퍼티를 정의해주는 것으로 CustomStringConvertible 프로토콜을 준수할 수 있다.

공식 문서의 예제를 보면 CustomStringConvertible 프로토콜을 준수하지 않을 때는 Point 구조체를 print() 시에 구조체가 그대로 나오지만, Point 구조체가 CustomStringConvertible 프로토콜을 준수할 때는 print() 시에 자동으로 description 프로퍼티에 정의된 형식으로 출력되는 것을 볼 수 있다.

// MARK: - CustomStringConvertible 프로토콜 준수 x
struct Point {
    let x: Int, y: Int
}


let p = Point(x: 21, y: 30)
print(p)
// Prints "Point(x: 21, y: 30)"


// MARK: - CustomStringConvertible 프로토콜 준수
extension Point: CustomStringConvertible {
    var description: String {
        return "(\(x), \(y))"
    }
}


print(p)
// Prints "(21, 30)"

적용해보기

CustomStringConvertible 프로토콜을 직접 적용해보았다.

지하철 도착 정보에 대한 구조체인 ArrivalInfo의 restTime 프로퍼티는 초 단위로 값을 받아오기 때문에 00분00초 형식으로 표현을 해주어야 한다.

struct ArrivalInfo {
    var restTime: RestTimeSecond    // 남은 시간 (단위: 초)
    var prevStation: String         // 이전역
    var nextStation: String         // 다음역
    var station: String             // 현재역
}

CustomStringConvertible 프로토콜을 준수하는 RestTimeSecond라는 타입을 정의해서 초 단위로 표현된 Int 값을 "00분00초" 의 String으로 표현해주도록 description 프로퍼티를 정의해주었다.

struct RestTimeSecond: CustomStringConvertible {
    var second: Int
    
    var description: String {
        return "\(second/60)분\(second%60)초"
    }
}

이후 실시간 정보를 받아와서 텍스트로 표시하도록 코드를 작성해주었다.

self?.subwayView.timeLabel.text =  "\(arrivalInfoList[1].restTime) 남았습니다."

공식 문서의 설명에서 String(describing:) 이니셜라이저 사용 시에 description 프로퍼티가 적용이 된다고 했기 때문에 문자열 보간 시에도 적용이 되지 않을까 싶어서 사용해봤는데 적용된다 ㅎㅎ