跳到主要内容

聊天功能

概要​

在Mobage JS SDK 中,可将 Chat 功能作为 Widget 植入应用软件进行使用。
植入Chat Widget 进行使用时,需要实现使用 RESTful API创建的 Chat 通道。
Chat 通道可在每个游戏内自由生成,也可从游戏向任意的通道发送信息。
在本教程中,将开发实现Chat 功能所需处理的程序。

注意
  • 1 个用户创建1 个聊天室,禁止只向特定用户发送信息(游戏通知)的行为。
  • 1个应用软件可生成通道的最大条数为 1,000,000 条。

Chat 功能的概要图如下。
在本概要图中,列出了 Mobage JS SDK 、 Widget 、 RESTful API 的关系。

关于图中所述主要实现位置,请从下述链接确认页面中的说明。

处理页面中的相应位置
A.无
B.生成聊天通道
C.使用People API ,获取好友的用户 ID 列表
D.对Chat Member API进行POST,将登录的用户及其好友添加至通道
E.显示用户的聊天列表
F.显示聊天画面
G.动作确认

需创建的文件列表​

在本教程中,要创建的文件如下所述。

文件名概要
config.php各种设置值的汇总
profile.js在Client 端执行 mobage.api.people.get ,获取用户的个人简介
profile.php显示用户的个人简介
chat_list.js在Client 端执行 mobage.api.userChatChannel.get 。获取已注册的通道
chat_list.php显示聊天列表
chat.js在Client 端执行 mobage.ui.embed ,将Chat Widget 植入
chat.php将 Chat Widget 植入指定的 div 要素中
chat_create.php执行以下各种API,创建添加有好友的通道
client_credentials.php通过Client 认证获取 Access Token
create_channel.php执行Chat Channel API ,创建通道
get_friend_list.php执行People API ,获取梦宝友
add_member_to_channel.php执行Chat Member API ,在通道中添加成员
post_chat_message.php执行Chat Message API ,从游戏进行发贴

教程前序​

预先使用登录功能进行登录​

本教程在以下教程结束的前提下进行。
在以下教程中,如未创建文件,请先完成。

下载样例代码​

样例代码可从 Github 克隆。

$ git clone https:``//github.com/DeNADev/mobage-jssdk-sample-others.git

启用聊天功能​

要使用聊天功能,需要在Mobage Developers 上进行启用聊天功能的设置。
“SPWeb”选项卡的下方有聊天区。在游戏聊天引导线(Sandbox)中点击“ON”键启用。
要正式启用,请在游戏聊天引导线(正式用)中点击“ON”键。

另外,以上画面中有个人简介设置信息区,可设置在游戏聊天画面中触摸各用户图标时的跳转 URL。
如无任何设置,那么触摸图标不会有任何跳转。点击上述“编辑个人简介URL”键,会显示以下画面,在这里进行设置。

在本教程中,输入如下。

http://example.com/mobage-jssdk-sample-others/chat/profile.php?user_id={user_id}

在本教程中,通过People API 显示昵称和缩略图,也可只显示游戏内的个人简介。
为了完成上述 URL ,将样例代码 profile.php、profile.js 配置在游戏服务器中。

开发的步骤​

为了实现“Chat功能”,按以下3大步骤进行。

  1. 显示用户的聊天列表
  2. 显示聊天画面
  3. 生成聊天通道

显示用户的聊天列表​

首先,开发用户已参加聊天列表的显示程序。
为了获取用户已参加的聊天通道的列表,使用Mobage JS SDK 的 mobage.api.userChatChannel.get 方法。
请参考样例代码中的 chat_list.php 和 chat_list.js 进行实现。

如下所示,使用 mobage.oauth.getConnectedStatus 进行 Mobage Connect 登录和游戏安装确认,然后执行。

var params = { state: clientData.state}; mobage.oauth.getConnectedStatus(params, function``(err, result) { if (result) { console.log(``'getConnectedStatus is OK'``); getUserChatChannel(); } else { console.log(err); } }); function getUserChatChannel() { mobage.api.userChatChannel.get({ userId: '@me'``, groupId: '@self'``, fields: [``'id'``, 'unreadMessages'``, 'updated' ]}, function``(err, result) { console.log(result); var channel_num = result.entry.length; var chat_channels = document.getElementById(``'mobage-chat-list'``); for (``var i=0;i<channel_num;i++) { var aTag = document.createElement(``'a'``); aTag.href = "./chat.php?channel_id=" + result.entry[i].id; aTag.innerHTML = 'Chat Room ' + result.entry[i].id + ' (' + result.entry[i].unreadMessages + ')'``; chat_channels.appendChild(aTag); var brTag = document.createElement(``'br'``); chat_channels.appendChild(brTag); } } ); }

对mobage.api.userChatChannel.get 方法的响应进行分析,获取 User Chat Channel 对象数组,使用for 语句生成对多条聊天画面的链接。
接着,将通道 ID 作为请求参数发送至要开发的 chat.php 链接中。

信息

可获取的通道数有多条时,默认获取上限为50 条。通过指定count 参数,最多可指定获取 1000 条。

此外,请将chat_create.php 链接添加至chat_list.php 的最下方生产新建聊天功能。

<``p``><``a href``=``'./chat_create.php'``>Create New Chat Channel</``a``></``p``>

显示聊天画面​

接着,开发实际显示聊天的画面。
根据请求参数获取通道ID,使用Mobage JS SDK 的 mobage.ui.embed 方法,将 Chat Widget 植入 UI 中。
关于实现,请参见样例代码中的 chat.js、chat.php。
 
如下所示,mobage.ui.embed 方法的第一参数指定 "chat" ,第二参数指定选项,进行 Chat 植入。

mobage.oauth.getConnectedStatus({state: clientData.state}, function``(err, result) { if (result) { mobage.ui.embed(``'chat'``, { targetId: 'mobage-sample-chat'``, channelId: 12345 }); } else { console.log(err); } });

通过在HTML文件中进行如下记载,将Chat Widget 植入。

植入前

<``div id``=``"mobage-sample-chat"``> </``div``>

植入后

<``div id``=``"mobage-sample-chat" class``=``"mbga-game-chat" data-plugins-type``=``"mbga-game-chat" data-talk-id``=``12345``"> <``iframe``> ... </``iframe``> </``div``>

关于Chat Widget 的详细说明,请参见以下链接。

生成聊天通道​

通过上述步骤可显示聊天,但如果没有聊天通道,就不能做出任何显示,因此要开发生成通道的程序。
关于实现,请参见样例代码中的 chat_create.php。

  1. 获取执行API 所需的 Access Token
  2. 对Chat Channel API 进行 POST ,生成空通道
  3. 使用People API ,获取好友的用户 ID 列表
  4. 对Chat Member API 进行POST ,将登录用户及其好友添加至通道
  5. 对Chat Message API 进行 POST ,从应用软件发送初始信息
信息

1个应用软件可生成的通道数有上限,因此请在游戏内事件终止等适当的时机请求删除。

获取执行API 所需的 Access Token​

首先,获取执行API 所需的 Access Token 。
为执行API ,准备有以下两种 Access Token 。

  • Authorization Code Grant 的 Access Token

  • Client Credentials Grant 的 Access Token

    Authorization Code Grant​

    使用在发行用户登录会话时,游戏服务器获取的 Authorization Code Grant 的 Access Token 。
    在此参见以下,使用在游戏服务器会话中进行管理的 Access Token 。
    获取 Authorization Code Grant 的 Access Token

    Client Credentials Grant​

    Client Credentials Grant 的 Access Token ,是 Client  API 执行权限 Access Token 。
    通过 Client Credentials Grant 发行Client 用 Access Token。

关于实现,请参见样例代码中的 client_credentials.php 。

client_credentials.php

$token_endpoint_request_params = [ 'grant_type'    => 'client_credentials'``, 'client_id'     => CLIENT_ID, 'client_secret' => $CLIENT_SECRETS``[CLIENT_ID] ]; $headers = [ 'Content-Type: application/x-www-form-urlencoded'``, 'Connection: close'``, ]; $options = [ 'http' => [ 'method'  => 'POST'``, 'content' => http_build_query(``$token_endpoint_request_params``), 'header'  => implode(``"\r\n"``, $headers``), ] ]; $raw_token_response = file_get_contents``(TOKEN_ENDPOINT_URL, false, stream_context_create(``$options``));

使用Token 响应获取的 JSON 的 access_token 字段的反馈值。

对 Chat Channel API 进行 POST ,生成空通道​

接着,对 Chat Channel API 进行POST ,生成空通道。
Chat Channel API 支持 Authorization Code Grant 和 Client Credentials Grant 两者,因此可使用任意 Access Token 。
在此使用 Client Credentials Grant 的 Access Token ,开发用于执行以下处理的程序 create_channel.php 。
关于实现,请参见样例代码中的  create_channel.php 。

create_channel.php

$http_method  = "POST"``; $url_fragment = "/@app/channels"``; // generate Authentication Header $endpoint = CHAT_END_POINT . $url_fragment``; $auth_header = array``( "Authorization: Bearer " . $access_token``, "Accept: */*"``, "Content-Type: application/json; charset=utf-8" ); $channel_data = array``( 'name' => $channel_name``, 'shortName' => $channel_shortname ); $body = json_encode(``$channel_data``); // access to platform server $curl = curl_init(``$endpoint``); $is_post_method = (``$http_method == 'POST'``) ? true : false; curl_setopt(``$curl``, CURLOPT_POST, $is_post_method``); curl_setopt(``$curl``, CURLOPT_POSTFIELDS, $body``); curl_setopt(``$curl``, CURLOPT_RETURNTRANSFER, true); curl_setopt(``$curl``, CURLOPT_FAILONERROR, false); curl_setopt(``$curl``, CURLOPT_ENCODING , "gzip"``); curl_setopt(``$curl``, CURLOPT_HTTPHEADER, $auth_header``); curl_setopt(``$curl``, CURLINFO_HEADER_OUT, true); curl_setopt(``$curl``, CURLOPT_HEADER, true); $response = curl_exec(``$curl``);

使用People API ,获取好友的用户 ID 列表​

接着,对 People API 进行 GET ,获取登录用户的好友用户 ID 列表。
People API 只支持 Authorization Code Grant ,因此使用 Authorization Code Grant 的 Access Token。
在此开发用于执行以下处理的程序 get_friend_list.php 。
关于实现,请参见样例代码中的 get_friend_list.php 。

get_friend_list.php

function getFriendList(``$access_token``) { $http_method  = "GET"``; $url_fragment = "/@me/@friends"``; // generate Authentication Header $endpoint = PEOPLE_END_POINT . $url_fragment``; $auth_header = array``( "Authorization: Bearer " . $access_token``, "Accept: */*" ); // access to platform server $curl = curl_init(``$endpoint``); $is_post_method = (``$http_method == 'POST'``) ? true : false; curl_setopt(``$curl``, CURLOPT_POST, $is_post_method``); curl_setopt(``$curl``, CURLOPT_RETURNTRANSFER, true); curl_setopt(``$curl``, CURLOPT_FAILONERROR, false); curl_setopt(``$curl``, CURLOPT_ENCODING , "gzip"``); curl_setopt(``$curl``, CURLOPT_HTTPHEADER, $auth_header``); curl_setopt(``$curl``, CURLINFO_HEADER_OUT, true); curl_setopt(``$curl``, CURLOPT_HEADER, true); $response = curl_exec(``$curl``); $curl_header_res_size = curl_getinfo(``$curl``, CURLINFO_HEADER_SIZE); $curl_body_res        = substr``(``$response``, $curl_header_res_size``); $decoded_response = json_decode(``$curl_body_res``, true); // If http status code isn't 200, die and respond as 500 Internal Server Error. if (!(``$http_status_code == 200)) { die``; } return $decoded_response``; }

接着,安装对 Chat Members API 进行 POST 的数据。People API 可获取的用户 ID 带有域名前缀,因此进行substring 。

chat_create.php

$friends = getFriendList(``$authorization_code_access_token``); $entry   = $friends``[``'entry'``]; // create Chat Member Format $chat_members = array``(); for``(``$i = 0; $i < count``(``$entry``); ++``$i``) { $global_id = $entry``[``$i``][``'id'``]; $local_id = substr``(``$global_id``, strpos``(``$global_id``, ':'``) + 1); // remove prefix $member = array``( 'objectType' => 'person'``, 'localId' => $local_id``); array_push``(``$chat_members``, $member``); } $viewer = array``( 'objectType' => 'person'``, 'localId' => $_SESSION``[``'user_id'``] ); array_push``(``$chat_members``, $viewer``);

对Chat Member API进行 POST ,将登录用户及其好友添加至通道​

接着,对Chat Member API进行 POST,将登录的用户及其好友添加至聊天。
Chat Member API 支持 Authorization Code Grant 和 Client Credentials Grant 两者,因此可使用任意 Access Token。
在此开发使用 Client Credentials Grant 的 Access Token 执行以下处理的程序 add_member_to_channel.php 。
如果添加了多个好友,那么HTTP 状态会变为 207 ,需考虑。此次确认不包括响应的内容。
 
关于实现,请参见样例代码中的 add_member_to_channel.php 。

add_member_to_channel.php

$http_method  = "POST"``; $url_fragment = "/@app/channels"``; // generate Authentication Header $endpoint = CHAT_END_POINT . $url_fragment . '/' . $channel_id . '/members'``; $auth_header = array``( "Authorization: Bearer " . $access_token``, "Accept: */*"``, "Content-Type: application/json; charset=utf-8" ); // POST Body with Chat Members $body = json_encode(``$chat_members``); // access to platform server $curl = curl_init(``$endpoint``); $is_post_method = (``$http_method == 'POST'``) ? true : false; curl_setopt(``$curl``, CURLOPT_POST, $is_post_method``); curl_setopt(``$curl``, CURLOPT_POSTFIELDS, $body``); curl_setopt(``$curl``, CURLOPT_RETURNTRANSFER, true); curl_setopt(``$curl``, CURLOPT_FAILONERROR, false); curl_setopt(``$curl``, CURLOPT_ENCODING , "gzip"``); curl_setopt(``$curl``, CURLOPT_HTTPHEADER, $auth_header``); curl_setopt(``$curl``, CURLINFO_HEADER_OUT, true); curl_setopt(``$curl``, CURLOPT_HEADER, true); $response = curl_exec(``$curl``);

对Chat Message API 进行 POST ,从应用软件发送初始信息​

接着,对Chat Message API 进行 POST ,从应用软件发送初始信息。
Chat Message API 中的 POST 只支持 Client Credentials Grant ,因此使用 Client Credentials Grant 的 Access Token。
在此开发用于执行以下处理的程序 post_chat_message.php 。
关于实现,请参见样例代码中的 post_chat_message.php 。

post_chat_message.php

$http_method  = "POST"``; $url_fragment = "/@app/channels"``; // generate Authentication Header $endpoint = CHAT_END_POINT . $url_fragment . '/' . $channel_id . '/messages'``; $auth_header = array``( "Authorization: Bearer " . $access_token``, "Accept: */*"``, "Content-Type: application/json; charset=utf-8" ); $message_data = array``( 'actor' => array``( 'objectType' => 'application'``, 'localId' => APPLICATION_ID ), 'payload' => array``( 'message' => $message ) ); $body = json_encode(``$message_data``); // access to platform server $curl = curl_init(``$endpoint``); $is_post_method = (``$http_method == 'POST'``) ? true : false; curl_setopt(``$curl``, CURLOPT_POST, $is_post_method``); curl_setopt(``$curl``, CURLOPT_POSTFIELDS, $body``); curl_setopt(``$curl``, CURLOPT_RETURNTRANSFER, true); curl_setopt(``$curl``, CURLOPT_FAILONERROR, false); curl_setopt(``$curl``, CURLOPT_ENCODING , "gzip"``); curl_setopt(``$curl``, CURLOPT_HTTPHEADER, $auth_header``); curl_setopt(``$curl``, CURLINFO_HEADER_OUT, true); curl_setopt(``$curl``, CURLOPT_HEADER, true); $response = curl_exec(``$curl``);

至此,完成功能的实现。

动作确认​

下面,按如下所述,将开发的程序配置于 Game Server。

文件名URL
config.phphttp://example.com/mobage-jssdk-sample-others/config.php
profile.jshttp://example.com/mobage-jssdk-sample-others/chat/profile.js
profile.phphttp://example.com/mobage-jssdk-sample-others/chat/profile.php
chat_list.jshttp://example.com/mobage-jssdk-sample-others/chat/chat_list.js
chat_list.phphttp://example.com/mobage-jssdk-sample-others/chat/chat_list.php
chat.jshttp://example.com/mobage-jssdk-sample-others/chat/chat.js
chat.phphttp://example.com/mobage-jssdk-sample-others/chat/chat.php
chat_create.phphttp://example.com/mobage-jssdk-sample-others/chat/chat_create.php
client_credentials.phphttp://example.com/mobage-jssdk-sample-others/chat/client_credentials.php
create_channel.phphttp://example.com/mobage-jssdk-sample-others/chat/create_channel.php
get_friend_list.phphttp://example.com/mobage-jssdk-sample-others/chat/get_friend_list.php
add_member_to_channel.phphttp://example.com/mobage-jssdk-sample-others/chat/add_member_to_channel.php
post_chat_message.phphttp://example.com/mobage-jssdk-sample-others/chat/post_chat_message.php
信息

为了进入本教程,需要准备可接收Platform 请求的 Game Server。
在本教程中,假设已准备可接收Platform请求的Game Server,域名为example.com,以此为前提进入说明。

为确认聊天动作,要事先准备User1 和 User2 两个帐号。另外,此次实现中要创建好友聊天,因此事先要建立User1 与 User2 的好友关系。

备注
  • 可参加聊天的成员需要事先安装对象游戏,请事先为User1 和 User2 完成游戏安装。

在index.html 中添加链接等,以User1 身份登录,尝试从终端访问 chat_list.php 。
尚未创建通道,因此会显示以下画面。
 

 
触摸“Create New Chat Channel”链接,会显示聊天画面与来自游戏的初始信息。
 

在此从User1 写入适当信息。
 

接着,试着在 User2 显示 chat_list.php 。会显示刚才 User1 创建的通道,状态为有1条未读信息。
 

User2 也尝试发送信息。在User1 端也会显示信息。
 

至此,好友聊天教程完成。

注意事项​

  • 请使用2.8.0及更高版本的JS SDK。

开发的代码​

本教程开发的代码可从 Github 克隆。

$ git clone https:``//github.com/DeNADev/mobage-jssdk-sample-others.git

参考资料​

  • People API 的详情请参见这里。
  • User Chat Channel API 的详情请参见这里。
  • Chat Channel API 的详情请参见这里。
  • Chat Member API 的详情请参见这里。
  • Chat Message API 的详情请参见这里。
  • 聊天服务的详情请参见这里。