V2NIMConversationIdUtil.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.utils;

import android.text.TextUtils;
import android.util.Pair;
import androidx.annotation.Nullable;
import com.netease.nimlib.SDKCacheUI;
import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.sdk.msg.constant.SessionTypeEnum;
import com.netease.nimlib.sdk.v2.conversation.enums.V2NIMConversationType;
import java.util.Locale;
/**
 * 会话id工具类
 */
public final class V2NIMConversationIdUtil {

    private V2NIMConversationIdUtil() {
    }

    private static final String TAG = "V2NIMConversationIdUtil";
    private static final String CONVERSATION_ID_FORMAT = "%s|%d|%s";
    private static final String CONVERSATION_ID_SPLIT = "\\|";

    /**
     * 生成会话id
     * @param targetId 目标id
     * @param type 会话类型
     * @return 会话id
     */
    public static String conversationId(String targetId, V2NIMConversationType type) {
        if (TextUtils.isEmpty(targetId) || type == null) {
            return null;
        }
        String account = SDKCacheUI.getAccount();
        if(TextUtils.isEmpty(account))
        {
            return null;
        }
        return String.format(Locale.ENGLISH,CONVERSATION_ID_FORMAT, account, type.getValue(), targetId);
    }

    public static String conversationId(String sessionId, SessionTypeEnum type) {
        switch (type){
            case P2P:
                return p2pConversationId(sessionId);
            case Team:
                return teamConversationId(sessionId);
            case SUPER_TEAM:
                return superTeamConversationId(sessionId);
            default:
                return null;
        }
    }

    /**
     * 生成p2p会话id
     * @param accountId 对方账号id
     * @return 会话id
     */
    public static String p2pConversationId(String accountId){
        return conversationId(accountId, V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P);
    }

    /**
     * 生成team会话id
     * @param teamId 群id
     * @return 会话id
     */
    public static String teamConversationId(String teamId){
        return conversationId(teamId, V2NIMConversationType.V2NIM_CONVERSATION_TYPE_TEAM);
    }

    /**
     * 生成superTeam会话id
     * @param superTeamId 超大群id
     * @return 会话id
     */
    public static String superTeamConversationId(String superTeamId){
        return conversationId(superTeamId, V2NIMConversationType.V2NIM_CONVERSATION_TYPE_SUPER_TEAM);
    }

    /**
     * 根据会话id返回会话类型
     * @param conversationId 会话id
     * @return 会话类型
     */
    public static V2NIMConversationType conversationType(String conversationId) {
        if (TextUtils.isEmpty(conversationId)) {
            return V2NIMConversationType.V2NIM_CONVERSATION_TYPE_UNKNOWN;
        }
        String[] components = conversationId.split(CONVERSATION_ID_SPLIT);
        // 3 parts
        if (components.length != 3) {
            return V2NIMConversationType.V2NIM_CONVERSATION_TYPE_UNKNOWN;
        }
        // account and target

        if (TextUtils.isEmpty(components[0]) || TextUtils.isEmpty(components[2])) {
            return V2NIMConversationType.V2NIM_CONVERSATION_TYPE_UNKNOWN;
        }
        try {
            int type = Integer.parseInt(components[1]);

            return V2NIMConversationType.typeOfValue(type);
        }
        catch (Throwable e) {
            NimLog.e(TAG, "conversationType error, conversationId=" + conversationId + ", e=" + e.getMessage());
            return V2NIMConversationType.V2NIM_CONVERSATION_TYPE_UNKNOWN;
        }
    }

    /**
     * 根据会话id返回会话对应目标 ID(accountId、teamId、superTeamId)
     * @param conversationId 会话id
     * @return 会话目标id
     */
    public static String conversationTargetId(String conversationId) {
        if (TextUtils.isEmpty(conversationId)) {
            return null;
        }
        String[] components = conversationId.split(CONVERSATION_ID_SPLIT);
        // 3 parts
        if (components.length != 3) {
            return null;
        }
        // account and target

        if (TextUtils.isEmpty(components[0]) || TextUtils.isEmpty(components[2])) {
            return null;
        }

        return components[2];
    }

    /**
     * 根据会话id返回会话发送方账号id
     * @param conversationId 会话id
     * @return 发送方账号id
     */
    public static String conversationSenderId(String conversationId) {
        if (TextUtils.isEmpty(conversationId)) {
            return null;
        }
        String[] components = conversationId.split(CONVERSATION_ID_SPLIT);
        // 3 parts
        if (components.length != 3) {
            return null;
        }
        // account and target
        if (TextUtils.isEmpty(components[0]) || TextUtils.isEmpty(components[2])) {
            return null;
        }

        return components[0];
    }

    /**
     * 会话id是否合法
     * @param conversationId 会话id
     * @return 是否合法 true:合法 false:不合法
     */
    public static boolean isConversationIdValid(String conversationId){
        if (TextUtils.isEmpty(conversationId)) {
            return false;
        }
        String[] components = conversationId.split(CONVERSATION_ID_SPLIT);
        // 3 parts
        if (components.length != 3) {
            return false;
        }

        String account = SDKCacheUI.getAccount();
        if(account != null && !account.equals(components[0]))
        {
            return false;
        }

        if(TextUtils.isEmpty(components[0]))
        {
            return false;
        }

        V2NIMConversationType type;
        try {
            int typeInt = Integer.parseInt(components[1]);
            type = V2NIMConversationType.typeOfValue(typeInt);
        }
        catch (NumberFormatException e) {
            return false;
        }
        if(type == V2NIMConversationType.V2NIM_CONVERSATION_TYPE_UNKNOWN)
        {
            return false;
        }

        if(TextUtils.isEmpty(components[2]))
        {
            return false;
        }

        return true;

    }

    @Nullable
    public static SessionTypeEnum sessionTypeV1(@Nullable V2NIMConversationType conversationType) {
        if (conversationType == null) {
            return null;
        }
        switch (conversationType) {
            case V2NIM_CONVERSATION_TYPE_P2P:
                return SessionTypeEnum.P2P;
            case V2NIM_CONVERSATION_TYPE_TEAM:
                return SessionTypeEnum.Team;
            case V2NIM_CONVERSATION_TYPE_SUPER_TEAM:
                return SessionTypeEnum.SUPER_TEAM;
            default:
                return SessionTypeEnum.None;
        }
    }

    public static V2NIMConversationType conversationType(SessionTypeEnum sessionType) {
        if (sessionType == null) {
            return V2NIMConversationType.V2NIM_CONVERSATION_TYPE_UNKNOWN;
        }
        switch (sessionType) {
            case P2P:
                return V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P;
            case Team:
                return V2NIMConversationType.V2NIM_CONVERSATION_TYPE_TEAM;
            case SUPER_TEAM:
                return V2NIMConversationType.V2NIM_CONVERSATION_TYPE_SUPER_TEAM;
            default:
                return V2NIMConversationType.V2NIM_CONVERSATION_TYPE_UNKNOWN;
        }
    }

    /**
     * 判断两个 P2P conversationId 是否代表同一个会话（双方视角不同但会话相同）。
     * P2P conversationId 格式为 {account}|{type}|{targetId}，
     * A 视角：A|1|B，B 视角：B|1|A，两者代表同一个会话。
     *
     * @param conversationId1 第一个会话id
     * @param conversationId2 第二个会话id
     * @return 是否代表同一个 P2P 会话
     */
    public static boolean isSameP2PConversation(String conversationId1, String conversationId2) {
        if (TextUtils.isEmpty(conversationId1) || TextUtils.isEmpty(conversationId2)) {
            return false;
        }
        if (conversationId1.equals(conversationId2)) {
            return true;
        }
        // 类型必须都是 P2P
        if (conversationType(conversationId1) != V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P
                || conversationType(conversationId2) != V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P) {
            return false;
        }
        // A|1|B 和 B|1|A 代表同一个会话：sender1 == target2 && target1 == sender2
        String sender1 = conversationSenderId(conversationId1);
        String target1 = conversationTargetId(conversationId1);
        String sender2 = conversationSenderId(conversationId2);
        String target2 = conversationTargetId(conversationId2);
        if (TextUtils.isEmpty(sender1) || TextUtils.isEmpty(target1)
                || TextUtils.isEmpty(sender2) || TextUtils.isEmpty(target2)) {
            return false;
        }
        return sender1 != null && sender1.equals(target2) && target1 != null && target1.equals(sender2);
    }

    public static Pair<String,SessionTypeEnum> parseConversationId(String conversationId) {
        if (TextUtils.isEmpty(conversationId)) {
            return null;
        }
        String[] components = conversationId.split(CONVERSATION_ID_SPLIT);
        // 3 parts
        if (components.length != 3) {
            return null;
        }

        String account = SDKCacheUI.getAccount();
        if(account != null && !account.equals(components[0]))
        {
            return null;
        }

        if(TextUtils.isEmpty(components[0]))
        {
            return null;
        }

        if (TextUtils.isEmpty(components[2])) {
            return null;
        }
        V2NIMConversationType type;
        try {
            int typeInt = Integer.parseInt(components[1]);
            type = V2NIMConversationType.typeOfValue(typeInt);
        }
        catch (NumberFormatException e) {
            return null;
        }

        if(type == V2NIMConversationType.V2NIM_CONVERSATION_TYPE_UNKNOWN)
        {
            return null;
        }

        SessionTypeEnum sessionTypeEnum = sessionTypeV1(type);
        if (sessionTypeEnum == null || sessionTypeEnum == SessionTypeEnum.None) {
            return null;
        }

        return new Pair<>(components[2], sessionTypeEnum);
    }
}