Convey 开源项目使用教程

Convey 开源项目使用教程

ConveyA simple recipe for .NET Core microservices.项目地址:https://gitcode.com/gh_mirrors/co/Convey

1. 项目的目录结构及介绍

Convey 项目的目录结构如下：

Convey/
├── src/
│   ├── Convey.Auth/
│   ├── Convey.CQRS.Commands/
│   ├── Convey.CQRS.Queries/
│   ├── Convey.Discovery.Consul/
│   ├── Convey.Docs.Swagger/
│   ├── Convey.HTTP/
│   ├── Convey.LoadBalancing.Fabio/
│   ├── Convey.Logging/
│   ├── Convey.Metrics.AppMetrics/
│   ├── Convey.Persistence.MongoDB/
│   ├── Convey.Persistence.Redis/
│   ├── Convey.Secrets.Vault/
│   ├── Convey.Service.Http/
│   ├── Convey.Tracing.Jaeger/
│   ├── Convey.WebApi/
│   └── Convey.WebApi.Security/
├── tests/
│   ├── Convey.Tests/
│   └── Convey.WebApi.Tests/
├── .gitignore
├── .editorconfig
├── .gitattributes
├── README.md
└── LICENSE

目录结构介绍

• src/：包含所有项目的源代码。

  • Convey.Auth/：身份验证相关功能。
  • Convey.CQRS.Commands/：命令查询职责分离（CQRS）模式中的命令处理。
  • Convey.CQRS.Queries/：CQRS 模式中的查询处理。
  • Convey.Discovery.Consul/：服务发现功能，使用 Consul。
  • Convey.Docs.Swagger/：API 文档生成，使用 Swagger。
  • Convey.HTTP/：HTTP 客户端功能。
  • Convey.LoadBalancing.Fabio/：负载均衡功能，使用 Fabio。
  • Convey.Logging/：日志记录功能。
  • Convey.Metrics.AppMetrics/：应用性能监控，使用 AppMetrics。
  • Convey.Persistence.MongoDB/：MongoDB 数据持久化。
  • Convey.Persistence.Redis/：Redis 数据持久化。
  • Convey.Secrets.Vault/：密钥管理，使用 Vault。
  • Convey.Service.Http/：HTTP 服务功能。
  • Convey.Tracing.Jaeger/：分布式追踪，使用 Jaeger。
  • Convey.WebApi/：Web API 功能。
  • Convey.WebApi.Security/：Web API 安全功能。

• tests/：包含所有项目的测试代码。

  • Convey.Tests/：核心功能测试。
  • Convey.WebApi.Tests/：Web API 功能测试。

• .gitignore：Git 忽略文件配置。

• .editorconfig：编辑器配置文件。

• .gitattributes：Git 属性配置。

• README.md：项目说明文档。

• LICENSE：项目许可证。

2. 项目的启动文件介绍

Convey 项目的启动文件通常位于 src/Convey.WebApi/ 目录下。以下是一个典型的启动文件示例：

using Convey;
using Convey.WebApi;
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;

namespace Convey.WebApi
{
    public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddConvey()
                    .AddWebApi()
                    .Build();
        }

        public void Configure(IApplicationBuilder app)
        {
            app.UseConvey()
               .UseWebApi()
               .Run();
        }
    }
}

启动文件介绍

• ConfigureServices 方法：用于配置服务容器，注册依赖项。
• Configure 方法：用于配置 HTTP 请求处理管道，设置中间件。

3. 项目的配置文件介绍

Convey 项目的配置文件通常是一个 appsettings.json 文件，位于项目根目录下。以下是一个典型的配置文件示例：

{
  "Logging": {
    "LogLevel": {
      "Default

ConveyA simple recipe for .NET Core microservices.项目地址:https://gitcode.com/gh_mirrors/co/Convey