etrules

ET框架完整开发规范 - AI开发助手

最重要基础原则

1. 语言要求：所有AI回复和代码注释都必须使用中文
2. 严禁假设性代码：AI提供的代码必须是完整可执行的，严禁出现"假设xxx已完成"等占位符

ET框架核心架构原则

Entity-Component-System (ECS) 架构

• Entity：只包含数据，不包含方法
• System：只包含逻辑，不包含数据
• Component：Entity的组成部分，遵循组合优于继承
• 分离原则：严格分离数据定义和业务逻辑

包结构规范

• 所有代码文件必须创建在 Packages/cn.etetet.* 目录下
• 包命名规范：cn.etetet.{功能模块名}
  • 核心包：cn.etetet.core
  • 功能包：cn.etetet.mmo、cn.etetet.bag、cn.etetet.skill 等
  • UI包：cn.etetet.yiui* 系列

程序集分类规范

每个包必须支持以下四个程序集分类：

1. Model 程序集 (Scripts/Model/)

• 用途：服务器和客户端共享的模型层
• 内容：Entity定义、配置数据、共享逻辑
• 特点：不可热更新，稳定性高

2. ModelView 程序集 (Scripts/ModelView/)

• 用途：客户端专用的视图模型层
• 内容：UI相关Entity、客户端专用组件
• 特点：不可热更新，UI底层支持

3. Hotfix 程序集 (Scripts/Hotfix/)

• 用途：服务器和客户端共享的热更新逻辑层
• 内容：System类、业务逻辑实现
• 特点：可热更新，核心业务逻辑

4. HotfixView 程序集 (Scripts/HotfixView/)

• 用途：客户端专用的热更新视图层
• 内容：UI System类、客户端显示逻辑
• 特点：可热更新，UI业务逻辑

Entity 开发规范

Entity 类定义规范

// 位置：Packages/cn.etetet.{包名}/Scripts/Model/ 或 Scripts/ModelView/
namespace ET  // 或 ET.Client, ET.Server
{
    /// <summary>
    /// 详细的中文描述
    /// </summary>
    [ComponentOf(typeof(ParentEntityType))]  // 指定父实体类型（如适用）
    public class ExampleComponent : Entity, IAwake, IDestroy
    {
        // 只包含数据字段，不包含方法
        public int SomeValue;
        public string SomeName;
        public List<int> SomeList;
    }
}

Entity 类要求

• 必须继承 Entity 基类
• 必须实现 IAwake 接口（生命周期接口）
• 根据需要实现其他接口：IDestroy、IUpdate、ISerialize 等
• 严禁在Entity类中定义任何方法
• 必须添加 [ComponentOf] 或 [ChildOf] 特性指定父级约束

生命周期接口规范

// 基础生命周期
public interface IAwake { }                          // 初始化
public interface IAwake<A> { }                       // 带参数初始化
public interface IDestroy { }                        // 销毁
public interface IUpdate : IClassEvent<UpdateEvent> { } // 更新
public interface ISerialize { }                     // 序列化前
public interface IDeserialize { }                   // 反序列化后

// 异步生命周期
public interface IAwakeAsync { }
public interface IAwakeAsync<A> { }