UMCrashConfigure.h
3.75 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
//
// UMCrashConfigure.h
// UMCrash
//
// Created by wangkai on 2020/9/3.
// Copyright © 2020 wangkai. All rights reserved.
//
#import <Foundation/Foundation.h>
typedef NSString *_Nullable(^CallbackBlock)(void);
FOUNDATION_EXPORT NSString * _Nonnull const UMReportExceptionNameForCSharp;
@class UMAPMConfig;
@interface UMCrashConfigure : NSObject
//获取sdk版本号
+ (NSString *_Nonnull)getVersion;
//return字符串不能大于256字节，大于部分将被截取
+ (void)setCrashCBBlock:(CallbackBlock _Nullable )cbBlock;
/**
* 设置自定义版本号和build版本号即子版本号 (需要在初始化appkey方法之前调用)
*/
+ (void)setAppVersion:( NSString * __nonnull )appVersion buildVersion:(NSString* __nullable)buildVersion;
/**
* 设置APM的各个模块的开启/关闭配置(需要在初始化appkey方法之前调用)
*/
+(void)setAPMConfig:(UMAPMConfig*_Nonnull)config;
/**
* @brief 设置APM的网络模块针对iOS13及以下系统的单独开关，以避免在同时集成NSURLProtocol和APM的网络模块的本身冲突引起崩溃。
* 如果需要调用，在初始化UAPM网络模块前调用。
*
* @param enable 指定开关。YES：(捕获iOS13及以下特定网络请求，默认开启)。NO:不捕获iOS13及以下特定网络请求。
*
* @note 问题原因：同时集成NSURLProtocol和APM的网络模块的场景，先初始化APM的网络模块，再初始化NSURLProtocol的registerClass，会导致崩溃在iOS13及以下版本会崩溃，目前可以确定为iOS系统API引起的问题，iOS14无此问题。（先初始化NSURLProtocol的registerClass，再初始化APM的网络模块，是不会出现问题的）
* 兼容iOS13及以下的初始化代码如下：
* @example:
* //确保NSURLProtocol的初始化在UMAPM的上面
* [NSURLProtocol registerClass:[UMURLProtocol class]];
* UMAPMConfig* config = [UMAPMConfig defaultConfig];
* config.networkEnable = YES;
* [UMCrashConfigure setAPMConfig:config];
* [UMConfigure initWithAppkey:UMAPPKEY channel:@"App Store"];
*
* @note
* 此开关默认打开，在同时集成NSURLProtocol和APM的网络模块的场景时候，根据需要调用，如果按照上述初始化顺序，不需要调用。
*
* @note 此函数关闭生效后，不会完全关闭网络模块，只是针对特定网络请求不再捕获，如果开发者能知道同时集成NSURLProtocol和APM的网络模块的场景的时候，最好通过调整初始化顺利来兼容所有场景，并在iOS13及以下版本测试兼容性。
* @note:其他场景下，不需要调用此函数。
*/
+(void)enableNetworkForProtocol:(BOOL)enable;
/**
* 上报自定义错误
* 用户可以用SDK预定义的字符串UMReportExceptionNameForCSharp来传递csharp类型的自定义异常
* @name 名称 长度限制256字节以内，超过截断。
* @reason 错误原因 长度限制256字节以内，超过截断。
* @stackTrace 堆栈 长度限制100*1024字节以内，超过截断。
*
* @example:
* // 日志类型唯一标识
NSString* name = @"csharp";
NSString* reason = @"csharp exception";
NSArray* stackTrace = [NSArray arrayWithObjects:
@"msg: Exception: Exception, Attempted to divide by zero.",
@"UnityDemo+ExceptionProbe.NormalException () (at <unknown>:0)",
@"UnityDemo.TrigException (System.Int32 selGridInt) (at <unknown>:0)",
@"UnityDemo.OnGUI () (at <unknown>:0)",
nil];
*
*[UMCrashConfigure reportExceptionWithName:name reason:reason stackTrace:stackTrace];
*
*
*/
+(void)reportExceptionWithName:(NSString* _Nonnull)name
reason:(NSString* _Nonnull)reason
stackTrace:(NSArray* _Nonnull)stackTrace;
@end