mirror of https://github.com/abpframework/abp.git
Halil İbrahim Kalkan
5 years ago
325 changed files with 56494 additions and 4218 deletions
@ -1,3 +1,147 @@ |
|||||
## Concurrency Check |
## Concurrency Check |
||||
|
|
||||
TODO |
### Introduction |
||||
|
|
||||
|
Concurrency Check (also known as **Concurrency Control**) refers to specific mechanisms used to ensure data consistency in the presence of concurrent changes (multiple processes, users access or change the same data in a database at the same time). |
||||
|
|
||||
|
There are two commonly used concurrency control mechanisms/approaches: |
||||
|
* **Optimistic Concurrency Control**: Optimistic Concurrency Control allows multiple users to attempt to **update** the same record without informing the users that others are also attempting to **update** it. |
||||
|
|
||||
|
* If a user successfully updates the record, the other users need to get the latest changes for the current record to be able to make changes. |
||||
|
* ABP's concurrency check system uses the **Optimistic Concurrency Control**. |
||||
|
|
||||
|
* **Pessimistic Concurrency Control**: Pessimistic Concurrency Control prevents simultaneous updates to records and uses a locking mechanism. For more information please see [here](https://www.martinfowler.com/eaaCatalog/pessimisticOfflineLock.html). |
||||
|
|
||||
|
### Usage |
||||
|
|
||||
|
#### `IHasConcurrencyStamp` Interface |
||||
|
|
||||
|
To enable **concurrency control** to your entity class, you should implement the `IHasConcurrencyStamp` interface, directly or indirectly. |
||||
|
|
||||
|
```csharp |
||||
|
public interface IHasConcurrencyStamp |
||||
|
{ |
||||
|
public string ConcurrencyStamp { get; set; } |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
* It is the base interface for **concurrency control** and only has a simple property named `ConcurrencyStamp`. |
||||
|
* While a new record is **creating**, if the entity implements the `IHasConcurrencyStamp` interface, ABP Framework automatically sets a unique value to the **ConcurrencyStamp** property. |
||||
|
* While a record is **updating**, ABP Framework compares the **ConcurrencyStamp** property of the entity with the provided **ConcurrencyStamp** value by the user and if the values match, it automatically updates the **ConcurrencyStamp** property with the new unique value. If there is a mismatch, `AbpDbConcurrencyException` is thrown. |
||||
|
|
||||
|
**Example: Applying Concurrency Control for the Book Entity** |
||||
|
|
||||
|
Implement the `IHasConcurrencyStamp` interface for your entity: |
||||
|
|
||||
|
```csharp |
||||
|
public class Book : Entity<Guid>, IHasConcurrencyStamp |
||||
|
{ |
||||
|
public string ConcurrencyStamp { get; set; } |
||||
|
|
||||
|
//... |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
Also, implement your output and update the DTO classes from the `IHasConcurrencyStamp` interface: |
||||
|
|
||||
|
```csharp |
||||
|
public class BookDto : EntityDto<Guid>, IHasConcurrencyStamp |
||||
|
{ |
||||
|
//... |
||||
|
|
||||
|
public string ConcurrencyStamp { get; set; } |
||||
|
} |
||||
|
|
||||
|
public class UpdateBookDto : IHasConcurrencyStamp |
||||
|
{ |
||||
|
//... |
||||
|
|
||||
|
public string ConcurrencyStamp { get; set; } |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
Set the **ConcurrencyStamp** input value to the entity in the **UpdateAsync** method of your application service, for that purpose you can use the `SetConcurrencyStampIfNotNull` method as below: |
||||
|
|
||||
|
```csharp |
||||
|
public class BookAppService : ApplicationService, IBookAppService |
||||
|
{ |
||||
|
//... |
||||
|
|
||||
|
public virtual async Task<BookDto> UpdateAsync(Guid id, UpdateBookDto input) |
||||
|
{ |
||||
|
var book = await BookRepository.GetAsync(id); |
||||
|
|
||||
|
book.SetConcurrencyStampIfNotNull(input.ConcurrencyStamp); |
||||
|
|
||||
|
//set other input values to the entity ... |
||||
|
|
||||
|
await BookRepository.UpdateAsync(book); |
||||
|
} |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
* After that, when multiple users try to update the same record at the same time, the concurrency stamp mismatch occurs and `AbpDbConcurrencyException` is thrown. |
||||
|
|
||||
|
#### Base Classes |
||||
|
|
||||
|
[Aggregate Root](./Entities.md#aggregateroot-class) entity classes already implement the `IHasConcurrencyStamp` interface. So, if you are deriving from one of these base classes, you don't need to manually implement the `IHasConcurrencyStamp` interface: |
||||
|
|
||||
|
- `AggregateRoot`, `AggregateRoot<TKey>` |
||||
|
- `CreationAuditedAggregateRoot`, `CreationAuditedAggregateRoot<TKey>` |
||||
|
- `AuditedAggregateRoot`, `AuditedAggregateRoot<TKey>` |
||||
|
- `FullAuditedAggregateRoot`, `FullAuditedAggregateRoot<TKey>` |
||||
|
|
||||
|
**Example: Applying Concurrency Control for the Book Entity** |
||||
|
|
||||
|
You can inherit your entity from one of [the base classes](#base-classes): |
||||
|
|
||||
|
```csharp |
||||
|
public class Book : FullAuditedAggregateRoot<Guid> |
||||
|
{ |
||||
|
//... |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
Then, you can implement your output and update the DTO classes from the `IHasConcurrencyStamp` interface: |
||||
|
|
||||
|
```csharp |
||||
|
public class BookDto : EntityDto<Guid>, IHasConcurrencyStamp |
||||
|
{ |
||||
|
//... |
||||
|
|
||||
|
public string ConcurrencyStamp { get; set; } |
||||
|
} |
||||
|
|
||||
|
public class UpdateBookDto : IHasConcurrencyStamp |
||||
|
{ |
||||
|
//... |
||||
|
|
||||
|
public string ConcurrencyStamp { get; set; } |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
Set the **ConcurrencyStamp** input value to the entity in the **UpdateAsync** method of your application service, for that purpose you can use the `SetConcurrencyStampIfNotNull` method as below: |
||||
|
|
||||
|
```csharp |
||||
|
public class BookAppService : ApplicationService, IBookAppService |
||||
|
{ |
||||
|
//... |
||||
|
|
||||
|
public virtual async Task<BookDto> UpdateAsync(Guid id, UpdateBookDto input) |
||||
|
{ |
||||
|
var book = await BookRepository.GetAsync(id); |
||||
|
|
||||
|
book.SetConcurrencyStampIfNotNull(input.ConcurrencyStamp); |
||||
|
|
||||
|
//set other input values to the entity ... |
||||
|
|
||||
|
await BookRepository.UpdateAsync(book); |
||||
|
} |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
After that, when multiple users try to update the same record at the same time, the concurrency stamp mismatch occurs and `AbpDbConcurrencyException` is thrown. You can either handle the exception manually or let the ABP Framework handle it for you. |
||||
|
|
||||
|
ABP Framework shows a user-friendly error message as in the image below, if you don't handle the exception manually. |
||||
|
|
||||
|
 |
||||
|
|||||
|
After Width: | Height: | Size: 21 KiB |
@ -1,3 +1,128 @@ |
|||||
# ABP Documentation |
# 领域服务 |
||||
|
|
||||
待添加 |
## 介绍 |
||||
|
|
||||
|
在 [领域驱动设计](Domain-Driven-Design.md) (DDD) 解决方案中,核心业务逻辑通常在聚合 ([实体](Entities.md)) 和领域服务中实现. 在以下情况下特别需要创建领域服务 |
||||
|
|
||||
|
* 你实现了依赖于某些服务（如存储库或其他外部服务）的核心域逻辑. |
||||
|
* 你需要实现的逻辑与多个聚合/实体相关,因此它不适合任何聚合. |
||||
|
|
||||
|
## ABP 领域服务基础设施 |
||||
|
|
||||
|
领域服务是简单的无状态类. 虽然你不必从任何服务或接口派生,但 ABP 框架提供了一些有用的基类和约定. |
||||
|
|
||||
|
### DomainService 和 IDomainService |
||||
|
|
||||
|
从 `DomainService` 基类派生领域服务或直接实现 `IDomainService` 接口. |
||||
|
|
||||
|
**示例: 创建从 `DomainService` 基类派生的领域服务.** |
||||
|
|
||||
|
````csharp |
||||
|
using Volo.Abp.Domain.Services; |
||||
|
namespace MyProject.Issues |
||||
|
{ |
||||
|
public class IssueManager : DomainService |
||||
|
{ |
||||
|
|
||||
|
} |
||||
|
} |
||||
|
```` |
||||
|
|
||||
|
当你这样做时: |
||||
|
|
||||
|
* ABP 框架自动将类注册为瞬态生命周期到依赖注入系统. |
||||
|
* 你可以直接使用一些常用服务作为基础属性,而无需手动注入 (例如 [ILogger](Logging.md) and [IGuidGenerator](Guid-Generation.md)). |
||||
|
|
||||
|
> 建议使用 `Manager` 或 `Service` 后缀命名领域服务. 我们通常使用如上面示例中的 `Manager` 后缀. |
||||
|
**示例: 实现将问题分配给用户的领域逻辑** |
||||
|
|
||||
|
````csharp |
||||
|
public class IssueManager : DomainService |
||||
|
{ |
||||
|
private readonly IRepository<Issue, Guid> _issueRepository; |
||||
|
public IssueManager(IRepository<Issue, Guid> issueRepository) |
||||
|
{ |
||||
|
_issueRepository = issueRepository; |
||||
|
} |
||||
|
|
||||
|
public async Task AssignAsync(Issue issue, AppUser user) |
||||
|
{ |
||||
|
var currentIssueCount = await _issueRepository |
||||
|
.CountAsync(i => i.AssignedUserId == user.Id); |
||||
|
|
||||
|
//Implementing a core business validation |
||||
|
if (currentIssueCount >= 3) |
||||
|
{ |
||||
|
throw new IssueAssignmentException(user.UserName); |
||||
|
} |
||||
|
issue.AssignedUserId = user.Id; |
||||
|
} |
||||
|
} |
||||
|
```` |
||||
|
|
||||
|
问题是定义如下所示的 [聚合根](Entities.md): |
||||
|
|
||||
|
````csharp |
||||
|
public class Issue : AggregateRoot<Guid> |
||||
|
{ |
||||
|
public Guid? AssignedUserId { get; internal set; } |
||||
|
|
||||
|
//... |
||||
|
} |
||||
|
```` |
||||
|
|
||||
|
* 使用 `internal` 的 set 确保外层调用者不能直接在调用 set ,并强制始终使用 `IssueManager` 为 `User` 分配 `Issue`. |
||||
|
|
||||
|
### 使用领域服务 |
||||
|
|
||||
|
领域服务通常用于 [应用程序服务](Application-Services.md). |
||||
|
|
||||
|
**示例: 使用 `IssueManager` 将问题分配给用户** |
||||
|
|
||||
|
````csharp |
||||
|
using System; |
||||
|
using System.Threading.Tasks; |
||||
|
using MyProject.Users; |
||||
|
using Volo.Abp.Application.Services; |
||||
|
using Volo.Abp.Domain.Repositories; |
||||
|
namespace MyProject.Issues |
||||
|
{ |
||||
|
public class IssueAppService : ApplicationService, IIssueAppService |
||||
|
{ |
||||
|
private readonly IssueManager _issueManager; |
||||
|
private readonly IRepository<AppUser, Guid> _userRepository; |
||||
|
private readonly IRepository<Issue, Guid> _issueRepository; |
||||
|
public IssueAppService( |
||||
|
IssueManager issueManager, |
||||
|
IRepository<AppUser, Guid> userRepository, |
||||
|
IRepository<Issue, Guid> issueRepository) |
||||
|
{ |
||||
|
_issueManager = issueManager; |
||||
|
_userRepository = userRepository; |
||||
|
_issueRepository = issueRepository; |
||||
|
} |
||||
|
public async Task AssignAsync(Guid id, Guid userId) |
||||
|
{ |
||||
|
var issue = await _issueRepository.GetAsync(id); |
||||
|
var user = await _userRepository.GetAsync(userId); |
||||
|
await _issueManager.AssignAsync(issue, user); |
||||
|
await _issueRepository.UpdateAsync(issue); |
||||
|
} |
||||
|
} |
||||
|
} |
||||
|
```` |
||||
|
|
||||
|
由于 `IssueAppService` 在应用层, 它不能直接将问题分配给用户.因此,它使用 `IssueManager`. |
||||
|
|
||||
|
## 应用程序服务与领域服务 |
||||
|
|
||||
|
虽然应用服务和领域服务都实现了业务规则,但存在根本的逻辑和形式差异； |
||||
|
虽然 [应用服务](Application-Services.md) 和领域服务都实现了业务规则,但存在根本的逻辑和形式差异: |
||||
|
|
||||
|
* 应用程序服务实现应用程序的 **用例** (典型 Web 应用程序中的用户交互), 而领域服务实现 **核心的、用例独立的领域逻辑**. |
||||
|
* 应用程序服务获取/返回 [数据传输对象](Data-Transfer-Objects.md), 领域服务方法通常获取和返回 **领域对象** ([实体](Entities.md), [值对象](Value-Objects.md)). |
||||
|
* 领域服务通常由应用程序服务或其他领域服务使用,而应用程序服务由表示层或客户端应用程序使用. |
||||
|
|
||||
|
## 生命周期 |
||||
|
|
||||
|
领域服务的生命周期是 [瞬态](https://docs.abp.io/en/abp/latest/Dependency-Injection) 的,它们会自动注册到依赖注入服务. |
||||
|
|||||
@ -0,0 +1,18 @@ |
|||||
|
using System; |
||||
|
using System.Collections.Generic; |
||||
|
|
||||
|
namespace Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations; |
||||
|
|
||||
|
[Serializable] |
||||
|
public class ApplicationGlobalFeatureConfigurationDto |
||||
|
{ |
||||
|
public HashSet<string> EnabledFeatures { get; set; } |
||||
|
|
||||
|
public Dictionary<string, List<string>> ModuleEnabledFeatures { get; set; } |
||||
|
|
||||
|
public ApplicationGlobalFeatureConfigurationDto() |
||||
|
{ |
||||
|
EnabledFeatures = new HashSet<string>(); |
||||
|
ModuleEnabledFeatures = new Dictionary<string, List<string>>(); |
||||
|
} |
||||
|
} |
||||
@ -1,10 +1,23 @@ |
|||||
namespace Volo.Abp.EventBus.RabbitMq; |
using Volo.Abp.RabbitMQ; |
||||
|
|
||||
|
namespace Volo.Abp.EventBus.RabbitMq; |
||||
|
|
||||
public class AbpRabbitMqEventBusOptions |
public class AbpRabbitMqEventBusOptions |
||||
{ |
{ |
||||
|
public const string DefaultExchangeType = RabbitMqConsts.ExchangeTypes.Direct; |
||||
|
|
||||
public string ConnectionName { get; set; } |
public string ConnectionName { get; set; } |
||||
|
|
||||
public string ClientName { get; set; } |
public string ClientName { get; set; } |
||||
|
|
||||
public string ExchangeName { get; set; } |
public string ExchangeName { get; set; } |
||||
|
|
||||
|
public string ExchangeType { get; set; } |
||||
|
|
||||
|
public string GetExchangeTypeOrDefault() |
||||
|
{ |
||||
|
return string.IsNullOrEmpty(ExchangeType) |
||||
|
? DefaultExchangeType |
||||
|
: ExchangeType; |
||||
|
} |
||||
} |
} |
||||
|
|||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
@ -0,0 +1,26 @@ |
|||||
|
using Microsoft.EntityFrameworkCore.Migrations; |
||||
|
|
||||
|
#nullable disable |
||||
|
|
||||
|
namespace Volo.CmsKit.Migrations |
||||
|
{ |
||||
|
public partial class Added_BlogPostStatus : Migration |
||||
|
{ |
||||
|
protected override void Up(MigrationBuilder migrationBuilder) |
||||
|
{ |
||||
|
migrationBuilder.AddColumn<int>( |
||||
|
name: "Status", |
||||
|
table: "CmsBlogPosts", |
||||
|
type: "int", |
||||
|
nullable: false, |
||||
|
defaultValue: 0); |
||||
|
} |
||||
|
|
||||
|
protected override void Down(MigrationBuilder migrationBuilder) |
||||
|
{ |
||||
|
migrationBuilder.DropColumn( |
||||
|
name: "Status", |
||||
|
table: "CmsBlogPosts"); |
||||
|
} |
||||
|
} |
||||
|
} |
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue