このガイドでは、iOS 向けの Simple Log Service SDK を使用して、ログデータを迅速に収集する方法を説明します。
前提条件
iOS SDK がインストールされている必要があります。詳細については、「iOS SDK のインストール」をご参照ください。
クイックスタート
SDK を初期化し、addLog メソッドを呼び出してログを送信します。
iOS SDK は複数のインスタンスの初期化をサポートしています。
LogProducerConfigインスタンスとLogProducerClientインスタンスは、ペアで使用する必要があります。Simple Log Service (SLS) にログを送信する際は、Alibaba Cloud アカウントまたは RAM ユーザーの AccessKey ペアを使用してリクエストを認証し、改ざんを防止する必要があります。認証情報の漏洩によるセキュリティ リスクを防ぐため、モバイルアプリケーションに AccessKey ペアをハードコードしないでください。代わりに、モバイルデバイス向けダイレクトログ転送サービスを使用して AccessKey ペアを設定することを推奨します。詳細については、「モバイルデバイスから Simple Log Service にログをアップロードするサービスの構築」をご参照ください。
@interface ProducerExampleController ()
// LogProducerConfig インスタンスと LogProducerClient インスタンスは、グローバルプロパティとして保持することを推奨します。
@property(nonatomic, strong) LogProducerConfig *config;
@property(nonatomic, strong) LogProducerClient *client;
@end
@implementation ProducerExampleController
// コールバックはオプションです。ログ送信ステータスを監視する場合に使用します。
// AccessKey ペアを動的に設定するには、呼び出された際に更新するコールバックを設定します。
static void _on_log_send_done(const char * config_name, log_producer_result result, size_t log_bytes, size_t compressed_bytes, const char * req_id, const char * message, const unsigned char * raw_buffer, void * userparams) {
if (result == LOG_PRODUCER_OK) {
NSString *success = [NSString stringWithFormat:@"send success, config : %s, result : %d, log bytes : %d, compressed bytes : %d, request id : %s", config_name, (result), (int)log_bytes, (int)compressed_bytes, req_id];
SLSLogV("%@", success);
} else {
NSString *fail = [NSString stringWithFormat:@"send fail , config : %s, result : %d, log bytes : %d, compressed bytes : %d, request id : %s, error message : %s", config_name, (result), (int)log_bytes, (int)compressed_bytes, req_id, message];
SLSLogV("%@", fail);
}
}
- (void) initLogProducer {
// サービスエンドポイント。値は https:// または http:// で始まる必要があります。
NSString *endpoint = @"";
NSString *project = @"";
NSString *logstore = @"";
_config = [[LogProducerConfig alloc] initWithEndpoint:endpoint
project:project
logstore:logstore
];
// ログ Topic を設定します。
[_config SetTopic:@"example_topic"];
// グローバルタグを追加します。これはすべてのログに付与されます。
[_config AddTag:@"example" value:@"example_tag"];
// 期限切れログを破棄するかどうかを指定します。0: ログを保持し、タイムスタンプを現在の時刻に更新します。1 (デフォルト): ログを破棄します。
[_config SetDropDelayLog:1];
// 認証に失敗したログを破棄するかどうかを指定します。0 (デフォルト): ログを保持します。1: ログを破棄します。
[_config SetDropUnauthorizedLog:0];
// ログ送信ステータスを監視するには、コールバックを渡します。
_client = [[LogProducerClient alloc] initWithLogProducerConfig:_config callback:_on_log_send_done];
}
// AccessKey ペアをリクエストします。
- (void) requestAccessKey {
// モバイルデバイス向けダイレクトログ転送サービスを使用して AccessKey ペアを設定することを推奨します。
// ...
// AccessKey ペアを取得した後、このメソッドを呼び出して更新します。
[self updateAccessKey:accessKeyId accessKeySecret:accessKeySecret securityToken:securityToken];
}
// AccessKey ペアを更新します。
- (void) updateAccessKey:(NSString *)accessKeyId accessKeySecret:(NSString *)accessKeySecret securityToken:(NSString *)securityToken {
// セキュリティトークンを含む Security Token Service (STS) からの AccessKey ペアの場合、このメソッドを使用して認証情報を更新します。
if (securityToken.length > 0) {
if (accessKeyId.length > 0 && accessKeySecret.length > 0) {
[_config ResetSecurityToken:accessKeyId
accessKeySecret:accessKeySecret
securityToken:securityToken
];
}
} else {
// セキュリティトークンを使用しない AccessKey ペアの場合、このメソッドを使用します。
if (accessKeyId.length > 0 && accessKeySecret.length > 0) {
[_config setAccessKeyId: accessKeyId];
[_config setAccessKeySecret: accessKeySecret];
}
}
}
// ログを送信します。
- (void) addLog {
Log *log = [Log log];
// ビジネス要件に基づいてログフィールドをカスタマイズします。
[log putContent:@"content_key_1" intValue:123456];
[log putContent:@"content_key_2" floatValue:23.34f];
[log putContent:@"content_key_3" value:@"Chinese characters"];
[_client AddLog:log];
}
@end 高度な使用法
パラメーターの動的な設定
iOS SDK を使用すると、プロジェクト、Logstore、エンドポイント、アクセスキーペアなどのパラメーターを動的に設定できます。エンドポイントの取得に関する詳細については、「エンドポイント」をご参照ください。アクセスキーペアの取得に関する詳細については、「アクセスキーペア」をご参照ください。
エンドポイント、プロジェクト、Logstore を動的に設定します。
// エンドポイント、プロジェクト、Logstore のパラメーターは、個別または一括で設定できます。 // エンドポイントを更新します。 [_config setEndpoint:@"your new-endpoint"]; // プロジェクトを更新します。 [_config setProject:@"your new-project"]; // Logstore を更新します。 [_config setLogstore:@"your new-logstore"];アクセスキーペアを動的に設定します。
アクセスキーペアを動的に設定する場合、コールバックの使用を推奨します。
// LogProducerClient の初期化時にコールバックを初期化している場合は、次のコードを無視できます。 static void _on_log_send_done(const char * config_name, log_producer_result result, size_t log_bytes, size_t compressed_bytes, const char * req_id, const char * message, const unsigned char * raw_buffer, void * userparams) { if (LOG_PRODUCER_SEND_UNAUTHORIZED == result || LOG_PRODUCER_PARAMETERS_INVALID) { [selfClzz requestAccessKey]; // selfClzz は現在のクラスインスタンスへの参照であり、C スタイルのコールバックで使用するためにキャプチャされます。 } } // ログの送信ステータスを確認する場合は、2 番目のパラメーターとしてコールバックを渡します。 _client = [[LogProducerClient alloc] initWithLogProducerConfig:_config callback:_on_log_send_done]; // アクセスキーペアをリクエストします。 - (void) requestAccessKey { // まず、モバイルデバイスからのダイレクトログ転送サービスを使用してアクセスキーペアを設定することを推奨します。 // ... // アクセスキーペアを取得した後、認証情報を更新します。 [self updateAccessKey:accessKeyId accessKeySecret:accessKeySecret securityToken:securityToken]; } // アクセスキーペアを更新します。 - (void) updateAccessKey:(NSString *)accessKeyId accessKeySecret:(NSString *)accessKeySecret securityToken:(NSString *)securityToken { // STS を使用してアクセスキーペアを取得する場合、アクセスキーペアにはセキュリティトークンが含まれます。この場合、次の方法でアクセスキーペアを更新します。 if (securityToken.length > 0) { if (accessKeyId.length > 0 && accessKeySecret.length > 0) { [_config ResetSecurityToken:accessKeyId accessKeySecret:accessKeySecret securityToken:securityToken ]; } } else { // STS を使用せずにアクセスキーペアを取得する場合は、次の方法でアクセスキーペアを更新します。 if (accessKeyId.length > 0 && accessKeySecret.length > 0) { [_config setAccessKeyId: accessKeyId]; [_config setAccessKeySecret: accessKeySecret]; } } }ログソース、ログトピック、タグを動的に設定します。
重要個々のログに対してログソース、ログトピック、タグを設定することはできません。これらの設定はグローバルであり、リトライバッファー内のログを含む、送信されていないすべてのログに適用されます。これらのパラメーターを使用して特定のログカテゴリを追跡すると、このグローバルな適用により予期しない動作が発生する可能性があります。カテゴリを追跡するには、代わりに各ログにカスタムフィールドを追加することを推奨します。
// ログトピックを設定します。 [_config SetTopic:@"your new-topic"]; // ログソースを設定します。 [_config SetSource:@"your new-source"]; // タグを設定します。タグは各ログに添付されます。 [_config AddTag:@"test" value:@"your new-tag"];
再開可能なアップロード
iOS SDK は再開可能なアップロードをサポートしています。この機能を有効にすると、addLog メソッドで送信されたログがローカルのバイナリログ (binlog) ファイルに永続化されます。SDK は、ログの送信に成功した後にのみこのローカルデータを削除するため、At-Least-Once 配信が保証されます。
再開可能なアップロードを有効にするには、SDK の初期化中に次のコードを追加します。
複数の LogProducerConfig インスタンスを初期化する場合、各
LogProducerConfigインスタンスのsetPersistentFilePathメソッドに一意のファイルパスを指定する必要があります。アプリが再開可能なアップロードを有効にした複数のプロセスを使用する場合、SDK はメインプロセスでのみ初期化してください。子プロセスもデータを収集する必要がある場合は、
SetPersistentFilePathメソッドに指定するファイルパスが各プロセスで一意であることを確認してください。そうしないと、ログデータが乱れたり失われたりする可能性があります。複数のスレッドから LogProducerConfig を繰り返し初期化すると、問題が発生する可能性があります。
- (void) initLogProducer {
// 値 1 は再開可能なアップロードを有効にし、0 は無効にします。デフォルト値は 0 です。
[_config SetPersistent:1];
// 永続化ファイル名。このファイルのディレクトリが存在することを確認してください。
NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
NSString *Path = [[paths lastObject] stringByAppendingString:@"/log.dat"];
[_config SetPersistentFilePath:Path];
// ロールオーバーする永続化ファイルの数。値は 10 を推奨します。
[_config SetPersistentMaxFileCount:10];
// 各永続化ファイルのサイズ (バイト単位)。N*1024*1024 として指定します。N の値は 1~10 を推奨します。
[_config SetPersistentMaxFileSize:N*1024*1024];
// ローカルにキャッシュするログの最大数。1,048,576 を超えないようにしてください。デフォルト値は 65,536 です。
[_config SetPersistentMaxLogCount:65536];
}設定パラメーター
すべての設定パラメーターは、LogProducerConfig クラスが提供します。以下の表で、これらのパラメーターについて説明します。
パラメーター | タイプ | 説明 |
SetTopic | String | トピックフィールドの値を指定します。デフォルト値は空の文字列です。 |
AddTag | String |
|
SetSource | String | ソースフィールドの値を指定します。デフォルト値は |
SetPacketLogBytes | Int | バッファー内のログパケットの最大サイズを指定します。この制限を超えたパケットはすぐに送信されます。 値の範囲:1~5,242,880 バイト。デフォルト:1,048,576 バイト (1 MiB)。 |
SetPacketLogCount | Int | パケットあたりのログの最大数を指定します。この制限を超えると、ログパケットはすぐに送信されます。 値の範囲:1~4,096。デフォルト:1,024。 |
SetPacketTimeout | Int | ログパケットがバッファー内に留まる最大時間を指定します。このタイムアウトに達すると、パケットはすぐに送信されます。 デフォルト:3,000 ミリ秒。 |
SetMaxBufferLimit | Int | プロデューサーインスタンスの最大バッファーサイズをバイト単位で指定します。この制限を超えると、 デフォルト:67,108,864 (64 MiB)。 |
SetPersistent | Int | 再開可能なアップロード機能を有効または無効にします。
|
SetPersistentFilePath | String | データ永続化用のファイルパスを指定します。ディレクトリが存在する必要があります。各 デフォルト値は空の文字列です。 |
SetPersistentForceFlush | Int |
高い信頼性が求められるシナリオでは、このオプションを推奨します。 |
SetPersistentMaxFileCount | Int | ローテーション用の永続化ファイルの最大数を指定します。値が 0 の場合、ローテーションは無効になり、単一のファイルが使用されます。推奨範囲:1~10。デフォルト:0。 |
SetPersistentMaxFileSize | Int | 各永続化ファイルの最大サイズをバイト単位で指定します。推奨値は 1,048,576 バイト (1 MiB) ~ 10,485,760 バイト (10 MiB) です。 |
SetPersistentMaxLogCount | Int | 永続化のためにローカルに保存できるログの最大数を指定します。値は 1,048,576 を超えてはなりません。デフォルト:65,536。 |
SetConnectTimeoutSec | Int | ネットワーク接続のタイムアウトを秒単位で指定します。デフォルト値は 10 です。 |
SetSendTimeoutSec | Int | ログパケットの送信タイムアウトを秒単位で指定します。デフォルト値は 15 です。 |
SetDestroyFlusherWaitSec | Int | フラッシャースレッドが破棄されるまでの最大待機時間を秒単位で指定します。デフォルト値は 1 です。 |
SetDestroySenderWaitSec | Int | センダースレッドプールが破棄されるまでの最大待機時間を秒単位で指定します。デフォルト値は 1 です。 |
SetCompressType | Int | アップロード時のデータ圧縮タイプを指定します。
|
SetNtpTimeOffset | Int | デバイス時刻と標準 NTP 時刻とのオフセットを秒単位で指定します。これは |
SetMaxLogDelayTime | Int | ログのタイムスタンプとデバイスのローカル時刻との間の許容最大時間差を秒単位で指定します。この差を超えた場合、ログは |
SetDropDelayLog | Int |
|
SetDropUnauthorizedLog | Int | 認証に失敗したログを破棄するかどうかを指定します。
|
エラーコード
すべてのエラーコードは log_producer_result で定義されています。次の表に、各エラーコードとその解決策を説明します。
エラーコード | 値 | 説明 | 解決策 |
LOG_PRODUCER_OK | 0 | 成功。 | 該当なし。 |
LOG_PRODUCER_INVALID | 1 | SDK が破棄されているか、無効です。 |
|
LOG_PRODUCER_WRITE_ERROR | 2 | データの書き込みに失敗しました。このエラーは、プロジェクトの書き込みトラフィックが上限に達した場合に発生することがあります。 | プロジェクトの書き込みトラフィックの上限を引き上げてください。詳細については、「リソースクォータの調整」をご参照ください。 |
LOG_PRODUCER_DROP_ERROR | 3 | ディスクキャッシュまたはメモリキャッシュがいっぱいです。 |
|
LOG_PRODUCER_SEND_NETWORK_ERROR | 4 | ネットワークエラーが発生しました。 | エンドポイント、プロジェクト、および Logstore の設定を確認してください。 |
LOG_PRODUCER_SEND_QUOTA_ERROR | 5 | プロジェクトの書き込みトラフィッククォータを超えました。 | プロジェクトの書き込みトラフィックの上限を引き上げてください。詳細については、「リソースクォータの調整」をご参照ください。 |
LOG_PRODUCER_SEND_UNAUTHORIZED | 6 | AccessKey の有効期限が切れている、無効である、またはアクセスポリシーの設定が正しくありません。 | AccessKey を確認してください。 RAM ユーザーには Simple Log Service のリソースを管理する権限が必要です。詳細については、「RAMユーザーへの権限付与」をご参照ください。 |
LOG_PRODUCER_SEND_SERVER_ERROR | 7 | サーバー側エラーが発生しました。 | テクニカルサポートにお問い合わせください。 |
LOG_PRODUCER_SEND_DISCARD_ERROR | 8 | データは破棄されました。通常、デバイスとサーバー間のクロックスキューが原因です。 | SDK は自動的にリクエストをリトライします。 |
LOG_PRODUCER_SEND_TIME_ERROR | 9 | デバイスのクロックがサーバー時刻と同期されていません。 | SDK はこの問題を自動的に修正します。 |
LOG_PRODUCER_SEND_EXIT_BUFFERED | 10 | すべてのキャッシュデータを送信する前に SDK が破棄されました。 | データ損失を防ぐには、再開可能なアップロード機能を有効にしてください。 |
LOG_PRODUCER_PARAMETERS_INVALID | 11 | SDK の初期化パラメータが無効です。 | AccessKey、エンドポイント、プロジェクト、Logstore などのパラメーターを確認してください。 |
LOG_PRODUCER_PERSISTENT_ERROR | 99 | キャッシュデータのディスクへの書き込みに失敗しました。 | 1. キャッシュファイルパスが正しいことを確認してください。 2. キャッシュファイルがいっぱいかどうかを確認してください。 3. 十分なディスク領域があることを確認してください。 |
よくある質問
ログが重複するのはなぜですか?
iOS SDK はログを非同期で送信します。ネットワークの問題により、送信の失敗やリトライが発生する可能性があります。SDK は、ステータスコード 200 を受信した場合にのみ送信が成功したと判断します。このプロセスにより、ログが重複する可能性があります。分析の際は、SQL クエリを使用してデータの重複を排除してください。
重複したログの発生率が高い場合は、SDK の初期化に問題がないか確認してください。主な原因と解決策は次のとおりです。
再開可能なアップロードの設定が正しくない
この問題を解決するには、
SetPersistentFilePathメソッドに渡されるファイルパスがグローバルに一意であることを確認してください。SDK の重複初期化
SDK の重複初期化は、多くの場合、シングルトンパターンが正しく使用されていないことが原因で発生します。次の例に示すように SDK を初期化してください。
// AliyunLogHelper.h @interface AliyunLogHelper : NSObject + (instancetype)sharedInstance; - (void) addLog:(Log *)log; @end // AliyunLogHelper.m @interface AliyunLogHelper () @property(nonatomic, strong) LogProducerConfig *config; @property(nonatomic, strong) LogProducerClient *client; @end @implementation AliyunLogHelper + (instancetype)sharedInstance { static AliyunLogHelper *sharedInstance = nil; static dispatch_once_t onceToken; dispatch_once(&onceToken, ^{ sharedInstance = [[self alloc] init]; }); return sharedInstance; } - (instancetype)init { self = [super init]; if (self) { [self initLogProducer]; } return self; } - (void) initLogProducer { // ご自身の初期化コードに置き換えてください。 _config = [[LogProducerConfig alloc] initWithEndpoint:@"" project:@"" logstore:@"" accessKeyID:@"" accessKeySecret:@"" securityToken:@"" ]; _client = [[LogProducerClient alloc] initWithLogProducerConfig:_config callback:_on_log_send_done]; } - (void) addLog:(Log *)log { if (nil == log) { return; } [_client AddLog:log]; } @end複数のプロセスを使用することも、重複初期化の原因となる可能性があります。SDK はメインプロセスでのみ初期化してください。異なるプロセス間で SDK を初期化する必要がある場合は、各プロセスで
SetPersistentFilePathに異なる値を設定して一意性を確保してください。
低速ネットワーク環境における設定の最適化
アプリケーションが低速ネットワーク環境で動作する場合は、以下のように SDK 設定を最適化してください。
// SDK を初期化します。 - (void) initProducer() { // HTTP 接続と送信のタイムアウトを調整して、重複したログの発生率を低減します。 // 必要に応じてタイムアウト値を調整できます。 [_config SetConnectTimeoutSec:20]; [_config SetSendTimeoutSec:20]; // その他の初期化パラメーター。 // ... }
ログ損失への対処
ログの報告は非同期プロセスです。送信が完了する前にアプリケーションが終了すると、ログが失われる可能性があります。再開可能なアップロード機能を有効にすることを推奨します。詳細については、「再開可能なアップロード」をご参照ください。
ログ報告遅延への対処
ネットワークの状態や特定のアプリケーションのユースケースによっては、ログの報告が遅延することがあります。ログ報告の遅延が一部のデバイスでのみ発生する場合、これは通常、正常な動作です。それ以外の場合は、次の表のエラーコードを使用して問題をトラブルシューティングしてください。
エラーコード | 説明 |
LOG_PRODUCER_SEND_NETWORK_ERROR | エンドポイント、プロジェクト、Logstore が正しく設定されていることを確認してください。 |
LOG_PRODUCER_SEND_UNAUTHORIZED | アクセスキーが有効で、有効期限が切れておらず、関連付けられた許可ポリシーが正しく設定されていることを確認してください。 |
LOG_PRODUCER_SEND_QUOTA_ERROR | プロジェクトの書き込みトラフィックのクォータを超えました。詳細については、「リソースクォータの調整」をご参照ください。 |
DNS 事前解決とキャッシュポリシー
はい。次の例では、iOS SDK と HTTPDNS SDK を使用して DNS 事前解決とキャッシュポリシーを実装する方法を示します。
注:SLS エンドポイントが HTTPS ドメイン名を使用する場合、「HTTPSおよびSNIシナリオの解決策」を参照する必要があります。
カスタム NSURLProtocol の実装
#import <Foundation/Foundation.h> #import "HttpDnsNSURLProtocolImpl.h" #import <arpa/inet.h> #import <zlib.h> #import <objc/runtime.h> static NSString *const hasBeenInterceptedCustomLabelKey = @"HttpDnsHttpMessagePropertyKey"; static NSString *const kAnchorAlreadyAdded = @"AnchorAlreadyAdded"; @interface HttpDnsNSURLProtocolImpl () <NSStreamDelegate> @property (strong, readwrite, nonatomic) NSMutableURLRequest *curRequest; @property (strong, readwrite, nonatomic) NSRunLoop *curRunLoop; @property (strong, readwrite, nonatomic) NSInputStream *inputStream; @property (nonatomic, assign) BOOL responseIsHandle; @property (assign, nonatomic) z_stream gzipStream; @end @implementation HttpDnsNSURLProtocolImpl - (instancetype)initWithRequest:(NSURLRequest *)request cachedResponse:(nullable NSCachedURLResponse *)cachedResponse client:(nullable id <NSURLProtocolClient>)client { self = [super initWithRequest:request cachedResponse:cachedResponse client:client]; if (self) { _gzipStream.zalloc = Z_NULL; _gzipStream.zfree = Z_NULL; if (inflateInit2(&_gzipStream, 16 + MAX_WBITS) != Z_OK) { [self.client URLProtocol:self didFailWithError:[[NSError alloc] initWithDomain:@"gzipの初期化に失敗" code:-1 userInfo:nil]]; } } return self; } /** * 指定されたリクエストをインターセプトして処理するかどうかを指定します。 * * @param request 指定されたリクエスト。 * @return リクエストをインターセプトする場合は YES、そのまま渡す場合は NO。 */ + (BOOL)canInitWithRequest:(NSURLRequest *)request { if([[request.URL absoluteString] isEqual:@"about:blank"]) { return NO; } // リクエストが再インターセプトされた場合に発生する可能性のある無限ループを防ぎます。 if ([NSURLProtocol propertyForKey:hasBeenInterceptedCustomLabelKey inRequest:request]) { return NO; } NSString * url = request.URL.absoluteString; NSString * domain = request.URL.host; // HTTPS リクエストのみをインターセプトします。 if (![url hasPrefix:@"https"]) { return NO; } // ホスト配列を構成してその配列内のホストのみをインターセプトするなど、さらに条件を追加できます。 // ホストが IP アドレスに置き換えられたリクエストのみをインターセプトします。 if (![self isPlainIpAddress:domain]) { return NO; } return YES; } + (BOOL)isPlainIpAddress:(NSString *)hostStr { if (!hostStr) { return NO; } // アドレスが IPv4 アドレスであるかどうかを確認します。 const char *utf8 = [hostStr UTF8String]; int success = 0; struct in_addr dst; success = inet_pton(AF_INET, utf8, &dst); if (success == 1) { return YES; } // アドレスが IPv6 アドレスであるかどうかを確認します。 struct in6_addr dst6; success = inet_pton(AF_INET6, utf8, &dst6); if (success == 1) { return YES; } return NO; } // リクエストをリダイレクトしたり、ヘッダーを追加したりするには、このメソッドで操作を実行します。 + (NSURLRequest *)canonicalRequestForRequest:(NSURLRequest *)request { return request; } // リクエストの読み込みを開始します。 - (void)startLoading { NSMutableURLRequest *request = [self.request mutableCopy]; // 無限ループを防ぐために、リクエストを処理済みとしてマークします。 [NSURLProtocol setProperty:@(YES) forKey:hasBeenInterceptedCustomLabelKey inRequest:request]; self.curRequest = [self createNewRequest:request]; [self startRequest]; } - (NSString *)cookieForURL:(NSURL *)URL { NSHTTPCookieStorage *cookieStorage = [NSHTTPCookieStorage sharedHTTPCookieStorage]; NSMutableArray *cookieList = [NSMutableArray array]; for (NSHTTPCookie *cookie in [cookieStorage cookies]) { if (![self p_checkCookie:cookie URL:URL]) { continue; } [cookieList addObject:cookie]; } if (cookieList.count > 0) { NSDictionary *cookieDic = [NSHTTPCookie requestHeaderFieldsWithCookies:cookieList]; if ([cookieDic objectForKey:@"Cookie"]) { return cookieDic[@"Cookie"]; } } return nil; } - (BOOL)p_checkCookie:(NSHTTPCookie *)cookie URL:(NSURL *)URL { if (cookie.domain.length <= 0 || URL.host.length <= 0) { return NO; } if ([URL.host containsString:cookie.domain]) { return YES; } return NO; } - (NSMutableURLRequest *)createNewRequest:(NSURLRequest*)request { NSURL* originUrl = request.URL; NSString *cookie = [self cookieForURL:originUrl]; NSMutableURLRequest* mutableRequest = [request copy]; [mutableRequest setValue:cookie forHTTPHeaderField:@"Cookie"]; return [mutableRequest copy]; } /** * リクエストをキャンセルします。 */ - (void)stopLoading { if (_inputStream.streamStatus == NSStreamStatusOpen) { [self closeStream:_inputStream]; } [self.client URLProtocol:self didFailWithError:[[NSError alloc] initWithDomain:@"読み込み停止" code:-1 userInfo:nil]]; } /** * CFHTTPMessage を使用してリクエストを転送します。 */ - (void)startRequest { // 元のリクエストのヘッダー情報。 NSDictionary *headFields = _curRequest.allHTTPHeaderFields; CFStringRef url = (__bridge CFStringRef) [_curRequest.URL absoluteString]; CFURLRef requestURL = CFURLCreateWithString(kCFAllocatorDefault, url, NULL); // GET や POST などの元のリクエストのメソッド。 CFStringRef requestMethod = (__bridge_retained CFStringRef) _curRequest.HTTPMethod; // リクエストの URL、メソッド、バージョンに基づいて CFHTTPMessageRef オブジェクトを作成します。 CFHTTPMessageRef cfrequest = CFHTTPMessageCreateRequest(kCFAllocatorDefault, requestMethod, requestURL, kCFHTTPVersion1_1); // HTTP POST リクエストに添付されたデータを追加します。 CFStringRef requestBody = CFSTR(""); CFDataRef bodyData = CFStringCreateExternalRepresentation(kCFAllocatorDefault, requestBody, kCFStringEncodingUTF8, 0); if (_curRequest.HTTPBody) { bodyData = (__bridge_retained CFDataRef) _curRequest.HTTPBody; } else if (_curRequest.HTTPBodyStream) { NSData *data = [self dataWithInputStream:_curRequest.HTTPBodyStream]; NSString *strBody = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]; NSLog(@"originStrBody: %@", strBody); CFDataRef body = (__bridge_retained CFDataRef) data; CFHTTPMessageSetBody(cfrequest, body); CFRelease(body); } else { CFHTTPMessageSetBody(cfrequest, bodyData); } // 元のリクエストのヘッダー情報をコピーします。 for (NSString* header in headFields) { CFStringRef requestHeader = (__bridge CFStringRef) header; CFStringRef requestHeaderValue = (__bridge CFStringRef) [headFields valueForKey:header]; CFHTTPMessageSetHeaderFieldValue(cfrequest, requestHeader, requestHeaderValue); } // CFHTTPMessage オブジェクトの入力ストリームを作成します。 #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" CFReadStreamRef readStream = CFReadStreamCreateForHTTPRequest(kCFAllocatorDefault, cfrequest); #pragma clang diagnostic pop self.inputStream = (__bridge_transfer NSInputStream *) readStream; // サーバーネームインディケーション (SNI) のホスト情報を設定します。これは重要なステップです。 NSString *host = [_curRequest.allHTTPHeaderFields objectForKey:@"host"]; if (!host) { host = _curRequest.URL.host; } [_inputStream setProperty:NSStreamSocketSecurityLevelNegotiatedSSL forKey:NSStreamSocketSecurityLevelKey]; NSDictionary *sslProperties = [[NSDictionary alloc] initWithObjectsAndKeys: host, (__bridge id) kCFStreamSSLPeerName, nil]; [_inputStream setProperty:sslProperties forKey:(__bridge_transfer NSString *) kCFStreamPropertySSLSettings]; [_inputStream setDelegate:self]; if (!_curRunLoop) { // 現在のスレッドのランループを保存します。これはリダイレクトされたリクエストにとって重要です。 self.curRunLoop = [NSRunLoop currentRunLoop]; } // 現在のランループでストリームをスケジュールします。 [_inputStream scheduleInRunLoop:_curRunLoop forMode:NSRunLoopCommonModes]; [_inputStream open]; CFRelease(cfrequest); CFRelease(requestURL); cfrequest = NULL; CFRelease(bodyData); CFRelease(requestBody); CFRelease(requestMethod); } - (NSData*)dataWithInputStream:(NSInputStream*)stream { NSMutableData *data = [NSMutableData data]; [stream open]; NSInteger result; uint8_t buffer[1024]; while ((result = [stream read:buffer maxLength:1024]) != 0) { if (result > 0) { // buffer には処理するデータの result バイトが含まれています [data appendBytes:buffer length:result]; } else if (result < 0) { // ストリームでエラーが発生しました。[iStream streamError] を使用して NSError オブジェクトを取得できます data = nil; break; } } [stream close]; return data; } #pragma mark - NSStreamDelegate /** * ストリームイベントを処理します。 */ - (void)stream:(NSStream *)aStream handleEvent:(NSStreamEvent)eventCode { if (eventCode == NSStreamEventHasBytesAvailable) { CFReadStreamRef readStream = (__bridge_retained CFReadStreamRef) aStream; #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" CFHTTPMessageRef message = (CFHTTPMessageRef) CFReadStreamCopyProperty(readStream, kCFStreamPropertyHTTPResponseHeader); #pragma clang diagnostic pop if (CFHTTPMessageIsHeaderComplete(message)) { NSInputStream *inputstream = (NSInputStream *) aStream; NSNumber *alreadyAdded = objc_getAssociatedObject(aStream, (__bridge const void *)(kAnchorAlreadyAdded)); NSDictionary *headDict = (__bridge NSDictionary *) (CFHTTPMessageCopyAllHeaderFields(message)); if (!alreadyAdded || ![alreadyAdded boolValue]) { objc_setAssociatedObject(aStream, (__bridge const void *)(kAnchorAlreadyAdded), [NSNumber numberWithBool:YES], OBJC_ASSOCIATION_COPY); // レスポンスが受信されたことをクライアントに通知します。この通知は一度だけ送信されます。 CFStringRef httpVersion = CFHTTPMessageCopyVersion(message); // レスポンスヘッダーからステータスコードを取得します。 CFIndex statusCode = CFHTTPMessageGetResponseStatusCode(message); if (!self.responseIsHandle) { NSHTTPURLResponse *response = [[NSHTTPURLResponse alloc] initWithURL:_curRequest.URL statusCode:statusCode HTTPVersion:(__bridge NSString *) httpVersion headerFields:headDict]; [self.client URLProtocol:self didReceiveResponse:response cacheStoragePolicy:NSURLCacheStorageNotAllowed]; self.responseIsHandle = YES; } // 証明書を検証します。 SecTrustRef trust = (__bridge SecTrustRef) [aStream propertyForKey:(__bridge NSString *) kCFStreamPropertySSLPeerTrust]; SecTrustResultType res = kSecTrustResultInvalid; NSMutableArray *policies = [NSMutableArray array]; NSString *domain = [[_curRequest allHTTPHeaderFields] valueForKey:@"host"]; if (domain) { [policies addObject:(__bridge_transfer id) SecPolicyCreateSSL(true, (__bridge CFStringRef) domain)]; } else { [policies addObject:(__bridge_transfer id) SecPolicyCreateBasicX509()]; } // 検証ポリシーをサーバー証明書にバインドします。 SecTrustSetPolicies(trust, (__bridge CFArrayRef) policies); if (SecTrustEvaluate(trust, &res) != errSecSuccess) { [self closeStream:aStream]; [self.client URLProtocol:self didFailWithError:[[NSError alloc] initWithDomain:@"サーバーの信頼性を評価できません" code:-1 userInfo:nil]]; return; } if (res != kSecTrustResultProceed && res != kSecTrustResultUnspecified) { // 証明書の検証に失敗した場合は、入力ストリームを閉じます。 [self closeStream:aStream]; [self.client URLProtocol:self didFailWithError:[[NSError alloc] initWithDomain:@"サーバーの信頼性評価に失敗" code:-1 userInfo:nil]]; } else { // 証明書が検証されました。 if (statusCode >= 300 && statusCode < 400) { // リダイレクトエラーコードを処理します。 [self closeStream:aStream]; [self handleRedirect:message]; } else { NSError *error = nil; NSData *data = [self readDataFromInputStream:inputstream headerDict:headDict stream:aStream error:&error]; if (error) { [self.client URLProtocol:self didFailWithError:error]; } else { [self.client URLProtocol:self didLoadData:data]; } } } } else { NSError *error = nil; NSData *data = [self readDataFromInputStream:inputstream headerDict:headDict stream:aStream error:&error]; if (error) { [self.client URLProtocol:self didFailWithError:error]; } else { [self.client URLProtocol:self didLoadData:data]; } } CFRelease((CFReadStreamRef)inputstream); CFRelease(message); } } else if (eventCode == NSStreamEventErrorOccurred) { [self closeStream:aStream]; inflateEnd(&_gzipStream); // エラーが発生したことをクライアントに通知します。 [self.client URLProtocol:self didFailWithError: [[NSError alloc] initWithDomain:@"NSStreamEventErrorOccurred" code:-1 userInfo:nil]]; } else if (eventCode == NSStreamEventEndEncountered) { CFReadStreamRef readStream = (__bridge_retained CFReadStreamRef) aStream; #pragma clang diagnostic push #pragma clang diagnostic ignored "-Wdeprecated-declarations" CFHTTPMessageRef message = (CFHTTPMessageRef) CFReadStreamCopyProperty(readStream, kCFStreamPropertyHTTPResponseHeader); #pragma clang diagnostic pop if (CFHTTPMessageIsHeaderComplete(message)) { NSNumber *alreadyAdded = objc_getAssociatedObject(aStream, (__bridge const void *)(kAnchorAlreadyAdded)); NSDictionary *headDict = (__bridge NSDictionary *) (CFHTTPMessageCopyAllHeaderFields(message)); if (!alreadyAdded || ![alreadyAdded boolValue]) { objc_setAssociatedObject(aStream, (__bridge const void *)(kAnchorAlreadyAdded), [NSNumber numberWithBool:YES], OBJC_ASSOCIATION_COPY); // レスポンスが受信されたことをクライアントに通知します。この通知は一度だけ送信されます。 if (!self.responseIsHandle) { CFStringRef httpVersion = CFHTTPMessageCopyVersion(message); // レスポンスヘッダーからステータスコードを取得します。 CFIndex statusCode = CFHTTPMessageGetResponseStatusCode(message); NSHTTPURLResponse *response = [[NSHTTPURLResponse alloc] initWithURL:_curRequest.URL statusCode:statusCode HTTPVersion:(__bridge NSString *) httpVersion headerFields:headDict]; [self.client URLProtocol:self didReceiveResponse:response cacheStoragePolicy:NSURLCacheStorageNotAllowed]; self.responseIsHandle = YES; } } } [self closeStream:_inputStream]; inflateEnd(&_gzipStream); [self.client URLProtocolDidFinishLoading:self]; } } - (NSData *)readDataFromInputStream:(NSInputStream *)inputStream headerDict:(NSDictionary *)headDict stream:(NSStream *)aStream error:(NSError **)error { // レスポンスヘッダーが不完全な場合。 UInt8 buffer[16 * 1024]; NSInteger length = [inputStream read:buffer maxLength:sizeof(buffer)]; if (length < 0) { *error = [[NSError alloc] initWithDomain:@"inputstreamの長さが無効です" code:-2 userInfo:nil]; [aStream removeFromRunLoop:_curRunLoop forMode:NSRunLoopCommonModes]; [aStream setDelegate:nil]; [aStream close]; return nil; } NSData *data = [[NSData alloc] initWithBytes:buffer length:length]; if (headDict[@"Content-Encoding"] && [headDict[@"Content-Encoding"] containsString:@"gzip"]) { data = [self gzipUncompress:data]; if (!data) { *error = [[NSError alloc] initWithDomain:@"データを読み取れません" code:-3 userInfo:nil]; return nil; } } return data; } - (void)closeStream:(NSStream*)stream { [stream removeFromRunLoop:_curRunLoop forMode:NSRunLoopCommonModes]; [stream setDelegate:nil]; [stream close]; } - (void)handleRedirect:(CFHTTPMessageRef)messageRef { // レスポンスヘッダー。 CFDictionaryRef headerFieldsRef = CFHTTPMessageCopyAllHeaderFields(messageRef); NSDictionary *headDict = (__bridge_transfer NSDictionary *)headerFieldsRef; [self redirect:headDict]; } - (void)redirect:(NSDictionary *)headDict { // リダイレクトに Cookie が必要な場合は、それらを処理します。 NSString *location = headDict[@"Location"]; if (!location) location = headDict[@"location"]; NSURL *url = [[NSURL alloc] initWithString:location]; _curRequest.URL = url; if ([[_curRequest.HTTPMethod lowercaseString] isEqualToString:@"post"]) { // RFC に従い、リダイレクトされた POST リクエストは GET リクエストに変換する必要があります。 _curRequest.HTTPMethod = @"GET"; _curRequest.HTTPBody = nil; } [self startRequest]; } - (NSData *)gzipUncompress:(NSData *)gzippedData { if ([gzippedData length] == 0) { return gzippedData; } unsigned full_length = (unsigned) [gzippedData length]; unsigned half_length = (unsigned) [gzippedData length] / 2; NSMutableData *decompressed = [NSMutableData dataWithLength:full_length + half_length]; BOOL done = NO; int status; _gzipStream.next_in = (Bytef *)[gzippedData bytes]; _gzipStream.avail_in = (uInt)[gzippedData length]; _gzipStream.total_out = 0; while (_gzipStream.avail_in != 0 && !done) { if (_gzipStream.total_out >= [decompressed length]) { [decompressed increaseLengthBy:half_length]; } _gzipStream.next_out = (Bytef *)[decompressed mutableBytes] + _gzipStream.total_out; _gzipStream.avail_out = (uInt)([decompressed length] - _gzipStream.total_out); status = inflate(&_gzipStream, Z_SYNC_FLUSH); if (status == Z_STREAM_END) { done = YES; } else if (status == Z_BUF_ERROR) { // Z_BUF_ERROR の原因が出力バッファーの不足である場合、入力バッファーは完全には処理されず、出力バッファーは満杯になります。この場合、ループを継続してバッファーを拡張する必要があります。 // 一方、Z_BUF_ERROR の原因が出力バッファーの不足でない場合は、エラーを示しているためループを終了する必要があります。 if (_gzipStream.avail_in == 0 || _gzipStream.avail_out != 0) { return nil; } } else if (status != Z_OK) { return nil; } } [decompressed setLength:_gzipStream.total_out]; return [NSData dataWithData:decompressed]; } @endカスタムの BeforeSend の実装
- (void)setupHttpDNS:(NSString *)accountId { // HTTPDNS を設定します。 HttpDnsService *httpdns = [[HttpDnsService alloc] initWithAccountID:accountId]; [httpdns setHTTPSRequestEnabled:YES]; [httpdns setPersistentCacheIPEnabled:YES]; [httpdns setReuseExpiredIPEnabled:YES]; [httpdns setIPv6Enabled:YES]; NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration]; NSMutableArray *protocolsArray = [NSMutableArray arrayWithArray:configuration.protocolClasses]; // 前のステップで定義したカスタムの NSURLProtocol を設定します。 [protocolsArray insertObject:[HttpDnsNSURLProtocolImpl class] atIndex:0]; [configuration setProtocolClasses:protocolsArray]; NSURLSession *session = [NSURLSession sessionWithConfiguration:configuration delegate:nil delegateQueue:nil]; [SLSURLSession setURLSession:session]; [SLSURLSession setBeforeSend:^NSMutableURLRequest * _Nonnull(NSMutableURLRequest * _Nonnull request) { NSURL *url = request.URL; // ここに条件を追加して、このロジックを特定の URL にのみ適用することができます。 HttpdnsResult *result = [httpdns resolveHostSync:url.host byIpType:HttpdnsQueryIPTypeAuto]; if (!result) { return request; } NSString *ipAddress = nil; if (result.hasIpv4Address) { ipAddress = result.firstIpv4Address; } else if(result.hasIpv6Address) { ipAddress = result.firstIpv6Address; } else { return request; } NSString *requestUrl = url.absoluteString; requestUrl = [requestUrl stringByReplacingOccurrencesOfString: url.host withString:ipAddress]; [request setURL:[NSURL URLWithString:requestUrl]]; [request setValue:url.host forHTTPHeaderField:@"host"]; return request; }]; }SLS SDK の初期化の完了
@implementation AliyunSLS - (void)initSLS { // SLS SDK にカスタム HTTPDNS を設定します。 // 注: // この設定はすべての SLS SDK インスタンスに適用されます。 [self setupHttpDNS:accountId]; [self initProducer]; } - (void)initProducer { // 通常どおり LogProducerConfig と LogProducerClient を初期化します。 // ... } @end