UITableViewControllerとUITableViewDataSourceの関係について

Question

Swift初心者です。
現在UITableViewControllerを使ってテーブルビューを実装中です(正確には、UITableViewControllerを継承したクラス内にコードを書いています)

UITableViewControllerのソースコードを見ると、UITableViewDataSourceというプロトコルを批准しています。UITableViewDataSourceは、それを批准したクラスに対して

tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int
tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell

という2つのメソッドを実装することを要求していると思うのですが、UITableViewControllerにそれら二つのメソッドが書かれているように見えません。

どういった仕組みでUITableViewControllerとUITableViewDataSourceの関係が成立しているのでしょうか？また、自分の理解しているデリゲートとプロトコルの関係が間違っていればご指摘いただけると幸いです。

###補足情報
Xcode version 8.1

Answer 1

結論から言いますとUITableViewControllerはUITableViewDataSourceに準拠しています。

ポイントは2つあります。

1. Xcodeなどで確認しているUIKitの内容はHeaderファイルであること
2. UITableViewControllerに関してpublicなものがHeaderに含まれていないこと

UITableViewControllerはUITableViewDataSourceに準拠している

次のようにUITableViewControllerを継承する場合にoverrideしていることからもUITableViewDataSourceのpublic funcが実装されていることが分かります。（他の回答者様も同様の内容について言及されています）

open class CustomTableViewController: UITableViewController {
    override public func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return 0
    }
    
    override public func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
        return UITableViewCell()
    }
}

例えば、自らUITableViewDataSourceに準拠させようとすると次のようになります

open class SampleTableViewController: UIViewController, UITableViewDelegate, UITableViewDataSource {
    public func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return 0
    }

    public func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
        return UITableViewCell()
    }
}

ヘッダーと実装ファイルの例

public以上のアクセスレベルのものがヘッダーに表示されます。
ここではヘッダーに含まれているものが実装のすべてではないということが分かっていただければ良いです。

実装ファイル

open class SampleTableViewController: UIViewController, UITableViewDelegate, UITableViewDataSource {
    open var openString: String?
    public var publicString: String?
    internal var internalString: String?
    fileprivate var fileprivateString: String?
    private var privateString: String?
    
    override open func viewDidLoad() {
        super.viewDidLoad()
        // Do any additional setup after loading the view, typically from a nib.
        
    }
    
    override open func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
        // Dispose of any resources that can be recreated.
    }
    
    public func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return 0
    }

    public func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
        return UITableViewCell()
    }
    
    func cannotAccessFromOutsideOfFramework() {
    }
}

ヘッダーファイル

open class SampleTableViewController : UIViewController, UITableViewDelegate, UITableViewDataSource {

    open var openString: String?

    public var publicString: String?

    override open func viewDidLoad()

    override open func didReceiveMemoryWarning()

    public func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int

    public func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell
}

UITableViewControllerヘッダーに含まれるはずのpublic funcは何処へ

上記示したように、UITableViewDataSourceに準拠し以下２つのメソッドを実装していればヘッダーファイルにも表示されるはずです。しかし、UIKitにはそれが含まれていません。
調べて見ましたが、Swiftのみでこの挙動の再現方法は分かりませんでした。

public func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int
public func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell

生成されるヘッダーファイルの比較

Swiftで実現する方法は分からなかったので、Frameworkとして生成されるヘッダーを比較しました。
以下の3つの場合について示します。尚Sampleプロジェクト新規プロジェクト作成しCocoa Touch Frameworkを追加することでSwift, Objective-Cそれぞれについて作成しました。

1. UIKit
2. Sampleプロジェクト（Swift）
3. Sampleプロジェクト（Objective-C）

Apple公式UIKit

UITableViewController.h

Xcodeに含まれているUITableViewController.hは以下の場所にあります。

/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/System/Library/Frameworks/UIKit.framework/Headers/UITableViewController.h

中身を見てみると以下の様になっています。

//
//  UITableViewController.h
//  UIKit
//
//  Copyright (c) 2008-2016 Apple Inc. All rights reserved.
//
#import <Foundation/Foundation.h>
#import <UIKit/UIViewController.h>
#import <UIKit/UITableView.h>
#import <UIKit/UIKitDefines.h>

// Creates a table view with the correct dimensions and autoresizing, setting the datasource and delegate to self.
// In -viewWillAppear:, it reloads the table's data if it's empty. Otherwise, it deselects all rows (with or without animation) if clearsSelectionOnViewWillAppear is YES.
// In -viewDidAppear:, it flashes the table's scroll indicators.
// Implements -setEditing:animated: to toggle the editing state of the table.

NS_ASSUME_NONNULL_BEGIN

NS_CLASS_AVAILABLE_IOS(2_0) @interface UITableViewController : UIViewController <UITableViewDelegate, UITableViewDataSource>

- (instancetype)initWithStyle:(UITableViewStyle)style NS_DESIGNATED_INITIALIZER;
- (instancetype)initWithNibName:(nullable NSString *)nibNameOrNil bundle:(nullable NSBundle *)nibBundleOrNil NS_DESIGNATED_INITIALIZER;
- (nullable instancetype)initWithCoder:(NSCoder *)aDecoder NS_DESIGNATED_INITIALIZER;

@property (nonatomic, strong, null_resettable) UITableView *tableView;
@property (nonatomic) BOOL clearsSelectionOnViewWillAppear NS_AVAILABLE_IOS(3_2); // defaults to YES. If YES, any selection is cleared in viewWillAppear:

@property (nonatomic, strong, nullable) UIRefreshControl *refreshControl NS_AVAILABLE_IOS(6_0) __TVOS_PROHIBITED;

@end

NS_ASSUME_NONNULL_END

Sampleプロジェクトにて検証した結果

Swiftで書かれたFrameworkではSWIFT_CLASSが使われておりObjective-Cへ変換されています。
この際にSwiftのアクセスレベルに応じてヘッダーが生成されています。
一方でObjective-Cで書かれたFrameworkではヘッダーと実装ファイルが分かれているため、
ヘッダーで定義したものが書き出されています。
上記UITableViewController.hとこれらを鑑みるとUIKitに関しては依然Objective-Cで作成されていると考えられます。
そのため、UITableViewController.hのヘッダーにはたとえpublic funcであってもUITableViewDataSourceに定義されているものは記載されていないと考えられます。

Swift Frameworkで書き出されるヘッダー

// Generated by Apple Swift version 3.0.1 (swiftlang-800.0.58.6 clang-800.0.42.1)
#pragma clang diagnostic push

#if defined(__has_include) && __has_include(<swift/objc-prologue.h>)
# include <swift/objc-prologue.h>
#endif

---
長いので省略
---

#pragma clang diagnostic ignored "-Wproperty-attribute-mismatch"
#pragma clang diagnostic ignored "-Wduplicate-method-arg"
@class UITableView;
@class UITableViewCell;
@class NSBundle;
@class NSCoder;

SWIFT_CLASS("_TtC25FrameworkForTeratail5919325SampleTableViewController")
@interface SampleTableViewController : UIViewController <UIScrollViewDelegate, UITableViewDataSource, UITableViewDelegate>
@property (nonatomic, copy) NSString * _Nullable openString;
@property (nonatomic, copy) NSString * _Nullable publicString;
- (void)viewDidLoad;
- (void)didReceiveMemoryWarning;
- (NSInteger)tableView:(UITableView * _Nonnull)tableView numberOfRowsInSection:(NSInteger)section;
- (UITableViewCell * _Nonnull)tableView:(UITableView * _Nonnull)tableView cellForRowAtIndexPath:(NSIndexPath * _Nonnull)indexPath;
- (nonnull instancetype)initWithNibName:(NSString * _Nullable)nibNameOrNil bundle:(NSBundle * _Nullable)nibBundleOrNil OBJC_DESIGNATED_INITIALIZER;
- (nullable instancetype)initWithCoder:(NSCoder * _Nonnull)aDecoder OBJC_DESIGNATED_INITIALIZER;
@end

#pragma clang diagnostic pop

Objective-C Frameworkで書き出されるヘッダー

#import <UIKit/UIKit.h>

@interface OCTableViewController : UIViewController <UITableViewDelegate, UITableViewDataSource>
- (id)initWithStyle:(UITableViewStyle)style;

@property (nonatomic, strong) UITableView *tableView;
@property (nonatomic) BOOL clearsSelectionOnViewWillAppear;
@end

まとめ

UITableViewControllerのヘッダーにはUITableViewDataSourceのメソッドは含まれていないものの、
UITableViewDataSourceに準拠したメソッドの実装は行われている。
その裏には依然Objective-Cが生きていることを垣間見ることができる。

長文失礼しました、参考になれば幸いです。

Comments

[secondpenguin]

nafu様
非常に本格的な検証ありがとうございます。
初学者の自分にとっては高度すぎるほどの内容であるにも関わらず、わかりやすい説明でとても助かりました。
なるほど、UITableViewController.hはObjective-Cで実装されており、結果、public funcとして実装されてあってもヘッダーに表示されていないということが起こっている、のですね。
自分は、ヘッダーとして公開されているものがAppleの膨大なソースコードのほんの一端であるということさえちゃんと意識できていなかったので、nafu様の回答で改めてSwiftの奥深さに触れることができた気がします。
ありがとうございました！

Answer 2

UITableViewControllerのソースコードを見ると

UIKitのソースコードって公開されてないんじゃ‥?

ちゃんと実装されていると思いますが。（コードはSwift2です）

let t = UITableViewController()
print(t.tableView(t.tableView, numberOfRowsInSection: 0))
//=> 0

Comments

[secondpenguin]

fuzzball様
ご回答ありがとうございます。
なるほど、私はUITableViewController.hで確認できるコードで全て完結できると勘違いしていました。確かにfuzzballs様が実行されている通り、疑問を持った箇所はコードが動くかどうかをシンプルに試して、実装されているということを確認して進めていくのが良さそうですね。
ありがとうございました！

Answer 3

tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int
tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell

上記のメソッドはUITableViewController クラスのメソッドではありません、UITableViewDataSource プロトコルのメソッドです。

ですからUITableViewDataSourceに準拠した時には上記の必須のメソッドを実装する必要があります。
※ 以下がUITableViewDataSourceのメソッドでoptionalの付いていない最初の2つが実装必須という事です。

public protocol UITableViewDataSource : NSObjectProtocol {
    
    @available(iOS 2.0, *)
    public func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int
    
    @available(iOS 2.0, *)
    public func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell
    
    @available(iOS 2.0, *)
    optional public func numberOfSections(in tableView: UITableView) -> Int
    
    @available(iOS 2.0, *)
    optional public func tableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String?
    
    @available(iOS 2.0, *)
    optional public func tableView(_ tableView: UITableView, titleForFooterInSection section: Int) -> String?
    
    @available(iOS 2.0, *)
    optional public func tableView(_ tableView: UITableView, canEditRowAt indexPath: IndexPath) -> Bool
    
    @available(iOS 2.0, *)
    optional public func tableView(_ tableView: UITableView, canMoveRowAt indexPath: IndexPath) -> Bool
    
    @available(iOS 2.0, *)
    optional public func sectionIndexTitles(for tableView: UITableView) -> [String]?
    
    @available(iOS 2.0, *)
    optional public func tableView(_ tableView: UITableView, sectionForSectionIndexTitle title: String, at index: Int) -> Int
    
    @available(iOS 2.0, *)
    optional public func tableView(_ tableView: UITableView, commit editingStyle: UITableViewCellEditingStyle, forRowAt indexPath: IndexPath)
    
    @available(iOS 2.0, *)
    optional public func tableView(_ tableView: UITableView, moveRowAt sourceIndexPath: IndexPath, to destinationIndexPath: IndexPath)
}

自身の定義したクラスがUITableViewControllerクラスを継承しているということはUITableViewControllerクラスに適用されているUITableViewDataSourceプロトコルのメソッドを実装しなければならないという事です。

// UITableViewControllerの上にマウスを持って行き⌘ボタンを押したままクリックするとUITableViewControllerの定義に飛べます。
class TableViewController: UITableViewController {
    // 自分で定義したクラス
}

↓

// 更にUITableViewDataSourceの上にマウスを持って行き⌘ボタンを押したままクリックするとUITableViewDataSourceの定義に飛べます。
@available(iOS 2.0, *)
open class UITableViewController : UIViewController, UITableViewDelegate, UITableViewDataSource {

    public init(style: UITableViewStyle)

    public init(nibName nibNameOrNil: String?, bundle nibBundleOrNil: Bundle?)
    public init?(coder aDecoder: NSCoder)

    open var tableView: UITableView!

    @available(iOS 3.2, *)
    open var clearsSelectionOnViewWillAppear: Bool // defaults to YES. If YES, any selection is cleared in viewWillAppear:

    @available(iOS 6.0, *)
    open var refreshControl: UIRefreshControl?
}

Comments

[secondpenguin]

_Kentarou さま
とても丁寧なご回答ありがとうございます。

自分もUITableViewDataSourceに書かれているメソッドを実装しなければいけないということは理解しており、コードの中に
tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int
tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell
の二つを実装しています。override funcを使って実装しています。

ここからが自分の理解が追いついていないところなのですが、overrideで実装できた以上、当然のようにUITableViewController自身に上記二つのメソッドが記述されていると思っていたのですが、UITableViewControllerの中を見てもそのメソッドはなく、混乱しているところです。

_Kentarou様からご回答いただいたソースの通り、open var tableView: UITableView!というプロパティはありますが、これはあくまでプロパティであってメソッドではないため、自分にはUITableViewControllerがUITableViewDataSourceを批准しきれていないように見えてしまうのです。

UITableViewDataSourceが要求するプロトコルをUITableViewControllerがメソッドを備えて批准し、具体的な内容については継承した子クラスで定義する、という流れなら自然に理解できるのですが……

質問の仕方が不慣れで大変申し訳ないです。よろしくお願いいたします。

[_Kentarou]

secondpenguinさんの言わんとしていることは理解しました。

確かに同じ様なものを自分で定義した場合は、継承元でもプロトコルのメソッドを書かないとエラーになりますね、、、

他にも同じ様なパターンはあるかもしれませんが、UIKitの中のことなのでちょっと調べた感じでは分からなかったです、すみません。

何かヒントになるような記述等ありましたら追記致します。

[secondpenguin]

_Kentarou様
ご返信ありがとうございます。ちょっとマニアックな疑問だったかもしれません。でもそれが分かっただけでも自分にとっては収穫です。
自分も引き続き調べてみます。ありがとうございます。