文档更新

AterDev · Feb 22, 2024 · 05b4862 · 05b4862
1 parent 96367ee
commit 05b4862
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 37 deletions.
diff --git a/zh/ater.dry/代码生成说明/Manager生成.md b/zh/ater.dry/代码生成说明/Manager生成.md
@@ -1,2 +1 @@
 # Manager代码生成说明
-
diff --git a/zh/ater.web/教程/分层项目说明/Application.md b/zh/ater.web/教程/分层项目说明/Application.md
@@ -13,35 +13,13 @@ Application层是业务实现的核心层，大多数业务逻辑实现都在该
 
 应用常量定义目录
 
-## QueryStore
-
-实体只读数据仓储的基类定义，请勿直接修改。
-
-## CommandStore
-
-实体可写数据仓储的基类定义，请勿直接修改。
-
 ## Implement
 
 数据仓储的基础实现类，请勿直接修改。
 
-## Interface
-
-数据仓储的接口定义，请勿直接修改。
-
-提供两个扩展接口实现自定义
-
-`interface ICommandStoreExt<TEntity>`
-
-`interface IQueryStoreExt<TEntity>`
-
 > [!IMPORTANT]
 > 为了保持兼容性，请不要直接修改以上默认生成的内容，如果你需要自定义，可通过`partial class`、`扩展接口`以及`继承类`的方式实现。
 
-## IManager
-
-业务逻辑接口目录，可通过生成器生成，可自由修改。
-
 ## Manager
 
 业务逻辑实现目录，可通过生成器生成，可自由修改。
@@ -62,7 +40,6 @@ Application层是业务实现的核心层，大多数业务逻辑实现都在该
 
 ### 业务层实现
 
-- 创建或修改`IUserManager`接口，定义功能接口。
 - 创建或修改`UserManager.cs`,继承`DomainManagerBase<User>`,实现`IUserManager`定义的业务逻辑。
 - 父类已实现常见的**CURD**操作。
 

diff --git a/zh/ater.web/教程/分层项目说明/Definition.md b/zh/ater.web/教程/分层项目说明/Definition.md
@@ -0,0 +1,35 @@
+# Definition
+
+该目录包含三个项目，都是用来定义业务对象的，包括实体定义、DTO定义和ORM的定义。
+
+## Entity
+
+用来定义实体模型类的项目，并且所有实体模型都应该放到该项目中。
+
+## EntityFramework
+
+该项目是对EntityFramework的基础配置和封装，分别定义了`Command`和`Query` DbContext，以及Factory模式的定义。
+
+通常你只需要在`ContextBase`中定义相应的实体`DbSet`属性。
+
+如果使用`dry studio`代码生成，你甚至不需要手动修改该项目下的代码。
+
+## Share
+
+`Share`项目是在`Entity`之上的共享项目，它引用`Entity`项目。
+
+该项目主要是提供`Dto`类型文件，以及封装和处理一些基础模块功能。
+
+### Models
+
+提供相关模型和`Dto`
+
+### Options
+
+提供选项模型
+
+## 建议及约定
+
+1. 该项目中封装的服务或功能，可单独进行测试，不与业务关联
+2. 不进行数据库相关操作
+3. 不进行业务逻辑处理
diff --git a/zh/ater.web/教程/分层项目说明/Entity.md b/zh/ater.web/教程/分层项目说明/Entity.md
diff --git a/zh/ater.web/教程/分层项目说明/Http.API.md b/zh/ater.web/教程/分层项目说明/Http.API.md
@@ -40,16 +40,6 @@ Program是`ASP.NET Core`中极其重要的入口类，在这里我们需要完
 
 可以根据实际需求自由替换。
 
-## RestControllerBase 基类
-
-基类提供了对`Swagger`的支持，定义了基本路由，覆写了部分响应对象，
-
-你可以在`Infrastructure\RestControllerBase.cs`中查看。
-
-## ClientApp
-
-集成前端`Angular`项目，如果不需要，可直接删除。
-
 ## Middleware
 
 自定义中间件实现

diff --git a/zh/ater.web/教程/分层项目说明/Infrastructure.md b/zh/ater.web/教程/分层项目说明/Infrastructure.md
@@ -0,0 +1,5 @@
+# Infrastructure
+
+该目录包含两个项目，是其他项目的基础核心依赖，主要定义了一些基础接口、模型以及扩展方法。
+
+通常你不需要关心该目录下的项目，也不应该修改该目录下的代码。
diff --git a/zh/ater.web/教程/项目结构说明.md b/zh/ater.web/教程/项目结构说明.md
@@ -12,6 +12,7 @@
 
 ## 代码目录src
 
+- Infrastructure 框架的基础定义，通常不需要关心，也不应该修改。
 - Definition 定义层，先定义后实施，该目录主要是定义实体和DTO，以及ORM关系等。
   - Entity 基础核心类库，**`实体模型`** 定义所在项目，包括基础库的扩展，辅助类等。
   - Share 共享类库，**`DTO`** 定义所在项目，可在多个应用间共用的内容，如各类模型定义、通用配置、数据处理转换等，依赖 `Entity`。