Browse Source

Translate the best-practices/entites document

pull/550/head
梁士伟 8 years ago
parent
commit
237fb2f31d
  1. 112
      docs/zh-Hans/Best-Practices/Entities.md
  2. 2
      docs/zh-Hans/Entity-Framework-Core.md

112
docs/zh-Hans/Best-Practices/Entities.md

@ -1,98 +1,98 @@
## Entity Best Practices & Conventions ## 实体最佳实践 & 约定
### Entities ### 实体
Every aggregate root is also an entity. So, these rules are valid for aggregate roots too unless aggregate root rules override them. 每个聚合根也是一个实体, 所以这些规则对聚合根也是有效的, 除非聚合根的某些规则覆盖了它们.
- **Do** define entities in the **domain layer**. - **推荐** 在 **领域层** 中定义实体.
#### Primary Constructor #### 主构造函数
* **Do** define a **primary constructor** that ensures the validity of the entity on creation. Primary constructors are used to create a new instance of the entity by the application code. * **推荐** 定义一个 **主构造函数** 确保实体在创建时的有效性, 在代码中通过主构造函数创建实体的新实例.
- **Do** define primary constructor as `public`, `internal` or `protected internal` based on the requirements. If it's not public, the entity is expected to be created by a domain service. - **推荐** 根据需求把主构造函数定义为 `public`,`internal` 或 `protected internal` . 如果它不是public的, 那么应该由领域服务来创建实体.
- **Do** always initialize sub collections in the primary constructor. - **推荐** 总是在主构造函数中初始化子集合.
- **Do not** generate `Guid` keys inside the constructor. Get it as a parameter, so the calling code will use `IGuidGenerator` to generate a new `Guid` value. - **不推荐** 在主构造函数中生成 `Guid` 键, 应该将其做为参数获取, 在调用时推荐使用 `IGuidGenerator` 生成新的 `Guid` 值做为参数.
#### Parameterless Constructor #### 无参构造函数
- **Do** always define a `protected` parameterless constructor to be compatible with ORMs. - **推荐** 总是定义 `protected` 无参构造函数与ORM兼容.
#### References #### 引用
- **Do** always **reference** to other aggregate roots **by Id**. Never add navigation properties to other aggregate roots. - **推荐** 总是通过 **id** **引用** 其他聚合根, 不要将导航属性添加到其他聚合根中.
#### Other Class Members #### 类的其他成员
- **Do** always define properties and methods as `virtual` (except `private` methods, obviously). Because some ORMs and dynamic proxy tools require it. - **推荐** 总是将属性与方法定义为 `virtual` (除了`私有`方法 ). 因为有些ORM和动态代理工具需要.
- **Do** keep the entity as always **valid** and **consistent** within its own boundary. - **推荐** 保持实体在自身边界内始终 **有效** 和 **一致**.
- **Do** define properties with `private`, `protected`, `internal ` or `protected internal` setter where it is needed to protect the entity consistency and validity. - **推荐** 使用 `private`,`protected`,`internal`或`protected internal` setter定义属性, 保护实体的一致性和有效性.
- **Do** define `public `, `internal` or `protected internal` (virtual) **methods** to change the properties (with non-public setters) if necessary. - **推荐** 定义 `public`, `internal` 或 `protected internal` (virtual)**方法**在必要时更改属性值(使用非public setters时).
### Aggregate Roots ### 聚合根
#### Primary Keys #### 主键
* **Do** always use a **Id** property for the aggregate root key. * **推荐** 总是使用 **Id** 属性做为聚合根主键.
* **Do not** use **composite keys** for aggregate roots. * **不推荐** 在聚合根中使用 **复合主键**.
* **Do** use **Guid** as the **primary key** of all aggregate roots. * **推荐** 所有的聚合根都使用 **Guid** 类型 **主键**.
#### Base Class #### 基类
* **Do** inherit from the `AggregateRoot<TKey>` or one of the audited classes (`CreationAuditedAggregateRoot<TKey>`, `AuditedAggregateRoot<TKey>` or `FullAuditedAggregateRoot<TKey>`) based on requirements. * **推荐** 根据需求继承 `AggregateRoot<TKey>` 或以下一个审计类 (`CreationAuditedAggregateRoot<TKey>`, `AuditedAggregateRoot<TKey>` 或 `FullAuditedAggregateRoot<TKey>`).
#### Aggregate Boundary #### 聚合边界
* **Do** keep aggregates **as small as possible**. Most of the aggregates will only have primitive properties and will not have sub collections. Consider these as design decisions: * **推荐** 聚合**尽可能小**. 大多数聚合只有原始属性, 不会有子集合. 把这些视为设计决策:
* **Performance** & **memory** cost of loading & saving aggregates (keep in mind that an aggregate is normally loaded & saved as a single unit). Larger aggregates will consume more CPU & memory. * 加载和保存聚合的 **性能** 与 **内存** 成本 (请记住,聚合通常是做为一个单独的单元被加载和保存的). 较大的聚合会消耗更多的CPU和内存.
* **Consistency** & **validity** boundary. * **一致性** & **有效性** 边界.
### Example ### 示例
#### Aggregate Root #### 聚合根
````C# ````C#
public class Issue : FullAuditedAggregateRoot<Guid> //Using Guid as the key/identifier public class Issue : FullAuditedAggregateRoot<Guid> //使用Guid作为键/标识符
{ {
public virtual string Title { get; private set; } //Changed using the SetTitle() method public virtual string Title { get; private set; } //使用 SetTitle() 方法set
public virtual string Text { get; set; } //Can be directly changed. null values are allowed public virtual string Text { get; set; } //可以直接set,null值也是允许的
public virtual Guid? MilestoneId { get; set; } //Reference to another aggregate root public virtual Guid? MilestoneId { get; set; } //引用其他聚合根
public virtual bool IsClosed { get; private set; } public virtual bool IsClosed { get; private set; }
public virtual IssueCloseReason? CloseReason { get; private set; } //Just an enum type public virtual IssueCloseReason? CloseReason { get; private set; } //一个枚举类型
public virtual Collection<IssueLabel> Labels { get; protected set; } //Sub collection public virtual Collection<IssueLabel> Labels { get; protected set; } //子集合
protected Issue() protected Issue()
{ {
/* This conctructor is for ORMs to be used while getting the entity from database. /* 此构造函数是提供给ORM用来从数据库中获取实体.
* - No need to initialize the Labels collection * - 无需初始化Lanels集合
since it will be overrided from the database. 因为它会被来自数据库的值覆盖.
- It's protected since proxying and deserialization tools - It's protected since proxying and deserialization tools
may not work with private constructors. 可能不适用于私有构造函数.
*/ */
} }
//Primary constructor //主构造函数
public Issue( public Issue(
Guid id, //Get Guid value from the calling code Guid id, //从调用代码中获取Guid值
[NotNull] string title, //Indicate that the title can not be null. [NotNull] string title, //表示标题不能为空.
string text = null, string text = null,
Guid? milestoneId = null) //Optional argument Guid? milestoneId = null) //可选参数
{ {
Id = id; Id = id;
Title = Check.NotNullOrWhiteSpace(title, nameof(title)); //Validate Title = Check.NotNullOrWhiteSpace(title, nameof(title)); //验证
Text = text; Text = text;
MilestoneId = milestoneId; MilestoneId = milestoneId;
Labels = new Collection<IssueLabel>(); //Always initialize the collection Labels = new Collection<IssueLabel>(); //总是初始化子集合
} }
public virtual void SetTitle([NotNull] string title) public virtual void SetTitle([NotNull] string title)
{ {
Title = Check.NotNullOrWhiteSpace(title, nameof(title)); //Validate Title = Check.NotNullOrWhiteSpace(title, nameof(title)); //验证
} }
/* AddLabel & RemoveLabel methods manages the Labels collection /* AddLabel和RemoveLabel方法管理Labels集合
* in a safe way (prevents adding the same label twice) */ * 安全的方式(防止两次添加相同的标签) */
public virtual void AddLabel(Guid labelId) public virtual void AddLabel(Guid labelId)
{ {
@ -109,8 +109,8 @@ public class Issue : FullAuditedAggregateRoot<Guid> //Using Guid as the key/iden
Labels.RemoveAll(l => l.LabelId == labelId); Labels.RemoveAll(l => l.LabelId == labelId);
} }
/* Close & ReOpen methods protect the consistency /* Close和ReOpen方法可保护一致性
* of the IsClosed and the CloseReason properties. */ * IsClosed 与 CloseReason 属性. */
public virtual void Close(IssueCloseReason reason) public virtual void Close(IssueCloseReason reason)
{ {
@ -126,7 +126,7 @@ public class Issue : FullAuditedAggregateRoot<Guid> //Using Guid as the key/iden
} }
```` ````
#### The Entity #### 实体
````C# ````C#
public class IssueLabel : Entity public class IssueLabel : Entity
@ -136,7 +136,7 @@ public class IssueLabel : Entity
protected IssueLabel() protected IssueLabel()
{ {
} }
public IssueLabel(Guid issueId, Guid labelId) public IssueLabel(Guid issueId, Guid labelId)
@ -147,7 +147,7 @@ public class IssueLabel : Entity
} }
```` ````
### References ### 参考文献
* Effective Aggregate Design by Vaughn Vernon * Effective Aggregate Design by Vaughn Vernon
http://dddcommunity.org/library/vernon_2011 http://dddcommunity.org/library/vernon_2011

2
docs/zh-Hans/Entity-Framework-Core.md

@ -1,6 +1,6 @@
## Entity Framework Core 集成 ## Entity Framework Core 集成
本文档介绍了如何将EF Core作为ORM提供程序集成到基于ABP的应用程序以及如何对其进行配置. 本文介绍了如何将EF Core作为ORM提供程序集成到基于ABP的应用程序以及如何对其进行配置.
### 安装 ### 安装

Loading…
Cancel
Save