プログラムを書こう！

実務や自作アプリ開発で習得した役に立つソフトウェア技術情報を発信するブログ

トップ > PWEditor > SwiftのFTPでファイルデータを更新する。

SwiftのFTPでファイルデータを更新する。

PWEditor Swift

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

f:id:paveway:20190914064630j:plain

目次

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

[改訂新版]Swift実践入門 ── 直感的な文法と安全性を兼ね備えた言語 (WEB+DB PRESS plus)

[改訂新版]Swift実践入門 ── 直感的な文法と安全性を兼ね備えた言語 (WEB+DB PRESS plus)

1. はじめに

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

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

を使用しています。

目次へ

2. 前提

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

paveway.hatenablog.com

目次へ

3. ファイルデータ更新処理

SwiftのFTPでファイルのデータを更新には、BlackRaccoonライブラリのFTPアップロード(BRRequestUpload)オブジェクトを使用します。

以下に手順を示します。

  1. FTPファイルデータを更新するViewControllerにBRReqeuestDelegateを設定します。
  2. FTPファイルデータ更新を行うFTPアップロード(BRRequestUpload)オブジェクトをインスタンス変数で用意します。
    また更新するファイルデータを設定するData型のインスタンス変数も用意します。

  3. FTPアップロード(BRRequestUpload)オブジェクトを生成し、FTPで接続するパラメータ(ホスト名、ユーザ名、パスワード、パス名)を設定します。

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

  4. FTPアップロード(BRRequestUpload)オブジェクトのstartメソッドを実行し、ファイルデータ更新を開始します。

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

    • 正常な場合はrequestCompletedメソッド
    • エラーの場合はrequestFaildメソッド
    • ファイルの更新許可を判定する場合はshouldOverwriteFileWithRequestメソッド
    • ファイルデータをアップロードする場合はrequestDataメソッド

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

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

    ファイルの更新を許可しない仕様であれば、FTPアップロード時もfalseを返却するようにすればよいと思います。

  6. 最後に2重起動防止のため、FTPアップロード(BRRequestUpload)オブジェクトをnilでクリアします。

実装例

class FtpFileUploadViewController: UIViewController, BRRequestDelegate {

    // 2. FTPアップロードオブジェクト
    var ftpUpload: BRRequestUpload!
    
    /// 2. FTPアップロードデータ
    var ftpUploadData: Data?

    /**
     FTPでファイルデータの更新を開始します。
     
     - Parameter pathName: ファイルデータを更新するファイルパス名
     - Parameter ftpUploadData: 更新するファイルデータ
     */
    func startUploadData(_ pathName: String、ftpUploadData: Data) {
        if ftpUpload != nil {
            // FTPアップロードオブジェクトが有効な場合、2重起動防止のため処理を終了します。
            return
        }

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

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

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

     - Parameter request: FTPリクエスト
     */
    func shouldOverwriteFileWithRequest(_ request: BRRequest) -> Bool {
        if request == ftpUpload {
            // FTPリクエストがFTPアップロードオブジェクトと等しい場合
            // 上書きを許可します。
            return true

        } else {
            // 上記以外、上書きを禁止します。
            return false
        }
    }
    
    /**
     5. ファイルデータを送信します。

     - Parameter request: リクエスト
     - Returns: 更新するファイルデータ
     */
    func requestData(toSend request: BRRequestUpload) -> Data? {
        if let ftpUploadData = ftpUploadData {
            let temp = ftpUploadData
            self.ftpUploadData = nil
            return temp

        } else {
            return nil
        }
    }
}

目次へ

4. おわりに

手順としては

paveway.hatenablog.com

とほぼ一緒です。

SEO対策からロゴ作成まで全部500円で出来るココナラ

詳解 Swift 第4版

詳解 Swift 第4版

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

目次へ

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

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

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

目次へ