Swift 极光IM聊天-发送消息

前言

最近公司的项目使用到了极光聊天的功能，但是正如目前市面上所看到的所有的与聊天相关的第三方，极光只是提供了最基本的单聊和群聊的功能，诸如视频会议等等这些功能目前在极光IM中还未提供。基于这一点的考量和公司项目的后期规划需求我将极光的聊天功能拆分了出来便于后期的维护和替换其他第三方聊天功能。并在此做一下相关的总结，方便后期的学习整理。
总共会分为三篇文章去写完整个聊天的功能：

• 发送消息
• 解析消息
• 语音视频通话

接入极光推送SDK

具体的接入方法请去参考官方文档。需要注意一点的是：一定要接入最新版本、一定要接入最新版本、一定要接入最新版本,不然有可能会出现问题。关于最新版本这个问题我是在接入极光的推送功能的时候出现的，接入的不是最新的版本的sdk导致我在登录不同账号的时候出现了崩溃(此处的崩溃主要是针对设置了别名信息进行单对单的时候)，出现的崩溃信息为-[JCOREMessageReceiptModel msgData]: unrecognized selector sent to instance 0x282ea74e0'。所以在接入极光的东西的时候如果你是参考了提供的demo也请一定将版本改成最新的，无论是推送还是IM

设置全局的监听信息

• 账号被顶下线的监听

//oc
- (void)onReceiveUserLoginStatusChangeEvent:(JMSGUserLoginStatusChangeEvent *)event;
//swift
func onReceive(_ event: JMSGUserLoginStatusChangeEvent!)

• 接收到消息的监听

//oc
- (void)onReceiveMessage:(JMSGMessage *)message error:(NSError *)error;
//swift
func onReceive(_ message: JMSGMessage!, error: Error!)

这两个是我使用到的全局监听。第一个是必选的第二个可以集合实际情况选择添加或者不添加，其他的一些监听会在后续中去说，(不同的类设置delegate会出现不同的效果，可以是全局的也可以是局部的）

发送消息

在发送消息时首先需要先创建一个聊天，即conversation

static func createConversation(userName : String , convblock : @escaping ChatConversiontBlock){
        JMSGConversation.createSingleConversation(withUsername:"你想和谁聊天的username", appKey: "####) {(result, error) in
            if error == nil {
                let conv = result as! JMSGConversation
                //这是个回调 可以根据需要自行设置
                convblock(conv)
            }else{
                HUD.show("获取会话信息失败")
            }
        }
    }

发送消息主要是以下几部流程(此处是针对极光IM的流程来说明的，其他的sdk基本都是大同小异只需要简单的调整即可。)
1.获取到你想发送的东西（文字、图片、语音、视频等等）
2.对你想发送的东西进行一些数据的转换（图片、语音、视频等转换成Data类型）
3.根据要发送的内容类型封装成对应的Model
4.将model转化成一个Message
5.将message发送出去

• 发送文本信息

//
let content = JMSGTextContent(text: "你想发送的东西")
let user = conversation.target as! JMSGUser//conversation 在前面说过了就是自己创建的聊天
let message = JMSGMessage.createSingleMessage(with: content, username: user.username)
conversation.send(message, optionalContent: JMSGOptionalContent.ex.default)

在此处也统一说明一下关于最后调用发送消息的方法时，参数optionalContent是干嘛用的。其实在使用的时候自己直接点进方法也是可以的。但为了方便这里直接简单的说一下这个参数是干嘛的。
JMSGOptionalContent.ex.default是官方封装好的一个实体类。这个实体类的具体参数如下：

@interface JMSGOptionalContent : NSObject
/*!
 * @abstract 不保存离线消息，NO，默认值，保存离线消息；YES，不保存离线消息
 */
@property(nonatomic, assign) BOOL noSaveOffline;
/*!
 * @abstract 不在状态栏显示消息，NO，默认值，状态栏显示消息；YES，状态栏不显示消息
 */
@property(nonatomic, assign) BOOL noSaveNotification;
/*!
 * @abstract 设置这条消息的发送是否需要对方发送已读回执，NO，默认值
 */
@property(nonatomic, assign) BOOL needReadReceipt;
/*!
 * @abstract 设置消息发送时的未读数，默认为 1
 */
@property(nonatomic, assign) SInt32 messageCount;
/*!
 * @abstract 自定义消息通知栏的内容
 * @discussion 这个属性可以具体参考 JMSGCustomNotification 类
 */
@property(nonatomic, strong) JMSGCustomNotification *customNotification;

JMSGOptionalContent.ex.default这里面的内容如下：

extension ExJMessage where Base: JMSGOptionalContent {

    /**
     default optional content
     */
    static var `default`: JMSGOptionalContent {
        let optionalContent = JMSGOptionalContent()
        optionalContent.needReadReceipt = true
        return optionalContent
    }
}

这样就很清楚了这个参数是干嘛的了，就是给你要发的这条消息添加一些属性条件，比如是否需要已读回执等等这个东西，如果项目有需求也可以自己去设置。
这里在说一下JMSGOptionalContent.ex.default的扩展放在了官方demo的这个文件JMSGOptionalContent+.swift中。也可以直接复制上面的代码直接使用。

• 发送图片

func send(forImage image: UIImage) {
        let data = image.jpegData(compressionQuality: 1.0)!
        let content = JMSGImageContent(imageData: data)!
        let user = .conversation.target as! JMSGUser
        let message = JMSGMessage.createSingleMessage(with: content, username: user.username)
        conversation!.send(message, optionalContent: JMSGOptionalContent.ex.default)
    }

• 发送语音
  发送自己录制的语音首先就需要先去录制语音，然后在将语音发送出去
  录制语音的功能IM官方Demo中已经提供了而且可以直接抽离出来直接放到任何你想用的项目中去。文件名字是JCRecordVoiceHelper.swift。然后简单的说一下在项目中可能会用到的几个地方

1. 在录制语音的过程中可能会有一个录制的动画，官方提供的可能不会满足项目的需求所以可能需要自己去写一下这个录制的动画，而我们又需获取到录制语音的时长
2. 录制语音的过程中可能需要获取到音量的大小
   以上是两个比较常见的问题，不论是音量还是时间都在如下的方法中可以获取到

@objc func updateMeters() {
        if recorder == nil {
            return
        }
        currentTimeInterval = recorder?.currentTime//这个是获取到当前的录制时长
        
        recorder!.updateMeters() // 刷新音量数据
        let maxV:Float = recorder!.peakPower(forChannel: 0) //获取音量最大值
        let lowPassResult:Double = pow(Double(10), Double(0.05*maxV))
        updateMeterDelegate?.setPeakPower(lowPassResult)
        //将录制的时长传递到对应的View中去
        updateMeterDelegate?.setRecordTime(currentTimeInterval!)
        
        if currentTimeInterval > maxRecordTime {
            stopRecord()
            delegate?.beyondLimit?(currentTimeInterval!)
            if stopRecordCompletion != nil {
                DispatchQueue.main.async(execute: stopRecordCompletion!)
                recorder?.updateMeters()
            }
        }
    }

另外JCRecordVoiceHelper这个类不是全局类，需要在你使用到录音的地方先去初始化它并实现对应的delegate方法，delegeta方法只有一个就是当录制时长超出上限。关于上限值的设定是这个参数let maxRecordTime = 60.0

@objc optional func beyondLimit(_ time: TimeInterval)

然后就是录制语音过程中可能会用到的几个方法：
在下面的代码中会出现recordHelper这么一个实例，这个是我自己对JCRecordVoiceHelper实例化后的对象名字
1. 取消发送语音
调用取消录制语音的代码：recordHelper.cancelledDeleteWithCompletion()
2. 开始录制语音
调用开始录制语音的代码recordHelper.startRecordingWithPath(String.getRecorderPath()),其中String.getRecorderPath()是我自己写的一个路径用来保存录制的语音的
3. 结束发送语音
调用取消录制语音的代码：recordHelper.finishRecordingCompletion()
具体在什么时机下调用上面的方法需要根据自己的需求去设定，如demo中是通过一个按钮的状态变换来决定调用什么方法的。
到此处录制语音相关的东西就结束了。

发送语音相关操作

//获取到录制的视频的URL并转换成data
let data = try! Data(contentsOf: URL(fileURLWithPath: recordHelper.recordPath!))
self.send(voiceData: data, duration: Double(recordHelper.recordDuration!)!)
//发送语音的方法
func send(voiceData: Data, duration: Double) {
        let content = JMSGVoiceContent(voiceData: voiceData, voiceDuration: NSNumber(value: duration))
        let user = conversation!.target as! JMSGUser
        let message = JMSGMessage.createSingleMessage(with: content, username: user.username)
        conversation.send(message, optionalContent: JMSGOptionalContent.ex.default)
    }

• 发送小视频

1. 发送小视频这里有个需要注意的问题就是Android和iOS是不同的，Android中不存在发送小视频这个功能,只有发送文件的功能，所以如果只是iOS之间通讯是可以直接发送小视频的，如果需要和Android之间也可以相互通讯的话此处发送小视频的方式要改为发送文件的方式，后面会在代码中具体的去具体的实现一下这个功能。
2. 关于视频的获取方式和获取图片的方式差不太多。一个是获取本地相册另一个是录制一个视频。关于录制视频这个功能官方demo中也已经提供了相关的封装好的类也是可以直接拿过来用的。录制视频的文件名为JCAudioPlayerHelper.swift，播放视频的文件名为JCVideoManager.swift。同时我在这里提供一个我自己用的录制视频的第三方工具VideoRecordManager至于我为啥会换掉这个录制视频的工具的原因就不说了应该都能体会的到的。
   demo提供的录制视频的工具类有一下几个delegate协议需要去实现一下。

func didAudioPlayerBeginPlay(_ AudioPlayer: AVAudioPlayer)
func didAudioPlayerStopPlay(_ AudioPlayer: AVAudioPlayer)
func didAudioPlayerPausePlay(_ AudioPlayer: AVAudioPlayer)

下面就来说一下发送视频的的具体方法：
1.获取到视频的url
2.转换视频格式，如果是自己手机拍摄的可以设置成MOV格式如果需要Android iOS相互通讯就需要转换成统一的格式MP4格式
3.获取视频的第一帧的图片做为展示图
4.发送小视频

//视频转换成MP4格式
func conversionVideoFormat(_ inputUrl: URL,callback: @escaping (_ para: URL? ,_ name : String?) -> Void){
        let date = Date()
        let formatter = DateFormatter()
        formatter.dateFormat = "yyyy-MM-dd-HH:mm:ss"
        let strDate = formatter.string(from: date) as String
        
        let path = "\(NSHomeDirectory())/Documents/output-\(strDate).mp4"
        let outputUrl: URL = URL(fileURLWithPath: path)
        let avAsset = AVURLAsset(url: inputUrl)
        let exportSeesion = AVAssetExportSession(asset: avAsset, presetName: AVAssetExportPresetMediumQuality)
        exportSeesion?.outputURL = outputUrl
        exportSeesion?.outputFileType = AVFileType.mp4
        exportSeesion?.exportAsynchronously(completionHandler: {
            switch exportSeesion?.status {
            case AVAssetExportSession.Status.unknown?:
                break;
            case AVAssetExportSession.Status.cancelled?:
                callback(nil, nil)
                break;
            case AVAssetExportSession.Status.waiting?:
                break;
            case AVAssetExportSession.Status.exporting?:
                break;
            case AVAssetExportSession.Status.completed?:
                callback(outputUrl, strDate)
                break;
            case AVAssetExportSession.Status.failed?:
                callback(nil , nil)
                break;
            default:
                callback(nil , nil)
                break
            }
        })
    }


let JC_VIDEO_MSG_IMAGE_WIDTH: CGFloat = 160.0
let JC_VIDEO_MSG_IMAGE_HEIGHT: CGFloat = 120.0
//获取视频第一帧图片
static func videoFirstFrame(_ videoUrl: URL) -> UIImage {
        let opts = [AVURLAssetPreferPreciseDurationAndTimingKey:false]
        let urlAsset = AVURLAsset(url: videoUrl, options: opts)
        let generator = AVAssetImageGenerator(asset: urlAsset)
        generator.appliesPreferredTrackTransform = true
        //let error: Error
        do {
            let img = try generator.copyCGImage(at: CMTimeMake(value: 0, timescale: 10), actualTime: nil) as CGImage
            let image = UIImage(cgImage: img)
            return image
        } catch let error as NSError {
            print("\(error)")
            return UIImage.createImage(color: .gray, size: CGSize(width: JC_VIDEO_MSG_IMAGE_WIDTH, height: JC_VIDEO_MSG_IMAGE_HEIGHT))!
        }
    }

发送小视频->iOS间使用

func send(videoUrl : URL)  {//发送视频的方式
        conversionVideoFormat(videoUrl) {[weak self] (paraUrl , filtName) in
            if paraUrl != nil {

                let image = ChatVM.videoFirstFrame(paraUrl!)
                let thumbData = image.jpegData(compressionQuality: 1.0)!
                let videoData = try! Data(contentsOf: paraUrl!)
                let thumb = ChatVM.videoFirstFrame(paraUrl!)
                let avUrl = AVURLAsset(url: paraUrl!)
                let time = avUrl.duration
                let seconds = ceil(Double(time.value)/Double(time.timescale))
                let content = JMSGVideoContent.init(videoData: videoData, thumbData: thumbData, duration: NSNumber(seconds))
                content.format = "mp4"
                let message = JMSGMessage.createSingleMessage(with: content, username: user.username)
                conversation!.send(message, optionalContent: JMSGOptionalContent.ex.default)
            }
        }
    }

发送小视频->iOS Android互通

func send(videoUrl : URL)  {
        conversionVideoFormat(videoUrl) {[weak self] (paraUrl , filtName) in
            if paraUrl != nil {

                let videoData = try! Data(contentsOf: paraUrl!)
                let thumb = ChatVM.videoFirstFrame(paraUrl!);
                
                let content = JMSGFileContent.init(fileData: videoData, fileName: (filtName ?? "filtVideo") + ".mp4")
                content.format = "mp4"
                //这个地方设置了一个扩展，只有这么写安卓端才会识别出来，
                //如果有其他的需求也可以自己给Extra设置额外的参数
                content.addStringExtra("mp4", forKey: "video")
                let user = self?.controller?.conversation!.target as! JMSGUser
                let message = JMSGMessage.createSingleMessage(with: content, username: user.username)
                conversation!.send(message, optionalContent: JMSGOptionalContent.ex.default)
            }
        }
    }

• 发送自定义消息
  关于自定义消息的发送，完全都是取决于自己的协商来去写的规则，这里只展示一下我们的约定，关于内容的获取和展示在后面解析消息的时候在详细的说一下

func sendCustom(code : String){
        let content = JMSGCustomContent.init(customDictionary: ["text" : "文本内容"])
        content?.addStringExtra("82102", forKey: "contentType")
        let user = self.controller?.conversation!.target as! JMSGUser
        let message = JMSGMessage.createSingleMessage(with: content!, username: user.username)
        conversation!.send(message, optionalContent: JMSGOptionalContent.ex.default)
    }

其他一些如发送地理定位 发送名片等如果有需要可以自行的去查看一下。

发送消息的功能基本就整理到这里了，下一篇总结一下解析消息的功能

---

下一篇：Swift 极光IM聊天-解析消息