# Method Swizzling

[yoogail105]

Method Swizzling

• swizzling: 뒤섞다
• 런타임 때 기존의 메서드를 원하는 메소드로 바꾸어 사용할 수 있도록 하는 기법
• 이미 정해진 iOS의 특정 메소드가 실행될 때, 해당 메서드 대신 다른 메서드가 실행되도록 하는 기법
  • 이미 정해진 iOS의 특정 메소드? viewDidLoad, viewWillAppear 등 viewController의 생명주기에 의해 자동으로 호출되는 메서드들
• method swizzling을 사용하지 않고, 특정 메서드가 호출될 때 특정 기능을 추가하는 방법
  • override를 통해, 특정 기능을 추가
  • UIViewController를 상속받는 서브 클래스를 만들어서, BaseViewController로 사용 → 모든 ViewContoller에서 특정 기능이 실행되도록 하고자 할 때에는 매우 번거롭다! ⇒ Method Swizzling을 통해 overriding, subClassing없이 간단하게 구현할 수 있음
• Objective-C의 런타임 기능
  • Objective-C는 클래스의 메소드나 프로퍼티를 호출 할 때, 해당 객체에 메세지를 보내는 방식으로 구현된다.
    • 내가 원하는 일: A 메소드 실행
    • “A 메소드 실행” 이라는 메세지를 그 클래스의 객체에 보냄
    • 메세지를 받은 객체는 A 메소드가 구현되어있는 곳으로 가서 A 메소드 실행
    • 위의 일들이 런타임 에서 일어남

*사진 출처: Swift ) Method Swizzling by zeddiOS

Method Swizzling 장단점

장점

• 특정 기능을 여러 클래스에 한 번에 적용할 수 있음
• 메소드를 호출하기 전에 사용자를 추적하거나, 원하는 특정 기능을 수행할 수 있음

단점

다음의 이유들로 인해 꼭 필요할 때에만 사용해야 한다!

• 런타임 시점에 임의로 메소드를 바꾸었기 때문에 버그가 발생할 수 있음
• iOS 버전에 따라 동작하지 않을 수 있음
• Firebase 등과 같은 툴에서 이미 method swizzling을 하고 있을 수 있기 때문에 미리 파악하는 것이 중요
  • FCM(Firebase Cloud Messaging)에서 APN token을 FCM 등록 토큰과 매칭할 때, downstream message callback handling을 할 때 method swizzling이 일어남
  • Method swizzling in Firebase Cloud Messaging
    

Method Swizzling 언제 사용?

• 앱의 생명주기에 앱의 분석 기능 통합할 때
• 특정 기능을 모든 클래스, 서브클래스에 한 번에 적용하고자 할 때
  

🔖 출처

• SeSac iOS 개발자 데뷔 과정 강의자료
• Swift ) Method Swizzling by zeddiOS
• [Swift] Method Swizzling이란? 민소네
• Swift) Method Swizzling을 알아보자 by 소들이
• Method swizzling in Firebase Cloud Messaging

[yoogail105]

Method Swizzling 구현해보기

• 유저가 화면을 볼 때마다 분석을 한다고 가정한다면,
• 우리는 모든 화면이 나타났다는 것을 추척해서, 뷰를 분석하는 API를 요청해야 할 것이다.
• TrackingViewController를 상속하는 UIViewController를 BaseViewController로 사용하여 구현할 수도 있다.
• 하지만 다음의 경우를 생각한다면, 이는 적절한 대안이 아닐 수 있다.
  • UITableViewController, UINavigationViewController와 같은 곳에는 구현을 어떻게 할 것인지?
  • 분석 기능을 가지고 있는 라이브러리를 제공하는 경우나, 너의 SDK class를 모든 UIViewController에 사용하고자 할 때 어떻게 할 것인지?
  • 다른 서드파티 라이브러리를 사용한다면, 그 UIViewController에 분석 기능을 추가할 수 없다면 어떻게 할 것인지?
• method swizzling은 이러한 문제점들을 간단하게 해결할 수 있다.
  

method swizzling의 동작

• 먼저 우리가 해야할 일은 워하는 기능이 담긴 custom func, _tracked_viweWillAppear를 작성하고, 기존의 viewWillAppear와 바꾸는 것
• 런타임에서, UIViewController의 viewWillAppear가 호출될 때, _tracked_viewWillAppear를 호출하는 로직을 구성
• UIViewController를 상속한 클래스들에서, super.ViewWillAppear를 호출하면, _tracked_viewWillAppear를 호출
• UITableVeiwController, UINavigationController와 같이 UIViewController를 확장/파생한 모든 컨트롤러에서도 똑같이 동작
  

Method Swizzling 구현

• 먼저 알아야 하는 함수: method_exchangeImplementations(_:_:)

  • originalMethod를 swizzledMethod로 바꾸는 것!

  func method_exchangeImplementations(_ originalMethod: Method, _ swizzledMethod: Method

• 우리가 원하는 것은 viewWillAppear를 바꾸는 것이기 때문에, swizzledMethod를 정의해 주어야 한다.

  @objc dynamic func _tracked_viewWillAppear(_ animated: Bool) {
          // code
          _tracked_viewWillAppear(animated)
  }

• method swizzling을 하기 위한 준비물인 originalMethod, swizzledMethod가 준비 되었으니, swizzle 메서드를 정의해 준다.

  static func swizzle() {
          if self != UIViewController.self {
              return
          }
          let _: () = {
              let originalSelector =
              #selector(UIViewController.viewWillAppear(_:))
              let swizzledSelector =
              #selector(UIViewController._tracked_viewWillAppear(_:))
              let originalMethod =
              class_getInstanceMethod(self, originalSelector)
              let swizzledMethod =
              class_getInstanceMethod(self, swizzledSelector)
              method_exchangeImplementations(originalMethod!, swizzledMethod!);
          }()
  }

• AppDelegate에서 swizzle()을 호출해준다.

  func application( _ application: UIApplication, 
              didFinishLaunchingWithOptions 
              launchOptions: [UIApplication.LaunchOptionsKey: Any]?
              ) -> Bool {
                 UIViewController.swizzle()
  
               return true
  }

  
  

🔖 참고

• Method Swizzling in iOS Development by Aruna Kumari Yarra
• Swift Native method swizzling by aDmin Malarczyk

[yoogail105]

Disable Method Swizzling

• Method swizzling in Firebase Cloud Messaging에 보면 FCM이 Method Swizzling을 사용하기 때문에 이를 disable하면 안된다고 되어있다.

  

  
  

• 그럼.. 이를 불가능하게 설정할 수 있다는 건가?🤔

• stack overflow에 비슷한 질문이 있었는데, NSObject를 기반으로 하고 있는 클래스라면, 방법이 없다고 한다.

• 그런데 기존의 프레임워크의 로직을 방해할 수 있어서 추천하지는 않지만, 특정 라이브러리에서 method swizzling이 되지 않도록 막고 싶다면 다음과 같이 조치를 취할 수는 있다.
  

public func method_exchangeImplementations(_ m1: Method!, _ m2: Method!) {
 }

public func class_addMethod(_ cls: Swift.AnyClass!, _ name: Selector!, _ imp: IMP!, _ types: UnsafePointer<Int8>!) -> Bool
 {
    return false
}

🔖 참고

• https://stackoverflow.com/questions/39972666/is-it-possible-to-disable-method-swizzling-in-a-swift-project