Add NSSecureCoding support for quick implementation macro MJSecureCodingImplementation(class, isSupport). (#821)

Author: wolfcon

MJExtension/NSObject+MJCoding.h

@@ -50,6 +50,17 @@ return self; \
 - (void)encodeWithCoder:(NSCoder *)encoder \
 { \
 [self mj_encode:encoder]; \
-}
+}\
+
+#define MJExtensionCodingImplementation MJCodingImplementation
+
+#define MJSecureCodingImplementation(CLASS, FLAG) \
+@interface CLASS (MJSecureCoding) <NSSecureCoding> \
+@end \
+@implementation CLASS (MJSecureCoding) \
+MJCodingImplementation \
++ (BOOL)supportsSecureCoding { \
+return FLAG; \
+} \
+@end \
 
-#define MJExtensionCodingImplementation MJCodingImplementation

MJExtension/NSObject+MJCoding.m

@@ -43,7 +43,8 @@ - (void)mj_decode:(NSCoder *)decoder
         if (allowedCodingPropertyNames.count && ![allowedCodingPropertyNames containsObject:property.name]) return;
         if ([ignoredCodingPropertyNames containsObject:property.name]) return;
 
-        id value = [decoder decodeObjectForKey:property.name];
+        // fixed `-[NSKeyedUnarchiver validateAllowedClass:forKey:] allowed unarchiving safe plist type ''NSNumber'(This will be disallowed in the future.)` warning.
+        id value = [decoder decodeObjectOfClasses:[NSSet setWithObjects:NSNumber.class, property.type.typeClass, nil] forKey:property.name];
         if (value == nil) { // 兼容以前的MJExtension版本
             value = [decoder decodeObjectForKey:[@"_" stringByAppendingString:property.name]];
         }

MJExtensionTests/MJExtensionTests.m

@@ -19,6 +19,7 @@
 #import <CoreData/CoreData.h>
 #import "MJFrenchUser.h"
 #import "MJCat.h"
+#import <MJExtensionTests-Swift.h>
 
 @interface MJExtensionTests : XCTestCase
 
@@ -440,13 +441,20 @@ - (void)testCoding {
     MJBag *bag = [[MJBag alloc] init];
     bag.name = @"Red bag";
     bag.price = 200.8;
+    bag.isBig = YES;
+    bag.weight = 200;
 
     NSString *file = [NSTemporaryDirectory() stringByAppendingPathComponent:@"bag.data"];
-    // 归档
-    [NSKeyedArchiver archiveRootObject:bag toFile:file];
 
+    NSError *error = nil;
+    // 归档
+    NSData *data = [NSKeyedArchiver archivedDataWithRootObject:bag requiringSecureCoding:YES error:&error];
+    [data writeToFile:file atomically:true];
+
     // 解档
-    MJBag *decodedBag = [NSKeyedUnarchiver unarchiveObjectWithFile:file];
+    NSData *readData = [NSFileManager.defaultManager contentsAtPath:file];
+    error = nil;
+    MJBag *decodedBag = [NSKeyedUnarchiver unarchivedObjectOfClass:MJBag.class fromData:readData error:&error];
     MJExtensionLog(@"name=%@, price=%f", decodedBag.name, decodedBag.price);
 }
 

MJExtensionTests/Model/MJBag.h

@@ -11,4 +11,6 @@
 @interface MJBag : NSObject
 @property (copy, nonatomic) NSString *name;
 @property (assign, nonatomic) double price;
+@property (nonatomic) BOOL isBig;
+@property (nonatomic) NSInteger weight;
 @end

MJExtensionTests/Model/MJBag.m

@@ -10,9 +10,10 @@
 
 @import MJExtension;
 
+// NSSecureCoding实现
+MJSecureCodingImplementation(MJBag, YES)
+
 @implementation MJBag
-// NSCoding实现
-MJExtensionCodingImplementation
 
 //+ (NSArray *)mj_ignoredCodingPropertyNames
 //{

README.md

@@ -29,8 +29,6 @@ MJExtension
 #### ‼️ `@objc` or `objcMembers` attributes should be added to class or property for declaration of Objc accessibility [在 Swift4 之后, 请在属性前加 `@objc` 修饰或在类前增加 `objcMembers`. 以保证 Swift 的属性能够暴露给 Objc 使用. ]‼️
 #### ‼️ Use `NSNumber` instead of `Bool`, which is not bridged to `BOOL`. [请勿使用 `Bool` 类型, 因为在 Swift 中并没有桥接该类型, 不能显式的对应 `BOOL`, 请使用 `NSNumber` 替代] ‼️
 
-
-
 ## Contents
 
 * [Getting Started 【开始使用】](#Getting_Started)
@@ -47,6 +45,7 @@ MJExtension
 	* [Model array -> JSON array](#Model_array_JSON_array)
 	* [Core Data](#Core_Data)
 	* [Coding](#Coding)
+	* [Secure Coding](#SecureCoding)
 	* [Camel -> underline](#Camel_underline)
 	* [NSString -> NSDate, nil -> @""](#NSString_NSDate)
 	* [NSDate -> NSString](#NSDate_NSString)
@@ -65,7 +64,7 @@ MJExtension
 * `JSONString` --> `Model Array`、`Core Data Model Array`
 * `Model Array`、`Core Data Model Array` --> `JSON Array`
 * Coding all properties of a model with only one line of code.
-    * 只需要一行代码，就能实现模型的所有属性进行Coding（归档和解档）
+    * 只需要一行代码，就能实现模型的所有属性进行Coding / SecureCoding（归档和解档）
 
 ## <a id="Installation"></a> Installation【安装】
 
@@ -467,40 +466,83 @@ User *user = [User mj_objectWithKeyValues:dict context:context];
 [context save:nil];
 ```
 
-### <a id="Coding"></a> Coding
+### <a id="Coding"></a> Coding (Archive & Unarchive methods are deprecated in iOS 12)
 
 ```objc
 #import "MJExtension.h"
 
-@implementation Bag
+@implementation MJBag
 // NSCoding Implementation
-MJExtensionCodingImplementation
+MJCodingImplementation
 @end
 
 /***********************************************/
 
 // what properties not to be coded
-[Bag mj_setupIgnoredCodingPropertyNames:^NSArray *{
+[MJBag mj_setupIgnoredCodingPropertyNames:^NSArray *{
     return @[@"name"];
 }];
-// Equals: Bag.m implements +mj_ignoredCodingPropertyNames method.
+// Equals: MJBag.m implements +mj_ignoredCodingPropertyNames method.
 
 // Create model
-Bag *bag = [[Bag alloc] init];
+MJBag *bag = [[MJBag alloc] init];
 bag.name = @"Red bag";
 bag.price = 200.8;
 
 NSString *file = [NSHomeDirectory() stringByAppendingPathComponent:@"Desktop/bag.data"];
-// Encoding
+// Encoding by archiving
 [NSKeyedArchiver archiveRootObject:bag toFile:file];
 
-// Decoding
-Bag *decodedBag = [NSKeyedUnarchiver unarchiveObjectWithFile:file];
+// Decoding by unarchiving
+MJBag *decodedBag = [NSKeyedUnarchiver unarchiveObjectWithFile:file];
 NSLog(@"name=%@, price=%f", decodedBag.name, decodedBag.price);
 // name=(null), price=200.800000
 ```
 
+### <a id="SecureCoding"></a> Secure Coding
+
+Using `MJSecureCodingImplementation(class, isSupport)` macro.
+
+```objc
+@import MJExtension;
+
+// NSSecureCoding Implementation
+MJSecureCodingImplementation(MJBag, YES)
+
+@implementation MJBag
+@end
+
+ /***********************************************/
+
+// what properties not to be coded
+[MJBag mj_setupIgnoredCodingPropertyNames:^NSArray *{
+    return @[@"name"];
+}];
+// Equals: MJBag.m implements +mj_ignoredCodingPropertyNames method.
+
+// Create model
+MJBag *bag = [[MJBag alloc] init];
+bag.name = @"Red bag";
+bag.price = 200.8;
+bag.isBig = YES;
+bag.weight = 200;
+
+NSString *file = [NSTemporaryDirectory() stringByAppendingPathComponent:@"bag.data"];
+
+NSError *error = nil;
+// Encoding by archiving
+NSData *data = [NSKeyedArchiver archivedDataWithRootObject:bag requiringSecureCoding:YES error:&error];
+[data writeToFile:file atomically:true];
+
+// Decoding by unarchiving
+NSData *readData = [NSFileManager.defaultManager contentsAtPath:file];
+error = nil;
+MJBag *decodedBag = [NSKeyedUnarchiver unarchivedObjectOfClass:MJBag.class fromData:readData error:&error];
+MJExtensionLog(@"name=%@, price=%f", decodedBag.name, decodedBag.price);
+```
+
 ### <a id="Camel_underline"></a> Camel -> underline【统一转换属性名（比如驼峰转下划线）】
+
 ```objc
 // Dog
 #import "MJExtension.h"