简介

Bmob平台为您的移动应用提供了一个完整的后端解决方案,我们提供轻量级的SDK开发包,让开发者以最小的配置和最简单的方式使用Bmob平台提供的服务,进而完全消除开发者编写服务器代码以及维护服务器的操作。

安装

使用CocoaPods安装BmobSDK

如何使用CocoaPods安装BmobSDK可查看我们提供的文档: https://github.com/bmob/bmob-ios-sdk/blob/master/InstallCocoaPods.md

兼容iOS9

iOS9默认不允许进行http请求,所以在使用SDK的过程中需要往Info.plist添加一些内容,

  1. 完全取消http请求限制
<key>NSAppTransportSecurity</key> 
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
</dict>
  1. 指定部分网址支持http
<key>NSAppTransportSecurity</key> 
<dict>
   <key>NSExceptionDomains</key>
      <dict>     
              <key>yourserver.com</key>    
           <dict>      
                <key>NSIncludesSubdomains</key>
                 <true/>
                <key>NSTemporaryExceptionAllowsInsecureHTTPLoads</key>
                <true/>             
                 <key>NSTemporaryExceptionMinimumTLSVersion</key>       
                 <string>TLSv1.1</string>    
            </dict>   
        </dict>
 </dict>

另外,最新版的sdk已支持bitcode。

其他一些需要注意兼容iOS9的地方可以参照这里:https://github.com/ChenYilong/iOS9AdaptationTips

应用程序

在Bmob平台注册的每个账户都可以创建多个应用程序,每个应用程序都有其独自的应用程序ID,在后续程序编写中,所有的应用程序将凭其ID来使用Bmob SDK。同一个应用可以分别在测试环境和生产环境中部署不同的版本。

应用安全

请大家在使用Bmob开发应用程序之前,认真阅读我们给大家提供的“数据与安全”的文档,确保你的应用在发布时安全。文档的链接地址是:http://docs.bmob.cn/datasafety/index.html?menukey=otherdoc&key=datasafety

对象

数据对象

Bmob存储的数据是建立在BmobObject基础上的,每个BmobObject包含键(Key)-值(value)对的JSON兼容数据。这个数据是无模式的,这意味着不需要提前指定每个BmobObject存在什么键。你只需要设置你想要的键值对让我们在后端存储。

例如,假设你要记录一个游戏的得分。一个单一的BmobObject对象可能包含:score: 1337, playerName: "Sean Plott", cheatMode: false。键必须是字母、数字的字符串。值可以是字符串、数字、布尔值、Json数组、和BmobObject对象等。

每个BmobObject有一个ClassName,它对应后台的表名。例如,我们可以调用的游戏分数对象的ClassName为GameScore,那么它在后台对应的表名就是GameScore。

特殊对象

为了提供更好的服务,BmobSDK中提供了BmobUser、BmobInstallation两个特殊的BmobObject对象来完成不同的功能,在这里我们统一称为特殊对象。
BmobUser对象主要是针对应用中的用户功能而提供的,它对应着web端的User表,使用BmobUser对象可以很方便的在应用中实现用户的注册、登录、邮箱验证等功能,具体的使用方法可查看文档的用户部分。
BmobInstallation对象主要用于应用的安装设备管理中,它对应着web端的Installation表,任何安装了你应用的设备都会在此表中产生一条数据标示该设备。结合Bmob提供的推送功能,还可以实现将自定义的消息推送给不同的设备终端,具体的使用方法可查看文档的消息推送部分。

数据类型

目前为止,我们支持的数据类型有NSString、NSNumber、NSDate、NSArray、NSDictionary以及BmobObject及其子类对象类型。对应后台的类型为String、Number、Date、Array、Object以及Pointer。

创建BmobObject对象

BmobObject提供以下几种方法对BmobOjbect进行初始化:

/**
 *    创建一个带有className的BmobObject对象
 *
 *    @param    className    表示对象名称(类似数据库表名)
 *
 *    @return    BmobObject
 */
+(instancetype )objectWithClassName:(NSString*)className;


/**
 *  创建一个带有className 和objectId的BmobObject对象
 *
 *  @param className 表名
 *  @param objectId  对象的id
 *
 *  @return BmobObject对象
 */
+(instancetype)objectWithoutDatatWithClassName:(NSString*)className objectId:(NSString *)objectId;

/**
 *  从字典创建BmobObject
 *
 *  @param dictionary 字典
 *
 *  @return BmobObject 对象
 */
-(instancetype)initWithDictionary:(NSDictionary *)dictionary;

添加数据

添加一条数据有两步,第一步是构造数据,第二步是保存数据至服务器上,有以下两种方法:

/**
 *    后台保存BmobObject对象,没有返回结果
 */
-(void)saveInBackground;

/**
 *    后台保存BmobObject对象,返回保存的结果
 *
 *    @param    block    返回保存的结果是成功还是失败
 */
-(void)saveInBackgroundWithResultBlock:(BmobBooleanResultBlock)block;

比如,在一个游戏的应用中,当需要保存游戏分数、玩家信息到服务器中的时候,就可以创建GameScore表来添加数据,添加数据的形式类型与iOS中的NSMutableDictionary对象类似,如下:

    //在GameScore创建一条数据,如果当前没GameScore表,则会创建GameScore表
    BmobObject  *gameScore = [BmobObject objectWithClassName:@"GameScore"];
    //score为1200
    [gameScore setObject:[NSNumber numberWithInt:1200] forKey:@"score"];
    //设置userName为小明
    [gameScore setObject:@"小明" forKey:@"playerName"];
    //设置cheatMode为NO
    [gameScore setObject:[NSNumber numberWithBool:NO] forKey:@"cheatMode"];
    //设置age为18
    [gameScore setObject:[NSNumber numberWithInt:18] forKey:@"age"];

    //异步保存到服务器
    [gameScore saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            //创建成功后会返回objectId,updatedAt,createdAt等信息
            //创建对象成功,打印对象值
            NSLog(@"%@",gameScore);
        } else if (error){
            //发生错误后的动作
            NSLog(@"%@",error);
        } else {
            NSLog(@"Unknow error");
        }
    }];

运行完以上代码后,数据即可保存到服务器端了。为了确认数据是否真的已经保存成功,你可以在Bmob服务器端你的应用程序的数据浏览项目中查看。你应该看到类似这样的结果:

    objectId: "0c6db13c", score: 1200, playerName: "小明", cheatMode: false, createdAt:"2012-03-29 10:32:54", updatedAt:"2012-03-29 10:32:54"

这里需要注意几点:

  • 在运行以上代码时,如果服务器端你创建的应用程序中已经存在GameScore数据表和相应的score、playerName、cheatMode等字段,那么你此时添加的数据和数据类型也应该和服务器端的表结构一致,否则将保存数据失败。
  • 如果服务器端不存在GameScore数据表,那么Bmob将根据你第一次(也就是运行的以上代码)保存的GameSocre对象在服务器为你创建此数据表并插入相应数据。
  • 每个BmobObject对象有几个默认的键(数据列)是不需要开发者指定的,objectId是每个保存成功数据的唯一标识符。createAt和updateAt代表每个对象(每条数据)在服务器上创建和最后修改的时间。这些键 (数据列)的创建和数据内容是由服务器端来完成的。
  • [gameScore saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error)中,成功创建后,error返回的是nil,可以通过 error.localizedDescription 查看返回的错误信息,之后的类似于 xxInBackground 中的error也是一样的结构。
  • objectId,updatedAt,createdAt这些系统属性在调用创建函数(saveInBackground)的时候不需要进行设置,创建成功后,会返回objectId,updatedAt,createdAt。

上述方法中每添加一条数据需要设置一次键值对,如果觉得过于繁琐,可以通过一个NSDictionary来添加数据,利用以下方法即可:

    -(void)saveAllWithDictionary:(NSDictionary*)dic;

这个函数。

如:

    BmobObject  *gameScore = [BmobObject objectWithClassName:@"GameScore"];
    //设置playerName列的值为小黑和age列的值18
    NSDictionary *dic = @{@"playerName":@"小黑",@"score":@18};
    [gameScore saveAllWithDictionary:dic];
    //异步保存
    [gameScore saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            //创建成功后的动作
        } else if (error){
            //发生错误后的动作
            NSLog(@"%@",error);
        } else {
            NSLog(@"Unknow error");
        }
    }];

更新数据

更新一个对象也是非常简单的,首先获取到要更新的BmobObject对象,进行修改值后再更新数据。例如:

- (void)updateObject{
    //创建一条数据,并上传至服务器
    BmobObject  *gameScore = [BmobObject objectWithClassName:@"GameScore"];
    [gameScore setObject:[NSNumber numberWithInt:1200] forKey:@"score"];

    //异步保存到服务器
    [gameScore saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            //创建成功后会返回objectId,updatedAt,createdAt等信息
            NSLog(@"创建成功,以下为对象值");
            NSLog(@"%@",gameScore);

            //此处是更新操作
            [gameScore setObject:[NSNumber numberWithInt:110] forKey:@"score"];
            [gameScore updateInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
                if (isSuccessful) {
                    NSLog(@"更新成功,以下为对象值,可以看到score值已经改变");
                    NSLog(@"%@",gameScore);
                } else {
                    NSLog(@"%@",error);
                }
            }];

        } else if (error){
            //发生错误后的动作
            NSLog(@"%@",error);
        } else {
            NSLog(@"Unknow error");
        }
    }];
}

如果列存储的是符合JSON格式的字符串对象,可以单独修改该对象的某个值,如有一列名为userAttibute,其值是: {"name":"John", "gender":"男"},如果要修改name为Mike,可以使用以下代码

- (void)updateObjectJSONField{
    //创建一条数据,并上传至服务器
    BmobObject  *gameScore = [BmobObject objectWithClassName:@"GameScore"];
    NSDictionary *json = @{@"name":@"John", @"gender":@"man"};
    [gameScore setObject:json forKey:@"userAttibute"];

    //异步保存到服务器
    [gameScore saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            //创建成功后会返回objectId,updatedAt,createdAt等信息
            NSLog(@"创建成功,以下为对象值");
            NSLog(@"%@",gameScore);

            //此处是更新操作
            BmobObject *gameScoreChanged = [BmobObject objectWithoutDatatWithClassName:@"GameScore" objectId:gameScore.objectId];
            [gameScoreChanged setObject:@"women" forKey:@"userAttibute.gender"];
            [gameScoreChanged updateInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
                if (isSuccessful) {
                    NSLog(@"更新成功,以下为对象值,可以看到json里面的gender已经改变");
                    NSLog(@"%@",gameScoreChanged);
                } else {
                    NSLog(@"%@",error);
                }
            }];

        } else if (error){
            //发生错误后的动作
            NSLog(@"%@",error);
        } else {
            NSLog(@"Unknow error");
        }
    }];
}

此处要注意一点,就是在上传 gameScore 之后,如果要再次进行更新,请重新构造对象,因为此时的 gameScore 对象还含有userAttibute 的值,下面是错误的代码:

    //创建一条数据,并上传至服务器
    BmobObject  *gameScore = [BmobObject objectWithClassName:@"GameScore"];
    NSDictionary *json = @{@"name":@"John", @"gender":@"man"};
    [gameScore setObject:json forKey:@"userAttibute"];

    //异步保存到服务器
    [gameScore saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            //创建成功后会返回objectId,updatedAt,createdAt等信息
            NSLog(@"创建成功,以下为对象值");
            NSLog(@"%@",gameScore);

            //错误的做法,直接使用gameScore来设置,请观察gameScore值上传时的值
            [gameScore setObject:@"women" forKey:@"userAttibute.gender"];
            NSLog(@"上传前的gameScore对象值\n%@",gameScore);
            [gameScore updateInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
                if (isSuccessful) {
                    NSLog(@"更新成功,以下为对象值,可以看到json里面的gender已经改变");
                    NSLog(@"%@",gameScore);
                } else {
                    NSLog(@"%@",error);
                }
            }];

        } else if (error){
            //发生错误后的动作
            NSLog(@"%@",error);
        } else {
            NSLog(@"Unknow error");
        }
    }];
}

运行后查看log,我们可以看到,除了userAttibute属性外,gameScore对象还有userAttibute.gender属性上传至服务器,这样服务器就无法区分客户端到底是要更新 userAttibuteg还是只更新userAttibute中的gender,从而报错。

2015-12-14 20:45:55.417 BmobSDKDemo[16867:1430005] 创建成功,以下为对象值
2015-12-14 20:45:55.418 BmobSDKDemo[16867:1430005] 
className = GameScore;
objectId = 0f3d45dbc5;
createdAt = 2015-12-14 12:45:55 +0000;
updatedAt = 2015-12-14 12:45:55 +0000;
date = {
    userAttibute =     {
        gender = man;
        name = John;
    };
};
2015-12-14 20:45:55.419 BmobSDKDemo[16867:1430005] 上传前的gameScore对象值

className = GameScore;
objectId = 0f3d45dbc5;
createdAt = 2015-12-14 12:45:55 +0000;
updatedAt = 2015-12-14 12:45:55 +0000;
date = {
    userAttibute =     {
        gender = man;
        name = John;
    };
    "userAttibute.gender" = women;
};

原子计数器

为了存储一个计数器类型的数据,Bmob提供对任何数字字段进行原子增加(或者减少)的功能,所以我们可以让score像下面一样增加一个固定的值:

    //创建一条数据,并上传至服务器
    BmobObject  *gameScore = [BmobObject objectWithClassName:@"GameScore"];
    [gameScore setObject:@0 forKey:@"atomicCounter"];
    [gameScore saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            BmobObject *gameScoreToBeChanged = [BmobObject objectWithoutDatatWithClassName:@"GameScore" objectId:gameScore.objectId];
            [gameScoreToBeChanged incrementKey:@"atomicCounter"];
            [gameScoreToBeChanged updateInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
                if (isSuccessful) {
                    NSLog(@"添加成功,可在后台查看objectID为%@的atomicCounter的值是否为1",gameScoreToBeChanged.objectId);
                } else {
                    NSLog(@"%@",error);
                }
            }];
        } else {
            NSLog(@"%@",error);
        }
    }];

也提供了

//列的值增加amount
- (void)incrementKey:(NSString *)key byAmount:(NSInteger )amount
//列的值减去一
- (void)decrementKey:(NSString *)key
//列的值减去amount
- (void)decrementKey:(NSString *)key byAmount:(NSInteger )amount

注意:需要调用更新函数才能完成计数器原子增加(或者减少)。

删除数据

从服务器删除对象:

    BmobObject *bmobObject = [BmobObject objectWithoutDatatWithClassName:@"GameScore"  objectId:@"baaf9cfa1b"];
    [bmobObject deleteInBackgroundWithBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            //删除成功后的动作
            NSLog(@"successful");
        } else if (error){
            NSLog(@"%@",error);
        } else {
            NSLog(@"UnKnow error");
        }
    }];

批量数据操作

Bmob提供了批量操作的类BmobObjectsBatch,使用该类,可以批量增加,修改,删除数据,但一次请求不能超过50条数据。下面是例子程序:

BmobObjectsBatch    *batch = [[BmobObjectsBatch alloc] init] ;
//在GameScore表中创建一条数据
[batch saveBmobObjectWithClassName:@"GameScore" parameters:@{@"aveScore": @{@"数学":@90},@"score":@78}];
//在GameScore表中更新objectId为27eabbcfec的数据
[batch updateBmobObjectWithClassName:@"GameScore" objectId:@"27eabbcfec" parameters:@{@"score": @85}];
//在GameScore表中删除objectId为30752bb92f的数据
[batch deleteBmobObjectWithClassName:@"GameScore" objectId:@"30752bb92f"];
[batch batchObjectsInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
    NSLog(@"batch error %@",[error description]);
}];

查询

查询单条数据

在某些情况下,如果知道某条数据的objectId,而且想得知该条数据的内容,可以使用BmobQuery检索得到一个完整的BmobObject:

//查找GameScore表
BmobQuery   *bquery = [BmobQuery queryWithClassName:@"GameScore"];
//查找GameScore表里面id为0c6db13c的数据
[bquery getObjectInBackgroundWithId:@"0c6db13c" block:^(BmobObject *object,NSError *error){
  if (error){
          //进行错误处理
  }else{
        //表里有id为0c6db13c的数据
      if (object) {
            //得到playerName和cheatMode
          NSString *playerName = [object objectForKey:@"playerName"];
          BOOL cheatMode = [[object objectForKey:@"cheatMode"] boolValue];
          NSLog(@"%@----%i",playerName,cheatMode);
          //打印objectId,createdAt,updatedAt
          NSLog(@"object.objectId = %@", [object objectId]);
          NSLog(@"object.createdAt = %@", [object createdAt]);
          NSLog(@"object.updatedAt = %@", [object updatedAt]);
      }
  }
}];

查询多条数据

在某些情况下,当需要查询表中多条元素的时候,可以直接使用findObjectsInBackgroundWithBlock函数获取查询结果,默认100条。

BmobQuery   *bquery = [BmobQuery queryWithClassName:@"GameScore"];
//查找GameScore表的数据
[bquery findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        for (BmobObject *obj in array) {
            //打印playerName
            NSLog(@"obj.playerName = %@", [obj objectForKey:@"playerName"]);
            //打印objectId,createdAt,updatedAt
            NSLog(@"obj.objectId = %@", [obj objectId]);
            NSLog(@"obj.createdAt = %@", [obj createdAt]);
            NSLog(@"obj.updatedAt = %@", [obj updatedAt]);
    }
}];

这里需要注意的是:

1.默认情况下,系统实际上并不会返回所有的数据,而是默认返回10条数据记录,你可以通过setLimit方法设置返回的记录数量。更多细节可点击查看分页查询一节。

2.当查询的是用户表这种系统表的时候,返回的是BmobUser的数组,设备表,角色表也是这样的。

3.查询用户表,设备表、角色表为:

BmobQuery   *bquery = [BmobUser query]; //用户表
BmobQuery   *bquery = [BmobInstallation query]; //设备表
BmobQuery   *bquery = [BmobRole query]; //角色表

条件查询

比较查询

当然了,在大多数情况下,开发者还是会通过特定的条件来筛选,过滤某些数据来进行查询。BmobQuery也提供了对应的查询方法。

如果要过滤特定键的值可以使用- (void)whereKey:(NSString *)key notEqualTo:(id)object。比如需要查询playerName不等于”小明”的数据时可以这样写:

当然,你也可以在你的查询操作中添加多个约束条件,来查询符合要求的数据。

BmobQuery   *bquery = [BmobQuery queryWithClassName:@"GameScore"];
//添加playerName不是小明的约束条件
[bquery whereKey:@"playerName" notEqualTo:@"小明"];

各种不同条件的比较查询,还有

各种不同的比较查询:
[bquery whereKey:@"age" lessThan:[NSNumber numberWithInt:18]];//age小于18
[bquery whereKey:@"age" lessThanOrEqualTo:[NSNumber numberWithInt:18]]; //age小于或等18
[bquery whereKey:@"age" greaterThan:[NSNumber numberWithInt:18]]; //age大于18
[bquery whereKey:@"age" greaterThanOrEqualTo:[NSNumber numberWithInt:18]]; //age大于或等于18

这里有点需要注意的是

时间搜索的话,等于的情况因为服务器是精确到微秒值,所以比较的值要加1秒。

子查询

如果你想查询匹配几个不同值的数据,如要查询“小明”,“小红”,“小白”三个人的信息是,可以使用

- (void)whereKey:(NSString *)key containedIn:(NSArray *)array;

函数,如下面所示:

[bquery whereKey:@"playerName" containedIn:[NSArray arrayWithObjects:@"小明",@"小红",@"小白", nil]];

如果是关联关系,直接在数组里面填写objectId即可,如下

 [bquery whereKey:@"author" containedIn:@[@"063a2d739e",@"b97ca382c3"]];

相反,要排除这几个人的信息可以用

- (void)whereKey:(NSString *)key notContainedIn:(NSArray *)array;

函数,如下所示:

[bquery whereKey:@"playerName" notContainedIn:[NSArray arrayWithObjects:@"小明",@"小红",@"小白", nil]];

列值是否存在

其他的约束条件有

//设置查询中该字段是有值的结果
-(void)whereKeyExists:(NSString *)key;
//设置查询中该字段是没有值的结果
-(void)whereKeyDoesNotExist:(NSString *)key;

例如:

//查询表中score列有值的数据
[bquery whereKeyExists:@"score"];
//查询表中score列没有值的数据
[bquery whereKeyDoesNotExist:@"score"];

模糊查询

对字符串值的模糊查询 比如查询包含字符串的值,有几种方法。如下:

//使用正则表达式查询
-(void)whereKey:(NSString*)key matchesWithRegex:(NSString*)regex;
//查询以特定字符串开头的值
-(void)whereKey:(NSString *)key startWithString:(NSString*)start;
//查询以特定字符串结尾的值
-(void)whereKey:(NSString *)key endWithString:(NSString*)end;

分页查询

有时,在数据比较多的情况下,你希望查询出的符合要求的所有数据能按照多少条为一页来显示,这时可以使用limit方法来限制查询结果的数据条数来进行分页。默认情况下,Limit的值为100,最大有效设置值1000(设置的数值超过1000还是视为1000)。

bquery.limit = 3;//限制得到的结果条数为3条

在数据较多的情况下,在limit的基础上分页显示数据是比较合理的解决办法,skip属性可以做到跳过查询的前多少条数据来实现分页查询的功能。默认情况下Skip的值为100。

bquery.skip = 3;//跳过3条数据

排序

对应数据的排序,如数字和字符串,可以使用升序或降序的方式来控制查询数据的结果顺序:

// 升序
- (void)orderByAscending:(NSString *)key ;
// 降序
- (void)orderByDescending:(NSString *)key ;

例如,分数由高到低的排序可以写成

[bquery orderByDescending:@"score"];

当需要组合排序的时候可以这样处理

//先按照年龄升序排序,年龄一样再按照更新时间降序排序
[bquery orderByAscending:@"age"]
[bquery orderByDescending:@"updatedAt"]

复合查询

当简单的查询条件,不能满足查询要时,BmobQuery也提供了2种复合查询的方法。

//并查询
-(void)addTheConstraintByAndOperationWithArray:(NSArray*)array;
//或查询
-(void)addTheConstraintByOrOperationWithArray:(NSArray *)array;

数组里面存的是若干个条件字典,其格式为

@{@"列名":条件值}

例如:

//查询score列中值等于5且姓名为Mike的数据
NSArray *array =  @[@{@"score":@5},@{@"name":@"Mike"}];
[bquery addTheConstraintByAndOperationWithArray:array];

支持的条件符号有

Key Operation
$lt 小于
$lte 小于等于
$gt 大于
$gte 大于等于
$ne 不等于
$in 在数组中
$nin 不在数组中
$exists 值不为空
$or 合成查询中的或查询
$and 合成查询中的与查询
$regex 匹配PCRE表达式

例如:

//查询score列中值大于150或者小于5的数据
NSArray *array =  @[@{@"score":@{@"$gt":@150}},@{@"score":@{@"$lt":@5}}];
[bquery addTheConstraintByOrOperationWithArray:array];
//查询score列中值大于5和小于150的数据
NSArray *array =  @[@{@"score":@{@"$gt":@5}},@{@"score":@{@"$lt":@150}}];
[bquery addTheConstraintByAndOperationWithArray:array];

需要注意的是,如果是要查找条件为等于的数据的话,直接构造成{@"列名":条件}即可,例如下面的例子:

//查找分数为90分跟分数为150分的数据
NSArray *array =  @[@{@"score":@90},@{@"score":@150}];
[bquery addTheConstraintByOrOperationWithArray:array];

//查找名字为张三跟李四的数据
NSArray *array =  @[@{@"name":@"张三"},@{@"name":"李四"}];
[bquery addTheConstraintByOrOperationWithArray:array];

其中日期类型和pointer类型构造的方法比较特殊。
例如要查询要个时间段的数据,可以构造时间

//createdAt大于或等于 2014-07-15 00:00:00
 NSDictionary *condiction1 = @{@"createdAt":@{@"$gte":@{@"__type": @"Date", @"iso": @"2014-07-15 00:00:00"}}}; 
//createdAt小于 2014-10-15 00:00:00
NSDictionary *condiction2 = @{@"createdAt":@{@"$lt":@{@"__type": @"Date", @"iso": @"2014-10-15 00:00:00"}}};
NSArray *condictonArray = @[condiction1,condiction2];
//作用就是查询创建时间在2014年7月15日到2014年10月15日之间的数据
[bquery addTheConstraintByAndOperationWithArray:condictonArray];

如果查询的条件刚好是pointer类型的话,例如要查询某篇文章的作者是A或者B的话,可以这样构造数据:

BmobQuery *query = [BmobQuery queryWithClassName:@"Post"];
//列author为pointer类型,指向用户表
//假设用户A的objectId为aaaa ,其中classname为表名
NSDictionary *condiction1 = @{@"author":@{@"__type":@"Pointer",@"className":@"_User",@"objectId":@"aaaa"}};
//假设用户b的objecId为bbbb
NSDictionary *condiction2= @{@"author":@{@"__type":@"Pointer",@"className":@"_User",@"objectId":@"bbbb"}};
NSArray *condictionArray = @[condiction1,condiction2];
//查找作者为用户A或者作者为用户B的数据
[query addTheConstraintByOrOperationWithArray:condictionArray];
[query findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
}];

另外我们还封装了以下方法,方便开发者使用,以下是与查询,注意add之前的查询只能添加一个条件,如果是或查询,将[main andOperation];换成[main orOperation];

    BmobQuery   *bquery = [BmobQuery queryWithClassName:@"GameScore_LT"];
    [bquery whereKey:@"score" equalTo:[NSNumber numberWithDouble:10.3]];
    BmobQuery   *bquery1 = [BmobQuery queryWithClassName:@"GameScore_LT"];
    [bquery1 whereKey:@"playerName" equalTo:@"test"];

    BmobQuery   *main = [BmobQuery queryWithClassName:@"GameScore_LT"];
    [main add:bquery];
    [main add:bquery1];
    [main andOperation];
    [main findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        for (BmobObject *obj in array) {
            //打印playerName
            NSLog(@"%@",obj);
            NSLog(@"obj.playerName = %@", [obj objectForKey:@"playerName"]);
        }
    }];

返回指定列

有的时候,一张表的数据列比较多,而我们只想查询返回某些列的数据时,我们可以使用以下方法来只返回需要的列的值

//设置查询后返回的字段数组    
-(void)selectKeys:(NSArray*)keys;
//指定返回查询的结果包括score和playerName两列的数据
[bquery selectKeys:@[@"score",@"playerName"]];

查询结果计数

如果你只是想统计满足查询对象的数量,你并不需要获取所有匹配的对象的具体数据信息,可以直接使用count替代find。例如,查询一个特定玩家玩的游戏场数:

BmobQuery *bquery = [BmobQuery queryWithClassName:@"GameScore"];
[bquery whereKey:@"playerName" equalTo:@"Barbie"];
[bquery countObjectsInBackgroundWithBlock:^(int number,NSError  *error){
         NSLog(@"%d",num);
}];

统计查询

如果你想对表进行统计查询,可以采用以下方法。

统计查询方法

统计方法共有以下几种,分别用于计算总和、平均值、最大值、最小值

- (void)sumKeys:(NSArray *)keys
- (void)averageKeys:(NSArray *)keys
- (void)maxKeys:(NSArray *)keys
- (void)minKeys:(NSArray *)keys

设置完成后使用下面的方法来返回结果。

- (void)calcInBackgroundWithBlock:(BmobObjectArrayResultBlock)block

例如,如果我们要计算GameScore表所有玩家的得分总和,可以使用以下代码:

    BmobQuery *bquery = [BmobQuery queryWithClassName:@"GameScore"];
    NSArray *sumArray = [NSArray arrayWithObject:@"score"];
    [bquery sumKeys:sumArray];
    [bquery calcInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        if (error) {
            NSLog(@"error is:%@",error);
        } else{
            if (array) {
                NSLog(@"%@",array);
                NSDictionary *dic = [[NSDictionary alloc] init];
                dic = [array objectAtIndex:0];
                NSLog(@"sum of score:%d",[[dic objectForKey:@"_sumScore"] intValue] );
            }
        }
    }];

计算总和只对Number类型的列有效,列名使用数组存放。返回的字典key值为_sum+首字母大写的列名,其它计算方法与sum类似,其返回的字典key值见下表

关键字 key值 例子
sum _sum+首字母大写 _sumScore
average _avg+首字母大写 _avgScore
max _max+首字母大写 _maxScore
min _min+首字母大写 _minScore

分组统计

分组可用于获取并不复杂的列值,如我想知道playerName列中有多少个不同的玩家名字,可使用以下代码:

    BmobQuery *bquery = [BmobQuery queryWithClassName:@"GameScore_LT"];
    NSArray *groupbyArray = [NSArray arrayWithObject:@"playerName"];
    [bquery groupbyKeys:groupbyArray];
    [bquery calcInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        if (error) {
            NSLog(@"error is:%@",error);
        } else{
            if (array) {
                NSLog(@"%@",array);
                for (NSDictionary *dic in array) {
                    NSString *playerName = [dic objectForKey:@"playerName"];
                    NSLog(@"player:%@",playerName);
                }
            }
        }
    }];

另外,groupby可以结合计算函数来使用,比如我想统计每个玩家的总分,可以使用以下代码:

    BmobQuery *bquery = [BmobQuery queryWithClassName:@"GameScore"];
    NSArray *groupbyArray = [NSArray arrayWithObject:@"playerName"];
    NSArray *sumArray = [NSArray arrayWithObject:@"score"];
    [bquery groupbyKeys:groupbyArray];
    [bquery sumKeys:sumArray];
    [bquery calcInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        if (error) {
            NSLog(@"error is:%@",error);
        } else{
            if (array) {
                NSLog(@"%@",array);
                for (NSDictionary *dic in array) {
                    NSString *playerName = [dic objectForKey:@"playerName"];
                    NSString *sum = [dic objectForKey:@"_sumScore"];
                    NSLog(@"player:%@\tsum:%@",playerName,sum);
                }
            }
        }
    }];
分组记录数

有时候,我们还想知道分组统计时每个分组有多少条记录,设置isGroupcount为YES即可,如下:

    bquery.isGroupcount = YES;

这样在返回的结果中就会包含类似于以下的键值对:

_count = 10

添加过滤条件

利用计算方法返回来的值可以通过限制条件来获取我们想关注的结果。添加条件使用以下方法。

 -(void)constructHavingDic:(NSDictionary *)havingDic

该方法通过构造havingDic来添加限制条件,其使用方法与复杂查询类似。

例如,我们统计每个玩家的总分,但我们只需要得到总分大于50的玩家,可以使用以下代码得到:

    BmobQuery *bquery = [BmobQuery queryWithClassName:@"GameScore"];
    NSArray *groupbyArray = [NSArray arrayWithObject:@"playerName"];
    [bquery groupbyKeys:groupbyArray];
    NSArray *sumArray = [NSArray arrayWithObject:@"score"];
    [bquery sumKeys:sumArray];
    NSDictionary *condication = [[NSDictionary alloc] initWithObjectsAndKeys:[NSNumber numberWithInt:50],@"$gt", nil];
    [bquery constructHavingDic:[[NSDictionary alloc] initWithObjectsAndKeys:condication,@"_sumScore", nil]];
    [bquery calcInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        if (error) {
            NSLog(@"error is:%@",error);
        } else{
            if (array) {
                NSLog(@"%@",array);
                for (NSDictionary *dic in array) {
                    NSString *playerName = [dic objectForKey:@"playerName"];
                    NSString *sum = [dic objectForKey:@"_sumScore"];
                    NSLog(@"player:%@\tsum:%@",playerName,sum);
                }
            }
        }
    }];

缓存查询

缓存查询通常是将查询结果缓存在磁盘上,当用户的设备处于离线状态时,就可以从缓存中获取数据来显示。或者在应用界面刚刚启动,从网络获取数据还未得到结果时,先使用缓存数据来显示。这样可以让用户不必在按下某个按钮后进行枯燥的等待。 默认的查询操作是没有启用缓存的,开发者可以通过设置BmobCachePolicy来启用缓存功能。例如:优先从网络获取数据,如果获取失败时再从缓存获取数据,这种情况通常用在网络不可用的情况下。

bquery.cachePolicy = kBmobCachePolicyNetworkElseCache;
[bquery findObjectsInBackgroundWithBlock:^(NSArray *array,NSError *error){
}];

BmobSDK提供几种不同的缓存策略,以使用不同应用场景的需求。

  • kBmobCachePolicyIgnoreCache

只从网络获取数据,且数据不会缓存在本地,这是默认的缓存策略。

  • kBmobCachePolicyCacheOnly

只从缓存读数据,如果缓存没有数据,返回一个空数组。

  • kBmobCachePolicyNetworkOnly

只从网络获取数据,同时会在本地缓存数据。

  • kBmobCachePolicyCacheElseNetwork

先从缓存读取数据,如果没有再从网络获取。

  • kBmobCachePolicyNetworkElseCache

先从网络获取数据,如果没有,再从缓存读取。

  • kBmobCachePolicyCacheThenNetwork

先从缓存读取数据,无论结果如何都会再次从网络获取数据,在这种情况下,Block将产生两次调用。通常这种做法是先快速从缓存读取数据显示在界面,然后在后台连接网络获取最新数据,取到后再更新界面。

|检查是否存在当前查询条件的缓存数据

[bquery hasCachedResult];

存在返回YES,否则返回NO
|清除当前查询的缓存数据

[bquery clearCachedResult];

|清除所有查询结果的缓存数据

[BmobQuery clearAllCachedResults];

|设置缓存有限时间,单位为秒

bquery.maxCacheAge = 10000;

BQL查询

Bmob Query Language(简称 BQL)是 Bmob 自 BmobSDK V1.5.7 版本开始,为查询 API 定制的一套类似 SQL 查询语法的子集和变种,主要目的是降低大家学习 Bmob 查询 API 的成本,可以使用传统的 SQL 语法来查询 Bmob 应用内的数据。

具体的 BQL 语法,请参考 Bmob Query Language 详细指南

基本BQL查询

可以通过以下方法来进行SQL查询:

例如:需要查询所有的游戏得分记录

    BmobQuery *bmobQuery = [[BmobQuery alloc] init];
    NSString *bql = @"select * from GameScore_BQL";
    [bmobQuery queryInBackgroundWithBQL:bql block:^(BQLQueryResult *result, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            if (result) {
                NSLog(@"%@",result.resultsAry);
            }
        }
    }];

其中result.resultsAry为BmobObject数组。

如果需要查询个数,则可以这样:

    NSString *bql = @"select count(*) from GameScore_BQL";
    BmobQuery *bmobQuery = [[BmobQuery alloc] init];
    [bmobQuery queryInBackgroundWithBQL:bql block:^(BQLQueryResult *result, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            if (result) {
                NSLog(@"%d",result.count);
            }
        }
    }];

其中result.count为记录条数,需要注意的是如果没有使用count关键字进行查询的话,对象result的count属性是没有意义的。

统计BQL查询

由于统计查询的结果是不定的,故BQL提供了另外一种查询方法来进行统计查询,可以使用 - (void)statisticsInBackgroundWithBQL:(NSString *)bql block:(BmobBQLArrayResultBlock)block; 方法来进行。

     NSString *bql = @"select sum(score) from GameScore_BQL group by playerName";
    [bmobQuery statisticsInBackgroundWithBQL:bql block:^(NSArray *result, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            if (result) {
                NSLog(@"%@",result);
            }
        }
    }];

目前统计查询支持的关键字如下表所示,即如果在sql语句中包含以下关键字时,则需要使用统计查询方法才能返回正确结果:

key Operation
group by 分组操作
groupcount 返回每个分组的总记录
having 分组中的过滤条件
sum 计算总和
average 计算平均值
max 计算最大值
min 计算最小值

占位符查询

在更多的时候,一个查询语句中间会有很多的值是可变值,为此,我们也提供了类似 Java JDBC 里的 PreparedStatement 使用占位符查询的语法结构。

注:目前只有where和limit关键字以及内置函数支持使用占位符。

普通查询

    BmobQuery *bmobQuery = [[BmobQuery alloc] init];
    NSString *bql = @"select * from GameScore_BQL where playerName = ? and score = ?";
    NSArray *placeholderArray = @[@"name2",@9];
    [bmobQuery queryInBackgroundWithBQL:bql pvalues:placeholderArray block:^(BQLQueryResult *result, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            if (result) {
                NSLog(@"%@",result.resultsAry);
            }
        }
    }];

数组中的数据会依次替换bql中的问号。

内置函数

对于包含内置函数的占位符查询,比较特殊,请使用Bmob Query Language 详细指南中的内置函数占位符查询用到的内置函数用到的内置函数列出的形式进行查询操作:

举例:我想查询在 '2015-05-14 14:56:30' 后的创建的记录,可以这样:

    BmobQuery *bmobQuery = [[BmobQuery alloc] init];
    NSString *bql = @"select * from GameScore_BQL where createdAt > date(?)";
    NSArray *placeholderArray = @[@"2015-05-14 14:56:30"];
    [bmobQuery queryInBackgroundWithBQL:bql pvalues:placeholderArray block:^(BQLQueryResult *result, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            if (result) {
                NSLog(@"%@",result.resultsAry);
            }
        }
    }];

1、我们更推荐使用占位符语法,理论上会降低 BQL 转换的性能开销;

2、同样的,统计查询也支持占位符,只需要- (void)statisticsInBackgroundWithBQL:(NSString *)bql pvalues:(NSArray*)pvalues block:(BmobBQLArrayResultBlock)block;方法即可。

BQL缓存策略

如果要使用缓存策略,可用 - (void)queryBQLCanCacheInBackgroundWithblock:(BmobBQLObjectResultBlock)block; 方法,样例代码如下:

    NSString *bql = [NSString stringWithFormat:@"select * from %@ where %@ = ?",TABLENAME,COLPLAYERNAME];
    NSArray *placeholder = @[@"name1"];

    BmobQuery *bmobQueryWriteCache = [[BmobQuery alloc] init];
    bmobQueryWriteCache.cachePolicy = kBmobCachePolicyNetworkOnly;
    [bmobQueryWriteCache setBQL:bql];
    [bmobQueryWriteCache setPlaceholder:placeholder];
    [bmobQueryWriteCache queryBQLCanCacheInBackgroundWithblock:^(BQLQueryResult *result, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else if (result){
            NSLog(@"actual:%@",result);
        }
    }];

注意:

  • BQL查询方法中,只有 - (void)queryBQLCanCacheInBackgroundWithblock:(BmobBQLObjectResultBlock)block; 才能使用缓存策略,其它方法即使设置了缓存策略也无缓存效果;
  • 使用- (void)queryBQLCanCacheInBackgroundWithblock:(BmobBQLObjectResultBlock)block;进行查询时,通过 -(void)setBQL:(NSString*)bql;-(void)setPlaceholder:(NSArray*)ary; 来设置BQL语句和占位符。

缓存策略只对普通查询有效,统计查询只支持从网络进行查询。具体使用可参考iOS开发文档中的缓存查询

数组

为了存储数组型数据,Bmob提供了3种操作来原子性地更改一个数组字段:

Add 在一个数组字段的后面添加一些指定的对象(包装在一个数组内)

AddUnique 只会在原本数组字段中没有这些对象的情形下才会添加入数组,插入数组的位置不固定的

Remove 从一个数组字段的值内移除指定的数组中的所有对象

添加数组数据

添加一行记录时创建一个普通的类似于列表的数组类型字段,可以使用以下方法添加:

BmobObject *gameScore = [BmobObject objectWithoutDatatWithClassName:@"GameScore" objectId:@"xxxxxxxx"];
[gameScore addObjectsFromArray:@[@"P1",@"P2"] forKey:@"skill"];
[gameScore updateInBackground];

删除数组数据

当需要移除数组里的数据时可以使用

-(void)removeObjectsInArray:(NSArray *)objects forKey:(NSString *)key;

如下面就移除了P3这个元素:

BmobObject *gameScore = [BmobObject objectWithoutDatatWithClassName:@"GameScore" objectId:@"xxxxxxxx"];
[gameScore removeObjectsInArray:@[@"P3"] forKey:@"skill"];
[gameScore updateInBackground];

更新数组数据

每一种方法都会有一个objects,即包含了这些方法将被添加或删除的对象列表,举个例子,技能skills是一个类似于集合的数组类型,那么我们可以在skills中加入一些对象,只有在skills原来的对象中不包含这些值的情况下才会被加入:

BmobObject *gameScore = [BmobObject objectWithoutDatatWithClassName:@"GameScore" objectId:@"xxxxxxxx"];
[gameScore addUniqueObjectsFromArray:@[@"P3"] forKey:@"skill"];
[gameScore updateInBackground];

查询数组数据

对于Key的类型是数组的情况,可以查找Key的数组值中包含有P1的对象。代码如下:

    //查询数组中包含某个元素的记录
    BmobQuery *query = [BmobQuery queryWithClassName:@"GameScore"];
    [query whereKey:@"skill" equalTo:@"P1"];
    [query findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            for (BmobObject *obj in array) {
                NSLog(@"%@",obj);
            }
        }
    }];

你同样可以使用"$all"操作符来找到类型为数组的Key的值中同时包含有P1和P2的对象:

    //查询数组中包含某些元素的记录
    BmobQuery *query1 = [BmobQuery queryWithClassName:@"GameScore
    "];
    NSArray *array = @[@"P1",@"P2"];
    [query1 whereKey:@"skill" equalTo:@{@"$all":array}];
    [query1 findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            for (BmobObject *obj in array) {
                NSLog(@"%@",obj);
            }
        }
    }];

当然,你也可以使用我们封装好的方法来查找

    //查询数组中包含某些元素的记录
    BmobQuery *query1 = [BmobQuery queryWithClassName:@"GameScore"];
    NSArray *array = @[@"P1",@"P2"];
    [query1 whereKey:@"skill" containsAll:array];
    [query1 findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            for (BmobObject *obj in array) {
                NSLog(@"%@",obj);
            }
        }
    }];

如果要查找包含P1或P2的对象,可以使用复杂查询中的或查

    BmobQuery *query = [BmobQuery queryWithClassName:@"Post"];
    NSArray *array =  @[@{@"skill":@{@"$all": @[@"P1"]}},@{@"skill":@{@"$all":@[@"P2"]}}];
    [query addTheConstraintByOrOperationWithArray:array];
    [query findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            NSLog(@"%d",array.count);
            for (BmobObject *obj in array) {
                 NSLog(@"%@",obj);
            }

        }
    }];

使用索引和对象key修改数组中的对象

比如你当前行有一列叫用户的工作经验projectExperiences,是一个Array数组列,里面包含了多个对象值:[{"name":"项目名称","descr":"项目描述","startTime":"开始时间","endTime":"结束时间"}, ...]

那么我们要修改projectExperiences数组中第一个对象的name值:

BmobObject *gameScore = [BmobObject objectWithoutDatatWithClassName:@"GameScore" objectId:@"xxxxxxxx"];
[bmobObject setObject:@"项目名称2" forKey:@"projectExperiences.0.name"];
[gameScore updateInBackground];

数据关联

数据关联章节Demo下载

关联关系描述

在程序设计中,不同类型的数据之间可能存在某种关系。分别是以下三种:

  1. 一对一,比如车队给司机分车,1个司机对应1台车;
  2. 一对多,比如1个作者会对应多篇贴子;
  3. 多对多,比如1篇帖子会有多个喜欢的读者,而每个读者也会有多篇喜欢的帖子。
    前面的两种关系我们提供Pointer类型来表示,而最后一种关系我们使用Relation类型来表示

在下面的讲解中我们可能会使用到以下的两张表,其表结构如下:

_User

字段 类型 含义
objectId string
username string 用户名,用户可以是作者发帖子,也可以是读者发评论

Post

字段 类型 含义
objectId string
title string 帖子标题
content string 帖子内容
author Pointer(_User) 作者
likes Relation(_User) 喜欢帖子的读者

预先在后台添加记录
_User表

Post表


Pointer的使用

添加关系

例如,user1写了一篇帖子,需要在Post表中添加一条记录,并且该记录包含一个关联author1记录的字段数据,可采用以下代码:

    BmobObject  *post = [BmobObject objectWithClassName:@"Post"];
    //设置帖子的标题和内容
    [post setObject:@"title4" forKey:@"title"];
    [post setObject:@"content4" forKey:@"content"];

    //设置帖子关联的作者记录
    BmobUser *author = [BmobUser objectWithoutDatatWithClassName:@"_User" objectId:@"vbhGAAAY"];
    [post setObject:author forKey:@"author"];

    //异步保存
    [post saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            //创建成功,返回objectId,updatedAt,createdAt等信息
            //打印objectId
            NSLog(@"objectid :%@",post.objectId);
        }else{
            if (error) {
                NSLog(@"%@",error);
            }
        }
    }];

添加成功后在后台的结果如下图所示,我们可以看到,author列的值是用圆框框起来的,表示这是一个Pointer,显示的值,为对应记录的objectId,点击它可以进入_User表中:

我们可以这么理解关联关系,它就是一个类型为指针的字段,利用它可以指向其它表的某条记录。

删除关系

如果需要删除某篇帖子关联的作者可以使用

- (void)deleteForKey:(id)key

具体代码如下:

    BmobQuery   *bquery = [BmobQuery queryWithClassName:@"Post"];
    [bquery getObjectInBackgroundWithId:@"ZqQ7KKKx" block:^(BmobObject *object,NSError *error){
        if (error){
            NSLog(@"%@",error);
        }else{
            if (object) {
                BmobObject *post = object;
                //将author列的值置为空
                [post deleteForKey:@"author"];
                //进行更新
                [post updateInBackground];
            }
        }
    }];

结果如下,可以看到,author列已经被置空

修改关系

如果需要修改某篇帖子关联的作者,可以使用以下代码:

    BmobQuery   *bquery = [BmobQuery queryWithClassName:@"Post"];
    //获得objectId查找出先前添加的文章
    [bquery getObjectInBackgroundWithId:@"ZqQ7KKKx" block:^(BmobObject *object,NSError *error){
        if (error){
            NSLog(@"%@",error);
        }else if (object) {
            BmobObject *post = object;
            //获得BmobUser对象
            BmobUser *user = [BmobUser objectWithoutDatatWithClassName:@"_User" objectId:@"qXZeCCCX"];
            //设置post的author值为新获得的BmobUser对象
            [post setObject:user forKey:@"author"];

            //进行更新
            [post updateInBackground];
        }
    }];

可以看到关联记录已经被修改:

查询关系

查询某个特定作者的帖子,可以用 -(void)whereKey:(NSString *)key equalTo:(id)object,具体代码如下

 //查询帖子表
 BmobQuery *query = [BmobQuery queryWithClassName:@"Post"];
 //构建objectId为vbhGAAAY 的作者
 BmobUser *author = [BmobUser objectWithoutDatatWithClassName:@"_User" objectId:@"vbhGAAAY"];
 //添加作者是objectId为vbhGAAAY条件
 [query whereKey:@"author" equalTo:author];
 [query findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else if (array){
            for (BmobObject *post in array) {
                NSLog(@"%@",[post objectForKey:@"title"]);
            }
        }
    }];

如我们需要查询帖子,并且需要将该帖子关联的作者的信息(objectId,username)打印出来,我们可以使用以下代码:

    BmobQuery *bquery = [BmobQuery queryWithClassName:@"Post"];

    //声明该次查询需要将author关联对象信息一并查询出来
    [bquery includeKey:@"author"];

    [bquery getObjectInBackgroundWithId:@"ZqQ7KKKx" block:^(BmobObject *object, NSError *error) {

        //打印文章标题,内容
        BmobObject *post = object;
        NSLog(@"title:%@",[post objectForKey:@"title"]);
        NSLog(@"content:%@",[post objectForKey:@"content"]);

        //取得文章的关联作者对象
        BmobUser *author = [post objectForKey:@"author"];
        //打印文章的关联作者对象的相关信息
        NSLog(@"objectId:%@",author.objectId);
        NSLog(@"name:%@",[author objectForKey:@"username"]);
    }];

查询关系的核心在于查询前需要将关联的列名include进来,使用下列方法即可

- (void)includeKey:(NSString *)key

如果查询多个关联关系,可以使用以下方法,使用逗号(,)操作来使查询中包含多个属性

[bquery includeKey:@"column1,column2,..."];

如果关联关系存在嵌套,可以使用以下英文字符点号(.)来操作,如下:

[bquery includeKey:@"column1.column2"];

另外,include 时可以指定返回的字段,如下:

//只返回likes列的数据
[bquery includeKey:@"post[likes]"];

//返回title和content列数据
[bquery includeKey:@"post[title|content]"];

约束关联对象值查询

我们可以对关联对象的值进行约束,来进行匹配查询。例如,如果我们想找查询出所有关联了user2的文章,可以使用以下代码

    BmobQuery *bquery = [BmobQuery queryWithClassName:@"Post"];

    //构造约束条件
    BmobQuery *inQuery = [BmobQuery queryWithClassName:@"_User"];
    [inQuery whereKey:@"username" equalTo:@"user2"];

    //匹配查询
    [bquery whereKey:@"author" matchesQuery:inQuery];
    [bquery findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else if (array){
            for (BmobObject *post in array) {
                NSLog(@"%@",[post objectForKey:@"title"]);
            }
        }
    }];

如果想要查询找所有没有关联user1的文章,则将

[bquery whereKey:@"author" matchesQuery:inQuery];

替换成

[bquery whereKey:@"author" doesNotMatchQuery:inQuery];

即可。

Pointer本质

Pointer可以用来表示一对一或者一对多的关系,其实可以看成是我们将一个指向某条记录的指针记录下来,我们查询时可以通过该指针以获得另外关联的对象。当然,我们也可以给这些指针指向的关联记录进行约束,只查询出符合特定条件的记录。

Relation的使用

添加关联关系

如果我们需要在Post表中添加一个字段以记录喜欢该贴子的读者,我们可以使用以下代码:

    //获取要添加关联关系的post
    BmobObject *post = [BmobObject objectWithoutDatatWithClassName:@"Post" objectId:@"ZqQ7KKKx"];

    //新建relation对象
    BmobRelation *relation = [[BmobRelation alloc] init];
    [relation addObject:[BmobObject objectWithoutDatatWithClassName:@"_User" objectId:@"vbhGAAAY"]];
    [relation addObject:[BmobObject objectWithoutDatatWithClassName:@"_User" objectId:@"qXZeCCCX"]];

    //添加关联关系到likes列中
    [post addRelation:relation forKey:@"likes"];
    //异步更新obj的数据
    [post updateInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            NSLog(@"successful");
        }else{
            NSLog(@"error %@",[error description]);
        }
    }];

可以看到添加了一个 likes 列,点击进去可以查看到该列里面存在哪些数据。

Post表:

从Post表中的title4记录点击关联关系框进去后查看的结果:

删除关联关系

如果要从刚刚的添加的likes列中删去其中一个读者,可采用以下代码。

    BmobObject *post = [BmobObject objectWithoutDatatWithClassName:@"Post" objectId:@"ZqQ7KKKx"];

    //新建relation对象
    BmobRelation *relation = [[BmobRelation alloc] init];
    [relation removeObject:[BmobObject objectWithoutDatatWithClassName:@"_User" objectId:@"vbhGAAAY"]];

    //添加关联关系到likes列中
    [post addRelation:relation forKey:@"likes"];

    //异步更新obj的数据
    [post updateInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            NSLog(@"successful");
        }else{
            NSLog(@"error %@",[error description]);
        }
    }];

从Author表中的author1记录点击关联关系框进去后查看的结果:

修改关联关系

如果需要给objectId为ZqQ7KKKx的帖子添加多一个喜欢该帖子的读者可以使用以下代码

    BmobObject *author = [BmobObject objectWithoutDatatWithClassName:@"Post" objectId:@"ZqQ7KKKx"];

    //新建relation对象
    BmobRelation *relation = [[BmobRelation alloc] init];
    [relation addObject:[BmobObject objectWithoutDatatWithClassName:@"_User" objectId:@"J6RU888L"]];
    //添加关联关系到postlist列中
    [author addRelation:relation forKey:@"likes"];

    //异步更新obj的数据
    [author updateInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            NSLog(@"successful");
        }else{
            NSLog(@"error %@",[error description]);
        }
    }];

运行代码后,从Author表中的author1记录点击关联关系框进去后查看的结果:

查询关联关系

如果我们需要查询喜欢objectId为ZqQ7KKKx的帖子的所有读者,可以采用下列代码:

    //关联对象表
    BmobQuery *bquery = [BmobQuery queryWithClassName:@"_User"];

    //需要查询的列
    BmobObject *post = [BmobObject objectWithoutDatatWithClassName:@"Post" objectId:@"ZqQ7KKKx"];
    [bquery whereObjectKey:@"likes" relatedTo:post];


    [bquery findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            for (BmobObject *user in array) {
                NSLog(@"%@",[user objectForKey:@"username"]);
            }
        }
    }];

注意:跟Pointer不同的是,这里本质上查询的是_User表。

Relation约束关联对象值查询

上面的查询是查找喜欢某篇帖子的所有读者,如果反过来,需要查找某个读者喜欢的所有帖子又要怎么做呢?可以参考以下代码:

    BmobQuery *bquery = [BmobQuery queryWithClassName:@"Post"];

    //构造约束条件
    BmobQuery *inQuery = [BmobQuery queryWithClassName:@"_User"];
    [inQuery whereKey:@"username" equalTo:@"user3"];

    //匹配查询
    [bquery whereKey:@"likes" matchesQuery:inQuery];
    [bquery findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else if (array){
            for (BmobObject *post in array) {
                NSLog(@"%@",[post objectForKey:@"title"]);
            }
        }
    }];

Relation的本质

Relation可以理解为其存储的是一个对象,而这个对象中存储的是多个指向其它记录的指针。

用户管理

属性

BmobUser除了从BmobObject继承的属性外,还有几个特定的属性:

  1. username: 用户的用户名(必需)。
  2. password: 用户的密码(必需)。
  3. email: 用户的电子邮件地址(可选)。

BmobUser自动处理用户账户管理所需的功能。

-(void)setUsername:(NSString *)username;//用户名,必需
-(void)setPassword:(NSString*)password;//密码,必需
-(void)setEmail:(NSString *)email;//设置邮箱
-(void)setObject:(id)obj forKey:(id)key;//设置某个属性的值
-(id)objectForKey:(id)key;//得到某个属性的值

注册

应用很常见的一个功能就是,注册用户,使用BmobUser注册用户也不复杂,如下的例子所示

BmobUser *bUser = [[BmobUser alloc] init];
[bUser setUsername:@"小明"];
[bUser setPassword:@"123456"];
[bUser setObject:@18 forKey:@"age"];
[bUser signUpInBackgroundWithBlock:^ (BOOL isSuccessful, NSError *error){
    if (isSuccessful){
        NSLog(@"Sign up successfully");
    } else {
        NSLog(@"%@",error);
    }
}];

需要有两点需要注意的是:

  • 有些时候你可能需要在用户注册时发送一封邮件,以确认用户邮箱的真实性。这时,你只需要登录自己的应用管理后台,在应用设置->邮件设置(下图)中把“邮箱验证”功能打开,Bmob云后端就会在用户注册时自动发动一封验证给用户。

  • username字段是大小写敏感的字段,如果你希望应用的用户名不区分大小写,请在注册和登录时进行大小写的统一转换。

登录

当用户注册成功后,需要让他们以后能够登录到他们的账户使用应用。要做到这点可以使用

[BmobUser loginWithUsernameInBackground:@"小明"
    password:@"123456"];

也可以使用

+ (void)loginWithUsernameInBackground:(NSString *)username
                              password:(NSString *)password
                                 block:(BmobUserResultBlock)block;

Bmob还提供了用户、email、手机号码均可作为账号进行登录的功能。使用以下方法即可

    [BmobUser loginInbackgroundWithAccount:account andPassword:password block:^(BmobUser *user, NSError *error) {
        if (user) {
            NSLog(@"%@",user);
        } else {
            NSLog(@"%@",error);
        }
    }];

获取当前用户

每次你登录成功,都会在本地磁盘中有一个缓存的用户对象作为当前用户,可以获取这个缓存的用户对象来进行登录:

BmobUser *bUser = [BmobUser getCurrentObject];
if (bUser) {
    //进行操作
}else{
    //对象为空时,可打开用户注册界面
}

当然,你也可以用如下的方法清除缓存用户对象:

[BmobUser logout];

1.这个用户对象缓存了基本的数据,所以可以通过-(id)objectForKey:(id)key; 这个方法来得到某一列的值

2.[BmobUser getCurrentObject] 跟[BmobUser getCurrentUser]功能作用是一样的,因版本升级的原因才保留了[BmobUser getCurrentObject]

3.由于是缓存的数据,所以web端的修改,本地是不会更新的!!!需要重新登录才会更新本地缓存数据

更新用户

当用户登录成功后,在本地有个缓存的用户对象,如果开发者希望更改当前用户的某个属性可按如下代码操作:

BmobUser *bUser = [BmobUser getCurrentUser];
//更新number为30
[bUser setObject:@30 forKey:@"number"];
[bUser updateInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
    NSLog(@"error %@",[error description]);
}];

一般来说,使用当前用户对象来进行资料更新可能会遇到一个问题。如果当前用户上次登录的时间距离当前时间过长,存放在本地的Token就有可能会过期,导致用户更新资料失败,这是需要重新登录,登录成功后才能更新资料。

在更新用户信息时,如果用户邮箱有变更并且在管理后台打开了邮箱验证选项的话,Bmob云后端同样会自动发动一封邮件验证信息给用户。

查询用户

查询用户和查询普通对象一样,只需指定BmobUser类即可,如下:

    BmobQuery *query = [BmobUser query];
    [query whereKey:@"username" equalTo:@"xiaolv"];
    [query findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        for (BmobUser *user in array) {
            NSLog(@"objectid %@",user.objectId);
        }
    }];

浏览器中查看用户表

User表是一个特殊的表,专门存储BmobUser对象。在浏览器端,你会看到一个User表旁边有一个小人的图标。

修改密码

v1.6.3 开始,我们提供使用旧密码来重置新密码的接口,示例如下:

    BmobUser *user = [BmobUser getCurrentUser];
    [user updateCurrentUserPasswordWithOldPassword:@"old password" newPassword:@"new password" block:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            //用新密码登录
            [BmobUser loginInbackgroundWithAccount:@"name" andPassword:@"new password" block:^(BmobUser *user, NSError *error) {
                if (error) {
                    NSLog(@"login error:%@",error);
                } else {
                    NSLog(@"user:%@",user);
                }
            }];
        } else {
            NSLog(@"change password error:%@",error);
        }
    }];

找回密码

为方便大家了解如何用Bmob开发找回密码的功能,我们为大家准备了另外一份文档,详细见我们在Github中的文档:

https://github.com/bmob/bmob-cloudcode-demo/blob/master/HOW-TO-FIND-PASSWORD.md

邮箱

邮箱验证

设置邮件验证是可选的一个应用设置, 这样可以对已经确认过邮件的用户提供一部分保留的体验,邮件验证功能会在用户(User)对象中加入emailVerified字段, 当一个用户的邮件被新添加或者修改过的话,emailVerified会默认被设为false,如果应用设置中开启了邮箱认证功能,Bmob会对用户填写的邮箱发送一个链接, 这个链接可以把emailVerified设置为 true.

BmobUser *user = [BmobUser getCurrentUser];
//应用开启了邮箱验证功能
if ([user objectForKey:@"emailVerified"]) {
    //用户没验证过邮箱
    if (![[user objectForKey:@"emailVerified"] boolValue]) {
        [user verifyEmailInBackgroundWithEmailAddress:@"xxxxxxxxxx"];
    }
}

邮箱修改密码

一旦你引入了一个密码系统,那么肯定会有用户忘记密码的情况。对于这种情况,我们提供了一种方法,让用户安全地重置起密码。

重置密码的流程很简单,开发者只需要求用户输入注册的电子邮件地址即可:

[BmobUser requestPasswordResetInBackgroundWithEmail:@"xxxx@qq.com"];

密码重置流程如下:

  1. 用户输入他们的电子邮件,请求重置自己的密码。
  2. Bmob向他们的邮箱发送一封包含特殊的密码重置连接的电子邮件。
  3. 用户根据向导点击重置密码连接,打开一个特殊的Bmob页面,根据提示,他们可以输入一个新的密码。
  4. 用户的密码已被重置为新输入的密码。

第三方账号登录

Bmob提供了非常简单的方法来实现使用第三方账号登陆的功能,目前支持新浪微博、手机QQ账号以及微信账号的登陆。以下是我们提供的一个demoThirdPartyLogin

新浪微博账号注册登录

新浪微博开放平台注册应用,然后根据新浪微博 iOS SDK使用说明安装SDK以及获取,开发者通过新浪微博提供的SDK得到用户的信息后,就可以调用BmobUser提供的方法来注册登录到应用。

//得到的新浪微博授权信息,请按照例子来生成NSDictionary
NSDictionary *dic = @{@"access_token":token,@"uid":uid,@"expirationDate":date};
//通过授权信息注册登录
[BmobUser loginInBackgroundWithAuthorDictionary:dic
                                      platform:BmobSNSPlatformSinaWeibo
                                         block:^(BmobUser *user, NSError *error) {
                                             NSLog(@"user objectid is :%@",user.objectId);
                                         }];

手机QQ账号登录

同样的,开发者通过QQ授权得到用户的信息后,同样可以调用BmobUser提供的方法来注册登录到应用。下面的例子是通过QQ提供的SDK授权得到的信息,进行登录的:

//得到的qq授权信息,请按照例子来生成NSDictionary
 NSDictionary *responseDictionary = @{@"access_token": _tencentOauth.accessToken,@"uid":_tencentOauth.openId,@"expirationDate":_tencentOauth.expirationDate};
 //通过授权信息注册登录
[BmobUser loginInBackgroundWithAuthorDictionary:responseDictionary
                                       platform:BmobSNSPlatformQQ
                                          block:^(BmobUser *user, NSError *error) {
                                               NSLog(@"error%@",[error description]);
                                            }];

微信账号登录

NSDictionary *responseDictionary = @{@"access_token": accessToken,@"uid":openId,@"expirationDate":expirationDate};
[BmobUser loginInBackgroundWithAuthorDictionary:responseDictionary
                                       platform:BmobSNSPlatformWeiXin
                                          block:^(BmobUser *user, NSError *error) {
                                               NSLog(@"error%@",[error description]);
                                            }];

第三方账号与BmobUser绑定

如果你的应用中有其他功能已经使用到了相关第三方平台的功能,比如社交分享功能,那么你可以将已经得到的用户授权信息传递给BmobSDK来便捷地与BmobUser进行绑定。以下代码展示了将第三方账号和已经存在的BmobUser对象进行绑定:

//新浪微博账号关联到当前用户
NSDictionary *dic = @{@"access_token":token,@"uid":uid,@"expirationDate":date};
BmobUser *currentUser = [BmobUser getCurrentUser];
[currentUser linkedInBackgroundWithAuthorDictionary:dic
                                           platform:BmobSNSPlatformSinaWeibo
                                              block:^(BOOL isSuccessful, NSError *error) {
                                                     NSLog(@"ERROR :%@",[error description]);
                                                 }];
//手机qq账号关联到当前用户
NSDictionary *responseDictionary = @{@"access_token": _tencentOauth.accessToken,@"uid":_tencentOauth.openId,@"expirationDate":_tencentOauth.expirationDate};
BmobUser *user = [BmobUser getCurrentUser];
[user linkedInBackgroundWithAuthorDictionary:responseDictionary
                                platform:BmobSNSPlatformQQ
                                   block:^(BOOL isSuccessful, NSError *error) {
                                       NSLog(@"error%@",[error description]);
                                   }];
//微信账号关联到当前用户
NSDictionary *responseDictionary = @{@"access_token": accessToken,@"uid":openId,@"expirationDate":expirationDate};
BmobUser *user = [BmobUser getCurrentUser];
[user linkedInBackgroundWithAuthorDictionary:responseDictionary
                                platform:BmobSNSPlatformWeiXin
                                   block:^(BOOL isSuccessful, NSError *error) {
                                       NSLog(@"error%@",[error description]);
                                   }];

解除绑定

解除绑定的账号,也是很简单的。下面是例子:

//当前用户解除关联的微博账号
BmobUser *user = [BmobUser getCurrentUser];
[user cancelLinkedInBackgroundWithPlatform:BmobSNSPlatformSinaWeibo
                                    block:^(BOOL isSuccessful, NSError *error) {
                                        NSLog(@"error is :%@",[error description]);
                                    }];
//当前用户解除关联的手机QQ账号
BmobUser *user = [BmobUser getCurrentUser];
[user cancelLinkedInBackgroundWithPlatform:BmobSNSPlatformQQ
                                     block:^(BOOL isSuccessful, NSError *error) {
                                         NSLog(@"error is :%@",[error description]);
                                     }];
//当前用户取消关联微信账号
NSDictionary *responseDictionary = @{@"access_token": accessToken,@"uid":openId,@"expirationDate":expirationDate};
BmobUser *user = [BmobUser getCurrentUser];
[user cancelLinkedInBackgroundWithAuthorDictionary:responseDictionary
                                platform:BmobSNSPlatformWeiXin
                                   block:^(BOOL isSuccessful, NSError *error) {
                                       NSLog(@"error%@",[error description]);
                                   }];

手机号相关功能

v1.5.8 开启Bmob加入了手机注册登录及密码重置等功能。以下介绍的功能可参考我们提供的BmobSmsDemo(使用前请先在Appdelegate.m中填入你的app id)

注:以下的新功能如果需要填入验证码参数的,请先调用请求验证码方法。

手机号注册

可使用以下代码进行一键注册并登录的操作。在使用前必须先请求手机验证码,注册成功后将以当前的手机号码作为用户名,并且会缓存用户信息在本地,可使用 [BmobUser getCurrentUser] 获取。

[BmobUser signOrLoginInbackgroundWithMobilePhoneNumber:mobilePhoneNumber andSMSCode:smsCode block:^(BmobUser *user, NSError *error) {
        if (user) {
            NSLog(@"%@",user);
        } else {
            NSLog(@"%@",error);
        }
}];

如果希望在用手机注册时为用户添加密码或者其它信息,可以使用以下代码实现:

    BmobUser *buser = [[BmobUser alloc] init];
    buser.mobilePhoneNumber = @"15123456789";
    buser.password = @"123";
    buser.email = @"xxx@gmail.com";
    [buser signUpOrLoginInbackgroundWithSMSCode:@"6位验证码" block:^(BOOL isSuccessful, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            BmobUser *user = [BmobUser getCurrentUser];
            NSLog(@"%@",[BmobUser getCurrentUser]);
        }
    }];

手机号登录

Bmob除了提供手机号验证码一键注册登录功能外,还另外提供了希望只给已存在用户用手机号进行登录的功能。代码如下:


    [BmobUser loginInbackgroundWithMobilePhoneNumber:mobilePhoneNumber andSMSCode:smsCode block:^(BmobUser *user, NSError *error) {
        if (user) {
            NSLog(@"%@",user);
        } else {
            NSLog(@"%@",error);
        }
    }];

绑定手机号

绑定手机号的基本思路为,先获取验证码,验证取得的验证码后再更新 mobilePhoneNumbermobilePhoneNumberVerified 即可,这是我们推荐的做法。当然,你也可以不通过验证码,直接使用用户输入的手机号来更新 mobilePhoneNumber 来进行绑定,不过这种方法并不推荐。

    //验证
    [BmobSMS verifySMSCodeInBackgroundWithPhoneNumber:mobilePhoneNumber andSMSCode:smsCode resultBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            //修改绑定手机
            BmobUser *buser = [BmobUser getCurrentUser];
            buser.mobilePhoneNumber = mobilePhoneNumber;
            [buser setObject:[NSNumber numberWithBool:YES] forKey:@"mobilePhoneNumberVerified"];
            [buser updateInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
                if (isSuccessful) {
                    NSLog(@"%@",buser);
                } else {
                    NSLog(@"%@",error);
                }
            }];

        } else {
            NSLog(@"%@",error);
        }
    }];

手机号修改密码

通过请求验证码和输入验证码从而进行账号密码重置,代码如下:

    [BmobUser resetPasswordInbackgroundWithSMSCode:smsCode andNewPassword:newPassword block:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            NSLog(@"%@",@"重置密码成功");
        } else {
            NSLog(@"%@",error);
        }
    }];

子类化

很多时候BmobObject并不能满足用户的需求,用户可能需要继承BmobOject来定制自己的需求。但是当用户需要保存继承类的属性至后台时,还需要做一些额外的处理。因此,我们推出子类化BmobObject的选项,以让用户的代码具备更好的扩展性。

子类化的使用

先来定义一个BmobObject的子类。

Test.h


@interface Test : BmobObject
@property (copy, nonatomic) NSString *title;
@property (copy, nonatomic) NSString *name;
@property (strong, nonatomic) NSNumber *isStudent;
@property (strong, nonatomic) NSNumber *age;
@end

Test.m


@implementation Test

@synthesize title;
@synthesize name;
@synthesize isStudent;
@synthesize age;

@end

后面你就可以像以下形式那样使用Test类了

    Test *test = [[Test alloc] init];
    test.title = @"title2";
    test.name = @"name2";
    test.isStudent = [NSNumber numberWithBool:NO];
    test.age = @22;
    [test sub_saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
        NSLog(@"error %@",error);
        NSLog(@"objectId %@",test.objectId);
    }];

注意:
1.当用到添加与更新操作时,要使用类似于sub_XXX的方法,而其它方法保持不变,与BmobObject一致。
2.子类的方法使用对象类型,不要使用基本类型。例如,要使用整型时,可以声明为NSNumber。

针对BmobUser的特别说明

如果要使用继承BmobUser的子类来进行登录,在构造其子类时,应用类似于以下的形式。

 TestUser *user = [[TestUser alloc] initFromBmobObject:[BmobUser getCurrentUser]];
    user.email = @"xxxaa@qq.com";
    [user sub_updateInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
        NSLog(@"error %@",error.description);
    }];

查询

查询后需要使用以下方法以得到子类的对象。

    BmobQuery *testQuery = [Test query];
    [testQuery findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
        for (BmobObject *obj in array) {
            Test *t = [[Test alloc] initFromBmobObject:obj];

        }
    }];

文件管理

文件管理章节Demo

创建文件对象

BmobFile可以让你的应用程序将文件存储到服务器中,比如常见的文件类型图像文件,影像文件、音乐文件和任何其他二进制数据都可以使用。当文件上传成功后,可以通过url属性来获取文件的地址。

上传文件

1.6.9版本之后,上传服务使用CDN服务

上传文件方法

如下图的例子,是将cs.txt的文本文件保存到服务器端:

-(void)saveInBackground:(BmobBooleanResultBlock)block;

可以在block里面把文件添加到gameScore里面,建议使用异步上传的方法,再在block进行操作。如下面的例子:

NSBundle    *bundle = [NSBundle mainBundle];
NSString *fileString = [NSString stringWithFormat:@"%@/cs.txt" ,[bundle bundlePath] ];
BmobObject *obj = [[BmobObject alloc] initWithClassName:@"GameScore"];
BmobFile *file1 = [[BmobFile alloc] initWithFilePath:fileString];
[file1 saveInBackground:^(BOOL isSuccessful, NSError *error) {
     //如果文件保存成功,则把文件添加到filetype列
     if (isSuccessful) {
         [obj setObject:file1  forKey:@"filetype"];
         [obj saveInBackground];
         //打印file文件的url地址
         NSLog(@"file1 url %@",file1.url);
     }else{
         //进行处理
     }
}];

上传文件进度

在上传文件时,有时会需要获取上传文件进度的需求。这时,可以使用

-(void)saveInBackground:(BmobBooleanResultBlock)block withProgressBlock:(BmobProgressBlock)progressBlock;

如在下面的例子中,打印上传的进度

NSBundle    *bundle = [NSBundle mainBundle];
NSString *fileString = [NSString stringWithFormat:@"%@/cs.txt" ,[bundle bundlePath] ];
BmobObject *obj = [[BmobObject alloc] initWithClassName:@"gameScoreFile"];
BmobFile *file1 = [[BmobFile alloc] initWithClassName:@"Asc" withFilePath:fileString];
[file1 saveInBackground:^(BOOL isSuccessful, NSError *error) {
    if (isSuccessful) {
        [obj setObject:file1  forKey:@"userFile"];
        [obj saveInBackground];
        NSLog(@"file1 url %@",file1.url);
    }
} withProgressBlock:^(CGFloat progress) {
    NSLog(@"上传进度%.2f",progress);
}];

以分片的方式上传文件

分片上传文件和上传整个文件的机制有所不同,是先把整个文件进行分片(256KB一片),然后再进行一片一片的上传(具体实现可查看RestAPI文档)。当文件以分片的方式上传到Bmob服务器时,具有几种优势:

  1. 适合于尺寸较大的文件传输,通过切片来避免单个HTTP数据量过大而导致连接超时;

  2. 在网络条件较差的环境下,较小的尺寸可以有较高的上传成功率,从而避免无休止的失败重试;

在BmobSDK中对应的函数方法为

-(void)saveInBackgroundByDataSharding:(BmobBooleanResultBlock)block;

示例如下:

NSBundle    *bundle = [NSBundle mainBundle];
//上传cs.txt文件
NSString *fileString = [NSString stringWithFormat:@"%@/cs.txt" ,[bundle bundlePath] ];
BmobObject *obj = [[BmobObject alloc] initWithClassName:@"gameScoreFile"];
//创建BmobFile对象
BmobFile *file1 = [[BmobFile alloc] initWithFilePath:fileString];
[file1 saveInBackgroundByDataSharding:^(BOOL isSuccessful, NSError *error) {
   if (isSuccessful) {
           //如果成功,保存文件到userFile
       [obj setObject:file1  forKey:@"userFile"];
       [obj saveInBackground];
   }else{
       //失败,打印错误信息
           NSLog(@"error: %@",[error description]);
   }
} ];

批量上传文件

有时,开发者需要一次性上传多个文件,这是可以使用SDK提供的多个上传文件的方法来使用

NSBundle    *bundle = [NSBundle mainBundle];
//文件cncc.jpg的路径
NSString *fileString = [NSString stringWithFormat:@"%@/cncc.jpg" ,[bundle bundlePath] ];
//文件cs.txt的路径
NSString *fileString2 = [NSString stringWithFormat:@"%@/cs.txt" ,[bundle bundlePath] ];
[BmobFile filesUploadBatchWithPaths:@[fileString,fileString2]
                      progressBlock:^(int index, float progress) {
                             //index 上传数组的下标,progress当前文件的进度
                          NSLog(@"index %d progress %f",index,progress);
                      } resultBlock:^(NSArray *array, BOOL isSuccessful, NSError *error) {
                      //array 文件数组,isSuccessful 成功或者失败,error 错误信息
                      BmobObject *obj = [[BmobObject alloc] initWithClassName:@"gameScoreFile"];
                          for (int i = 0 ; i < array.count ;i ++) {
                              BmobFile *file = array [i];
                              NSString *key = [NSString stringWithFormat:@"userFile%d",i];
                              [obj setObject:file  forKey:key];
                          }                          
                          [obj saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) { 
                              }];
                      }];

下载文件

获取文件对象只需通过-(id)objectForKey:(id)key;来得到,例如,

BmobFile *file = (BmobFile*)[gameScore objectForKey:@"filetype"];

可用通过file的url属性(file.url),来得到文件的地址进行下载。

删除文件

删除文件接口只能删除1.6.9版本之后上传的文件

如果需要删除文件,使用以下接口即可

/**
 *  异步请求删除文件
 *
 *  @param block 返回删除结果与信息,如果删除成功,则无返回信息
 */
-(void)deleteInBackground:(BmobBooleanResultBlock)block;

当开发者需要一次性删除多个文件的时候,可以调用批量删除文件的接口

    NSArray *array = @[@"http://bmob-cdn-1.b0.upaiyun.com/jpg/579c8dc6676e460b82d83c8eb5c8aaa5.jpg",@"http://bmob-cdn-1.b0.upaiyun.com/jpg/59e3817d6cec416ba99a126c9d42768f.jpg "]

    [BmobFile filesDeleteBatchWithArray:array resultBlock:^(NSArray *array, BOOL isSuccessful, NSError *error) {
        NSLog(@"fail delete array %@",array);
        NSLog(@"error %@",error.localizedDescription);
        NSLog(@"issuccessful %i",isSuccessful);
    }];

数据实时功能

Bmob提供了数据实时功能,当开发者监听某个变化事件,例如监听表更新时,表的内容一旦变化,服务器就会通知SDK,SDK提供了相应回调函数来给开发者使用。当然开发者也可以取消相对应的监听,这样就不会收到数据变化的消息了。

监听功能

SDK提供了两个方法来监听数据变化,其中一个方法是针对表,另一个则针对行。

-(void)listenTableChange:(BmobActionType)actionType tableName:(NSString *)tableName;

这个函数可以监听到表更新(包括该表的行数据的变化)、表删除的行为。例如:

-(void)listen{
    //创建BmobEvent对象
    _bmobEvent          = [BmobEvent defaultBmobEvent];
    //设置代理
    _bmobEvent.delegate = self;
    //启动连接
    [_bmobEvent start];
}

在代理的函数,进行操作

//可以进行监听或者取消监听事件
-(void)bmobEventCanStartListen:(BmobEvent *)event{
    //监听Post表更新
    [_bmobEvent listenTableChange:BmobActionTypeUpdateTable tableName:@"Post"];
}
//接收到得数据
-(void)bmobEvent:(BmobEvent *)event didReceiveMessage:(NSString *)message{
    //打印数据
    NSLog(@"didReceiveMessage:%@",message);
}

相对的,也有监听行更新。行删除的函数:

-(void)listenRowChange:(BmobActionType)actionType tableName:(NSString *)tableName objectId:(NSString *)objectId;

当然了表删除,行更新,行删除等行为也可以在代理函数-(void)bmobEventCanStartListen:(BmobEvent *)event上进行监听。例如:

-(void)bmobEventCanStartListen:(BmobEvent *)event
    //监听Test表删除事件,
    [_bmobEvent listenTableChange:BmobActionTypeDeleteTable tableName:@"Test"];
    //监听Post表中objectId为a1419df47a 的行更新事件
    [_bmobEvent listenRowChange:BmobActionTypeUpdateRow tableName:@"Post" objectId:@"a1419df47a"];
    //监听Post表中objectId为wb1o000F 的行删除事件
    [_bmobEvent listenRowChange:BmobActionTypeDeleteRow tableName:@"Post" objectId:@"wb1o000F"];
}

需要注意的是,监听事件后,接收到的数据是json格式的字符串,可以序列化为NSDictionary。

取消监听功能

当开发者想取消监听某个行为时,可以使用下面的函数

//取消订阅表的变化事件,包括表更新,表删除
-(void)cancleListenTableChange:(BmobActionType)actionType tableName:(NSString *)tableName;

//取消订阅行的变化事件
-(void)cancleListenRowChange:(BmobActionType)actionType tableName:(NSString *)tableName objectId:(NSString *)objectId;

这里有个实例可以参考下。

ACL和角色

大多数应用程序需要对不同的数据进行灵活的访问和控制,这就可以使用Bmob提供的ACL模式来实现。例如:

  • 对于私有数据,读写权限可以只局限于数据的所有者。
  • 对于一个论坛,会员和版主有写的权限,一般的游客只有读的权限。
  • 对于日志数据只有开发者才能够访问,ACL可以拒绝所有的访问权限。
  • 属于一个被授权的用户或者开发者所创建的数据,可以有公共的读的权限,但是写入权限仅限于管理者角色。
  • 一个用户发送给另外一个用户的消息,可以只给这些用户赋予读写的权限。
    用Bmob SDK,你可以对这些数据设置一个默认的ACL,这样,即使黑客反编译了你的应用,获取到Application Key,也仍然无法操作和破坏你的用户数据,确保了用户数据的安全可靠。而作为开发者,当你需要对这些数据进行管理时,可以通过超级权限Key(Master Key)进行。

默认访问权限

在没有显示指定的情况下,每一个BmobObject(表)中的ACL(列)属性的默认值是所有人可读可写的。在客户端想要修改这个权限设置,只需要简单简单调用BmobACL的setPublicReadAccess方法和setPublicWriteAccess方法,即:

BmobACL *acl = [BmobACL ACL];
//设置所有人读权限为true
[acl setPublicReadAccess];
//设置所有人写权限为true
[acl setPublicWriteAccess];

注意:可读可写是默认的权限,不需要写额外的代码。

指定用户的访问权限

假如你想实现一个分享日志类的应用时,这可能会需要针对不同的日志设定不同的访问权限。比如,公开的日志,发布者有更改和修改的权限,其他用户只有读的权限,那么可用如下代码实现:

BmobObject *blog = [[BmobObject alloc] initWithClassName:@"blog"] ;
[blog setObject:@"论电影的七个元素" forKey:@"title"];
[blog setObject:@"这是blog的具体内容" forKey:@"content"];
BmobACL *acl = [BmobACL ACL];
[acl setPublicReadAccess];//设置所有人可读
[acl setWriteAccessForUser:[BmobUser getCurrentUser]];//设置只有当前用户可写
blog.ACL= acl;
[blog saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
    if (isSuccessful) {
        //进行操作
    }else{
        //进行操作
    }
}];

有时,用户想发表一篇不公开的日志,这种情况只有发布者才对这篇日志拥有读写权限,相应的代码如下:

BmobObject *blog = [[BmobObject alloc] initWithClassName:@"blog"] ;
[blog setObject:@"一个人的秘密" forKey:@"title"];
[blog setObject:@"这是blog的具体内容" forKey:@"content"];
BmobACL *acl = [BmobACL ACL];
[acl setReadAccessForUser:[BmobUser getCurrentUser]];//设置只有当前用户可读
[acl setWriteAccessForUser:[BmobUser getCurrentUser]];//设置只有当前用户可写
blog.ACL= acl;
[blog saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
    if (isSuccessful) {
        //进行操作
    }else{
        //进行操作
    }
}];

角色管理

上面的指定用户访问权限虽然很方便,但是对于有些应用可能会有一定的局限性。比如一家公司的工资系统,员工和公司的出纳们只拥有工资的读权限,而公司的人事和老板才拥有全部的读写权限。要实现这种功能,你也可以通过设置每个用户的ACL权限来实现,如下:

//创建公司某用户的工资对象
BmobObject *wageinfo  = [[BmobObject alloc] initWithClassName:@"wageinfo"];
[wageinfo setObject:[NSNumber numberWithUnsignedInteger:100000] forKey:@"wage"];
//这里创建四个用户对象,分别为老板、人事小张、出纳小谢和自己
BmobUser *boss        = [BmobUser objectWithoutDatatWithClassName:@"User" objectId:@"xxxxxx"];
BmobUser *hr_zhang    = [BmobUser objectWithoutDatatWithClassName:@"User" objectId:@"xxxxxx"];
BmobUser *cashier_xie = [BmobUser objectWithoutDatatWithClassName:@"User" objectId:@"xxxxxx"];
BmobUser *me          = [BmobUser objectWithoutDatatWithClassName:@"User" objectId:@"xxxxxx"];
//创建ACL对象
BmobACL *acl = [BmobACL ACL];
//4个用户对象均可读
[acl setReadAccessForUser:boss];
[acl setReadAccessForUser:hr_zhang];
[acl setReadAccessForUser:cashier_xie];
[acl setReadAccessForUser:me];
//设置boss跟hr_zhang 写的权限
[acl setWriteAccessForUser:boss];
[acl setWriteAccessForUser:hr_zhang];
wageinfo.ACL= acl;
[wageinfo saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
    if (isSuccessful) {
        //进行操作
    }else{
        //进行操作
    }
}];

但是,一个公司的人事、出纳和员工不仅仅只有一个人,同时还会有离职、调换岗位以及新员工加入等问题存在。如果用上面的代码对公司的每个人进行一一设置的话是不现实的,既麻烦也很难维护。针对这个问题,我们可以利用BmobRole来解决。我们只需要对用户进行分类,每个分类赋予不同的权限。如下代码实现:

//创建公司某用户的工资对象
BmobObject *wageinfo  = [[BmobObject alloc] initWithClassName:@"wageinfo"];
[wageinfo setObject:[NSNumber numberWithUnsignedInteger:100000] forKey:@"wage"];
//这里创建5个用户对象,分别为老板、人事小张、人事小罗、出纳小谢和自己
BmobUser *boss           = [BmobUser objectWithoutDatatWithClassName:@"User" objectId:@"xxxxxx"];
BmobUser *hr_zhang       = [BmobUser objectWithoutDatatWithClassName:@"User" objectId:@"xxxxxx"];
BmobUser *hr_luo         = [BmobUser objectWithoutDatatWithClassName:@"User" objectId:@"xxxxxx"];;
BmobUser *cashier_xie    = [BmobUser objectWithoutDatatWithClassName:@"User" objectId:@"xxxxxx"];
BmobUser *me             = [BmobUser objectWithoutDatatWithClassName:@"User" objectId:@"xxxxxx"];
//创建HR和Cashier两个用户角色(这里为了举例BmobRole的使用,将这段代码写在这里,正常情况下放在员工管理界面会更合适)
BmobRole *hr             = [BmobRole roleWithName:@"HR"];
BmobRole *cashier        = [BmobRole roleWithName:@"Cashier"];
//将hr_zhang和hr_luo归属到hr角色中
BmobRelation *hrRelation = [BmobRelation relation];
[hrRelation addObject:hr_zhang];
[hrRelation addObject:hr_luo];
[hr addUsersRelation:hrRelation];
//保存到云端角色表中(web端可以查看Role表)
[hr saveInBackground];
//将cashier_xie归属到cashier角色中
BmobRelation *cashierRelation = [BmobRelation relation];
[cashierRelation addObject:cashier_xie];
[cashier addUsersRelation:cashierRelation];
//保存到云端角色表中(web端可以查看Role表)
[cashier saveInBackground];
//创建ACL对象
BmobACL *acl = [BmobACL ACL];
[acl setReadAccessForUser:boss];// 假设老板只有一个, 设置读权限
[acl setReadAccessForUser:me];// 给自己设置读权限
[acl setReadAccessForRole:hr];// 给hr角色设置读权限
[acl setReadAccessForRole:cashier];// 给cashier角色设置读权限
//设置boss跟hr_zhang 写的权限
[acl setWriteAccessForUser:boss];// 设置老板拥有写权限
[acl setWriteAccessForRole:hr];// 设置ht角色拥有写权限
wageinfo.ACL= acl;
[wageinfo saveInBackgroundWithResultBlock:^(BOOL isSuccessful, NSError *error) {
    if (isSuccessful) {
        //进行操作
    }else{
        //进行操作
    }
}];

需要说明一点的是,Web端的Role表也具有ACL的列,你可以将角色管理的权限赋予某些用户。

角色之间的从属关系

下面我们来说一下角色与角色之间的从属关系。用一个例子来说明下:一个互联网企业有移动部门,部门中有不同的小组,如Android开发组和IOS开发组。每个小组只拥有自己小组的代码读写权限,但这两个小组同时拥有核心库代码的读权限。

//创建MobileDep(移动研发部)、AndroidTeam(android开发组)和iOSTeam(ios开发组)三个角色
BmobRole *mobileDep =[BmobRole roleWithName:@"MobileDep"];
BmobRole *androidTeam = [BmobRole roleWithName:@"AndroidTeam"];
BmobRole *iosTeam     = [BmobRole roleWithName:@"iOSTeam"];
//保存AndroidTeam和iosTeam角色到云端
[androidTeam saveInBackground];
[iosTeam saveInBackground];
//将androidTeam和iosTeam两种角色添加到移动部门角色中
BmobRelation *relation = [BmobRelation relation];
[relation addObject:androidTeam];
[relation addObject:iosTeam];
[mobileDep addRolesRelation:relation];
// 假设创建三个代码数据对象
BmobObject *coreCode = [BmobObject objectWithClassName:@"Code"];
BmobObject *androidCode = [BmobObject objectWithClassName:@"Code"];
BmobObject *iosCode = [BmobObject objectWithClassName:@"Code"];
//......此处省略一些具体的属性设定
[coreCode saveInBackground];
[androidCode saveInBackground];
[iosCode saveInBackground];
//设置androidTeam角色对androidCode对象的读和写的权限
[androidCode.ACL setReadAccessForRole:androidTeam];
[androidCode.ACL setWriteAccessForRole:androidTeam];
//设置iosTeam角色对iosCode对象的读和写的权限
[iosCode.ACL setReadAccessForRole:iosTeam];
[iosCode.ACL setWriteAccessForRole:iosTeam];
//设置mobileDep角色可以对coreCode对象进行读操作
[coreCode.ACL setReadAccessForRole:mobileDep];

地理位置

Bmob允许用户根据地球的经度和纬度坐标进行基于地理位置息的信查询。你可以在BmobObject的查询中添加一个BmobGeoPoint的对象查询。你就可以实现轻松查找出离当前用户最接近的信息或地点的功能。

地理位置对象

首先需要创建一个BmobGeoPoint对象。例如,创建一个-东经116.39727786183357度北纬39.913768382429105度的BmobGeoPoint对象:

BmobGeoPoint *point = [[BmobGeoPoint alloc] initWithLongitude:116.39727786183357 WithLatitude:39.913768382429105];

添加地理信息

[gameScore setObject:point forKey:@"location"];

地理查询

现在,你的数据表中有了一定的地理坐标对象的数据,这样可以测试找出最接近某个点的信息了。你可以使用BmobQuery对象的whereNear方法来这样做:

BmobGeoPoint  *point = [[BmobGeoPoint alloc] initWithLongitude:116.39727786183357 WithLatitude:39.913768382429105];
BmobQuery *bquery = [BmobQuery queryWithClassName:@"GameScore"];
[bquery whereKey:@"location" nearGeoPoint:point];
[bquery setLimit:10];
[bquery findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
    //进行操作
}];

要限制查询指定距离范围的数据可以使用whereWithinKilometers(公里)、whereWithinMiles(英里)或whereWithinRadians(弧度)方法。 要查询一个矩形范围内的信息可以使用whereWithinGeoBox来实现:

BmobGeoPoint *southwestOfSF = [[BmobGeoPoint alloc] initWithLongitude:116.39727786183357 WithLatitude:39.913768382429105];
BmobGeoPoint* northeastOfSF =[[BmobGeoPoint alloc] initWithLongitude:116.39727786183357 WithLatitude:40.913768382429105];
BmobQuery *bquery = [BmobQuery queryWithClassName:@"GameScore"];
[bquery whereKey:@"location" withinGeoBoxFromSouthwest:southwestOfSF
                                           toNortheast:northeastOfSF];
[bquery setLimit:10];
[bquery findObjectsInBackgroundWithBlock:^(NSArray *array, NSError *error) {
    //进行操作
}];

注意事项
目前有几个需要注意的地方:

  1. 每个BmobObject数据对象中只能有一个BmobGeoPoint对象。

  2. 地理位置的点不能超过规定的范围。纬度的范围应该是在-90.0到90.0之间。经度的范围应该是在-180.0到180.0之间。如果您添加的经纬度超出了以上范围,将导致程序错误。

  3. 地理位置查询最大的距离根据表数据的不同有不同的限制,使用-(void)whereKey:(NSString )key nearGeoPoint:(BmobGeoPoint )geopoint;默认100KM。当需要指定距离时,最好指定一下最大距离。

云端逻辑

我们提供了BmobCloud类来调用云端逻辑的功能,有两种方法

//同步调用云端逻辑,fuction指的用函数名 parameters为函数需要的参数,同步的方法情在子线程中使用,不然会卡住主线程
+(id)callFunction:(NSString *)function withParameters:(NSDictionary *)parameters;

例子:

    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        //sayhello 为云端逻辑的函数名,
        //num 为参数名,@1为 参数值

        id result = [BmobCloud callFunction:@"sayhello" withParameters:@{@"num":@1}];
        dispatch_async(dispatch_get_main_queue(), ^{
            NSLog(@"cloudFunction %@",result);
        });
    });
//异步调用云端逻辑,fuction指的用函数名 parameters为函数需要的参数
+ (void)callFunctionInBackground:(NSString *)function withParameters:(NSDictionary *)parameters block:(BmobIdResultBlock)block;

例如,在应用中添加了sayhello的云端逻辑,功能是打印出hello,可以在SDK里这样调用

[BmobCloud callFunctionInBackground:@"sayhello" withParameters:nil block:^(id object, NSError *error) {
      if (error) {
          NSLog(@"error %@",[error description]);
      }
     NSLog(@"object      %@",object);
}] ;

注意,为了确保体验,建议使用异步调用的方法。

关于云端逻辑的编写,详细参考 云端逻辑开发文档

短信服务

在一些应用场景下,你可能希望用户验证手机号码后才能进行一些操作,例如充值等。这些操作跟用户系统没有关系,可以通过我们提供的的短信验证API来实现。

每个 Bmob 帐户有 30 条免费额度的短信数量用于测试,超过需要购买短信条数才能继续使用。

默认使用 【比目科技】 作为签名,可以在控制台进行修改。

短信服务除了集成成进原来的BmobSDK包外,还另外拆分了一个独立的SDK包,使用前请先导入 SystemConfiguration.frameworkCoreLocation.framework,注册方法还是 [Bmob registerWithAppKey:@""];

短信模板需要符以下要求,否则模板审核不予通过。

请求发送短信内容

这个接口可让开发者使用 Bmob 的短信功能灵活发送短信内容到用户的手机上。

此接口必须要开发者在后台提交身份证信息,在(Bmob》账户管理》身份验证) 中填写,并通过了我们的审核后才可以使用。

请不要发送任何敏感内容,一经发现,Bmob 有权立刻停止您的该接口使用权。

样例代码如下:

    [BmobSMS requestSMSInbackgroundWithPhoneNumber:@"phoneNumber" Content:@"您的XX服务还有XX时间到期,请及时续费。" andSendTime:@"2015-07-01 10:59:00" resultBlock:^(int number, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            NSLog(@"smsId:%d",number);
        }
    }];
说明:
1.如果需要立即发送,sendTime设置为nil;
2.sendTime的格式为 yyyy-MM-dd HH:mm:ss;
3.如果sendTime的格式不正确或者是这个时间已经是过去的时间,那么短信会立即发送;
4.smsID可用于查询短信的发送状态。

获取短信验证码

如下图所示,在使用获取短信验证码功能前可以先设置好几个模板以用于不同的功能。

获取短信验证码可使用以下方法

    //请求验证码
    [BmobSMS requestSMSCodeInBackgroundWithPhoneNumber:mobilePhoneNumber andTemplate:@"test" resultBlock:^(int number, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            //获得smsID
            NSLog(@"sms ID:%d",number);
        }
    }];
注意,短信模板设置后需要通过审核才能使用,以下情况将使用Bmob设定的默认模板(Bmob 默认的模板是: 您的验证码是%smscode%,有效期为%ttl%分钟。您正在使用%appname%的验证码
)。
1.传入模板名为nil或者@“”;
2.传入不存在的模板;
3.传入的模板未通过审核

验证短信验证码

验证短信验证码状态


    //验证
    [BmobSMS verifySMSCodeInBackgroundWithPhoneNumber:mobilePhoneNumber andSMSCode:smsCode resultBlock:^(BOOL isSuccessful, NSError *error) {
        if (isSuccessful) {
            NSLog(@"%@",@"验证成功,可执行用户请求的操作");
        } else {
            NSLog(@"%@",error);
        }
    }];

}

查询短信验证码状态

查询短信验证码状态示例代码:

    [BmobSMS querySMSCodeStateInBackgroundWithSMSId:smsId resultBlock:^(NSDictionary *dic, NSError *error) {
        if (dic) {
            NSLog(@"%@",dic);
        } else {
            NSLog(@"%@",error);
        }
    }];
注:SmsState包含两种状态:

1、smsState(短信状态) :SUCCESS(发送成功)、FAIL(发送失败)、SENDING(发送中)。

2、verifyState(验证状态):true(已验证)、false(未验证)。

注意事项:

关于短信条数的计算规则如下,

  1. 实际计算的短信字数 = 模板的内容或自定义短信的内容字数 + 6。加上6是因为默认的签名【比目科技】占了6个字。
  2. 实际计算的短信字数在70个字以下算1条。
  3. 实际计算的短信字数超过70字的以67字为一条来计算的。也就是135个字数是计算为3条的。
  4. 计算得到的短信条数在本条短信发送成功后将会从你的账户剩余的短信条数中扣除。

短信发送限制规则是1/分钟,5/小时,10/天。即对于一个应用来说,一天给同一手机号发送短信不能超过10条,一小时给同一手机号发送短信不能超过5条,一分钟给同一手机号发送短信不能超过1条。

其它功能

获取服务器时间

获取服务器时间戳可以直接调用[Bmob getServerTimestamp],例如:

    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        NSDateFormatter *dateFormatter = [[NSDateFormatter alloc] init];
        //设置时区
        [dateFormatter setTimeZone:[NSTimeZone timeZoneWithName:@"Asia/Shanghai"]];
        //时间格式
        [dateFormatter setDateFormat:@"yyyy-MM-dd hh:mm:ss"];
        //调用获取服务器时间接口,返回的是时间戳
        NSString  *timeString = [Bmob getServerTimestamp];
        //时间戳转化成时间
        NSDate *date = [NSDate dateWithTimeIntervalSince1970:[timeString intValue]];
        NSString *dateStr = [dateFormatter stringFromDate:date];
        NSLog(@"北京时间:%@",dateStr);
    });

设置API网络请求超时时间

使用 +(void)setBmobRequestTimeOut:(CGFloat)seconds; 方法可以设置API中网络请求的超时时间,例如,想要设置访问Bmob后台时超过15s就返回超时错误,可以这样写.

[Bmob setBmobRequestTimeOut:15];

BmobSDK默认是20s后得不到回复就提示超时,如果没有特别的需求,建议不要设置该时间。

获取表结构

v1.6.1 开始,我们开放获取表结构的接口。

获取特定表的结构

可通过表名来获取特定表的结构,样例代码如下:

    [Bmob getTableSchemasWithClassName:@"_User" callBack:^(BmobTableSchema *bmobTableSchema, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            //直接用description来查看表结构
            NSLog(@"%@",bmobTableSchema.description);

            /*
             分别打印表结构
            */
            //打印表名
            NSLog(@"表名:%@",bmobTableSchema.className);
            //打印表结构
            NSDictionary *fields = bmobTableSchema.fields;
            NSArray *allKey = [fields allKeys];
            for (NSString *key in allKey) {
                NSLog(@"列名:%@",key);
                NSDictionary *fieldStrcut = [fields objectForKey:key];
                NSLog(@"列类型:%@",[fieldStrcut objectForKey:@"type"] );
                if ([[fieldStrcut objectForKey:@"type"] isEqualToString:@"Pointer"]) {
                    NSLog(@"关联关系指向的表名:%@",[fieldStrcut objectForKey:@"targetClass"]);
                }
            }
        }
    }];

获取所有表的结构

可通过以下代码得到所有表的结构

    [Bmob getAllTableSchemasWithCallBack:^(NSArray *tableSchemasArray, NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        } else {
            for (BmobTableSchema* bmobTableSchema in tableSchemasArray) {
                //直接用description来查看表结构
                NSLog(@"%@",bmobTableSchema.description);

                /*
                 分别打印表结构
                 */
                //打印表名
                NSLog(@"表名:%@",bmobTableSchema.className);
                //打印表结构
                NSDictionary *fields = bmobTableSchema.fields;
                NSArray *allKey = [fields allKeys];
                for (NSString *key in allKey) {
                    NSLog(@"列名:%@",key);
                    NSDictionary *fieldStrcut = [fields objectForKey:key];
                    NSLog(@"列类型:%@",[fieldStrcut objectForKey:@"type"] );
                    if ([[fieldStrcut objectForKey:@"type"] isEqualToString:@"Pointer"]) {
                        NSLog(@"关联关系指向的表名:%@",[fieldStrcut objectForKey:@"targetClass"]);
                    }
                }
            }
        }
    }];

返回数据说明

表结构以 BmobTableSchema 对象的形式返回,其中属性 className 表示表名,而属性 fields 是一个字典,里面包含了所有列的类型,其结构如下:

{@"列名1":dic,@“列名2”:dic}

而dic的结构为:

{@"type":@"typeName",@"targetClass":@"tableName"}

其中 type 指的是该类的类型, 而 targetClass 指的是指向的表名,只有在 typePointer 或者 Relation 时才有值。

具体形式如下:

{
    ACL =     {
        type = Object;
    };
    author =     {
        targetClass = "_User";
        type = Pointer;
    };
    content =     {
        type = String;
    };
    createdAt =     {
        type = Date;
    };
    likes =     {
        targetClass = "_User";
        type = Relation;
    };
    objectId =     {
        type = String;
    };
    skill =     {
        type = Array;
    };
    title =     {
        type = String;
    };
    updatedAt =     {
        type = Date;
    };
};

错误码列表

以下是iOS的错误码列表,如果在开发过程中还遇到其他的错误信息,请查找我们的RestAPI错误码列表

100

内容:It is busy...Try it later!

含义:一般是请求服务器的内容有误,如果是查询的话,请检查一下查询条件是否有误。

20000

内容:nil password!

含义:登录或者注册时输入的密码为空。

20001

内容:nil username!

含义:登录或者注册时输入的用户名为空。

20002

内容:connect failed!

含义:请求失败。

20003

内容:none objectid!

含义:更新对象、删除对象、查询单个对象时没有objectid

20004

内容:none object!

含义:查询时,查询结果为空

20005

内容:expired!

含义:缓存查询时,查询时间已过期

20006

内容:cloud function failed!

含义:云端逻辑调用失败

20008

内容:none filename!

含义:上传文件时,文件名为空

20009

内容:none file!

含义:上传文件时,找不到文件

20010

内容:unknow error!

含义:未知错误

20011

内容:none filendata!

含义:上传文件时,文件内容为空

20012

内容:update content is nil!

含义:更新时,更新内容为空

20013

内容:fuction name is nil!

含义:调用云端逻辑时,函数名为空

20014

内容:array is too big!

含义:批量操作时,传入的数组超过界限

20015

内容:nil array!

含义:批量操作时,传入的数组为空

20016

内容:nil push content!

含义:推送时,推送内容为空

20017

内容:init is not finish,please wait a moment

含义:初始化未完成

20023

内容:init fail

含义:初始化失败

20024

内容:format error

含义:批量文件上传时格式错误

20025

内容:nil class name

含义:表名为空

20027

内容:string is nil or equal ""

含义:传的参数有错,一般是传入空字符串造成

20028

内容:Invalid mobile phone number, the format can't be empty or null

含义:非法手机号

20029

内容:Invalid sms code, the format can't be empty or null

含义:非法验证码

20030

内容:File not exist

含义:获取文件url、删除文件时传入的文件名不存在