human: 如何处理七牛云的低代码互动直播服务端接入指南

gpt: [低代码](https://developer.qiniu.com/lowcode) > 使用文档 >
[互动直播](https://developer.qiniu.com/lowcode/manual/12004/qlive) > 互动直播服务端接入指南

#  互动直播服务端接入指南

最近更新时间: 2023-03-28 17:23:02

# 1\. 项目编译运行

## 1.1 项目编译

  * 本项目使用go 1.16 编译

    
    
    1. clone 项目
    git clone https://github.com/pili-engineering/QNLiveKit_Server 
    2. 编译
    cd QNLiveKit_Server/app/live
    go build
    

  * 在当前目录下，生成可执行文件 live

## 1.2 项目运行

  * 项目的运行，需要提供一个配置文件 config.yaml。配置文件的说明，见后面。

    
    
    ./live -f config.yaml 2>&1 > live.log &
    

# 2\. 配置文件

  * 互动直播使用 yaml 格式的配置文件，文件内容如下所示：

    
    
    node_id: {{ nodeId }}
    service:
      host: {{ host }}
      port: {{ port }}
      
    jwt_key: {{ jwt_key }}
    callback: https://niucube-api.qiniu.com/v1/live/callback
    censor_callback: https://{{xxx}}
    censor_bucket: {{ censor_bucket }}
    censor_addr:https://{{xxx}}
    gift_addr: https://{{xxx}}
    cache_config:
      type: {{type}}
      addr: {{host:ip}}
    mysqls:
      - host: 127.0.0.1
        port: 3306
        username: {{ user }}
        password: {{ password }}  
        max_idle_conns: 10
        max_open_conns: 100
        database: live
        conn_max_life_time: 5
        default: live
      - host: 127.0.0.1
        port: 3306
        username: {{ user }}
        password: {{ password }}  
        max_idle_conns: 10
        max_open_conns: 100
        database: live
        conn_max_life_time: 5
        default: live
        read_only: true
    mac_config:
      enable: true
      access_key: ak
      secret_key: sk
    im_config:
      app_id: {{ im_app_id }}
      endpoint: {{ im_endpoint }}
      token: {{ im_admin_token }}
      
    rtc_config:
      app_id: {{ app_id }}
      access_key: {{ ak }}
      secret_key: {{ sk }}
      room_token_expire_s: 3600
      hub: {{ 直播hub }} 
      security_type: none
      publish_key: {{ publish_key }}
      publish_expire_s: 3600
      playback_url: https://{{xxx}}-playback.com
      stream_pattern: qn_live_kit-%s
      publish_url: rtmp://{{xxx}}-publish.com
      publish_domain: {{xxx}}-publish.com
      rtmp_play_url: rtmp://{{xxx}}-rtmp.com
      flv_play_url: https://{{xxx}}-hdl.com
      hls_play_url: https://{{xxx}}-hls.com
    prome_config:
      client_mode: pusher
      exporter_config:
        listen_addr: ":9200"  
      pusher_config:
        url: "https://{{xxx}}"
        job: live
        instance: live_{{.node}}
        interval_s: 10
    cron_config:
      single_task_node: 1
    

## **2.1 基本配置**

### node配置

    
    
    node_id: {{ nodeId }}
    

字段名 | 类型 | 示例 | 说明  
---|---|---|---  
node_id | int | 1 | 互动直播支持分布式部署，每个节点指定一个nodeId。所有节点的nodeId 不能重复。  
nodeId 会用于内部的ID 生成。  
  
  

### service

    
    
    service:
      host: {{ host }}
      port: {{ port }}
    

  * 互动直播服务提供HTTP RESTful API 接口。service 配置服务的监听地址。

字段名 | 类型 | 示例 | 说明  
---|---|---|---  
host | string | 127.0.0.1（本地） | 监听的IP，部署在服务器上可为空或填0.0.0.0  
port | int | 8080 | 监听的端口  
  
  

### jwt_key

    
    
    jwt_key: {{ jwt_key }}
    

  * 字符串
  * 用于客户端鉴权token 的加解密

### callback

    
    
    callback: {{ callback_addrs }}
    

字段名 | 类型 | 示例 | 说明  
---|---|---|---  
callback | string | https://niucube-api.qiniu.com/v1/live/callback | 配置低代码服务的回调地址,该地址由业务服务来实现.  
低代码服务会将状态信息，通过回调的方式，通知给业务服务  
  
  

## **2.2 Redis 配置**

    
    
    cache_config:
        type: node
        addr: {{ip:port}}
    #    password: {{password}}
    

或者

    
    
    cache_config:
        type: cluster
        addrs:
        	- {{ip:port}}
        	- {{ip:port}}
    #    password: {{password}}
    

字段名 | 类型 | 示例 | 说明  
---|---|---|---  
type | string | node/cluster | 低代码服务，使用redis 作为缓存。支持redis 单节点模式，与集群模式。  
node：单节点模式  
cluster：集群模式  
addr | string | addr: 127.0.0.1:6379 | 配置type为node时，必须配置单节点redis 的地址。  
addrs |  | 如上所示 | 配置type为cluster时，必须配置的redis集群地址列表。  
password | string |  | redis如果设置密码，取消注释，填入密码；没设置密码，不需要password字端  
  
  

## **2.3 数据库配置**

    
    
    mysqls:
      - host: 127.0.0.1
        port: 3306
        username: {{ user }}
        password: {{ password }}  
        max_idle_conns: 10
        max_open_conns: 100
        database: live
        conn_max_life_time: 5
        default: live
      - host: 127.0.0.1
        port: 3306
        username: {{ user }}
        password: {{ password }}  
        max_idle_conns: 10
        max_open_conns: 100
        database: live
        conn_max_life_time: 5
        default: live
        read_only: true
    

  * 使用读写分离模式，必须其一包含配置项read_only: true
  * 互动直播服务使用mysql 进行业务数据存储。
  * 支持配置多个数据库。

## **2.4 面向服务的鉴权配置**

    
    
    mac_config:
      enable: true
      access_key: {{ ak }}
      secret_key: {{ sk }}
    

字段名 | 类型 | 示例 | 说明  
---|---|---|---  
enable | bool | true | enable：true，开启鉴权；false，关闭鉴权。如果互动直播服务，与需要调用互动直播服务接口的其他服务，在同一个安全局域网内，可以关闭服务端接口的鉴权。  
access_key | string | ak | 互动直播服务，提供面向服务端的接口，与面向客户端的接口。面向服务端的接口，使用 ak/sk 的鉴权方式。这里的access_key自行定义  
secret_key | string | sk | secret key 自行定义  
  
  

## **2.5 im_config**

    
    
    im_config:
      app_id: {{ im_app_id }}
      endpoint: {{ im_endpoint }}
      token: {{ im_admin_token }}
    

字段名 | 类型 | 示例 | 说明 |   
---|---|---|---|---  
app_id | string |  | 互动直播服务，使用七牛IM 作为即时通信消息服务。  
app_id：创建IM App时，为App生成的唯一标识 |   
endpoint | string |  | endpoint：App所在API服务的地址 ，参考 [IM服务接入指南 __](https://developer.qiniu.com/IM/8332/startim)与[IM服务端接入指南 __](https://developer.qiniu.com/IM/8102/im-service-integration-guide)|   
token | string |  | token：IM中获取的管理员token，参考 [IM服务接入指南 __](https://developer.qiniu.com/IM/8332/startim)与[IM服务端接入指南 __](https://developer.qiniu.com/IM/8102/im-service-integration-guide)|   
  
  

![im_config.png](https://dn-odum9helk.qbox.me/Fji74H0cj12GJx-M2qZPAQw0YCot)

  

## **2.6 rtc_config**

    
    
    rtc_config:
      app_id: {{ app_id }}
      access_key: {{ ak }}
      secret_key: {{ ak }}
      room_token_expire_s: 3600
      hub: {{ 直播hub }} 
      security_type: none
      publish_key: {{ publish_key }}
      publish_expire_s: 3600
      stream_pattern: qn_live_kit-%s
      playback_url: https://{{xxx}}-playback.com
      publish_url: rtmp://{{xxx}}-publish.com
      publish_domain: {{xxx}}-publish.com
      rtmp_play_url: rtmp://{{xxx}}-rtmp.com
      flv_play_url: https://{{xxx}}-hdl.com
      hls_play_url: https://{{xxx}}-hls.com
    

字段名 | 类型 | 示例 | 说明  
---|---|---|---  
app_id | string |  | 互动直播服务，使用七牛的RTC 服务，作为连麦服务。  
RTC 应用的配置，参考：[管理实时音视频 __](https://developer.qiniu.com/rtc/9858/applist)  
access_key | string |  | 七牛对API请求鉴权，用户需要使用密钥（AccessKey/SecretKey）进行身份验证。此处填入AccessKey  
secret_key | string |  | 此处填入SecretKey，第一次使用七牛API之前，您需要在七牛开发者平台的 [密钥管理 __](https://portal.qiniu.com/user/key)中取得密钥  
room_token_expire_s | int | 3600 |   
hub | string | live | 直播空间信息，参考：[直播云 __](https://developer.qiniu.com/pili)  
security_type | string | none/expiry/expiry_sk | 推流鉴权方式,详情见下表  
publish_key | string |  | 详情见下表  
publish_expire_s | int | 3600 |   
stream_pattern | string | qn_live_kit-%s |   
playback_url | string |  | 域名管理-加速域名-点播域名  
publish_url | string | rtmp:// 前缀 | 域名管理-直播域名-推流域名  
publish_domain | string |  | 域名管理-直播域名-推流域名  
rtmp_play_url | string | rtmp:// 前缀 | 域名管理-直播域名-RTMP播放域名  
flv_play_url | string |  | 域名管理-直播域名- HDL播放域名  
hls_play_url | string |  | 域名管理-直播域名-HLS播放域名  
  
  

![pili_url_mapping.png](https://dn-
odum9helk.qbox.me/FnbLDJKbHxGkWPYxnJGzlTo-0AIa)

  

![pili_playback_url.png](https://dn-
odum9helk.qbox.me/FpenTD0Z0iP0AC83UYGSQLy0tfIP)

  

  * 直播推流鉴权说明：目前直播推流鉴权，支持三种方式：无鉴权，限时鉴权，限时鉴权SK，不同鉴权模式的配置方式如下

鉴权模式 | security_type | publish_key | publish_expire_s  
---|---|---|---  
无鉴权 | none | 无需指定，留空 | 过期时间秒。如：3600 表示 一小时后过期，推流URL 过期  
限时鉴权 | expiry | 使用配置的key 鉴权。从【直播空间设置】获取key | 同上  
限时鉴权SK | expiry_sk | 使用RTC 用户的SK 鉴权。无需配置，留空。 | 同上  
  
  

![s.png](https://dn-odum9helk.qbox.me/FneT88PVDevLINZdtsW8ahVNZtKy)

  

## **2.7 Prometheus系统监控配置**

    
    
    prome_config:
      client_mode: exporter
      exporter_config:
        listen_addr: ":9200"
    

或

    
    
    prome_config:
      client_mode: pusher
      pusher_config:
        url: "https://{{xxx}}"
        job: live
        instance: live_{{.node}}
        interval_s: 10
    

低代码服务运行过程中，生成prometheus 监控数据指标。

字段名 | 类型 | 示例 | 说明  
---|---|---|---  
client_mode | string | exporter/pusher | client_mode：指标导出模式配置，支持的模式如下  
exporter：exporter 模式，开启http 监听，由prometheus 服务来拉取。  
pusher：pusher模式，主动向prometheus-gateway 推送指标。  
exporter_config  
listen_addr | string | “:9200” | 在client_mode 为 exporter 时，需要配置。  
listen_addr： 监听的端口  
pusher_config  
url  
job  
instance  
interval_s | string |  | 在client_mode 为 pusher_config 时，需要配置。url：prometheus-gateway 的指标收集地址。  
job：任务名称  
instance：live 服务的实例ID。  
interval_s：推送间隔。单位：秒。  
  
  

## **2.8 cron_config**

live 服务，有一些后台任务运行。

    
    
    cron_config:
      single_task_node: 1
    

  * single_task_node：单任务运行节点的ID。有些任务，需要全局单线程执行，只有节点ID 等于 single_task_node 的节点，才会运行单线程的任务。

## **2.9 三鉴模块配置**

live 服务，使用七牛的AI 审核功能，对直播内容进行内容审核。

    
    
    censor_callback: https://{{host}}
    censor_bucket: {{ censor_bucket }}
    censor_addr: https://{{xxx}}
    

  * 如果不需要鉴黄鉴暴恐鉴敏感人物模块，可删去这三行配置文件，但是需要调用关闭三鉴模块的接口：其中enable设为false。https://developer.qiniu.com/lowcode/12364/qlive-admin-api-censor

  * censor_callback：AI审核结果回调地址，配置为项目的域名。

  * censor_bucket: AI审核疑似违规照片的存储bucket。

  * censor_addr: bucket内存储文件的外链域名。

  * 存储的bucket，与外链域名配置，参考 [对象存储使用 __](https://developer.qiniu.com/kodo/8452/kodo-console-guide)

## **2.10 礼物模块配置**

live 服务，支持直播间礼物发送功能。

    
    
    gift_addr: https://{{xxx}}
    

字段名 | 类型 | 示例 | 说明  
---|---|---|---  
gift_addr | string | http://127.0.0.1:8099/manager/gift/test | 礼物支付的回调接口。礼物发送之前，需要业务服务提供礼物支付功能。  
live 服务在发送礼物之前，回调该接口，完成实际支付。  
只有支付成功的礼物，才会被发送。  
暂时通过 http://127.0.0.1:8099/manager/gift/test 接口返回模拟的支付成功  
  
### **礼物支付的回调接口要求**

Body 参数  
使用JSON 格式数据

参数 | 类型 | 必填 | 说明 | 举例  
---|---|---|---|---  
LiveId | string | 是 | 直播间ID | 1582200377771377896  
UserId | string | 是 | 用户ID | test_user  
BizId | string | 是 | 交易ID | 1574597777432780800  
AnchorId | string | 是 | 当前直播间主播ID | test_anchor  
GiftId | int | 是 | 礼物ID | 3  
Amount | int | 是 | 礼物数量 | 99  
  
举例如下

    
    
    {
        "biz_id": "1574597777432780800",
        "user_id":"test_user_001",
        "live_id":"1772215041443373056",
        "anchor_id": "test_user_002"  , 
        "gift_id":1  ,
        "amount": 99
    }
    

返回

    
    
    {
        "request_id":"xxxxx", //请求ID
        "code": 0,            //错误码：成功时为0；其他错误码表示失败
        "message": "success"  //code 非0 时，错误原因描述
    }
    

以上内容是否对您有帮助？