Turms项目插件配置详解：以敏感词过滤插件为例

配置属性命名规范

在Turms项目中，插件配置需要遵循特定的命名规范。以turms-plugin-antispam（敏感词过滤插件）为例，正确的属性命名应当采用小驼峰式（camelCase）风格。常见的错误包括：

1. 使用下划线分隔（如dict_parsing）
2. 使用连字符分隔（如dict-parsing）
3. 大小写不规范（如DictParsing）

正确的配置示例如下：

turms:
  plugin:
    antiSpam:
      enabled: true
      dictParsing:
        textFilePath: /path/to/sensitive_words.csv
        textFileCharset: UTF-8
        skipInvalidCharacter: true

配置位置说明

Turms插件配置应当放置在turms-service服务的配置文件中，而非插件本身的资源目录。这是因为：

1. 插件作为服务的一部分运行，其配置需要由主服务加载
2. 服务启动时会验证所有配置项，确保配置的正确性
3. 采用集中式配置管理，便于维护和部署

配置验证机制

Turms设计了严格的配置验证机制，当遇到以下情况时会抛出异常：

1. 配置了不存在的属性
2. 属性值类型不匹配
3. 必填属性缺失

这种设计有助于开发者快速发现配置问题，而不是在运行时才遇到意外行为。

项目架构说明

需要特别注意的是，turms-server-common是Turms项目中的公共库模块，而非独立服务。它的作用是：

1. 提供各服务共用的基础组件
2. 定义核心数据模型和接口
3. 实现跨服务的通用功能

理解这一点对于正确配置Turms系统至关重要，因为所有实际运行的服务器（如turms-gateway、turms-service等）都会依赖这个公共库。

最佳实践建议

1. 始终使用IDE的代码提示功能来验证属性名称
2. 新添加配置时，先参考现有配置的命名风格
3. 启动服务前，仔细检查控制台输出的配置验证信息
4. 对于复杂插件，建议先在测试环境验证配置

通过遵循这些规范和实践，可以确保Turms插件配置的正确性和可维护性，充分发挥插件的功能优势。