プログラムを書こう!

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

SwiftのFTPでファイルを作成する。

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

f:id:paveway:20190914064630j:plain

目次

  1. はじめに
  2. 前提
  3. ファイル作成処理
  4. おわりに

作って学ぶ iPhoneアプリの教科書 【Swift4&Xcode 9対応】 ~人工知能アプリを作ってみよう! ~(特典PDF付き)

作って学ぶ iPhoneアプリの教科書 【Swift4&Xcode 9対応】 ~人工知能アプリを作ってみよう! ~(特典PDF付き)

1. はじめに

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

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

を使用しています。

目次へ

2. 前提

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

paveway.hatenablog.com

目次へ

3. ファイル作成処理

SwiftのFTPでファイルを作成するには、BlackRaccoonライブラリのオブジェクトを使用します。
BlackRaccoonライブラリで、直感的にファイルを作成するオブジェクトはありません。
そのためFTPアップロードを行うFTPアップロード(BRRequestUpload)オブジェクトで、アップロードするデータを空にしてファイルを作成します。

以下に手順を示します。

  1. FTPファイルを作成するViewControllerにBRReqeuestDelegateを設定します。
  2. FTPファイル作成を行うFTPアップロード(BRRequestUpload)オブジェクトをインスタンス変数で用意します。
  3. FTPアップロード(BRRequestUpload)オブジェクトを生成し、FTPで接続するパラメータ(ホスト名、ユーザ名、パスワード、パス名)を設定します。

    • ホスト名は、IPアドレス形式またはURL形式で指定可能です。
    • ホスト名、ユーザ名、パスワードに使用できる文字は1バイト文字のみです。 2バイト文字の場合、クラッシュします。
    • パス名は、ルートディレクトリの場合は"/"、サブディレクトリの場合は"/<サブディレクトリ名>"を指定します。
  4. FTPアップロード(BRRequestUpload)オブジェクトのstartメソッドを実行し、ファイル作成を開始します。

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

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

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

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

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

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

実装例

class FtpCreateFileViewController: UIViewController, BRRequestDelegate {

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

    /**
     FTPでファイル一覧の取得を開始します。
     */
    func createFile(_ pathName: String) {
        if ftpUpload != nil {
            // FTPアップロードオブジェクトが有効な場合、2重起動防止のため処理を終了します。
            return
        }

        // 3. FTPアップロードオブジェクトを生成し、FTPで接続するパラメータを設定します。
        ftpUpload = BRRequestUpload(delegate: self)
        ftpUpload.hostname = <ホスト名>
        ftpUpload.username = <ユーザ名>
        ftpUpload.password = <パスワード>
        ftpUpload.path = pathName
        
        // 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 {
            // FTPアップロードデータが有効な場合
            self.ftpUploadData = nil
            return ftpUploadData

        } else {
            return Data()
        }
    }
}

目次へ

4. おわりに

ドキュメントをみると、FTPアップロード(BRRequestUpload)オブジェクトに"sentData"というメンバーがあり、それにアップロードするデータをセットすればよいように記載されています。
しかしPWEditorで実装した時は、ドキュメントにはrequestDataメソッドでファイルデータを返すように書いてあり、そのように実装しました。
もしかしたら現在のライブラリは仕様が変わったかもしれません。

【IT派遣テクノウェイブ】

作って学ぶ iPhoneアプリの教科書 【Swift4&Xcode 9対応】 ~人工知能アプリを作ってみよう! ~(特典PDF付き)

作って学ぶ iPhoneアプリの教科書 【Swift4&Xcode 9対応】 ~人工知能アプリを作ってみよう! ~(特典PDF付き)

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

目次へ


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

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

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

目次へ