Quellcode durchsuchen

Update docs

master
Savorboard vor 3 Jahren
Ursprung
Commit
20ff7d9531
6 geänderte Dateien mit 115 neuen und 2 gelöschten Zeilen
  1. +56
    -0
      docs/content/about/release-notes.md
  2. +2
    -0
      docs/content/user-guide/en/getting-started/introduction.md
  3. +26
    -0
      docs/content/user-guide/en/getting-started/quick-start.md
  4. +2
    -0
      docs/content/user-guide/zh/getting-started/introduction.md
  5. +19
    -0
      docs/content/user-guide/zh/transport/azure-service-bus.md
  6. +10
    -2
      docs/mkdocs.yml

+ 56
- 0
docs/content/about/release-notes.md Datei anzeigen

@@ -1,5 +1,61 @@
# Release Notes

## Version 5.0.1 (2021-04-07)

**Features:**

* Add KafkaOptions.MainConfig to AutoCreateTopic. (#810)
* Add support rewriting the default configuration of Kafka consumer. (#822)
* Add DefaultChallengeScheme dashboard options to specify dashboard auth challenge scheme. (#815)

**Bug Fixed:**
* Fixed topic selector in IConsumerServiceSelector. (#806)
* Update AWS topic subscription and SQS access policy generation. (#808)
* Fixed memory leak when using transction to publish message. (#816)
* Fixed SQL content filter on IMonitoringApi.PostgreSql.cs. (#814)
* Fixed the expiration time display problem in the dashboard due to time zone issues (#820)
* Fixed the creation timing of Kafka automatically creating Topic. (#823)
* Fixed Dashboard metric not update. (#819)

## Version 5.0.0 (2021-03-23)
**Features:**

* Upgrade to .NET Standard 2.1 and support .NET 5. (#727)
* Replace Newtonsoft.Json to System.Text.Json. (#740)
* Support NATS Transport. (#595,#743)
* Enabling publiser confirms for RabbitMQ. (#730)
* Support query subscription from DI implementation factory. (#756)
* Add options to create lazy queue for RabbitMQ. (#772)
* Support to add custom tags for Consul. (#786)
* Support custom group and topic prefiex. (#780)
* Renemae DefaultGroup option to DefaultGroupName.
* Add auto create topic at startup for Kafka. (#795,#744)

**Bug Fixed:**

* Fixed retrying process earlier than consumer registration to DI. (#760)
* Fixed Amazon SQS missing pagination topics. (#765)
* Fixed RabbitMQ MessageTTL option to int type. (#787)
* Fixed Dashboard auth. (#793)
* Fixed ClientProvidedName could not be renamed for RabbitMQ. (#791)
* Fixed EntityFramework transaction will not rollback when exception occurred. (#798)

## Version 3.1.2 (2020-12-03)

**Features:**
* Support record the exception message in the headers. (#679)
* Support consul service check for https. (#722)
* Support custom producer threads count options for sending. (#731)
* Upgrade dependent nuget packages to latest.

**Bug Fixed:**

* Fixed InmemoryQueue expired messages are not removed bug. (#691)
* Fixed Executor key change lead to possible null reference exception. (#698)
* Fixed Postgresql delete expires data logic error. (#714)

## Version 3.1.1 (2020-09-23)

**Features:**


+ 2
- 0
docs/content/user-guide/en/getting-started/introduction.md Datei anzeigen

@@ -25,6 +25,8 @@ CAP is modular in design and highly scalable. You have many options to choose fr

[Article: Introduction and how to use](http://www.cnblogs.com/savorboard/p/cap.html)

[Article: New features in version 5.0](https://www.cnblogs.com/savorboard/p/cap-5-0.html)

[Article: New features in version 3.0](https://www.cnblogs.com/savorboard/p/cap-3-0.html)

[Article: New features in version 2.6](https://www.cnblogs.com/savorboard/p/cap-2-6.html)


+ 26
- 0
docs/content/user-guide/en/getting-started/quick-start.md Datei anzeigen

@@ -45,6 +45,19 @@ public class PublishController : Controller
}
```

### Publish with extra header

```c#
var header = new Dictionary<string, string>()
{
["my.header.first"] = "first",
["my.header.second"] = "second"
};

capBus.Publish("test.show.time", DateTime.Now, header);

```

## Process Message

```C#
@@ -59,6 +72,19 @@ public class ConsumerController : Controller
}
```

### Process with extra header

```c#
[CapSubscribe("test.show.time")]
public void ReceiveMessage(DateTime time, [FromCap]CapHeader header)
{
Console.WriteLine("message time is:" + time);
Console.WriteLine("message firset header :" + header["my.header.first"]);
Console.WriteLine("message second header :" + header["my.header.second"]);
}

```

## Summary

One of the most powerful advantages of asynchronous messaging over direct integrated message queues is reliability, where failures in one part of the system do not propagate or cause the entire system to crash. Messages are stored inside the CAP to ensure the reliability of the message, and strategies such as retry are used to achieve the final consistency of data between services.

+ 2
- 0
docs/content/user-guide/zh/getting-started/introduction.md Datei anzeigen

@@ -25,6 +25,8 @@ CAP 采用模块化设计,具有高度的可扩展性。你有许多选项可

[Article: CAP 介绍及使用](http://www.cnblogs.com/savorboard/p/cap.html)

[Article: CAP 5.0 版本中的新特性](https://www.cnblogs.com/savorboard/p/cap-5-0.html)

[Article: CAP 3.0 版本中的新特性](https://www.cnblogs.com/savorboard/p/cap-3-0.html)

[Article: CAP 2.6 版本中的新特性](https://www.cnblogs.com/savorboard/p/cap-2-6.html)


+ 19
- 0
docs/content/user-guide/zh/transport/azure-service-bus.md Datei anzeigen

@@ -45,4 +45,23 @@ NAME | DESCRIPTION | TYPE | DEFAULT
:---|:---|---|:---
ConnectionString | Endpoint 地址 | string |
TopicPath | Topic entity path | string | cap
EnableSessions | 启用 [Service bus sessions](https://docs.microsoft.com/en-us/azure/service-bus-messaging/message-sessions) | bool | false
ManagementTokenProvider | Token提供 | ITokenProvider | null

#### Sessions

当使用 `EnableSessions` 选项启用 sessions 后,每个发送的消息都会具有一个 session id。 要控制 seesion id 你可以在发送消息时在消息头中使用 `AzureServiceBusHeaders.SessionId` 携带它。


```csharp
ICapPublisher capBus = ...;
string yourEventName = ...;
YourEventType yourEvent = ...;

Dictionary<string, string> extraHeaders = new Dictionary<string, string>();
extraHeaders.Add(AzureServiceBusHeaders.SessionId, <your-session-id>);

capBus.Publish(yourEventName, yourEvent, extraHeaders);
```

如果头中没有 session id , 那么消息 Id 仍然使用的 Message Id.

+ 10
- 2
docs/mkdocs.yml Datei anzeigen

@@ -19,18 +19,26 @@ theme:
palette:
primary: 'deep purple'
accent: 'indigo'
language: 'en'
language: en
include_sidebar: true
logo: 'img/logo.svg'
favicon: 'img/favicon.ico'
features:
- tabs
- navigation.tabs
- navigation.instant
i18n:
prev: 'Previous'
next: 'Next'

#Customization
extra:
alternate:
- name: English
link: /user-guide/en/getting-started/quick-start
lang: en
- name: 中文
link: /user-guide/zh/getting-started/quick-start
lang: zh
social:
- icon: 'fontawesome/brands/github'
link: 'https://github.com/dotnetcore/CAP'


Laden…
Abbrechen
Speichern