Swiftでネットワーク層を書く：プロトコル指向のアプローチ

現在、アプリケーションのほぼ100％がネットワークを使用しているため、誰もがネットワーク層の組織と使用に直面しています。 この問題を解決するには、主に2つのアプローチがあります。サードパーティのライブラリを使用するか、ネットワーク層の独自の実装です。 この記事では、2番目のオプションを検討し、プロトコルと列挙を使用して、言語のすべての最新機能を使用してネットワーク層の実装を試みます。 これにより、プロジェクトが不要な依存関係から追加ライブラリの形で保存されます。 Moyaを見たことがある人は、実装と使用の多くの同様の詳細をすぐに認識しますが、今回だけは、MoyaとAlamofireに触れずに自分でそれを行います。





このガイドでは、サードパーティのライブラリを使用せずに、純粋なSwiftにネットワーク層を実装する方法を説明します。 この記事を確認すると、コードは次のようになります。

• プロトコル指向
• 使いやすい
• 使いやすい
• タイプセーフ
• エンドポイントには列挙型が使用されます

以下は、ネットワーク層の使用が実装後にどのように見えるかの例です。







router.requestのみを記述することにより（および列挙のすべての力を使用して、可能な要求とそのパラメーターのすべてのオプションが表示されます。



まず、プロジェクトの構造について少し



何か新しいものを作成するときはいつでも、また将来すべてを簡単に理解できるようにするためには、すべてを正しく整理して構成することが非常に重要です。 適切に編成されたフォルダー構造は、アプリケーションアーキテクチャを構築する際の重要な詳細であると考えています。 すべてをフォルダに適切に配置するために、事前に作成しましょう。 これは、プロジェクトの一般的なフォルダー構造のようになります。







Endpointtypeプロトコル



まず、 EndPointTypeプロトコルを定義する必要があります。 このプロトコルには、要求を構成するために必要なすべての情報が含まれます。 リクエスト（エンドポイント）とは何ですか？ 本質的には、ヘッダー、リクエストパラメータ、リクエスト本文などのすべての関連コンポーネントを含むURLRequestです。 EndPointTypeプロトコルは、ネットワーク層実装の最も重要な部分です。 ファイルを作成してEndPointTypeという名前を付けましょう。 このファイルをServiceフォルダーに配置します（EndPointフォルダーではなく、理由-少し後で明らかになります）







HTTPプロトコル



EndPointTypeには、リクエストを作成するために必要ないくつかのプロトコルが含まれています。 これらのプロトコルが何であるか見てみましょう。



HTTPMethod



ファイルを作成し、 HTTPMethodという名前を付けて、Serviceフォルダーに配置します。 このリストは、リクエストのHTTPメソッドを設定するために使用されます。







HTTPTask

ファイルを作成し、 HTTPTaskという名前を付けて、Serviceフォルダーに配置します。 HTTPTaskは、特定の要求のパラメーターを構成する役割を果たします。 必要に応じてさまざまなクエリオプションを追加できますが、今度は通常のクエリ、パラメーターを含むクエリ、パラメーターとヘッダーを含むクエリを作成するため、これら3種類のクエリのみを実行します。







次のセクションでは、 パラメータとそれらの操作方法について説明します



HTTPHeaders



HTTPHeadersは辞書の単なるタイプエイリアスです。 HTTPTaskファイルの上部で作成できます。

public typealias HTTPHeaders = [String:String]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

パラメータとエンコード



ファイルを作成し、 ParameterEncodingという名前を付けて、Encodingフォルダーに配置します。 Parametersの typealiasを作成します。これは再び通常の辞書になります。 これは、コードをより理解しやすく読みやすくするためです。

 public typealias Parameters = [String:Any]
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次に、単一のエンコード関数でParameterEncoderプロトコルを定義します。 encodeメソッドには、 inout URLRequestとParametersの 2つのパラメーターがあります。 INOUTは、関数パラメーターを参照として定義するSwiftキーワードです。 通常、パラメーターは値として関数に渡されます。 呼び出しの関数パラメーターの前にinoutを記述する場合、このパラメーターを参照型として定義します。 inout引数の詳細については、このリンクをたどることができます。 つまり、 inoutを使用すると、パラメーターで値を取得して関数内で操作するだけでなく、関数に渡された変数自体の値を変更できます。 ParameterEncoderプロトコルはJSONParameterEncoderおよびURLPameterEncoderに実装されます。

 public protocol ParameterEncoder { static func encode(urlRequest: inout URLRequest, with parameters: Parameters) throws }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ParameterEncoderには、 パラメーターをエンコードすることがタスクである単一の関数が含まれています。 このメソッドは処理が必要なエラーをスローする可能性があるため、throwを使用します。



また、標準エラーではなく、カスタマイズされたエラーを生成すると便利な場合があります。 Xcodeが提供するものを解読することは常に非常に困難です。 すべてのエラーをカスタマイズして説明すると、何が起こったかを常に正確に把握できます。 これを行うには、 Errorから継承する列挙を定義しましょう。







ファイルを作成し、 URLParameterEncoderという名前を付けて、 エンコードフォルダーに配置します。







このコードはパラメーターのリストを受け取り、URLパラメーターとして使用するために変換およびフォーマットします。 ご存知のように、一部の文字はURLで許可されていません。 パラメーターも「＆」記号で区切られているため、これに注意する必要があります。 リクエストでヘッダーが設定されていない場合は、ヘッダーのデフォルト値も設定する必要があります。



これは、単体テストでカバーされることになっているコードの一部です。 URLリクエストを作成することが重要です。そうしないと、多くの不要なエラーが発生する可能性があります。 オープンAPIを使用する場合、失敗したテストに対して可能な限り多くのリクエストを使用したくないことは明らかです。 単体テストについて詳しく知りたい場合は、この記事から始めてください。



JSONParameterEncoder



ファイルを作成し、 JSONParameterEncoderという名前を付けて、エンコードフォルダーに配置します。







すべてがURLParameterの場合と同じです。ここでは、JSONのパラメーターを変換し、エンコード「application / json」を定義するパラメーターをヘッダーに再度追加します。



ネットワークルーター



ファイルを作成し、 NetworkRouterという名前を付けて、Serviceフォルダーに配置します。 クロージャのタイプエイリアスを定義することから始めましょう。

 public typealias NetworkRouterCompletion = (_ data: Data?,_ response: URLResponse?,_ error: Error?)->()
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次に、 NetworkRouterプロトコルを定義します。







NetworkRouterにはリクエストに使用するEndPointがあり 、リクエストが完了するとすぐに、このリクエストの結果がNetworkRouterCompletionクロージャーに渡されます。 このプロトコルにはキャンセル機能もあり、これを使用して長期のロードおよびアンロード要求を中断できます。 RouterがEndPointTypeの任意のタイプをサポートするようにしたいので、ここでもrelatedtypeを使用しました 。 relatedtypeを使用しないと、ルーターにはEndPointTypeを実装する特定のタイプが必要になります 。 relatedtypeについて詳しく知りたい場合は、 この記事を読むことができます。



ルーター



ファイルを作成し、 Routerという名前を付けてServiceフォルダーに入れます。 URLSessionTask型のプライベート変数を宣言します。 すべての作業がそれになります。 外部に誰も変更できないようにするため、非公開にします。







リクエスト



ここでは、 URLSession.sharedを使用してURLSessionを作成します。これが最も簡単な作成方法です。 しかし、この方法が唯一のものではないことを忘れないでください。 より複雑な構成URLSessionを使用すると、その動作を変更できます。 詳細については、 この記事をご覧ください 。



buildRequest関数を呼び出すことで要求が作成されますbuildRequest内のエンコード関数が例外をスローする可能性があるため、関数呼び出しはdo-try-catchにラップされています。 応答 、 データ、およびエラーが完了に渡されます。







ビルドリクエスト



buildRequest関数を使用してリクエストを作成します。 この機能は、ネットワーク層でのすべての重要な作業を担当します。 基本的にEndPointTypeをURLRequestに変換します 。 そして、 EndPointがリクエストに変わるとすぐに、それをsessionに渡すことができます。 ここで多くのことが起こっているので、メソッドを見てみましょう。 まず、 buildRequestメソッドを調べてみましょう 。



1. URLRequestリクエスト変数を初期化します。 その中にベースURLを設定し、それに使用される特定のリクエストのパスを追加します。



2. request.httpMethodに EndPointからhttpメソッドを割り当てます 。



3.エンコーダーがエラーをスローする可能性があるため、do-try-catchブロックを作成します。 1つの大きなdo-try-catchブロックを作成することにより、試行ごとに個別のブロックを作成する必要がなくなります。



4.スイッチで、 route.taskを確認します 。



5.タスクのタイプに応じて、対応するエンコーダーを呼び出します。







パラメータを構成する



ルーターでconfigureParameters関数を作成します 。







この関数は、クエリパラメータの変換を行います。 APIはJSON形式のbodyParametersとURL形式に変換されたURLParametersの使用を想定しているため、適切なパラメーターを対応する変換関数に渡すだけです。これについては記事の冒頭で説明しました。 さまざまなタイプのエンコードを含むAPIを使用する場合、この場合、エンコードタイプの追加列挙を使用してHTTPTaskを追加することをお勧めします。 このリストには、可能なすべてのタイプのエンコードが含まれている必要があります。 その後、configureParametersで、この列挙にもう1つの引数を追加します。 その値に応じて、switchを使用して切り替え、必要なエンコードを行います。



追加のヘッダーを追加



ルーターでaddAdditionalHeaders関数を作成します。







必要なヘッダーをすべてリクエストに追加するだけです。



キャンセルする



キャンセル機能は非常にシンプルに見えます：







使用例



それでは、実際の例を使用してネットワーク層を使用してみましょう。 TheMovieDBに接続して、アプリケーションのデータを受信します。



MovieEndPoint



MovieEndPointファイルを作成し、EndPointフォルダーに配置します。 MovieEndPointは次と同じです

MoyaのTargetType。 ここでは、代わりに独自のEndPointTypeを実装します。 同様の例でMoyaを使用する方法を説明する記事は、 このリンクにあります。

 import Foundation enum NetworkEnvironment { case qa case production case staging } public enum MovieApi { case recommended(id:Int) case popular(page:Int) case newMovies(page:Int) case video(id:Int) } extension MovieApi: EndPointType { var environmentBaseURL : String { switch NetworkManager.environment { case .production: return "https://api.themoviedb.org/3/movie/" case .qa: return "https://qa.themoviedb.org/3/movie/" case .staging: return "https://staging.themoviedb.org/3/movie/" } } var baseURL: URL { guard let url = URL(string: environmentBaseURL) else { fatalError("baseURL could not be configured.")} return url } var path: String { switch self { case .recommended(let id): return "\(id)/recommendations" case .popular: return "popular" case .newMovies: return "now_playing" case .video(let id): return "\(id)/videos" } } var httpMethod: HTTPMethod { return .get } var task: HTTPTask { switch self { case .newMovies(let page): return .requestParameters(bodyParameters: nil, urlParameters: ["page":page, "api_key":NetworkManager.MovieAPIKey]) default: return .request } } var headers: HTTPHeaders? { return nil } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

映画モデル



MovieModelおよびJSONデータモデルを解析してモデルにするには、Decodableプロトコルを使用します。 このファイルをModelフォルダーに配置します。



注 ：Codable、Decodable、およびEncodableプロトコルの詳細については、他の記事を参照してください。これらのプロトコルを使用したすべての機能について詳しく説明しています。

 import Foundation struct MovieApiResponse { let page: Int let numberOfResults: Int let numberOfPages: Int let movies: [Movie] } extension MovieApiResponse: Decodable { private enum MovieApiResponseCodingKeys: String, CodingKey { case page case numberOfResults = "total_results" case numberOfPages = "total_pages" case movies = "results" } init(from decoder: Decoder) throws { let container = try decoder.container(keyedBy: MovieApiResponseCodingKeys.self) page = try container.decode(Int.self, forKey: .page) numberOfResults = try container.decode(Int.self, forKey: .numberOfResults) numberOfPages = try container.decode(Int.self, forKey: .numberOfPages) movies = try container.decode([Movie].self, forKey: .movies) } } struct Movie { let id: Int let posterPath: String let backdrop: String let title: String let releaseDate: String let rating: Double let overview: String } extension Movie: Decodable { enum MovieCodingKeys: String, CodingKey { case id case posterPath = "poster_path" case backdrop = "backdrop_path" case title case releaseDate = "release_date" case rating = "vote_average" case overview } init(from decoder: Decoder) throws { let movieContainer = try decoder.container(keyedBy: MovieCodingKeys.self) id = try movieContainer.decode(Int.self, forKey: .id) posterPath = try movieContainer.decode(String.self, forKey: .posterPath) backdrop = try movieContainer.decode(String.self, forKey: .backdrop) title = try movieContainer.decode(String.self, forKey: .title) releaseDate = try movieContainer.decode(String.self, forKey: .releaseDate) rating = try movieContainer.decode(Double.self, forKey: .rating) overview = try movieContainer.decode(String.self, forKey: .overview) } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ネットワークマネージャー



ManagerフォルダーにNetworkManagerファイルを作成します。 現在、NetworkManagerには2つの静的プロパティのみが含まれています。APIキーと、接続するサーバーのタイプを記述する列挙です。 NetworkManagerには、タイプMovieApiの ルーターも含まれています。







ネットワーク応答



NetworkManagerでNetworkResponse列挙を作成します。







要求への応答を処理するときにこの列挙を使用し、対応するメッセージを表示します。



結果



NetworkManagerで結果列挙を作成します。







結果を使用して、リクエストが成功したかどうかを判断します。 そうでない場合は、理由とともにエラーメッセージを返します。



要求応答処理



handleNetworkResponse関数を作成します。 この関数は、 HTTPResponseなどの1つの引数を取り、 Resultを返します。







この関数では、HTTPResponseから受け取ったstatusCodeに応じて、エラーメッセージまたは成功したリクエストのサインを返します。 通常、200..299の範囲のコードは成功を意味します。



ネットワーク要求を行う



それで、ネットワーク層の使用を開始するためにすべてを行いました。リクエストを作成してみましょう。



新しい映画のリストをリクエストします。 関数を作成し、 getNewMoviesという名前を付けます。







手順を見てみましょう。



1. getNewMoviesメソッドを2つの引数で定義します。ページネーションページ番号と、 ムービーモデルのオプションの配列またはオプションのエラーを返す完了ハンドラーです。



2. ルーターを呼び出します。 クロージャーでページ番号とプロセス完了を渡します。



3.ネットワークがない場合、または何らかの理由でリクエストを送信できなかった場合、 URLSessionはエラーを返します。 これはAPIエラーではないことに注意してください。このようなエラーはクライアントで発生し、通常はインターネット接続の品質が低いために発生します。



4. statusCodeプロパティにアクセスする必要があるため、 応答をHTTPURLResponseにキャストする必要があります。



5. 結果を宣言し、 handleNetworkResponseメソッドを使用して初期化する



6. 成功とは、リクエストが成功し、予想される応答を受け取ったことを意味します。 次に、データに答えが付いているかどうかを確認し、ない場合は、returnを使用してメソッドを終了します。



7.回答にデータが含まれている場合、受信したデータをモデルに解析する必要があります。 その後、結果のモデルの配列を完了に渡します。



8.エラーが発生した場合は、単にエラーを完了に渡します。



それだけです。これが、サードパーティのポッドやライブラリの形で依存関係を使用せずに、純粋なSwiftで独自のネットワーク層が動作する方法です。 フィルムのリストを取得するためのテストAPIリクエストを作成するには、 NetworkManagerプロパティを使用してMainViewControllerを作成し、それを介してgetNewMoviesメソッドを呼び出します。

  class MainViewController: UIViewController { var networkManager: NetworkManager! init(networkManager: NetworkManager) { super.init(nibName: nil, bundle: nil) self.networkManager = networkManager } required init?(coder aDecoder: NSCoder) { fatalError("init(coder:) has not been implemented") } override func viewDidLoad() { super.viewDidLoad() view.backgroundColor = .green networkManager.getNewMovies(page: 1) { movies, error in if let error = error { print(error) } if let movies = movies { print(movies) } } } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

少額ボーナス



特定の場所でどのようなプレースホルダーが使用されているのか理解していないときに、Xcodeの状況がありましたか？ たとえば、 ルーター用に作成したばかりのコードを見てください。







NetworkRouterCompletionを自分で決定しましたが、それでもそのタイプとその使用方法を忘れがちです。 しかし、私たちの最愛のXcodeがすべてを処理し、プレースホルダーをダブルクリックするだけで十分で、Xcodeが目的のタイプを置き換えます。







おわりに



これでプロトコル指向のネットワーク層の実装ができました。これは非常に使いやすく、いつでもニーズに合わせてカスタマイズできます。 その機能と、すべてのメカニズムの仕組みを理解しました。



このリポジトリでソースコードを見つけることができます 。