iOS项目的封装过程

前言

�接手外包项目，发现问题颇多，�下面是对整个项目封装过程的记录！

当前项目存在的问题

1: 接口前缀太多，切换环境不方便
2: 通用方法没有进行封装 -> 支付方法哪里用到写哪里
3: 扩展性和容错率太低！许多数组取值是直接根据数组下标来取的
4: 宏定义乱用 -> 用户数据没有进行封装,直接用宏来写

封装过程

1.对接口的处理

为什么不合理

之前的项目接口前缀是直接写在pch文件中，每次切换环境需要来回注释，十分的不方便。
而且pch文件本身是预编译环境，不做改动的代码才是这里的最佳选择，如果网络环境需要经常切换，存放在这里就不是很合理！

解决方案

网络环境一般为本地测试、预发布环境、正式环境。
我们可以使用三个pilst文件来对其进行封装。切换一次网络环境，只需要切换对应的plist文件即可。

注意：plist文件存在安全问题，如果是为了安全期间，可以将plist文件更改为类或者json数据！

好处

1.切换环境十分方便快捷，额其实这一条就够了，下面是方便切换网络环境的好处
2.在扩展方面十分方便，想想你的测试微信支付账号和微信正式支付账号的切换
3.方便后台和测试MM测试，想想你正在忙着撸代码呢？测试MM一会让你切换正式网络环境，一会让你切换本地环境。每次都需要重新打包，是不是很烦躁，不要怕，在APP的某一处，偷偷的用上一个点击方法，可以让她自由切换哦！

切换网络环境.jpg

图文介绍

1.创建plist文件

plist文件.png

.
2.根据场景调用对应的plist文件

- (void)setAppType:(XBApp_Type)type{
    NSString *path = nil;
    switch (type) {
        case XBApp_Type_Local:
            path =  [[NSBundle mainBundle] pathForResource:@"LocalNetworkProtocol" ofType:@"plist"];
            break;
        case XBApp_Type_Debug:
            path =  [[NSBundle mainBundle] pathForResource:@"DebugNetworkProtocol" ofType:@"plist"];
            break;
        case XBApp_Type_Release:
            path =  [[NSBundle mainBundle] pathForResource:@"ReleaseNetworkProtocol" ofType:@"plist"];
            break;
        default:  NSLog(@"-------- 警告!未选择打包模式 --------------");
            break;
    }
    _customMadeDic = [NSDictionary dictionaryWithContentsOfFile:path] ;
}

2.对通用方法的处理

对常用的方法做一些分类，比如判断字符串是否为空，判断字符串是否为电话号码，判断字符串是否为url等等....这些分类可以让你快速的开发。

3.尽量不要采取数组下标进行取值

在项目中，经常要截取一些url的参数，不要采用下标取值，正确姿势是写一个url的解析分类，获取url中对应的参数

警告：这是一个错误姿势

    NSString * string = @"https://112.112.112.112/apinew/customPage?groupId=6&sign=a7522acd73eeef8cd6f8c5c04c1b17f2&timeline=201702171414&appStartToken=&version=1.5.5";
    NSArray * ary = [string componentsSeparatedByString:@"&"];
if ([string rangeOfString:@"shop_checks"].location != NSNotFound) {
        NSString * specValue = [[ary[4] componentsSeparatedByString:@"="] lastObject];
        NSString * num = [[ary[3] componentsSeparatedByString:@"="] lastObject];
        NSString * skuProductId = [[ary[2] componentsSeparatedByString:@"="] lastObject];
        NSString * productId = [[ary[1] componentsSeparatedByString:@"="] lastObject];
}

正确的解锁姿势，写一个分类取出URL中的参数

// 将URL中得参数转化成字典
+ (NSDictionary*)getURLParameter:(NSString*)urlString{
    if (urlString.length == 0) {
        return  nil;
    }
    NSMutableDictionary *dict =[NSMutableDictionary dictionary];
    NSArray *urlArray = [urlString componentsSeparatedByString:@"?"];
    
    if (urlArray.count > 1) {   //如果大于1，认为有参数
        NSString *URLParString = [urlArray lastObject];
        
        if ([URLParString rangeOfString:@"&"].location != NSNotFound) { //多个参数
            NSArray *dictArray = [URLParString componentsSeparatedByString:@"&"];
            for (NSString *KVString in dictArray) {
                NSArray *KVArray = [KVString componentsSeparatedByString:@"="];
                for (int i = 0; i < KVArray.count; i++) {
                    if (i == KVArray.count - 1) {
                        [dict setValue:KVArray[i] forKey:KVArray[i - 1]];
                    }
                }
            }
        }else if ([URLParString rangeOfString:@"="].location != NSNotFound){ //单个参数
            NSArray *dictArray = [URLParString componentsSeparatedByString:@"="];
            for (int i = 0; i < dictArray.count; i++) {
                if (i == dictArray.count - 1) {
                    [dict setValue:dictArray[i] forKey:dictArray[i - 1]];
                }
            }
        }
    }
    
    return dict;
}

这只是其中一个例子，在项目中尽量不要采用数组下标取值这种操作。这种操作相对系统来说是危险的。
弊端有两方面：
1.容易造成系统崩溃
2.不容易对功能进行扩展

4.宏定义的使用

使用宏的话，尽量先对代码进行封装，�再使用宏来简化代码。避免别人接手一脸懵逼的情况

警告：下面为错误示范

#define kUserId [[NSUserDefaults standardUserDefaults] objectForKey:@"userId"]
#define kuserName [[NSUserDefaults standardUserDefaults] objectForKey:@"userName"]
#define KuserLoginState [[NSUserDefaults standardUserDefaults] boolForKey:@"isLogined"]
#define kInitEntryId [[NSUserDefaults standardUserDefaults] objectForKey:@"initEntryId"]
#define kToken [[NSUserDefaults standardUserDefaults] objectForKey:@"kToken"]

这些是用户信息，完全可以使用一个模型先封装起来，后期想用宏处理的时候再用宏进行处理
正确的解锁姿势,先创建一个储存类，然后再创建一个用户类，加密可以选择SSKeychainss:

1.创建储存类

.h文件
#import 
#import "XBUserdefaultDefine.h"
#import 

@interface XBUserDefault : NSObject
+ (id)sharedWXUserDefault;

- (NSInteger)integerValueForKey:(NSString*)key;
- (BOOL)boolValueForKey:(NSString*)key;
- (NSString*)textValueForKey:(NSString*)key;
- (NSDictionary*)dicValueForKey:(NSString*)key;
- (CGFloat)floatValueForKey:(NSString*)key;
- (void)setInteger:(NSInteger)value forKey:(NSString*)key;
- (void)setBool:(BOOL)value forKey:(NSString*)key;
- (void)setFloat:(float)value forkey:(NSString*)key;
- (void)setObject:(id)object forKey:(NSString*)key;

- (void)removeObjectForKey:(NSString*)key;
- (NSArray*)allKeys;
- (BOOL)hasKey:(NSString*)key;
@end

.m文件
#import "XBUserDefault.h"

@implementation XBUserDefault
+ (id)sharedWXUserDefault{
    static dispatch_once_t predicate;
    static XBUserDefault *sharedUserDefault = nil;
    dispatch_once(&predicate, ^{
        sharedUserDefault = [[XBUserDefault alloc] init];
    });
    return sharedUserDefault;
}

- (NSInteger)integerValueForKey:(NSString*)key{
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    return [userDefaults integerForKey:key];
}
- (BOOL)boolValueForKey:(NSString*)key{
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    return [userDefaults boolForKey:key];
}
- (NSString*)textValueForKey:(NSString*)key{
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    return [userDefaults stringForKey:key];
}
- (NSDictionary*)dicValueForKey:(NSString*)key{
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    return [userDefaults dictionaryForKey:key];
}
- (CGFloat)floatValueForKey:(NSString*)key{
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    return [userDefaults floatForKey:key];
}
- (void)setInteger:(NSInteger)value forKey:(NSString*)key{
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    [userDefaults setInteger:value forKey:key];
    [userDefaults synchronize];
}
- (void)setBool:(BOOL)value forKey:(NSString*)key{
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    [userDefaults setBool:value forKey:key];
    [userDefaults synchronize];
}
- (void)setFloat:(float)value forkey:(NSString*)key{
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    [userDefaults setFloat:value forKey:key];
    [userDefaults synchronize];
}
- (void)setObject:(id)object forKey:(NSString*)key{
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    [userDefaults setObject:object forKey:key];
    [userDefaults synchronize];
}
- (void)removeObjectForKey:(NSString*)key{
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    [userDefaults removeObjectForKey:key];
    [userDefaults synchronize];
}
- (NSArray*)allKeys{
    NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
    return [[userDefaults dictionaryRepresentation] allKeys];
}
- (BOOL)hasKey:(NSString*)key{
    NSArray *allKeys = [self allKeys];
    NSInteger index = [allKeys indexOfObject:key];
    return index != NSNotFound;
}
@end

2.创建用户对象

.h文件
#import 
@interface XBUserOBJ : NSObject
+(XBUserOBJ*)sharedUserOBJ;
-(void)setUser:(NSString*)user;    //设置帐号
-(void)setPwd:(NSString*)pwd;      //设置密码
- (void)setUserID:(NSString*)userID;  //用户ID
- (NSString*)user;
- (NSString*)pwd;
- (NSString*)userID;
- (NSString*)token;
-(void)removeAllUserInfo;
@end

.m文件
#import "XBUserOBJ.h"
#import "XBUserDefault.h"
@implementation XBUserOBJ

+(XBUserOBJ*)sharedUserOBJ{
    static dispatch_once_t onceToken;
    static XBUserOBJ *sharedUserOBJ = nil;
    dispatch_once(&onceToken,^{
        sharedUserOBJ = [[XBUserOBJ alloc] init];
    });
    return sharedUserOBJ;
}
-(void)setUser:(NSString *)user{
    XBUserDefault *userDefault = [XBUserDefault sharedWXUserDefault];
    [userDefault setObject:user forKey:XB_Userdefault_User];
}
-(void)setPwd:(NSString *)pwd{
    XBUserDefault *userDefault = [XBUserDefault sharedWXUserDefault];
    [userDefault setObject:pwd forKey:XB_Userdefault_Pwd];
}
- (void)setUserID:(NSString *)userID{
    XBUserDefault *userDefault = [XBUserDefault sharedWXUserDefault];
    [userDefault setObject:userID forKey:XB_Userdefault_UserID];
}
//获取
-(NSString*)user{
    XBUserDefault *userDefault = [XBUserDefault sharedWXUserDefault];
    return [userDefault textValueForKey:XB_Userdefault_User];
}
-(NSString*)pwd{
    XBUserDefault *userDefault = [XBUserDefault sharedWXUserDefault];
    return [userDefault textValueForKey:XB_Userdefault_Pwd];
}
- (NSString*)userID{
    XBUserDefault *userDefault = [XBUserDefault sharedWXUserDefault];
    return [userDefault textValueForKey:XB_Userdefault_UserID];
}
- (void)removeAllUserInfo{
    XBUserDefault *userDefault = [XBUserDefault sharedWXUserDefault];
    [userDefault removeObjectForKey:XB_Userdefault_UserID];
    [userDefault removeObjectForKey:XB_Userdefault_UserToken];
    [userDefault removeObjectForKey:XB_Userdefault_NewUserID];
    [userDefault removeObjectForKey:XB_Userdefault_User];
    [userDefault removeObjectForKey:XB_Userdefault_Pwd];
}

公共文件
#ifndef RKXB_XBUserdefaultDefine_h
#define RKXB_XBUserdefaultDefine_h
#pragma mark  ----  用户信息存储
#define XB_Userdefault_UserID @"XB_Userdefault_UserID"
#define XB_Userdefault_UserToken @"kToken"
#define XB_Userdefault_NewUserID @"XB_Userdefault_NewUserID"
#define XB_Userdefault_NewUserToken @"XB_Userdefault_NewUserToken"
#define XB_Userdefault_User  @"XB_Userdefault_User"
#define XB_Userdefault_Pwd   @"XB_Userdefault_Pwd"
#define XB_UserDefault_Type  @"XB_UserDefault_Type"
#endif

Demo下载地址(网络环境和封装用户信息)：https://github.com/chuheridangwu/ExampleProject