簡介
描述
BaseJsonViewController是一個用OC編寫的提供了搜索、插入、編輯、查看路徑、復(fù)制json/value等功能的Json可視化編輯工具。
由于網(wǎng)絡(luò)數(shù)據(jù)請求下來后，
APP端對json原數(shù)據(jù)的展示并不明朗。 修改網(wǎng)絡(luò)數(shù)據(jù)只能通過Charles等抓包工具實現(xiàn)，受到的限制太多，所以誕生了在APP端直接對json進行查看、修改的Json視圖工具:BaseJsonViewController。后續(xù)會對
BaseJsonViewController進行持續(xù)的更新優(yōu)化，歡迎使用。
主要功能
json結(jié)構(gòu)展示：
- 一鍵壓縮/展開 ： 點擊
??all展開全部，點擊??…壓縮全部（需要注意的是，如果進行了壓縮，處在插入狀態(tài)的cell，將被刪除）。 - 添加了層級的背景色、縮進等。默認最大展示6個層級，如果超過6個層級則跳轉(zhuǎn)到新的頁面，進行展示。
- 對類型的區(qū)分：分為
DictionaryArrayStringNumber。 - 支持展開與收起功能，如果有子節(jié)點，則單擊可以展開\收起。
- value的展示：一行cell 的 value默認最多展示兩行。如果超過兩行則壓縮，并在底部展示。
搜索功能：
點擊放大鏡可以進入搜索頁面
在源碼中的位置：BaseJsonViewController->BaseJsonViewMainView->BaseJsonHeaderView->BaseJsonViewSearchView
搜索關(guān)鍵詞：輸入關(guān)鍵詞，并且會自動進行搜索。
精準搜索：如果選中精準搜索，搜索策略將從
containsString變成isEqualToString。注意：不管是否為精準搜索，都區(qū)分大小寫。
- 搜索Editing：如果選中【搜Editing】按鈕，則會搜索整個
json中處在Editing狀態(tài)并符合關(guān)鍵詞搜索的數(shù)據(jù)。注意：如果有處在
插入狀態(tài)的數(shù)據(jù)，這時候會自動被刪除。
上一個\下一個：當(dāng)搜索完成后，點擊【上一個】、【下一個】自動跳轉(zhuǎn)到相應(yīng)的行。
查看總覽：跳轉(zhuǎn)到一個搜索結(jié)果總覽控制器，顯示了搜索結(jié)果的路徑及`value
展示路徑/搜索數(shù)量：當(dāng)沒有搜索條件(即：沒有
搜索詞、且搜Editing處于非選中狀態(tài))時，顯示的是本控制器節(jié)點的路徑。否則顯示的是搜索結(jié)果數(shù)量。展示路徑/報錯信息：具有滾動、放大功能，最大放大倍數(shù)為1倍
當(dāng)搜索條件報錯時，展示的是紅色的報錯信息。
當(dāng)有搜索內(nèi)容時，展示的是當(dāng)前選中的搜索結(jié)果的節(jié)點路徑，
刪除功能
側(cè)滑cell，出現(xiàn)刪除功能(注意，因為側(cè)滑功能比較多，所以在iphone5上面會導(dǎo)致刪除功能被遮擋)
復(fù)制功能
復(fù)制功能分為兩種：
- 如果側(cè)滑
cell對應(yīng)的節(jié)點為Array或Dictionary則會只能復(fù)制json - 如果側(cè)滑
cell對應(yīng)的節(jié)點為String或Number則可以復(fù)制json與value
編輯功能
側(cè)滑cell，并點擊編輯按鈕開啟編輯功能(下面把被編輯的節(jié)點稱為Model,把Model的父節(jié)點稱為SuperModel)。
SuperModel類型對Model的key的影響：
SuperModel點為Array類型：Model的key必須為空。
SuperModel為Dictionary類型：Model的key必須有值。點擊取消按鈕：取消所有修改。
點擊完成按鈕：
選中
Number按鈕，轉(zhuǎn)成Numbser類型，輸入的值必須為數(shù)字，否則會報錯，并在報錯位置進行顯示。選中
String按鈕，轉(zhuǎn)成String類型，會有個默認值，默認值為""。選中
json按鈕：
- 如果
Model為Array類型，則會把jons解析出來作為Model的子節(jié)點數(shù)據(jù)- 如果
Model為Dictionary類型，則會直接解析Json，如果json內(nèi)包含一個對象則該對象作Model的數(shù)據(jù)，把對象的Key作為Model的key。選中
Dictionary按鈕：
- 如果
Model為Dictionary類型，則不會產(chǎn)生任何效果，否則Model清空子節(jié)點數(shù)據(jù)，并把Model轉(zhuǎn)成Dictionary類型。選中
Array按鈕：如果
Model為Array類型，則不會產(chǎn)生任何效果，否則Model清空子節(jié)點數(shù)據(jù)，并把Model轉(zhuǎn)成Array類型。
插入功能
側(cè)滑cell，并點擊插入按鈕開啟編輯功能
注意：如果在插入的節(jié)點沒有點擊完成的情況下，對節(jié)點的父節(jié)點執(zhí)行收起操作,會自動刪除剛剛插入的節(jié)點
注意：如果插入節(jié)點的父節(jié)點為Dictionary類型,插入的節(jié)點在父節(jié)點中的順序不固定
把被編輯的節(jié)點稱為
Model。把
Model的父節(jié)點稱為SuperModel。把
Model插入的子節(jié)點稱為SubModel。把
SuperModel插入的子節(jié)點稱為SuperSubModel)。
- 如果
Model為Dictionary則可以【插入子節(jié)點】或【插入父節(jié)點】。
- 【插入子節(jié)點】：
- 如果
Model為關(guān)閉狀態(tài)，則自動展開Model，并在Model字節(jié)點的第一行插入一個新的節(jié)點SubModel，這時候，SubModel處于被編輯狀態(tài)。- 注意：此時插入的
SubModel在父節(jié)點Model無序- 【插入父節(jié)點】：在
Model的后面插入為SuperSubModel插入SuperSubModel- 如果
Model為Array類型，則可以【插入子節(jié)點】或【插入父節(jié)點】。
- 【插入子節(jié)點】：
- 如果
Model為展開狀態(tài)，則自動壓縮Model，并在Model字節(jié)點的第一行插入一個新的節(jié)點SubModel，這時候，SubModel處于被編輯狀態(tài)。- 注意：此時插入的
SubModel在父節(jié)點Model有序。- 【插入父節(jié)點】：在
Model的后面插入為SuperSubModel插入SuperSubModel- 如果
Model為String或Number類型，則可以【插入父節(jié)點】。在Model的后面插入為SuperSubModel插入SuperSubModel
實現(xiàn)思路
- 對
json的解析- 為了避免造成不必要的開銷，對
json解析的時機做了調(diào)整：- 當(dāng)節(jié)點
A被打開時候，才會解析A的子節(jié)點數(shù)據(jù)。 - 在解析節(jié)點
A數(shù)據(jù)時，優(yōu)先獲取緩存的A子節(jié)點數(shù)據(jù)。 - 在對
A進行編輯或插入時，對A的的子節(jié)點數(shù)據(jù)進行更新。
- 當(dāng)節(jié)點
- 為了避免造成不必要的開銷，對
- 對視圖的展示
- 對與無限層級縮放的視圖來說，我們有必要把數(shù)據(jù)展平。
- 數(shù)據(jù)中創(chuàng)建一個用于標記層級的變量。來做一個無限縮放層級的假象。
實現(xiàn)細節(jié)
對于節(jié)點Model的定義
Model就代表了一個節(jié)點，所以Model的結(jié)構(gòu)至關(guān)重要。
主要的屬性：
- level：所處層級,在進行初始化時，根據(jù)父節(jié)點的
level進行賦值。
@property (nonatomic,assign) NSInteger level;
- count：字節(jié)點的個數(shù)
@property (nonatomic,assign) NSInteger count;
- isOpen是否為打開狀態(tài)
@property (nonatomic,assign) BOOL isOpen;
- originData：所有子節(jié)點的原始數(shù)據(jù)(可能為nil、Array、Dictionary、Number、String)
@property (nonatomic,strong) id originData;
- key：如果originData為字典，則key就是originData的key，否則為nil
@property (nonatomic,strong) NSString *key;
- data： originData 轉(zhuǎn)化成的數(shù)據(jù)(可能為：nil、NSString、 NSArray<BaseJsonViewStepModel>、BaseJsonViewStepModel)
@property (nonatomic,strong) id data;
- originData：父節(jié)點( 在父節(jié)點創(chuàng)建子節(jié)點時，進行的賦值)
@property (nonatomic,weak) BaseJsonViewStepModel *superPoint;
- type：當(dāng)前節(jié)點的類型
typedef enum : NSUInteger {
BaseJsonViewStepModelType_Dictionary,
BaseJsonViewStepModelType_Array,
BaseJsonViewStepModelType_Number,
BaseJsonViewStepModelType_String,
} BaseJsonViewStepModelType;
@property (nonatomic,assign) BaseJsonViewStepModelType type;
- 所處的狀態(tài)
typedef enum : NSUInteger {
BaseJsonViewStepCellStatus_Normal,
BaseJsonViewStepCellStatus_EditingSelf,
BaseJsonViewStepCellStatus_InsertItem,
} BaseJsonViewStepCellStatus;
@property (nonatomic,assign) BaseJsonViewStepCellStatus status;
對model的創(chuàng)建
+ (BaseJsonViewStepModel *) createStepModelWithOriginData: (id) data andKey: (NSString *)key
/**
創(chuàng)建 一個model
@param data 原始的子節(jié)點數(shù)據(jù)
@param key 創(chuàng)建出的model對應(yīng)的key
@return model
*/
+ (BaseJsonViewStepModel *) createStepModelWithOriginData: (id) data andKey: (NSString *)key{
BaseJsonViewStepModel *model = [BaseJsonViewStepModel new];
model.originData = data;
model.key = key;
return model;
}
+ (BaseJsonViewStepModel *(^)(id)) createWithID
類方法，返回一個
block，block傳入的是id類型的數(shù)據(jù)。數(shù)據(jù)可以是
BaseJsonViewStepModel: 直接返回這個data。不再創(chuàng)建NSString：先轉(zhuǎn)成字典，然后創(chuàng)建model使用方法
BaseJsonViewStepModel.createWithId(data);
+ (BaseJsonViewStepModel *(^)(id)) createWithID {
return ^(id data) {
BaseJsonViewStepModel *model;
if ([data isKindOfClass:BaseJsonViewStepModel.class]) {
model = data;
}
if ([data isKindOfClass:NSString.class]) {
NSDictionary *dic = BaseJsonViewManager.convertToDicWithJson(data);
if (dic) {
model = BaseJsonViewManager.convertToStepModelWithDic(dic);
}
}
if (!model) {
model = [BaseJsonViewStepModel createStepModelWithOriginData:data andKey:@""];
}
return model;
};
}
搜索功能
搜索功能將會搜索出 所有的符合條件的model，并返回一個數(shù)組
isSearchEditing的篩選策略
- isSearchEditing：如果為true。
- 如果
key為nil，則搜索全部處在編輯狀態(tài)的model。- 如果
key有值
- 如果
isAccurateSearch為true：搜索所有key或valueisEqualToStringkey的正在編輯狀態(tài)的model- 如果
isAccurateSearch為true：搜索所有key或valuecontainsStringkey的正在編輯狀態(tài)的model
/**
搜索
@param key 搜索 關(guān)鍵字
@param isAccurateSearch 是否為精準搜索（如果選中精準搜索，搜索策略將從`containsString` 變成 `isEqualToString`。不管是否為精準搜索，都區(qū)分大小寫）
@param isSearchEditing 是否搜索正在編輯狀態(tài)的model
@return 搜索結(jié)果
*/
- (NSMutableArray <BaseJsonViewStepModel *>*) searchWithKey:(NSString *)key andIsAccurateSearch: (BOOL) isAccurateSearch andIsSearchEditing:(BOOL) isSearchEditing {
SBaseJsonViewStepSearchModelConfig config;
config.isSearchEditing = isSearchEditing;
config.isAccurateSearch = isAccurateSearch;
config.key = key;
config.model = self;
return BaseJsonViewStepSearchModel.getResultWithSearchConfig(config);
}
刪除功能
從父節(jié)點移除本節(jié)點
這個功能主要是找到originData中相同的元素，進行刪除。
- (void) removeFromeSuper {
if ([self.superPoint.originData isKindOfClass:NSArray.class]) {
NSArray *array = self.superPoint.originData;
NSMutableArray *arrayM = [[NSMutableArray alloc]initWithArray:array];
[arrayM removeObject:self.originData];
self.superPoint.originData = arrayM;
}
if ([self.superPoint.originData isKindOfClass:NSDictionary.class]) {
NSDictionary *dic = self.superPoint.originData;
NSMutableDictionary *dicM = [[NSMutableDictionary alloc]initWithDictionary:dic];
NSString *key = self.key;
if (key.length > 0) {
dicM[self.key] = nil;
}
self.superPoint.originData = dicM;
}
[self.superPoint reloadDataWitOriginDataProperty];
}
插入節(jié)點
根據(jù)原始數(shù)據(jù)插入節(jié)點，并返回BaseJsonViewStepErrorModel。
BaseJsonViewStepErrorModel 記錄了插入時的錯誤信息
/**
插入一個節(jié)點
@param key 節(jié)點的key
@param originData 節(jié)點的原始子節(jié)點y數(shù)據(jù)
@param index 插入的位置
@return 插入報錯的model
*/
- (BaseJsonViewStepErrorModel *) insertWithKey: (NSString *)key
andOriginData: (id) originData
andIndex:(NSInteger) index;
根據(jù)model插入節(jié)點，并返回BaseJsonViewStepErrorModel。
BaseJsonViewStepErrorModel 記錄了插入時的錯誤信息
/**
插入一個Model
@param model 準備插入的 節(jié)點 model
@param index 插入的位置
@return 錯誤信息
*/
- (BaseJsonViewStepErrorModel *) insertWithModel: (BaseJsonViewStepModel *) model
andIndex:(NSInteger) index;
最后
彩蛋：點擊title會復(fù)制當(dāng)前Controller展示的json數(shù)據(jù)呦~
工具剛剛成型，很多需要修改的地方，希望大家勇于提bug 謝謝~
