[iOS] Objective-C <-> Swift 같이 사용하기(1. 프로젝트에서 2. framework에서) + @objc attribute 정확히 사용하기

제품 개발 중 고객사의 요청에 따라 Swift 언어에 대응하는 일이 많아지면서,

기존 Objective-C로 구현된 제품 자체를 Swift로 Converting 하는 작업을 하고 있다.

 

이 과정에서 한 프로젝트에서 Objective-C와 Swift를 함께 사용하고, 

Swift로 만든 Framework를 Objective-C 프로젝트에서

Objective-C로 만든 Framework를 Swift 프로젝트에서 테스트해야 했다.

 

이렇게 Swift와 Objective-C 를 함께 사용하기 위해 설정할 것들과

두 언어의 차이점에서 발생하는 문제점을 공유하고자 한다.

---

[Contents]

1. Swift 프로젝트에서 Objective-C 사용하기
   1. Swift 프로젝트에서 Objective-C 사용하는 방법 (Import Objective-C into Swift)
2. Objective-C 프로젝트에서 Swift 사용하기
   1. Objective-C 프로젝트에서 Swift 사용하는 방법(Import Swift into Objective-C)
   2. Objective-C 프로젝트에서 Swift Framework를 사용하기
3. Swift, Objective-C를 같이 사용할 때 주의할 점
   
   1. enums in Swift and Objective-C

---

⭐️ 1. Swift 프로젝트에서 Objective-C 사용하기

공식 문서 : https://developer.apple.com/documentation/swift/importing-objective-c-into-swift

Importing Objective-C into Swift | Apple Developer Documentation

 

1-1. Swift 프로젝트에서 Objective-C 소스 사용하는 방법 (Import Objective-C into Swift)

1.  브리징 헤더 파일(Bridging header) 생성

Swift code에서 Objective-C 코드를 쓰려면, Objcective-C Bridging header 가 필요하다.

 

Xcode에서 이 헤더를 생성하는 방법은 자동, 수동 두 가지가 있다.

먼저, 스위프트 프로젝트에서 오브젝티브-C 파일을 생성하면 아래와 같은 팝업을 볼 수 있다.

 

 

1-1) 이때, Create Bridging Header를 선택했을 경우(자동)
파일을 생성한 곳에 AppName-Bridging-Header.h 파일이 생성된 것을 볼 수 있다.

 

1-2) Don't Create를 선택하거나 팝업이 보이지 않을 경우(수동)

AppName-Bridging-Header.h 파일을 직접 생성해준다.
다만, 이 프로젝트에서 브릿징 헤더 파일을 사용하고 있다는 사실을 명시해 주기 위해서
'Project - Target - Build Settings - Objective-C Bridging Header'에 파일의 위치/AppName-Bridging-Header.h 를 추가

*이때, 브리징 헤더 파일명은 "Project name"-Bridging-Header.h 이어야 함!

 

생성된 헤더파일을 Build Settings에 추가하여 컴파일할 때 참조되도록 해야 한다.

 

*여러 개 target 이 있어 여러 개 브릿징 헤더 파일이 생성되는 경우!

"Project name"-Bridging-Header.h 1개를 제외하고 다 삭제 후 Build Setting에 해당 파일의 경로(상대경로)를 넣어주어

모든 타깃이 같은 브릿징 헤더를 사용해야 한다.

 

2. 사용하기

이 파일 안에 아래와 같이 Swift에서 사용할 오브젝티브-C 파일의 헤더 파일을 import 해주면 된다.

#import "NewObjectiveCFile.h"
// MARK: - Models -
#import "User.h"
#import "Group.h"

// MARK: - Managers -
#import "AnalyticsManager.h"
#import "AlertManager.h"

+Swift에서 Objective-C 메소드를 사용할 때, NS_SWIFT_NAME 매크로(preprocessor)를 사용하여 커스텀 가능!

예를 들어, 아래 메소드를

+(void)SuperGoodAdditionFeature:(NSInteger)a (NSInteger)b;

원래 Swift에서 이 코드를 사용할 때,

let result = SuperGoodAdditionFeature(1, 2)

NS_SWIFT_NAME 매크로 사용하여 재정의하여 Swift 용 별명을 만들어 준다.

+(void)SuperGoodAdditionFeature:(NSInteger)a (NSInteger)b
NS_SWIFT_NAME(add(a:b:));

재정의한 이름(renaming)으로아래와 같이 코딩 가능하다.

let result = add(a: 1,b: 2)

공식 문서 : https://developer.apple.com/documentation/swift/renaming-objective-c-apis-for-swift

 

---

⭐️ 2. Objective-C 프로젝트에서 Swift 사용하기

공식 문서 : https://developer.apple.com/documentation/swift/importing-swift-into-objective-c

Importing Swift into Objective-C | Apple Developer Documentation

2-1. Objective-C 프로젝트에서 Swift 소스 사용하는 방법(Import Swift into Objective-C)

1. 'Project - Target - Build Settings - Defines Module'을  Yes로 설정

2. @objc 속성(attribute) 사용

Objective-C에서 사용할 Swift 파일의 클래스나 함수명 앞에는 @objc 속성을 사용해서 Swift 클래스, 메서드, 속성을 Objective-C에서 사용 가능하다. 

자세한 내용 : https://lxxyeon.tistory.com/95

이 속성은 compiler에게 Objective-C에서 속성을 붙인 것에 접근할 것을 알리고, 만약 Swift class가 Objective-C를 상속되었다면, compiler가 자동으로 @objc를 붙여준다. 이 속성은 3가지로 사용되는데,

• @objc : 메서드, 속성
• @objc(name) : 사용할 메서드나 속성의 이름을 재정의(custom)해서 사용할 수 있다.
  

@objc(sharedManager)
static let shared = MyManager()

위 변수를 Objective-C에서 호출할 때,

[MyManager sharedManager]

메소드의 파라미터도 재정의 가능!

@objc(processNotificationPayload:notificationType:)
static func processNotification(with payload: String, notificationType: NotificationType) {
  ...
}

• @objcMembers : 클래스의 모든 멤버, 확장, 하위 클래스, 클래스의 extensions 

@objcMembers class MyController: UIViewController {
    func login() {

    }
}

공식문서 : https://docs.swift.org/swift-book/documentation/the-swift-programming-language/attributes/#objc

 

이때, 클래스는 Objective-C 클래스(예: NSObject)를 상속받아 구현해야 한다.

@objc(TestService)
class TestService: NSObject {
    @objc static let shared = TestService()
    
    @objc func sayHello() {
    	print("Hello!")
    }
}

이제 Swift 코드를 사용하고 싶은 Objective-C 파일에서 해당 코드를 호출해 보면, 아래와 같은 오류가 발생한다.

[[TestService shared] sayHello];

// error
Use of undeclared identifier 'TestService'

이 오류는 우리가 헤더 파일을 임포트 하지 않아서 생긴 오류!!

그렇다면 우리는 헤더 파일을 새로 생성해야 하느냐!

 

그럴 필요 없이 우리가 위에서 Defines Module을 Yes로 설정해 놓았기 때문에 컴파일하는 과정에서 XCode가 헤더 파일을 자동으로 생성해 준다.

 

3. 사용할 Objective-C에 #import "{module name}-Swift.h" 추가

. h에서는 순환참조(cyclical reference)를 막기 위해 Swift code를 import 하지 않고 @class, @protocol로 마킹한다.

// MyObjcClass.h
@class MySwiftClass;
@protocol MySwiftProtocol;

@interface MyObjcClass : NSObject
- (MySwiftClass *)returnSwiftClassInstance;
- (void)test;
- (id <MySwiftProtocol>)returnInstanceAdoptingSwiftProtocol;
// ...
@end

.m 파일에서 자동 생성된 브릿지 헤더 파일(-Swift.h)을 import 해준다.

// .m
#import "MyObjcClass.h"
#import "ProductModuleName-Swift.h"

@implementation MyObjcClass
- (void) test {
    MySwiftClass *module = [[MySwiftClass alloc] init];
    [module test];
}
@end

4. 사용하기

 

---

2-2. Objective-C에서 Swift Framework를 사용하기

먼저 결론은 Swift Framework 내에 브릿징 헤더를 만들어서 사용할 Objective-C 코드 내에 import를 해주는 것이다.

 

근데, 이때, 직접 브릿징 헤더를 만들지 않고, 설정을 통해 자동으로 생성한다.

HOW? Build Setting > SWIFT_INSTALL_OBJC_HEADER 검색 > install Generated Header > Yes로 설정!!

 

 build 된 프레임워크 레포에 가면 생성된 헤더 파일이 있음을 확인!

이 헤더파일이름을 사용하고 싶은 곳에 import 해주면 된다!

이 헤더파일 또한 Swift의 interface를 정의하고 있고, 생성된 umbrella header는 umbrella framework에 대한 master header 가 된다.

#import <Framework/Framework-Swift.h>

 

*umbrella framework는 여러 프레임워크를 그룹화(subframework들을 encapsulate) 한 것으로 header file들을 include 하고 있다.

Umbrella framework는 내부의 구현을 잘 숨겨서 필요한 interface 만 제공할 수 있고,

precompiled header를 사용해 build 도 더 빨리 할 수 있는 장점이 있음.

---

⭐️ 3. Swift, Objective-C를 같이 사용할 때 주의할 점!

• Objective-C에서는 구조체와 튜플이 표시되지 않는다.
  • Swift에서 Tuple을 이용하여 여러 값을 한 번에 넘길 수 있다. 하지만 Objective-C는 ARC가 적용된 이후엔 struct 내부에 클래스 타입을 사용하지 못하도록 금지되어 있음.
  • Objective-C에 적용하면 아래와 같은 에러 발생 >  unsafe_unretained 사용하여 해결 가능!

• Swift Tuples, Generics을 포함한 아래 유형들은 @objc를 붙여도 Objective-C에서 사용할 수 없다.
  • 지원되지 않는 유형 : https://stackoverflow.com/questions/26463487/swift-globals-and-global-functions-in-objective-c
• Objective-C는 함수나 메소드 인자에 default 값을 지원하지 않는다.
• Objective-C에서 사용할 Swift 클래스를 Objective-C 클래스(예: NSObject)를 상속받아 구현해야 한다.
• Any in Swift = id in Objective-C
• Objective-C에서는 Swift 클래스를 상속할 수 없다. 그러나 protocol은 구현 가능!
• Objective-C 속성 중 null 지정자가 명시적으로 지정되지 않으면, Swift에서는 옵셔널로 처리한다 ->  언래핑된다. -> 충돌이 발생할 수 있습니다!

---

3-1.enums in Swift, Objective-C

IMPORTANT: Swift enums can't be used in Objective-C header files.

Objectiev-C와 Swift 열거형의 불일치함을 맞춰보자.

기본적인 Objectiev-C의 열거형의 예는 아래와 같다.

typedef enum my_type {
    MyTypeDefault = 0,
    MyTypeSolo,
    MyType
}MyType;

 

이런 식으로 선언할 경우 MyType이라는 타입은 Swift의 enum과는 다르게 struct 형태로 선언되어 버린다.

따라서, Swift에서 사용할 때, enum 스럽지 않은 형태인 각 필드의 이름 그대로 접근하게 된다.

let type: MyType = MyTypeDefault

 

이를 Swift에 어울리게 구현하려면 NS_ENUM 매크로를 이용해 열거형을 정의하여 수정~!

typedef NS_ENUM(int, MyType) {
    MyTypeDefault = 0,
    MyTypeSolo,
    MyType
};

 

이렇게 구현하면 MyType은 Swift의 enum형식으로 재정의되어 MyType 타입 인스턴스의 값을 .default, .solo 와 같이 prefix를 생략한 형태의 이름으로 쓸 수 있다. 

let type: MyType = .default

 

추가로, 아래와 같이 특이한 이름을 추가된 상황도 살펴보자.

마지막에 추가한 AnotherTypeSuperSolo라는 이름은 어울리지 않게. AnotherTypeSuperSolo와 같은 심볼로 밖에 접근할 수가 없을 것이다.

typedef NS_ENUM(int, MyType) {
    MyTypeDefault = 0,
    MyTypeSolo,
    MyType,
    AnotherTypeSuperSolo
};

 

이를 해결하기 위해 또 NS_SWIFT_NAME을 사용하여 해결 가능하다.

typedef NS_ENUM(int, MyType) {
    MyTypeDefault = 0,
    MyTypeSolo,
    MyType,
    AnotherTypeSuperSolo NS_SWIFT_NAME(anotherTypeSuperSolo)
};

이제 추가했던 마지막 이름을 Swift 스럽게 사용할 수 있게 된다.

let firstType: MyType = .default
let secondType: MyType = .anotherTypeSuperSolo

 

참고: https://infinum.com/handbook/ios/miscellaneous/swift-objective-c-interoperability-and-best-practices#make-swift-visible-to-objective-c