一. 簡介
一個數學表達式計算器,能實現和 UIWebView 的 stringByEvaluatingJavaScriptFromString: 一樣的計算效果,但效率要高很多,可以在子線程中執行;
基本全面覆蓋 NSExpression 的 expressionForFunction:arguments 中的所有function,使用要比 NSExpression 簡單很多,只需將注意力放大expression表達式的編輯上,將任意復雜度的表達式,通過eval:方法傳入便可輕松得到計算結果;
支持復雜加減乘除四則運算,與或非邏輯運算,和大于小于等比較運算;
支持三目運算;
表達式中能自動識別處理的函數,基本全部覆蓋NSExpression,有的未實現的,因為可以自己有數學表達式表達,比如 a+b,這個表達式計算最基本功能,無需通過函數調用來實現;
以上所述的計算類型在符合數學表達式邏輯的前提下,可以組合在一個表達式中,函數支持嵌套調用;
支持字符串相加(字符串拼接);
開發者可以擴展自己的函數,通過構建 DFEvaluatorFunction 對象來聲明自定義的函數,詳細使用方式可以參考 demo。
二. 使用方式
-
引入頭文件
#import <DFEvalKit/DFEvaluator.h>
DFEvaluator.h 文件中只聲明了4個方法:
- -(id)eval:(NSString *)expression // 用于傳入表達式進行計算并返回計算結果
- -(void)setCustomFunctions:(NSDictionary *)customFunctions // 用于給開發者注冊自定義方法
- -(void)setDateFormatter:(NSDateFormatter *)dateFormatter // 設置支持的日期格式,默認只支持 yyyy-MM-dd HH:mm:ss 格式
- -(void)withoutFunctionTransfer:(BOOL)withoutFunction; // 不支持函數調用,僅用于計算純數學表達式,默認為支持函數調用
- -(id)eval:(NSString *)expression // 用于傳入表達式進行計算并返回計算結果
開發者僅需通過這4個 API 來使用表達式計算全部功能
// DFEvaluator.h
@interface DFEvaluator : NSObject
#pragma mark - API
/**
* 表達式計算
*
* @param expression 需要計算的表達式
*
* @return 計算結果
*/
- (id)eval:(NSString *)expression;
/**
* 設置開發者自定義的函數集
*
* @param customFunctions 每個函數用 DFEvaluatorFunction 對象來描述,以函數名為 key
*
*/
- (void)setCustomFunctions:(NSDictionary *)customFunctions;
/**
* 設置支持的日期格式,默認只支持 yyyy-MM-dd HH:mm:ss 格式
*
* @param dateFormat 日期格式
*/
- (void)setDateFormat:(NSString *)dateFormat;
/**
* 不支持函數調用,僅用于計算純數學表達式,默認為支持函數調用
*/
- (void)withoutFunctionTransfer:(BOOL)withoutFunction;
@end
-
具體使用方式
-
支持的數學運算操作符和操作數類型
typedef NS_ENUM(NSInteger, DFEvaluatorNodeType) { /** * 未知 0 */ Unknown, /** * + 加 */ Plus, /** * - 減 */ Subtract, /** * * 乘 */ MultiPly, /** * / 除 */ Divide, /** * ( 左括號 */ LParentheses, /** * ) 右括號 */ RParentheses, /** * % 求模,取余 */ Mod, /** * ^ 冪運算 */ Power, /** * << 左移位 */ LShift, /** * >> 右移位 */ RShift, /** * & 按位與 */ BitwiseAnd, /** * | 按位或 */ BitwiseOr, /** * && 邏輯與 */ And, /** * || 邏輯或 */ Or, /** * ! 邏輯非 */ Not, /** * == 比較等 */ Equal, /** * != 或 <> 比較不等 */ Unequal, /** * > 比較大于 */ GT, /** * < 比較小于 */ LT, /** * >= 比較大于等于 */ GTOrEqual, /** * <= 比較小于等于 */ LTOrEqual, /** * 數值 */ Numeric, /** * 字符串 */ String, /** * 日期時間 */ Datetime };
-
使用示例
// 簡單四則運算 [DFEvaluator eval:@"22 + 33 * 66 + 3^5"]; // 3^5 3的5次方 // 簡單比較運算 [DFEvaluator eval:@"5 < 6"]; // 邏輯運算 [DFEvaluator eval:@"5 < 3 || 6 > 5)"]; // 位運算 [DFEvaluator eval:@"4 << 5"]; // 字符串相加 [DFEvaluator eval:@"\"Hello\" + \" \" + \"World\" << 5"];
-
包含函數的運算
-
支持的函數清單
// 邏輯運算類 ternaryOperation(5<7, \"真\", \"假\") // 三目表達式 日期類處理方法, 日期字符串格式要求為:yyyy-MM-dd或者yyyy-MM-dd HH:mm:ss dateDiff(差值類型, 較早日期, 較晚日期) // 時間差值 getYear(date) // 獲取日期中的年份 getQuarter(date) // 獲取日期中的第幾季度 getLocalQuarter(date) // 獲取日期中的中文第幾季度 getMonth(date) // 獲取日期中的月份 getLocalMonth(date) // 獲取日期中的中文月份 getWeek(date) // 獲取日期中的第幾周 getLocalWeek(date) // 獲取日期中的中文第幾周 getDayOfWeek(date) // 獲取日期中的星期幾 getLocalDayOfWeek(date) // 獲取日期中的中文星期幾 getDay(date) // 獲取日子 getLocalDay // 獲取中文日子 now() // 獲取現在時間 // 數值類 getLocalMoney(digit) // 將數值轉換為大寫金額 round(digit) // 數值四舍五入 ceil(digit) // 數值0舍1入 trunc(digit) // 向下取整 floor(digit) // 向下取整 abs(digit) // 求絕對值 sqrt(digit) // 開平方 log(digit) // 底數為e對數 ln(digit) // 底數為e對數 log10(digit) // 底數為10對數 log2(digit) // 底數為2對數 raiseToPower(x, n) // 計算 x 的 n 次方 exp(digit) // 求e的x次方 bitwiseXor(a, b) // a 異或 b onesComplement(a) // a 的補碼 average(digit, digit, ...) // 求平均 sum(digit, digit, ...) // 求和 count(digit, digit, ...) // 計數 min(digit, digit, ...) // 找最小值 max(digit, digit, ...) // 找最大值 median(digit, digit, ...) // 找中值 mode(digit, digit, ...) // 一數組或數據區域中出現頻率最多的數值 stddev(digit, digit, ...) // 樣本標準偏差 random(void) // 獲取隨機數小數 randomn(digit) // 獲取隨機數整數 // 字符串類 contains("待檢字符串", "被包含字符串") // 檢查包含子字符串 unContains("待檢字符串", "不被包含字符串") // 檢查不包含子字符串 lowercase("字符串") // 轉小寫 uppercase("字符串") // 轉大寫
-
調用方式
// 三目運算函數 [DFEvaluator eval:@"ternaryOperation(5<7, \"真\", \"假\")"]; // 獲取大寫金額 [DFEvaluator eval:@"getLocalMoney(10086)"]; // 復雜混合運算表達式 [DFEvaluator eval:@"dateDiff(\"dd\", \"2016-12-17\", now()) * 10 - getYear(now()) + max(11, 22,33,1000) * sqrt(floor(1000.445))"];
-
-
-
自定義函數的使用,以 demo 為例:
第一步:自定義方法的OC實現
demo 中在 ViewController.m 實現了如下四個方法,可以看到返回時,均構建了 DFEvaluatorFunctionResult 類實例來返回,這是必須的;方法中傳入的 param 會根據表達式中調用函數時括號內傳入的參數情況解析成字符串,一維數組,或者二維數組,具體規則看如下代碼段的注釋。
#pragma mark - 自定義函數測試 /* * 不帶參函數 * 在表達式中寫入 test1() * * @return 創建 DFEvaluatorResult 實例,返回函數運行結果 */ - (DFEvaluatorFunctionResult *)test1 { return [[DFEvaluatorFunctionResult alloc] initWithResult:@"測試不帶參函數" dataType:DFEvaluatorFunctionResultDataTypeString] ; } /* * 帶一個加單參數的函數 * * @param param 如在表達式中寫:test2(123) 則此處 param 為: @"123" * * @return 創建 DFEvaluatorFunctionResult 實例,返回函數運行結果 */ - (DFEvaluatorFunctionResult *)test2:(id)param { return [[DFEvaluatorFunctionResult alloc] initWithResult:[NSString stringWithFormat:@"測試帶參函數,傳入參數為:%@", param] dataType:DFEvaluatorFunctionResultDataTypeString]; } /* * 一維多參函數,將所有參數拼接成一個字符串 * 如表達式中寫:test3(123, 456, 789...) 數量根據自己的需要來定 * * @param param 此處得到 param 為一維數組 @[@"123", @"456", @"789"...] * * @return 創建 DFEvaluatorFunctionResult 實例,返回函數運行結果 */ - (DFEvaluatorFunctionResult *)test3:(id)param { // 將所有參數拼接成一個字符串 NSMutableString *result = [NSMutableString string]; for(NSString *str in param) { [result appendString:str]; } return [[DFEvaluatorFunctionResult alloc] initWithResult:result dataType:DFEvaluatorFunctionResultDataTypeString]; } /* * 二維多參函數,函數功能為將所有參數拼接為字符串 * 如表達式中寫:test3(123, [456, 789], @"333", [234]...) 數量根據自己的需要來定 * * @param param 此處得到 param 為二維數組 @[@"123", @[@"456", @"789"], @"333", @[@"234"]...] * * @return 創建 DFEvaluatorFunctionResult 實例,返回函數運行結果 */ - (DFEvaluatorFunctionResult *)test4:(id)param { NSMutableString *result = [NSMutableString string]; for(id obj in param) { if([obj isKindOfClass:[NSArray class]]) { for(NSString *str in (NSArray *)obj) { [result appendString:str]; } } else { [result appendString:obj]; } } return [[DFEvaluatorFunctionResult alloc] initWithResult:result dataType:DFEvaluatorFunctionResultDataTypeString]; }
第二步:構建 DFEvaluatorFunction 實例
如下代碼將上述四個 test 方法分別構建一個 DFEvaluatorFunction 實例來進行描述,并以用于表達式調用的函數名為 key 存入字典,準備注入表達式解析計算器中。- (NSDictionary *)customFunctions { if(!_customFunctions) { _customFunctions = [NSMutableDictionary dictionary]; // test1 無參函數 DFEvaluatorFunction *function = [[DFEvaluatorFunction alloc] initWithFunctionName:@"test1" selector:@selector(test1) target:self]; [_customFunctions setObject:function forKey:function.functionName]; // test2 帶一個參數的函數 function = [[DFEvaluatorFunction alloc] initWithFunctionName:@"test2" selector:@selector(test2:) target:self]; [_customFunctions setObject:function forKey:function.functionName]; // test3 帶多個一維參數的函數 function = [[DFEvaluatorFunction alloc] initWithFunctionName:@"test3" selector:@selector(test3:) target:self]; [_customFunctions setObject:function forKey:function.functionName]; // test4 帶多個二維參數的函數 function = [[DFEvaluatorFunction alloc] initWithFunctionName:@"test4" selector:@selector(test4:) target:self]; [_customFunctions setObject:function forKey:function.functionName]; } return _customFunctions; }
第三步:將構建好的 DFEvaluatorFunction 實例注入表達式解析計算器
代碼如下,即在 demo 中點擊 “計算” 按鈕時執行的代碼/* * 創建表達式計算器對象 */ - (DFEvaluator *)evaluator { if(!_evaluator) { _evaluator = [[DFEvaluator alloc] init]; [_evaluator setCustomFunctions:self.customFunctions]; // 注入自定義函數集 // 默認就是這個格式 // [_evaluator setDateFormat:@"yyyy-MM-dd HH:mm:ss"]; // 默認就是 false,即表達式支持函數調用,當表達式不需要函數調用是,調用該方法置為 true,可以調高運算效率 // [_evaluator withoutFunctionTransfer:false]; } return _evaluator; }
最后上圖看看運行效果
感興趣請下載demo研究,運行后,點擊快速測試,快速一睹 DFEvaluator 的風采吧!
意見建議請聯系:
QQ: 247159603
**博客:猿視界