插件窝 干货文章 如何在ThinkPHP6中使用腾讯云IM进行实时通信操作?

如何在ThinkPHP6中使用腾讯云IM进行实时通信操作?

腾讯 SDK gt class 505    来源:    2024-10-24

随着互联网和移动互联网的快速发展,实时通信技术已经成为了许多应用中不可或缺的一环。而腾讯云im(即即时通信im)作为国内领先的实时通讯平台之一,其功能和性能也得到了广泛的认可。本文将介绍如何在thinkphp6框架中使用腾讯云im进行实时通信操作。

一、申请腾讯云IM账号

首先,需要到腾讯云官网(https://cloud.tencent.com/product/im)进行注册和申请IM服务。注册完成后,到控制台中创建应用并获取对应的SDKAppID、Identifier和SecretKey,这些信息将在后续配置中用到。

二、安装官方IM SDK

腾讯云提供了多种语言的IM SDK供开发者使用,本文主要介绍的是PHP版本的IM SDK。进入官方GitHub库(https://github.com/tencentyun/TIMServer/tree/master/examples/php)下载最新的php-sdk-v4。

立即学习“PHP免费学习笔记(深入)”;

在ThinkPHP6应用目录下,通过composer安装ImSDK包,执行命令:composer require tencentyun/php-sdk-v4:latest,以此实现IM SDK的自动载入。

三、配置IM SDK

在ThinkPHP6的项目配置文件(默认为config/app.php)中,添加如下配置项:

'imsdk' => [
    'sdk_app_id'   => 'SDKAppID',   // 应用ID
    'identifier'   => 'Identifier', // 用户标识
    'exp_time'     => 86400,        // 身份凭证有效时间(单位:秒)
    'private_key'  => 'SecretKey',  // 应用密钥
    'public_key'   => 'PublicKey',  // 公钥,非必填项
    'http_scheme'  => 'https',      // HTTPS协议
    'account_type' => '1',          // 账号类型,非必填项
],

其中,sdk_app_id为申请IM服务时获得的应用ID,identifier为用户在应用中的标识,exp_time为身份凭证的有效时间,private_key为申请IM服务时获得的应用密钥,http_scheme为通信协议,account_type为账号类型(默认为1)。

四、集成IM SDK

在ThinkPHP6中可以使用服务容器来集成IM SDK,首先需要在项目根目录下创建一个Service目录,在该目录下新建一个IMService类。该类的代码如下:

<?php
namespace appservice;

use IlluminateSupportFacadesLog;
use TencentyunTIMTIMSdk;

class IMService
{
    private $sdk;

    public function __construct()
    {
        $sdk = new TIMSdk(config('imsdk.sdk_app_id'), config('imsdk.identifier'));
        $sdk->setPrivateKey(config('imsdk.private_key'));
        $sdk->setPublickey(config('imsdk.public_key', ''));
        $sdk->setExpire(config('imsdk.exp_time'));
        $sdk->setAccountType(config('imsdk.account_type', '1'));
        $sdk->setHttpScheme(config('imsdk.http_scheme', 'https'));
        $this->sdk = $sdk;
    }

    public function createGroup($name)
    {
        $group = $this->sdk->getGroup();
        $data = [
            'Type' => 'Public',   // 群组类型(Public:公开群)
            'Name' => $name,      // 群组名称
        ];
        return $group->create($data);
    }
}

这个类主要实现了创建一个IM服务实例,并封装了一些IM操作,例如创建群组。

接下来,在config/目录下创建一个im.php文件,用于设置服务容器的绑定,代码如下:

<?php
use appserviceIMService;
return [
    'im' => IMService::class,
];

这段代码将IMService类与服务容器中的名称im进行绑定。

最后,在需要使用IM服务的地方,例如控制器中,可以通过依赖注入使用已绑定的服务,如下:

<?php
namespace appcontroller;

use appserviceIMService;
use thinkacadeRequest;

class Index
{
    public function index(IMService $im)
    {
        $groupName = Request::param('groupName');
        $result = $im->createGroup($groupName);
        if ($result['ErrorCode'] > 0) {
            return json([
                'code' => 0,
                'msg'  => $result['ErrorInfo'],
            ]);
        }
        return json([
            'code' => 1,
            'msg'  => '创建群组成功',
            'data' => [
                'groupId' => $result['GroupId'],
            ],
        ]);
    }
}

以上代码通过依赖注入IMService服务,在控制器中使用该服务创建了一个腾讯云IM的群组,返回了群组ID。可以根据需要进行其他IM操作。

五、结语

本文介绍了如何在ThinkPHP6中使用腾讯云IM进行实时通信操作。通过配置、集成和依赖注入,可以轻松地使用腾讯云IM进行各种实时通信操作,例如创建群组、发送消息等。此外,还可以根据具体需要进行更多的IM功能开发,例如实现即时通讯、视频通话等。