NIMMessageAntispamConfig.java

浏览该文件的文档.

package com.netease.nimlib.sdk.msg.config;

import java.io.Serializable;

/**
 * NIMMessageAntispamConfig 类
 * <p>
 * 该类用于配置网易云信（NIM）消息反垃圾功能的参数。
 * 它实现了 Serializable 接口，允许对象进行序列化。
 */
public class NIMMessageAntispamConfig implements Serializable {

    /**
     * 指定是否需要过安全通
     * 对于已开通安全通的用户有效，默认消息都会走安全通
     * 如果对单条消息设置 enable 为false，则此消息不会走安全通
     * 该字段为true时，以下字段(antispamBusinessId/antispamCustomMessage/antispamCheating/antispamExtension)才生效
     */
    private final boolean antispamEnabled;

    /**
     * 指定易盾业务id，而不使用云信后台配置的
     * 安全通后台对接易盾
     */
    private final String antispamBusinessId;

    /**
     * 自定义消息中需要反垃圾的内容（仅当消息类型为自定义消息时有效）
     * 自定义消息开发者自定义的反垃圾字段， content 必须是 json 格式，长度不超过 5000 字节
     * 格式如下 { "type": 1, //1:文本，2：图片，3视频 "data": "" //文本内容or图片地址or视频地址 }
     */
    private final String antispamCustomMessage;

    /**
     * 易盾反作弊（辅助检测数据），json格式，限制长度1024
     */
    private final String antispamCheating;

    /**
     * 易盾反垃圾（增强检测数据），json格式，限制长度1024
     */
    private final String antispamExtension;

    /**
     * 私有构造函数，使用默认值初始化
     */
    private NIMMessageAntispamConfig() {
        this(DEFAULT_ANTISPAM_ENABLED, null, null, null, null);
    }

    /**
     * 私有构造函数，使用指定参数初始化
     *
     * @param antispamEnabled       是否启用反垃圾
     * @param antispamBusinessId    易盾业务ID
     * @param antispamCustomMessage 自定义反垃圾消息
     * @param antispamCheating      反作弊数据
     * @param antispamExtension     增强检测数据
     */
    private NIMMessageAntispamConfig(boolean antispamEnabled, String antispamBusinessId, String antispamCustomMessage, String antispamCheating,
            String antispamExtension) {
        this.antispamEnabled = antispamEnabled;
        this.antispamBusinessId = antispamBusinessId;
        this.antispamCustomMessage = antispamCustomMessage;
        this.antispamCheating = antispamCheating;
        this.antispamExtension = antispamExtension;
    }

    /**
     * 获取是否启用反垃圾
     *
     * @return 反垃圾是否启用
     */
    public boolean isAntispamEnabled() {
        return antispamEnabled;
    }

    /**
     * 获取易盾业务ID
     *
     * @return 易盾业务ID
     */
    public String getAntispamBusinessId() {
        return antispamBusinessId;
    }

    /**
     * 获取自定义反垃圾消息
     *
     * @return 自定义反垃圾消息
     */
    public String getAntispamCustomMessage() {
        return antispamCustomMessage;
    }

    /**
     * 获取反作弊数据
     *
     * @return 反作弊数据
     */
    public String getAntispamCheating() {
        return antispamCheating;
    }

    /**
     * 获取增强检测数据
     *
     * @return 增强检测数据
     */
    public String getAntispamExtension() {
        return antispamExtension;
    }

    /**
     * 重写toString方法，返回对象的字符串表示
     *
     * @return 对象的字符串表示
     */
    @Override
    public String toString() {
        return "V2NIMMessageAntispamConfig{" + "antispamEnabled=" + antispamEnabled + ", antispamBusinessId='" + antispamBusinessId + '\''
                + ", antispamCustomMessage='" + antispamCustomMessage + '\'' + ", antispamCheating='" + antispamCheating + '\'' + ", antispamExtension='"
                + antispamExtension + '\'' + '}';
    }

    /**
     * 默认的反垃圾启用状态
     */
    private static final boolean DEFAULT_ANTISPAM_ENABLED = true;

    /**
     * NIMMessageAntispamConfig的构建器类
     */
    public static final class NIMMessageAntispamConfigBuilder {

        private boolean antispamEnabled = DEFAULT_ANTISPAM_ENABLED;
        private String  antispamBusinessId;
        private String  antispamCustomMessage;
        private String  antispamCheating;
        private String  antispamExtension;

        private NIMMessageAntispamConfigBuilder() {
        }

        /**
         * 创建一个新的NIMMessageAntispamConfigBuilder实例
         *
         * @return NIMMessageAntispamConfigBuilder实例
         */
        public static NIMMessageAntispamConfigBuilder builder() {
            return new NIMMessageAntispamConfigBuilder();
        }

        /**
         * 设置是否启用反垃圾
         *
         * @param antispamEnabled 是否启用反垃圾
         *
         * @return 构建器实例
         */
        public NIMMessageAntispamConfigBuilder withAntispamEnabled(boolean antispamEnabled) {
            this.antispamEnabled = antispamEnabled;
            return this;
        }

        /**
         * 设置易盾业务ID
         *
         * @param antispamBusinessId 易盾业务ID
         *
         * @return 构建器实例
         */
        public NIMMessageAntispamConfigBuilder withAntispamBusinessId(String antispamBusinessId) {
            this.antispamBusinessId = antispamBusinessId;
            return this;
        }

        /**
         * 设置自定义反垃圾消息
         *
         * @param antispamCustomMessage 自定义反垃圾消息
         *
         * @return 构建器实例
         */
        public NIMMessageAntispamConfigBuilder withAntispamCustomMessage(String antispamCustomMessage) {
            this.antispamCustomMessage = antispamCustomMessage;
            return this;
        }

        /**
         * 设置反作弊数据
         *
         * @param antispamCheating 反作弊数据
         *
         * @return 构建器实例
         */
        public NIMMessageAntispamConfigBuilder withAntispamCheating(String antispamCheating) {
            this.antispamCheating = antispamCheating;
            return this;
        }

        /**
         * 设置增强检测数据
         *
         * @param antispamExtension 增强检测数据
         *
         * @return 构建器实例
         */
        public NIMMessageAntispamConfigBuilder withAntispamExtension(String antispamExtension) {
            this.antispamExtension = antispamExtension;
            return this;
        }

        /**
         * 构建NIMMessageAntispamConfig实例
         *
         * @return 新的NIMMessageAntispamConfig实例
         */
        public NIMMessageAntispamConfig build() {
            return new NIMMessageAntispamConfig(antispamEnabled, antispamBusinessId, antispamCustomMessage, antispamCheating, antispamExtension);
        }
    }
}