Skip to content

Latest commit

 

History

History
569 lines (398 loc) · 20 KB

status_system.md

File metadata and controls

569 lines (398 loc) · 20 KB
Raw

事件流系统

事件流系统在应用开发中, 出现的场景非常多, 比如常见的用户关注, 朋友圈, 私信等, 都需要事件流系统的支持.

基本概念

Status

是指一条广义上的状态,不只可以表示某个用户更新了状态, 还可以表示任意的一个事件,比如某人发布了一篇文章, 某个图片被赞等.

Follower/Followee

分别表示用户的粉丝和用户的关注, 在控制台中对应着两张表_Follower和_Followee.

特别提示

发了一条状态, 并不代表会自动发送了一条push消息（也就是推送通知）, 开发者可以自由的实现push与否。关于消息推送请参考消息推送开发指南

JavaScript SDK的使用方法

用户关系

AV.User新增两个方法follow和unfollow来建立用户关系，你可以关注某个用户：

AV.User.current().follow('52f9be45e4b035debf88b6e2').then(function(){
    //关注成功
}, function(err){
    //关注失败
    console.dir(err);
});

follow方法接收一个AV.User对象或者User对象的objectId（通过user.id拿到）。

取消关注使用unfollow方法：

AV.User.current().unfollow('52f9be45e4b035debf88b6e2').then(function(){
    //取消关注成功
}, function(err){
    //取消关注失败
    console.dir(err);
});

关注后，可以查询自己关注的用户列表，使用AV.User#followeeQuery得到一个AV.Query对象来查询关注的用户列表：

var query = AV.User.current().followeeQuery();
query.include('followee');
query.find().then(function(followees){
   //关注的用户列表followees
});

followee是一个Pointer类型，通过include将它的所有信息查询包括进来，否则只会返回用户的id。当查询计数的时候（使用AV.Query#count方法）不建议include。

查询自己的粉丝（他人关注了我，他人就是我的粉丝），可以通过followerQuery方法：

var query = AV.User.current().followerQuery();
query.include('follower');
query.find().then(function(followers){
   //粉丝列表followers
});

followerQuery和followerQuery方法返回的AV.Query对象可以像普通的AV.Query对象那样使用，他们本质上都是查询数据管理平台中的_Follower和_Followee表，你可以添加order,skip,limit以及其他where条件等信息。

状态

关注了用户之后（也就是成为他的粉丝），你就会接收到该用户发送给他的粉丝的状态信息。例如，我喜欢了某个视频，我可以发送这条信息“我喜欢了视频xxxx”给我的粉丝。我的粉丝就可以在他们的收件箱(inbox)里收到这条状态信息。

发布状态

当前登录用户发送一条状态给关注他的粉丝： 的粉丝：

var status = new AV.Status('视频url', '我喜欢了视频xxxx.');
status.set('sound', 'sound.wmv');
AV.Status.sendStatusToFollowers(status).then(function(status){
    //发布状态成功，返回状态信息
	console.dir(status);
}, function(err){
    //发布失败
    console.dir(err);
});

发布状态成功，粉丝的收件箱不一定马上能看到，因为发布过程是一个异步的过程，会有一定的延迟，通常这个延迟都不大（几秒之内）。发送状态必须处于用户登录状态，使用AV.Status.sendStatusToFollowers将发送给登录用户的粉丝。

AV.Status对象包含下列属性：

  • id 对象的objectId
  • messageId 状态在某个用户收件箱的消息编号，发件箱返回的status则没有此属性，messageId可用于收件箱的分页查询，见下文。
  • inboxType 收件箱类型，默认是timeline收件箱，也就是default。SDK默认提供private表示私信，default表示timeline，您也可以自定义。
  • data 状态属性，一个JSON对象，可通过get和set方法获取和设置
  • createdAt 消息的创建时间

其中data.source属性是保留属性，默认指向状态的发布者。

发送私信给某个用户

我还可以发送一条私信给单独某个用户：

var status = new AV.Status(null, '秘密消息');
AV.Status.sendPrivateStatus(status,'52f9be45e4b035debf88b6e2').
  then(function(status){
    //发送成功呢
	console.dir(status);
   }, function(err){
    //发布失败
    console.dir(err);
});

AV.Status.sendPrivateStatus的第二个参数指定私信接收的用户或者用户的objectId。

发送给自定义收件箱

通过send方法还可以自定义inboxType:

var query = ... //一个AV.Query对象，定义接收者。
var status = new AV.Status(null, '我读了《clojure编程乐趣》');
//定义一个book收件箱
status.inboxType = 'book';
status.query = query;
status.send().then(function(status){
  //发送成功
});

查询收件箱

查询我的timeline收件箱，可以通过AV.Status.inboxQuery方法：

var query = AV.Status.inboxQuery(AV.User.current());
query.find().then(function(statuses){
  //查询成功，返回状态列表，每个对象都是AV.Status
}, function(err){
  //查询失败
  console.dir(err);
});

收件箱返回的status列表，每个status都有messageId属性，表示这条status在这个收件箱里的唯一编号，AV.InboxQuery有两个方法用于限制messageId的范围：sinceId和maxId。其中:

  • sinceId设定查询返回的status的messageId必须大于传入的message id，
  • maxId限定查询返回的status的messageId必须小于等于传入的message id。

通过sinceId和maxId可以实现分页查询：

  • 查询本次查询之后新增的status（向后翻页刷新）:
//假设messageId是上次查询返回的status的最大messageId编号
var messageId = ...
var query = AV.Status.inboxQuery(AV.User.current());
query.sinceId(messageId);
//查询从上次查询返回结果之后的更新status
query.find().then(function(statuses){
  //查询成功，返回状态列表，每个对象都是AV.Status
}, function(err){
  //查询失败
  console.dir(err);
});
  • 查询本次查询的前一页（也就是更老的status，向前翻页）:
//假设messageId是上次查询返回的status的最大messageId编号
var messageId = ...
var query = AV.Status.inboxQuery(AV.User.current());
query.maxId(messageId);

AV.Status.inboxQuery还可以指定收件箱的类型，默认是查询timeline收件箱，也可以查询私信收件箱：

var query = AV.Status.inboxQuery(AV.User.current(), 'private');

查询收件箱未读状态数目

使用AV.Status.countUnreadStatuses可以查询某个收件箱的未读状态数目和总数目：

AV.Status.countUnreadStatuses(AV.User.current()).then(function(result){
	console.dir(result);
	var total = result.total;
	var unread  = result.unread;
}, function(err){
    //查询失败
});

查询发件箱

查询我发出去的状态信息，可以通过statusQuery方法：

var query = AV.Status.statusQuery(AV.User.current());
query.find().then(function(statuses){
  //查询成功，返回状态列表，每个对象都是AV.Object
}, function(err){
  //查询失败
  console.dir(err);
});

AV.Status.statusQuery返回的是一个普通的AV.Query对象，本质上是查询数据管理平台的_Status表。您可以自主添加更多查询条件。

iOS SDK中的使用方法

状态

发布状态

发布一条时间线状态, 即发一条我的粉丝可以看到的状态

AVStatus *status=[[AVStatus alloc] init];

status.data=@{@"text":@"data type change"};

[AVUser logInWithUsername:@"travis" password:@"123456"];
[AVStatus sendStatusToFollowers:status andCallback:^(BOOL succeeded, NSError *error) {
    NSLog(@"============ Send %@", [status debugDescription]);
}];

其中status.data可以任意指定NSDictionary数据. 注意: 这个字典中的source字段不可用，内部保留

发私信

给某个用户发私信也非常简单

AVStatus *status=[[AVStatus alloc] init];
status.data=@{@"text":@"this is a private message"};

NSString *userObjectId=@"XXXXXXXXXXXXX";

[AVStatus sendPrivateStatus:status toUserWithID:userObjectId andCallback:^(BOOL succeeded, NSError *error) {
    NSLog(@"============ Send %@", [status debugDescription]);
}];

自定义状态

除了上面常见两种场景, 自定义状态可以通过设置受众群体和发送者 来实现更加灵活的功能

AVStatus *status=[[AVStatus alloc] init];
[status setData:@{@"text":@"we have new website, take a look!",@"link":@"http://avoscloud.com"}];

status.type=@"system";

AVQuery *query=[AVUser query];
[query whereKey:@"age" equalTo:@(20)];
[status setQuery:query];

[status sendInBackgroundWithBlock:^(BOOL succeeded, NSError *error) {

}];

上面是系统广播的基本实现. 因为指定了一个AVUser查询,所以会发送给所有age=20的用户, 指定了type是system或者任意字符串, 则所有用户会在查询这个类型的状态中看到这一条.

获取状态

下面代码会获取用户时间线上的50条状态

AVStatusQuery *query=[AVStatus inboxQuery:kAVStatusTypeTimeline];

//限制50条
query.limit=50; 

//限制1397这个messageId上次查询的最大messageId, 如果不设置,默认为最新的
query.maxId=1397;  
   
//需要同时附带发送者的数据
[query includeKey:@"source"];

[query findObjectsInBackgroundWithBlock:^(NSArray *objects, NSError *error) {
    //获得AVStatus数组
}];

同理, 可以获得用户的私信,只要把参数改为kAVStatusTypePrivateMessage。返回的AVStatus对象有一个messageId属性，用于唯一表示这条Status在这个inbox里的标示符。可以用这个id结合query做分页查询。

AVStatusQuery可以设置sinceId和maxId:

  • sinceId设定查询返回的status的messageId必须大于传入的message id，
  • maxId限定查询返回的status的messageId必须小于等于传入的message id。

使用这两个id就可以做分页查询。AVStatusQuery查询不支持skip

获取收件箱的未读status数目（从上次访问收件箱最新status到现在的未读status数目）可以通过[AVStatus getUnreadStatusesCountWithType:andCallback]方法。

下面的代码是某个用户发送出去的状态,请注意,查询发送出去的状态,是无法用messageId(sinceId,maxId)来做分片查询的,因为messageId只是相对于某个用户的Inbox才有意义, 同时返回的状态中也没有messageId的数据

AVStatusQuery *query=[AVStatus statusQuery];

//设置查询某个用户, 默认是查询当前用户
[query whereKey:@"source" equalTo:<AVUser>];

//限制条数
query.limit=20;

//设置消息类型
query.inboxType=kAVStatusTypeTimeline;

[query findObjectsInBackgroundWithBlock:^(NSArray *objects, NSError *error) {
    //获得AVStatus数组
}];

好友关系

关注和取消关注

NSString *userObjectId  =@"XXXXXX";

//关注
[[AVUser currentUser] follow:userObjectId andCallback:^(BOOL succeeded, NSError *error) {
    if (error.code==kAVErrorDuplicateValue) {
        //重复关注
    }

}];

//取消关注
[[AVUser currentUser] unfollow:userObjectId andCallback:^(BOOL succeeded, NSError *error) {

}];

获取粉丝和关注列表

有2个特殊的AVQuery:

//粉丝列表查询
AVQuery *query= [AVUser followerQuery:@"USER_OBJECT_ID"];

//关注列表查询
AVQuery *query= [AVUser followeeQuery:@"USER_OBJECT_ID"];

是分别获得某个用户的粉丝和关注, 我们也可以同时取得这这两种:

[[AVUser currentUser] getFollowersAndFollowees:^(NSDictionary *dict, NSError *error) {
    NSArray *followers=dict[@"followers"];
    NSArray *followees=dict[@"followees"];
}];

Android SDK中的使用方法

Android的事件流已经正式发布，欢迎尝试！

状态

发布状态

发布一条时间线状态, 即发一条我的粉丝可以看到的状态

AVStatus status= new AVStatus();
// 或者您也可以使用静态方法
// AVStatus status = AVStatus.createStatus("my image", "my message");
status.setImageUrl("myImageUrl");
status.setMessage("myMessage");
// 或者您也可以使用方法
// setData(Map<String, Object> data)

AVUser.logIn("myUserName", "myPassword");
AVStatus.sendStatusToFollowersInBackgroud(status, new SaveCallback() {
    @Override
    public void done(AVException parseException) {
        Log.i(TAG, "Send status finished.");
    }
});

其中status.setData可以任意指定Map<String, Object>数据. 注意: 这个map中的source字段不可用

发私信

给某个用户发私信也非常简单

AVStatus status = AVStatus.createStatus("test image", "test message");
AVStatus.sendPrivateStatusInBackgroud(status, "user object id", new SaveCallback() {
    @Override
    public void done(AVException parseException) {
        Log.i(TAG, "Send private status finished.");
    }
});

自定义Status

除了上面常见两种场景, 自定义Status可以通过设置受众群体和发送者来实现更加灵活的功能

Map<String, Object> data = new HashMap<String, Object>();
data.put("text", "we have new website, take a look!");
data.put("link", "http://avoscloud.com");
AVStatus status = AVStatus.createStatusWithData(data);
status.setInboxType("system"); 

    status.sendInBackgroundWithBlock(new SaveCallback() {
        @Override
        public void done(AVException e) {
            Log.i(TAG, "Send finished");

        }
    });

上面是系统广播的基本实现. 因为指定了一个无条件的AVUser查询,所以会发送给所有的用户, 指定了inboxType是system或者任意字符串, 则所有用户会在查询这个类型的状态中看到这一条.我们在SDK中间为您准备两种预定的类型:AVStatus.INBOX_TYPE.TIMELINE和AVStatus.INBOX_TYPE.PRIVATE。

获取收件箱状态

下面代码会获取用户收件箱内时间线上的50条状态

  AVStatusQuery<AVStatus> inboxQuery = AVStatus.inboxQuery(AVStatus.class, userB,AVStatus.INBOX_TYPE.TIMELINE.toString());
  inboxQuery.setLimit(50);  //设置最多返回50条状态
  inboxQuery.setSinceId(0);  //查询返回的status的messageId必须大于sinceId，默认为0
  inboxQuery.findInBackground(new FindCallback<AVStatus>(){
    @Override
    public void done(final List<AVStatus> parseObjects, final AVException parseException) {

    }
  });

同理, 可以获得用户收件箱的私信,只要把type参数改为AVStatus.INBOX_TYPE.PRIVATE.toString()即可

AVStatus有一个messageId属性，用于标示这条status在inbox里的唯一位置。使用这个messageId结合AVStatusQuery可以做分页查询，AVStatusQuery可以设置sinceId和maxId：

  • sinceId设定查询返回的status的messageId必须大于传入的message id，
  • maxId限定查询返回的status的messageId必须小于等于传入的message id。

使用这两个id就可以做分页查询。AVStatusQuery查询不支持skip。

获取收件箱的计数

使用AVStatus.getUnreadStatusesCountInBackground方法可以查询收件箱的未读status数目和总status数目：

AVStatus.getUnreadStatusesCountInBackground(AVStatus.INBOX_TYPE.TIMELINE.toString(), new CountCallback() {
        public void done(int count, AVException e) {
            if (e == null) {
                //count就是未读status数目
            } else {
                //有错误发生。
            }
        }
    });

查询发件箱状态

下面的代码能够查询当前用户发件箱内已经发送的50条状态

  AVStatusQuery<AVStatus> query = AVStatus.statusQuery(AVStatus.class,AVUser.getCurrentUser());
  query.setLimit(50);    //设置最多返回50条状态
  query.setSinceId(0);   //查询返回的status的messageId必须大于sinceId，默认为0
  //query.setInboxType(AVStatus.INBOX_TYPE.TIMELINE.toString()); 此处可以通过这个方法来添加查询的状态条件，当然这里你也可以用你自己定义的状态类型，因为这里接受的其实是一个字符串类型。
  query.findInBackground(new FindCallback<AVStatus>(){
    @Override
    public void done(final List<AVStatus> parseObjects,final AVException parseException) {

    }
  });

好友关系

关注和取消关注

//关注
AVUser.getCurrentUser().followInBackground(userObjectId, new FollowCallback() {
        @Override
        public void done(AVObject object, AVException e) {
            if (e == null) {
                Log.i(TAG, "follow succeed.");
            } else if (e.getCode() == AVException.DUPLICATE_VALUE) {
                Log.w(TAG, "Already followed.");
            }
        }
    });


//取消关注
AVUser.getCurrentUser().unfollowInBackground("the user object id", new FollowCallback() {
        @Override
        public void done(AVObject object, AVException e) {
            if (e == null) {
                Log.i(TAG, "unfollow succeed.");
            } else {
                Log.w(TAG, "unfollow failed.");
            }
        }
    });

获取粉丝和关注列表

您可以使用followerQuery/followeeQuery来查询您的粉丝/关注列表，这样可以设置更多的查询条件，比如

    // 其中userA是AVUser对象，您也可以使用AVUser的子类化对象进行查询
    AVQuery<AVUser> followerQuery = userA.followerQuery(AVUser.class);
    //AVQuery<AVUser> followerQuery = AVUser.followerQuery(userA.getObjectId(),AVUser.class); 也可以使用这个静态方法来获取非登陆用户的好友关系
    followerQuery.findInBackground(new FindCallback<AVUser>() {
        @Override
        public void done(List<AVUser> parseObjects, AVException parseException) {
            // parseObjects包含了userA的粉丝列表
        }
    });

    AVQuery<AVUser> followeeQuery = AVUser.followeeQuery(userB.getObjectId(), AVUser.class);
    //AVQuery<AVUser> followeeQuery = userB.followeeQuery(AVUser.class);
    followeeQuery.findInBackground(new FindCallback<AVUser>() {
        @Override
        public void done(List<AVUser> parseObjects, AVException parseException) {
            Assert.assertTrue(parseException == null);
            Assert.assertTrue(parseObjects.size() > 0);
            Assert.assertTrue(containsUser(parseObjects, userA));
            AVLock.go();
        }
    });

通过AVQuery，您也可以增加skip或者limit操作，比如

        AVQuery<AVUser> followerSkipQuery = AVUser.followerQuery(userA.getObjectId(), AVUser.class);
        followerSkipQuery.setLimit(1);
        followerSkipQuery.skip(i);
        followerSkipQuery.findInBackground(new FindCallback<AVUser>() {
            @Override
            public void done(List<AVUser> parseObjects, AVException parseException) {
                // parseObjects.size() == 1
            }
        });
    }

您也可以查找某个特定的粉丝，比如

    AVQuery<AVUser> followerNameQuery = userA.followerQuery(userA.getObjectId(), AVUser.class);
    followerNameQuery.whereEqualTo("follower", userC);
    followerNameQuery.findInBackground(new FindCallback<AVUser>() {
        @Override
        public void done(List<AVUser> parseObjects, AVException parseException) {
            // parseObjects中应当只包含userC
        }
    });

注：默认的得到的AVUser对象仅仅有ObjectId数据，如果需要整个AVUser对象所有属性，则需要调用include方法。例如

        AVQuery<AVUser> followerNameQuery = AVUser.followerQuery(userA.getObjectId(), AVUser.class);
        followerNameQuery.include("follower");

        AVQuery<AVUser> followeeNameQuery = AVUser.followeeQuery(userA.getObjectId(), AVUser.class);
        followerNameQuery.include("followee");