SwiftのFTPでディレクトリを作成する。

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

f:id:paveway:20190914064630j:plain

1. はじめに

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

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

BlackRaccoonライブラリ

を使用しています。

目次へ

2. 前提

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

paveway.hatenablog.com

目次へ

3. ディレクトリ作成処理

SwiftのFTPでディレクトリを作成するには、BlackRaccoonライブラリのオブジェクトを使用します。

以下に手順を示します。

FTPファイル一覧を取得するViewControllerにBRReqeuestDelegateを設定します。
FTPディレクトリ作成を行うFTPディレクトリ作成(BRRequestCreateDirectory)オブジェクトをインスタンス変数で用意します。
FTPディレクトリ作成(BRRequestCreateDirectory)オブジェクトを生成し、FTPで接続するパラメータ(ホスト名、ユーザ名、パスワード、パス名)を設定します。
- ホスト名は、IPアドレス形式またはURL形式で指定可能です。
- ホスト名、ユーザ名、パスワードに使用できる文字は1バイト文字のみです。
  2バイト文字の場合、クラッシュします。
- パス名に、作成するディレクトリのパス名を指定します。
FTPディレクトリ作成(BRRequestCreateDirectory)オブジェクトのstartメソッドを実行し、ディレクトリ作成を開始します。
ディレクトリ作成の結果は、以下のメソッドでコールバックされます。
- 正常な場合はrequestCompletedメソッド
- エラーの場合はrequestFaildメソッド
- ファイルの更新許可を判定する場合はshouldOverwriteFileWithRequestメソッド
コールバックメソッドはドキュメントをみるとわかるように、他のファイル操作を行った場合も呼び出されます。
そのため引数requestがFTPディレクトリ作成(BRRequestCreateDirectory)オブジェクトと等しいかチェックして、FTPディレクトリ作成処理の結果としてコールバックメソッドが呼び出されたか判断しています。

shouldOverwriteFileWithRequestメソッドは、おそらくFTPアップロードの時にだけ必要なメソッドで、既存のファイルを上書きしてよいかどうかを返却します。
そのためFTPアップロードの時はtrue、それ以外はfalseを返却するようにしています。
最後に2重起動防止のため、FTPディレクトリ作成(BRRequestCreateDirectory)オブジェクトをクリアします。

実装例

class FtpFileCreateDirViewController: UIViewController, BRRequestDelegate {

    // 2. FTPディレクトリ作成オブジェクト
    var ftpCreateDirectory: BRRequestCreateDirectory!

    /**
     FTPでディレクトリ作成を開始します。

     - Parameter pathName: 作成するディレクトリパス名
     */
    func startCreateFtpDir(_ pathName: String) {
        if BRRequestCreateDirectory != nil {
            // FTPディレクトリ作成オブジェクトが有効な場合、2重起動防止のため処理を終了します。
            return
        }

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

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

     - Parameter request: FTPリクエスト
     */
    func requestFailed(_ request: BRRequest) {
        if let request == ftpListDirectory {
            // FTPリクエストがFTPディレクトリ作成オブジェクトと等しい場合
            // エラー終了の場合の処理を記述してください。
            
            // 6. 2重起動防止のため、FTPディレクトリ作成オブジェクトをクリアします。
            self.ftpCreateDirectory = nil
        }
    }

    /**
     5. 上書きリクエスト時に呼び出されます。

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

目次へ

4. おわりに

今回のディレクトリ作成処理は、FTPのファイル操作の中で実装が簡単な部類に入ると思います。

Tech Boost

本気ではじめるiPhoneアプリ作り Xcode 9.x+Swift 4.x対応 (「ヤフー黒帯」シリーズ)

作者: 西磨翁
出版社/メーカー: SBクリエイティブ
発売日: 2017/12/14
メディア: 単行本
この商品を含むブログを見る

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

目次へ

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

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

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

目次へ

プログラムを書こう！

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

SwiftのFTPでディレクトリを作成する。

目次

1. はじめに

2. 前提

3. ディレクトリ作成処理

実装例

4. おわりに