Room读取第三方库CommunicationIdentifier对象实例化失败求助

问题根源 #

你遇到的错误是因为Gson无法实例化CommunicationIdentifier——这个第三方SDK类大概率是抽象类/接口，或是没有无参构造函数，且存在多个子类（比如Azure SDK中的CommunicationUserIdentifier、PhoneNumberIdentifier等）。你之前写的CommunicationIdentifierConverter对ChatMessageContent内部嵌套的CommunicationIdentifier无效，因为Room的TypeConverter是针对整个字段的序列化/反序列化，而ChatMessageContent是被整体转成JSON字符串的，Gson在解析这个JSON时，内部的CommunicationIdentifier字段不会触发Room的Converter，而是用默认逻辑处理，自然失败。

有效解决方案 #

方案1：利用SDK自带的RawId序列化（推荐，如果SDK支持）

大部分通信SDK都会给标识符类提供rawId（标准化字符串），以及从rawId还原实例的方法。以Azure Communication SDK为例：

1. 编写针对CommunicationIdentifier的Room TypeConverter：

class CommunicationIdentifierConverter {
    @TypeConverter
    fun toCommunicationIdentifier(rawId: String?): CommunicationIdentifier? {
        return rawId?.let { CommunicationIdentifier.fromRawId(it) }
    }

    @TypeConverter
    fun fromCommunicationIdentifier(identifier: CommunicationIdentifier?): String? {
        return identifier?.rawId
    }
}

2. 如果CommunicationIdentifier是ChatMessageContent的直接属性，你需要修改MessageEntity，把ChatMessageContent拆分成可单独处理的字段（但如果ChatMessageContent是黑盒SDK类无法修改，就用方案2）。

方案2：给Gson自定义TypeAdapter处理CommunicationIdentifier

如果无法拆分ChatMessageContent，就给Gson配置专门的TypeAdapter，让它能正确序列化/反序列化CommunicationIdentifier及其子类：

1. 创建CommunicationIdentifier的TypeAdapter：

class CommunicationIdentifierTypeAdapter : TypeAdapter<CommunicationIdentifier>() {
    private val gson = Gson()

    override fun write(out: JsonWriter, value: CommunicationIdentifier?) {
        if (value == null) {
            out.nullValue()
            return
        }
        val jsonObj = JsonObject().apply {
            // 写入类型标记，用于反序列化时识别子类
            val type = when (value) {
                is CommunicationUserIdentifier -> "communicationUser"
                is PhoneNumberIdentifier -> "phoneNumber"
                is MicrosoftTeamsUserIdentifier -> "teamsUser"
                is UnknownIdentifier -> "unknown"
                else -> "unknown"
            }
            addProperty("type", type)
            // 写入rawId作为兜底
            addProperty("rawId", value.rawId)
            // 写入子类特有的属性
            when (value) {
                is CommunicationUserIdentifier -> addProperty("id", value.id)
                is PhoneNumberIdentifier -> addProperty("phoneNumber", value.phoneNumber)
                is MicrosoftTeamsUserIdentifier -> {
                    addProperty("userId", value.userId)
                    addProperty("isAnonymous", value.isAnonymous)
                    addProperty("cloud", value.cloud?.name)
                }
            }
        }
        gson.toJson(jsonObj, out)
    }

    override fun read(`in`: JsonReader): CommunicationIdentifier? {
        val jsonObj = JsonParser.parseReader(`in`).asJsonObject
        val rawId = jsonObj.get("rawId").asString
        val type = jsonObj.get("type")?.asString ?: return UnknownIdentifier(rawId)
        
        return when (type) {
            "communicationUser" -> CommunicationUserIdentifier(jsonObj.get("id").asString)
            "phoneNumber" -> PhoneNumberIdentifier(jsonObj.get("phoneNumber").asString)
            "teamsUser" -> MicrosoftTeamsUserIdentifier(
                userId = jsonObj.get("userId").asString,
                isAnonymous = jsonObj.get("isAnonymous").asBoolean,
                cloud = jsonObj.get("cloud")?.asString?.let { CommunicationCloudEnvironment.valueOf(it) }
            )
            else -> UnknownIdentifier(rawId)
        }
    }
}

2. 修改ChatMessageContentConverter，使用配置了该TypeAdapter的Gson实例：

class ChatMessageContentConverter {
    private val gson = GsonBuilder()
        .registerTypeAdapter(CommunicationIdentifier::class.java, CommunicationIdentifierTypeAdapter())
        .create()

    @TypeConverter
    fun toChatMessageContent(value: String?): ChatMessageContent? {
        return value?.let { gson.fromJson(it, ChatMessageContent::class.java) }
    }

    @TypeConverter
    fun fromChatMessageContent(content: ChatMessageContent?): String? {
        return content?.let { gson.toJson(content) }
    }
}

3. 移除之前单独添加的CommunicationIdentifierConverter，因为现在ChatMessageContent的Gson已经能处理内部的CommunicationIdentifier了。

注意事项 #

• 确保TypeAdapter覆盖了SDK中所有CommunicationIdentifier的子类，避免遗漏导致反序列化失败。
• 如果SDK后续更新了CommunicationIdentifier的子类，需要同步更新TypeAdapter的逻辑。

内容的提问来源于stack exchange，提问作者MaaAn13