SwiftのFTPでファイルデータを取得する。

この記事は2018年09月29日に投稿しました。
この記事は2018年09月30日に更新しました

目次

1. はじめに
2. 前提
3. ファイルデータ取得処理
4. おわりに

絶対に挫折しないiPhoneアプリ開発「超」入門 増補第6版【Swift 4 & iOS 11】完全対応 (Informatics&IDEA)

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。
今回はSwiftのFTPでファイルデータを取得してみます。

PWEditorでは、SwiftでFTPを操作するため、

• BlackRaccoonライブラリ

を使用しています。

目次へ

2. 前提

下記の記事を参考にBlackRaccoonライブラリを使用できる状態にしておいてください。

paveway.hatenablog.com

目次へ

3. ファイルデータ取得処理

SwiftのFTPでファイルデータを取得するには、BlackRaccoonライブラリのFTPファイルダウンロード(BRRequestDownload)オブジェクトを使用します。

以下に手順を示します。

1. FTPファイルデータを取得するViewControllerにBRReqeuestDelegateを設定します。
2. FTPファイルデータ取得を行うFTPファイルダウンロード(BRRequestDownload)オブジェクトをインスタンス変数で用意します。
   またファイルデータを格納するNSMutableData型のインスタンス変数も用意します。
   ファイルデータ自体の型はData型ですが、ファイルデータはいっぺんにダウンロードされるのではなく、逐次ダウンロードされるため、NSMutableData型の変数で受け取ることにしています。

3. FTPファイルダウンロード(BRRequestDownload)オブジェクトを生成し、FTPで接続するパラメータ(ホスト名、ユーザ名、パスワード、パス名)を設定します。

   • ホスト名は、IPアドレス形式またはURL形式で指定可能です。
   • ホスト名、ユーザ名、パスワードに使用できる文字は1バイト文字のみです。 2バイト文字の場合、クラッシュします。
   • パス名は、ルートディレクトリの場合は"/"、サブディレクトリの場合は"/<サブディレクトリ名>"を指定します。

4. FTPファイルダウンロード(BRRequestDownload)オブジェクトのstartメソッドを実行し、ファイルデータ取得を開始します。

5. ファイルデータ取得の結果は、以下のメソッドでコールバックされます。

   • 正常な場合はrequestCompletedメソッド
   • エラーの場合はrequestFaildメソッド
   • ファイルの更新許可を判定する場合はshouldOverwriteFileWithRequestメソッド
   • ファイルデータがダウンロードされた場合はrequestDataAvailableメソッド

   requestDataAvailableメソッド以外のコールバックメソッドはドキュメントをみるとわかるように、他のファイル操作を行った場合も呼び出されます。
   そのため引数requestがFTPファイルダウンロード(BRRequestDownload)オブジェクトと等しいかチェックして、FTPファイルダウンロード処理の結果としてコールバックメソッドが呼び出されたか判断しています。

   shouldOverwriteFileWithRequestメソッドは、おそらくFTPアップロードの時にだけ必要なメソッドで、既存のファイルを上書きしてよいかどうかを返却します。
   そのためFTPアップロードの時はtrue、それ以外はfalseを返却するようにしています。

   ダウンロードされたファイルデータはrequestDataAvailableメソッドに渡されます。
   1回のメソッド呼び出しですべてのファイルデータが渡されるとは限らないため、渡されたファイルデータはappendで保存します。

6. 最後に2重起動防止のため、FTPファイルダウンロード(BRRequestDownload)オブジェクトをクリアします。

実装例

class FtpFileDownloadViewController: UIViewController, BRRequestDelegate {

    // 2. FTPダウンロードオブジェクト
    var ftpDownload: BRRequestDownload!

    /// FTPダウンロードデータ
    var ftpDownloadData: NSMutableData?

    /**
     FTPでファイルデータの取得を開始します。
     */
    func startGetFtpFileData(_ pathName: String) {
        if ftpDownload != nil {
            // FTPダウンロードオブジェクトが有効な場合、2重起動防止のため処理を終了します。
            return
        }
        
        ftpDownloadData = NSMutableData()

        // 3. FTPダウンロードオブジェクトを生成し、FTPで接続するパラメータを設定します。
        ftpDownload = BRRequestDownload(delegate: self)
        ftpDownload.hostname = <ホスト名>
        ftpDownload.username = <ユーザ名>
        ftpDownload.password = <パスワード>
        ftpDownload.path = pathName
        
        // 4. ファイルデータ取得を開始します。
        ftpDownload.start()
    }
    
    /**
     5. FTPのリクエストが完了した時に呼び出されます。

     - Parameter request: FTPリクエスト
     */
    func requestCompleted(_ request: BRRequest) {
        if let request == ftpDownload {
            // FTPリクエストがFTPダウンロードオブジェクトと等しい場合
            // 正常終了の場合の処理を記述してください。
            
            // 6. 2重起動防止のため、FTPダウンロードオブジェクトをクリアします。
            ftpDownload = nil
        }
    }
    
    /**
     5. FTPリクエストがエラーした時に呼び出されます。

     - Parameter request: FTPリクエスト
     */
    func requestFailed(_ request: BRRequest) {
        if let request == ftpDownload {
            // FTPリクエストがFTPダウンロードオブジェクトと等しい場合
            // エラー終了の場合の処理を記述してください。
            
            // 6. 2重起動防止のため、FTPダウンロードオブジェクトをクリアします。
            ftpDownload = nil
        }
    }
    
    /**
     5. 上書きリクエスト時に呼び出されます。

     - Parameter request: FTPリクエスト
     */
    func shouldOverwriteFileWithRequest(_ request: BRRequest) -> Bool {
        // 上書きを禁止します。
        return false
    }

    /**
     5. データを受信した時に呼び出されます。

     - Parameter request: FTPダウンロードリクエスト
     */
    func requestDataAvailable(_ request: BRRequestDownload) {
        // 受信したデータを保存します。
        if let ftpDownloadData = ftpDownloadData {
            ftpDownloadData.append(request.receivedData)
        }
    }
}

目次へ

4. おわりに

ドキュメントを見るとrequestDataAvailableメソッドについて記載がありません。
ドキュメントによるとファイルのダウンロードされたデータは、FTPファイルダウンロード(BRRequestDownload)オブジェクトのreceivedDataに格納されます。
しかしファイルデータが大きいと全部のデータが格納されないことがありました。
そのためいろいろ調べて、上記の方法でファイルデータを取得するようにしました。

お仕事決まれば全額キャッシュバック！転職特化型Ruby実践研修【ポテパンキャンプ】

詳細！Swift 4 iPhoneアプリ開発 入門ノート Swift 4+Xcode 9対応

紹介している一部の記事のコードはGitlabで公開しています。
興味のある方は覗いてみてください。

目次へ

---

私が勤務しているニューラルでは、主に組み込み系ソフトの開発を行っております。
弊社製品のハイブリッドOS Bi-OSは高い技術力を評価されており、特に制御系や通信系を得意としています。
私自身はiOSモバイルアプリやウィンドウズアプリを得意としております。
ソフトウェア開発に関して相談などございましたら、お気軽にご連絡ください。

また一緒に働きたい技術者の方も随時募集中です。
興味がありましたらご連絡ください。

EMAIL : info-nr@newral.co.jp / m-futamata@newral.co.jp
TEL : 042-523-3663
FAX : 042-540-1688

目次へ