IM 即时通讯
Android
产品介绍
简介
产品优势
主要功能
功能介绍
帐号集成与登录
群组功能
聊天室功能
聊天室标签功能
圈组功能
多端登录与互踢策略
质量数据监控台
海外数据中心
IM平滑迁移方案
接口及业务限制
更新日志
IM UIKit 更新日志
NIM SDK 开发版更新日志
NIM SDK 稳定版更新日志
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
实现单聊消息收发(不含 UI)
跑通圈组 Demo 源码
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能概览
快速集成 IM UIKit
组件导入
初始化
界面跳转
自定义用户信息
全局配置
会话列表相关
集成会话列表界面
会话列表事件监听
自定义会话列表界面 UI
会话列表 API 概览
会话消息相关
集成会话界面
会话界面事件监听
实现音视频通话
实现地理位置消息功能(含 UI)
实现自定义消息发送(含 UI)
自定义会话界面 UI
会话消息 API 概览
通讯录相关
集成通讯录界面
自定义通讯录界面 UI
通讯录界面事件监听
通讯录 API 概览
IM UIKit 常见问题排查
IM UIKit API 概览
不含 UI 集成
集成 SDK
初始化
登录相关
登录 IM
多端登录与互踢
登出 IM
消息相关
消息概述
消息收发
自定义消息收发
消息配置选项
NOS 存储场景
广播消息收发
消息已读回执
消息撤回
消息重发与转发
消息更新
消息过滤
语音消息处理
插入本地消息
历史消息
最近会话
服务端会话服务
用户资料
用户关系
在线状态订阅
系统通知
系统通知概述
内置系统通知管理
内置系统通知未读数
自定义系统通知收发
离线推送与消息提醒
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
聊天室
圈组功能
圈组概述
登录管理
服务器相关
服务器概述
服务器管理
服务器成员管理
游客功能
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
实时互动频道
频道分组
频道分组黑白名单
频道未读数管理
搜索服务器和频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
用户定制权限
频道分组身份组
自定义权限项
成员权限查询与判定
身份组相关查询
圈组订阅机制
圈组消息相关
图解圈组消息流转
圈组消息收发
圈组消息撤回
圈组消息更新
圈组消息删除
消息正在输入
会话消息回复(Thread)
圈组快捷评论
获取频道最后一条消息
查询历史消息
查询@我的消息
圈组消息缓存
圈组消息搜索
圈组系统通知相关
圈组系统通知概述
圈组系统通知收发
圈组系统通知更新
圈组离线推送
圈组内容审核
圈组相关抄送
圈组第三方回调
圈组各端接口命名差异
反垃圾
聊天扩展
其他
最佳实践
IM 登录最佳实践
IM 应用隐私合规
聊天室重要消息投递
API 参考
Android SDK API
Android SDK 状态码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
开通聊天室功能
配置应用客户端标识
常见问题
FAQ
错题集
Android 离线推送
实现离线推送
配置消息的推送属性
设置群消息强制推送
设置推送全局免打扰
设置多端推送策略
集成小米推送
集成华为推送
集成荣耀推送
集成 OPPO 推送
集成 vivo 推送
集成魅族推送
集成谷歌推送(FCM)
消息提醒
实现消息提醒
配置消息提醒功能
设置群消息强制提醒
设置消息提醒文案
定制通知栏显示信息
Android 端推送问题排查
第三方推送厂商的限制说明
服务协议

IM 登录最佳实践

更新时间: 2023/01/12 20:26:13

登录对于 IM 产品来说至关重要,是后续业务顺利进行的前提条件。开发者集成 NIM SDK 的各项能力时,如果未能正确使用登录接口或处理登录状态,将引发不必要的问题,影响开发进度。本文介绍如何以最佳姿势进行手动登录自动登录,进而实现 IM 登录。

  • 手动登录:首次登录 IM 时调用AuthService.login方法实现。
  • 自动登录:手动登录 IM 成功之后调用,具体调用方式为在初始化时传入的上次登录的信息loginInfo

本文的手动登录仅以静态 Token 登录为例,更多登录相关说明请参见登录 IM

前提条件

  • 已创建应用并获取 App Key 1. 在左侧导航栏中找到“应用”,并单击“创建”。
    创建应用
    2. 填写应用的基本信息后,单击“创建”。
    创建应用
    3. 创建应用后,可以在左侧导航栏中查看该应用,并单击 “App Key 管理”,并获取 App Key 和 App Secret。
    查看应用的AppKey
  • 集成 NIM SDK

  • 已通过云信服务端注册 IM 账号 ,获取 IM 账号(accid)和对应的静态token

    您也可通过控制台注册 IM 测试账号。测试账号及对应的静态token仅适用于调试环境,线上生产环境必须将测试账号及其token替换为云信服务端生成的正式accidtoken

实现方案

手动登录

IM 手动登录接口的调用,需要在用户登录应用时(即在应用的登录界面点击登录按钮时)进行,其他情况一般不需要调用手动登录接口。在登录界面中,IM 登录可以作为整个应用登录过程的一个环节。常见的方案是先实现应用自身账号体系的登录,成功后再使用返回的accidtoken进行 IM 的登录。

  • 手动登录流程


    手动登录流程图.png

  • 接口调用

    1. 调用AuthService.login方法手动登录云信IM。
    2. 调用后处理。
      • 如果登录成功,保存 IM 的accidtoken到本地,方便下次应用启动自动登录时使用。
      • 如果登录失败,清理本地保存的用户登录信息,防止下次启动走自动登录逻辑。

    示例代码如下:

    LoginInfo loginInfo = new LoginInfo(accid,token);
    NIMClient.getService(AuthService.class).login(loginInfo).setCallback(new RequestCallback<LoginInfo>() {
        @Override
        public void onSuccess(LoginInfo result) {
            //保存accid、token,用于下次自动登录。
            //该sp只用于保存当前登录的账号,如有多账号的情况需要业务层自己处理。
            Preferences.saveUserAccount(result.getAccount());
            Preferences.saveUserToken(result.getToken());
            MyApplication.hasLogined = true;
            // TODO 登录成功
        }
        @Override
        public void onFailed(int code) {
            //清理登录账号、token缓存,调用login失败后,不允许走自动登录。
            Preferences.saveUserAccount("");
            Preferences.saveUserToken("");
            MyApplication.hasLogined = false;
            // TODO 登录失败提示
        }
        @Override
        public void onException(Throwable exception) {
            //清理登录账号、token缓存,调用login失败后,不允许走自动登录。
            Preferences.saveUserAccount("");
            Preferences.saveUserToken("");
            MyApplication.hasLogined = false;
            // TODO 登录异常提示
        }
    });
    

自动登录

手动登录 IM 成功后,下次启动应用可以使用云信 IM 的自动登录模式。自动登录后,即使登录未完成或者网络无法访问,应用也可以直接访问用户本地 SDK 数据。

  • 自动登录流程


  • 接口调用

    初始化 NIM SDK 时(如调用NIMClient.init方法),传入上次登录的LoginInfo对象,即可实现自动登录。

    自动登录的使用限制如下:

    • 自动登录只能登录上次登录的IM 账号,不能登录其他账号。
    • 需要某个 IM 账号曾经通过手动登录接口登录成功后才可以调用。
    • 无论之前是否曾经手动登录成功,只要最近一次手动登录接口调用失败,则不可以继续自动登录。
    • 当收到KICKOUTKICK_BY_OTHER_CLIENTFORBIDDENPWD_ERRORDATA_UPGRADE这些IM 登录状态时,后续自动登录将无效,需要用户通过手动登录接口重新登录。更多相关说明,见下文的登录状态处理

    实现自动登录的示例代码如下:

    LoginInfo loginInfo = null;
    //获取之前登录成功保存的accid、token信息。
    String account = Preferences.getUserAccount();
    String token = Preferences.getUserToken();
    if (!TextUtils.isEmpty(account)&&!TextUtils.isEmpty(token)){
        //之前已经登录过,可以走自动登录。
        hasLogined = true;
        loginInfo = new LoginInfo(account,token);
    }
    SDKOptions sdkOptions = new SDKOptions();
    NIMClient.init(this,loginInfo,sdkOptions);
    

登录状态处理

IM 登录状态表示当前登录的 NIM SDK 实例与云信服务端的长连接状态,也可以理解为用户设备和云信服务端的网络连接状态。调用初始化接口之后,可以在应用的主界面调用observeOnlineStatus方法注册 IM 的登录状态回调,监听当前的登录状态,并通过 UI 层提示用户。其他使用场景一般只需要在手动登录成功后或者自动登录期间才需要处理 IM 登录状态。

observeOnlineStatus方法必须在 NIM SDK 初始化之后调用。


登录状态处理的流程图如下:

示例代码如下:

/**
 * 用户在线状态观察者
 */
private Observer<StatusCode> onlineStatusObserver = new Observer<StatusCode>() {

    @Override
    public void onEvent(StatusCode statusCode) {
        // TODO 通过ui层处理把当前状态展示给用户
        tvLoginStatus.setText(userStatus);
        if (!MyApplication.hasLogined){
            //TODO 如果尚未登录过,可以根据自己业务需求确定是否需要进入登录页面
            
        }else if(statusCode.wontAutoLogin()){
            //TODO 如果登录过,并且不能自动重连的情况下,必须跳转到登录页面
        }else{
            //TODO 不做任何处理,状态事件结束        
        })
    }
};
NIMClient.getService(AuthServiceObserver.class).observeOnlineStatus(onlineStatusObserver,true);

Sample Code 下载


点击下载
Sample Code
点击下载...
Text is not SVG - cannot display

体验 Sample Code 时需在主项目的AndroidManifest.xml中把com.netease.nim.appKey的配置改为您自己的 App Key。

此文档是否对你有帮助?
有帮助
我要吐槽
  • 前提条件
  • 实现方案
  • 手动登录
  • 自动登录
  • 登录状态处理
  • Sample Code 下载