🐛 🤶🏽 ♒️ アプリケーションの邪魔にならないカスタムツール 🐶 💃🏼 🗄️

基本コース「iOS開発者」の開始前夜に、別の興味深い翻訳を用意しました。

: WWDC 2020, . , , — - , . , , - WWDC

あなたのほとんどはおそらく、機能の多くがHTTPを介したサーバーとの通信に依存しているアプリケーションで作業したか、現在作業しています。物事が期待どおりに機能しない場合、またはまだ慣れていないコードの領域を理解したい場合は、アプリケーションとサーバーの間で行われるHTTP要求を確認すると役立つことがよくあります。どのようなリクエストがありましたか？サーバーは正確に何を送信していますか？このために、あなたはおそらくのようなツールを使用チャールズプロキシまたはWiresharkのを。

ただし、これらのツールは、使用、特にセットアップが非常に難しいことがよくあります。独自のSSL証明書を設定し、デバイスにそれを信頼させるために多くの重要な手順を実行する必要がある場合があります。また、アプリケーションを理解する必要がない可能性のある多くの情報も表示されます。同時に、アプリケーションで何が起こっているのかをマッピングすることは困難です。この作業のほとんどを実行でき、セットアップにかかる手間が大幅に少なく、アプリケーションで実際に行われていることにはるかに匹敵する方法で情報を表示するツールがあると言ったらどうでしょうか。？

来週のWWDCの準備のために¹、I（再）は、前のWWDCsから会談のカップルを見ました。とにかく、コアツールがそれらを統合し、 Xcode 10のカスタムツールを作成するのがはるかに簡単になるように書き直されたことを完全に見逃しました。また、WWDC 2019は、私が長年欠いていたツールの素晴らしい入門書であることがわかりました。

かっこいい、ツールが通常測定しないものを測定するために独自のツールを書くことができるようになりました。しかし、何を測定でき、それはどれほど簡単ですか？「ほとんどすべて」と「それほど難しくはなく、十分に速い」と私は言います。通常、必要なのは、標識ポインタをコードからツールに表示するためのデータに変換する方法を示すXMLファイルを作成することだけです。これを行うために必要なXMLは、特に凝ったものではありません。主な障害は、あなたが書く「コード」があなたが慣れているものと非常に異なる可能性が高いことです。例はほとんどなく、ドキュメントはこれを行う方法の一般的な概要のみを提供します。Xcodeは実際にはかなりですがXMLファイルを厳密に検証し、自動補完はなく、エラーを見つけやすくするものはほとんどありません。しかし、少し時間を過ごした後必要な要素を見つけることができ、コードを適応させる例があれば、物事を非常に迅速に行うことができます。ここでは、例を挙げて、すべての有用なリンクをリストしてみます。

ただし、最初から始めましょう。以前にCharlesまたはWiresharkを使用してアプリケーションをデバッグしたことがあるか、多くのHTTP要求を行うアプリケーションを開発したことがある方は、アプリケーション用にカスタマイズされたHTTPトレースツールを作成できるようにしてください。少なくともフレームワーク。次のようになります。

このプロトタイプをビルドしてデバッグするのに約1日かかりました（関連するWWDCビデオを見た後）。コード以外に興味がない場合は、ここで確認できます。

概要概要

カスタムツールを作成する最も簡単な方法は、os_signpostを使用することです。これは、まさにここで行うことです。これを使用して、標識ポインタ.eventまたは.beginおよび.endをログに記録します。次に、これらのos_signpost間隔を分析し、ログインした追加の値を抽出するカスタムツールを設定し、グラフに表示する方法、グループ化する方法、フィルタリングする方法、ツールの詳細ペインにリストまたはツリー/フローチャートの構造を表示する方法を設定します。 ..。

Webライブラリを通過するすべてのHTTPリクエストを間隔（開始+終了）として表示するツールを作成して、それらの所要時間を確認し、アプリケーションで発生する他のイベントと相関させたいと考えています。この記事では、ツールのネットワーキングライブラリとしてAlamofireを使用し、プロファイリングアプリケーションとしてWordpressを使用します。これは、これらがオープンソースであるためです。ただし、すべてのコードをネットワークライブラリに簡単に適合させることができます。

ステップ0：Instrumentsアプリをチェックしてください

( 411 WWDC 2019) — . «Orientation», , (instruments), (tracks), (lanes), (traces), (templates), (detail view) . .
( 410 WWDC 2018), , . , «Architecture» ( , , ) «Intermediate». , , , - . , , . , .

1: signpost-

道標上にツールを構築したいと考えています。つまり、道標を介してデータをログに記録します。 Alamofireは、リクエストが開始または終了するたびに通知を送信するため、必要なのは次の^2つだけです。

NotificationCenter.default.addObserver(forName: Notification.Name.Task.DidResume, object: nil, queue: nil) { (notification) in
    guard let task = notification.userInfo?[Notification.Key.Task] as? URLSessionTask,
        let request = task.originalRequest,
        let url = request.url else {
            return
    }
    let signpostId = OSSignpostID(log: networking, object: task)
    os_signpost(.begin, log: SignpostLog.networking, name: "Request", signpostID: signpostId, "Request Method %{public}@ to host: %{public}@, path: %@, parameters: %@", request.httpMethod ?? "", url.host ?? "Unknown", url.path, url.query ?? "")
}
NotificationCenter.default.addObserver(forName: Notification.Name.Task.DidComplete, object: nil, queue: nil) { (notification) in
    guard let task = notification.userInfo?[Notification.Key.Task] as? URLSessionTask else { return }
    let signpostId = OSSignpostID(log: networking, object: task)
    let statusCode = (task.response as? HTTPURLResponse)?.statusCode ?? 0
    os_signpost(.end, log: SignpostLog.networking, name: "Request", signpostID: signpostId, "Status: %@, Bytes Received: %llu, error: %d, statusCode: %d", "Completed", task.countOfBytesReceived, task.error == nil ? 0 : 1, statusCode)
}

リクエストが開始されると、標識をログに記録し、.begin完了すると、標識を追加し.endます。通話の終了と対応する通話の開始を一致さsignpostIdせるために、複数のリクエストが並行して発生している場合に正しい間隔を閉じるようにします。理想的にはsignpostId、リクエストオブジェクトに格納して、とに同じものを使用していることを確認する必要が.beginあり.endます。ただし、RequestAlamofireでタイプを編集したくなかったのでOSSignpostID(log:, object:)、IDオブジェクトを使用して渡すことにしました。URLSessionTaskどちらの場合も同じであるため、ベースオブジェクトを使用します。これにより、OSSignpostID(log:, object:)複数回呼び出されたときに同じ識別子を返すことができます。

フォーマット文字列を使用してデータをログに記録します。ツール側での解析を容易にし、また解析を容易にするために、おそらく常に2つの引数を明確に定義された文字列で区切る必要があります。に.endすでにログインしている場合は、通話にデータを記録する必要がないことに注意してください.begin。それらは1つの間隔に結合され、アクセスできるようになります。

ステップ2：Xcodeで新しいカスタムツールプロジェクトを作成します。

カスタムインスツルメントの作成（WWDC 2018のセッション410）またはインスツルメントアプリのヘルプ-ツールボックスプロジェクトの作成の手順に従って、Xcodeで新しいツールボックスプロジェクトを作成します。これにより、を使用した基本的なXcodeプロジェクトが得られます.instrpkg。そこにすべての詳細を示します。

ステップ3：残りを行う

基本的に、InstrumentsAppヘルプ-標識データからツールを作成するで概説されている手順に従います。ここでのすべての手順の説明は正しいですが、それでも詳細が不足しているため、実際のカスタムツールの例を目の前に置くことをお勧めします。あなたはここで私のものを見ることができます。基本的に、次の部分が必要になります。

スキーマ

これは、標識ポインタからのデータを使用可能な変数に解析する方法をツールに指示します。ログメッセージから変数を抽出し、それらを列に分散するテンプレートを定義します。

<os-signpost-interval-schema>
	<id>org-alamofire-networking-schema</id>
	<title>Alamofire Networking Schema</title>

	<subsystem>"org.alamofire"</subsystem>
	<category>"networking"</category>
	<name>"Request"</name>

	<start-pattern>
	    <message>"Request Method " ?http-method " to host: " ?host ", path: " ?url-path ", parameters: " ?query-parameters</message>
	</start-pattern>
	<end-pattern>
	    <message>"Status: " ?completion-status ", Bytes Received: " ?bytes-received ", error: " ?errored ", statusCode: " ?http-status-code</message>
	</end-pattern>

	<column>
	    <mnemonic>column-http-method</mnemonic>
	    <title>HTTP Method</title>
	    <type>string</type>
	    <expression>?http-method</expression>
	</column>
	<!--      -->
</os-signpost-interval-schema>

mnemonic後でこの列を参照する識別子です。どういうわけか、列に変数と同じ名前を付けるのは少し奇妙だと思ったので、それらの前に接頭辞を付けましたcolumn。しかし、私が知る限り、これを行う必要はありません。

ツール

ツールは、基本的な定義で構成されています。

<instrument>
    <id>org.alamofire.networking.instrument</id>
    <title>Alamofire</title>
    <category>Behavior</category>
    <purpose>Trace HTTP calls made via Alamofire, grouped by method, host, path, etc.</purpose>
    <icon>Network</icon>
    
    <create-table>
        <id>alamofire-requests</id>
        <schema-ref>org-alamofire-networking-schema</schema-ref>
    </create-table>

    <!--     -->
</instrument>

とても簡単です。これらのフィールドのほとんどは自由形式のテキストであるか、前に定義した資料に関連しています（schema-ref）。しかし、こことここで定義された値の小さなセットのみを持つことcategoryもiconできます。ツール内 のグラフグラフは、ツールのユーザーインターフェイスのグラフィック部分、つまりトラック領域に表示される視覚的表現を定義します。これは次のようになります。

<instrument>
    <!--    -->
    <graph>
        <title>HTTP Requests</title>
        <lane>
            <title>the Requests</title>
            <table-ref>alamofire-requests</table-ref>
            
            <plot-template>
                <instance-by>column-host</instance-by>
                <label-format>%s</label-format>
                <value-from>column-url-path</value-from>
                <color-from>column-response</color-from>
                <label-from>column-url-path</label-from>
            </plot-template>
        </lane>
    </graph>
    <!--    --> 
</instrument>

異なるレーンを持つことができ、plot-templateを使用して、レーンごとに動的な数のプロットを実装できます。私の例には、単純なグラフの例が含まれています。理由はわかりませんがgraph、laneタイトルがあります。これに加えて、の各チャートはplot-templateからラベルも受け取りlabel-formatます。

リスト、集計、または詳細ビューのいずれか

チャートだけでは、ツールはやや不完全に見えます。また、詳細ビューに何かを表示したいとします。あなたがこれを行うことができlist、aggregationまたはnarrative。私がまだ会っていないさらに多くのオプションがあるかもしれません。集計は次のようになります。

<instrument>
    <!--    -->
    <aggregation>
        <title>Summary: Completed Requests</title>
        <table-ref>alamofire-requests</table-ref>
        <slice>
                <column>column-completion-status</column>
                <equals><string>Completed</string></equals>
        </slice>
        <hierarchy>
            <level>
                <column>column-host</column>
            </level>
            <level>
                <column>column-url-path</column>
            </level>
        </hierarchy>
        
        <column><count/></column>
        <column><average>duration</average></column>
        <column><max>duration</max></column>
        <column><sum>column-size</sum></column>
        <column><average>column-size</average></column>
    </aggregation>
    <!--    --> 
</instrument>

リストは次のようになります。

<instrument>
    <!--    -->
    <list>
        <title>List: Requests</title>
        <table-ref>alamofire-requests</table-ref>
        <column>start</column>
        <column>duration</column>
        <column>column-host</column>
        <!--   ->
    </list>
    <!--    -->
</instrument>

ボーナス素材

実際、これがすべてです。しかし、あなたはWWDCビデオで説明されている以上のことをしていないので、いくつかのギャップを埋めることを約束しました。

私のサンプルツールには、さらにいくつかの優れた機能が含まれています。リクエストが成功したかどうかに応じて間隔に色を付ける

小さなCLIPS式。色の値は、Instruments Engineering TypeReferenceにあります。チャートテンプレートを使用すると、1つのストリップに複数のチャートを表示したり、たとえば、私の例のようにホストごとにチャートを作成したりできます。ただし、複数のレベルの階層を設定して、ユーザーがパーツを展開または折りたたむことができるようにすることができます。このためには、要素を使用する必要があります、

<engineering-type-track>階層を定義してから、階層のさまざまなレベルに追加（拡張）して、グラフと詳細ビューを追加します。また、それぞれのツール内でアドオンをアクティブ化することを忘れないでください。

さらなる行動

以前のリンクからまだそれを見つけていない場合は、実際には、ファイルに入れることができるすべての完全なヘルプがあり.instrpkgます。たとえば、ツールに選択できる要素 <instrument>やアイコンがわかります。重要なポイントの1つは、順序が重要です。したがって、たとえば、では<instrument>、<title>より前に表示する必要<category>があります。そうしないと、説明が無効になります。カスタムツール

の作成（WWDC 2018のセッション410）を再度確認して、必要になる可能性のある詳細をメモします。使用例を見つけたWWDC2019セッションのサンプルコードもあります<engineering-type-track>。

CLIPSは、カスタムモデラー（モデラー-ここでは説明しません）の作成に使用される言語ですが、列宣言中の短い式にも使用できます。言語ドキュメントは、必要なものよりもはるかに広範囲です。単純な式を作成するためにおそらく知っておく必要がある主なことは、CLIPSはプレフィックス表記を使用?a + ?bするため、代わりに作成する必要があるということ(+ ?a ?b)です。

カスタムツールに関するその他の記事

Xcodeでカスタムツールボックスを作成することについての Igor

デバッグ

XCodeos_signpostトレースドキュメントにツールを追加することは常に良い考えです。このようにして、何かが期待どおりに機能しない場合、データが正しくログに記録されているかどうか、およびツールがデータを正しく解釈したかどうかを確認できます。

私がまだ理解していないこと

Instrumentsがデフォルトで提供し、列定義の式でユーザーインターフェイス（たとえば、期間）に表示する値を使用する方法（たとえば、受信したバイトを期間で割ってボーレート列を作成するため）。
余分な詳細領域に何かを表示する方法。コールスタック専用のようです。たとえば、選択したリクエストのJSON本文を表示したいのですが、これを明確にする例が見つかりません。

このツールの機能

まだ進行中の作業

ダウンロードして、自分の目で確かめてください。

脚注

さて、実際には他の理由がありました。
私の例にログインするための完全なコードは、Logger.swiftファイルにあります。Alamofire 5は執筆時点ですでにリリースされていますが、Wordpress iOSアプリの現在のバージョンで使用されているため、Alamofire4.8で想定されています。通知があるため、このロギングコードは、Alamofire自体を変更せずに簡単に追加できますが、カスタムネットワーキングライブラリがある場合は、ライブラリ自体にエントリを追加して詳細にアクセスする方が簡単な場合があります。

iOS開発のクイックスタート（無料のウェビナー）

アプリケーションの邪魔にならないカスタムツール