Anley.DomainDrivenDesign.Contract 1.1.1.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Anley.DomainDrivenDesign.Contract --version 1.1.1.1                

                    
                

            
NuGet\Install-Package Anley.DomainDrivenDesign.Contract -Version 1.1.1.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Anley.DomainDrivenDesign.Contract" Version="1.1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Anley.DomainDrivenDesign.Contract --version 1.1.1.1                

                    
                

            
#r "nuget: Anley.DomainDrivenDesign.Contract, 1.1.1.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Anley.DomainDrivenDesign.Contract as a Cake Addin
#addin nuget:?package=Anley.DomainDrivenDesign.Contract&version=1.1.1.1

// Install Anley.DomainDrivenDesign.Contract as a Cake Tool
#tool nuget:?package=Anley.DomainDrivenDesign.Contract&version=1.1.1.1

Anley.DomainDrivenDesign.Contract

领域驱动设计程序契约类库。

一、Application

1、AneResult - 结果类

用于约束API接口返回标准的操作结果。

示例操作结果如下：

{
  "code": 200,
  "message": ""
}

其中，code为结果码，其可能为以下值：

代码 结果类型
200 成功
300 失败
400 语义有误
401 未认证
403 拒绝执行
404 数据不存在
408 请求超时
409 操作冲突
500 内部错误

2、AneResult<TData> - 含数据的结果类

用于约束含数据的API接口返回标准的操作结果。

示例操作结果如下：

{
  "data": {
    "accessToken": "token",
    "expireMinutes": 120
  },
  "code": 200,
  "message": ""
}

3、FriendlyException - 友好异常类

用于抛出自定义业务异常。

实例化友好异常时，NLog将自动记录异常。

4、GlobalExceptionFilter - 全局异常处理类

全局异常捕捉，并返回符合AneResult标准的结果。其中，code值为500。

二、Authorization

1、AuthorizationHelper - 授权帮助类

  • GenerateAccessToken()：生成访问令牌（JWT），加密方式为国密SM2算法。
  • VerifyAccessToken()：验证访问令牌（JWT），返回当前用户

2、AuthorizationMiddleware - 授权中间件

授权验证。请求API接口时，请将访问令牌存储于Headers-Authorization中，格式为：Bearer {token}或{token}。

授权验证支持白名单机制，请在appsettings.json中添加配置：

{
    "Authorization": {
        "TokenExpire": 120,
        "AnonymousPaths": [
            "/swagger",
            "/heart",
            "/images",
            "/api/Login",
            "/api/Register"
        ]
    }
}

3、ICurrentUser - 当前用户接口

请在项目中继承该接口，以实现访问令牌中的身份识别。

继承该接口时，可以增加自定义字段，字段值将存储于访问令牌中，请勿存储敏感数据。

三、Configuration

1、ConfigurationExtension - 配置扩展类

  • Configuration：获取配置
  • RegisterConfiguration()：注册配置

2、AuthorizationConfiguration - 授权配置

  • TokenExpire：Token有效期（单位：分钟），默认为120分钟
  • AnonymousPaths：可匿名访问路径

3、EncryptionConfiguration - 加密配置

  • SM2Server：国密SM2服务端密钥
  • SM2Client：国密SM2客户端密钥
  • SM3：国密SM3密钥
  • SM4：国密SM4密钥

四、DependencyInjection

继承自本目录下的所有类将自动进行依赖注入。

接口/类 功能
IScopedAutoInject 范围内自动注入接口
ISingletonAutoInject 单例自动注入接口
ITransientAutoInject 临时自动注入接口
ISelfScopedAutoInject 范围内自动自注入接口
ISelfSingletonAutoInject 单例自动自注入接口
ISelfTransientAutoInject 临时自动自注入接口
MappingProfile 映射配置抽象类

五、Domain

接口/类 功能
IEntity/Entity 实体接口/实体类
ICreatableEntity/CreatableEntity 可创建实体接口/可创建实体类
IUpdatableEntity/UpdatableEntity 可更新实体接口/可更新实体类
IDeletableEntity 可删除实体接口
IAggregateRoot/AggregateRoot 聚合根接口/聚合根类
ValueObject 值对象抽象类

六、DomainAdapter

类 功能
PagedVo 分页查询视图对象抽象类
PagedDto 分页数据传输对象
SelectorOption 选择器选项

七、Enums

类 功能
AneResultCode 结果码枚举
FileExtensions 文件扩展类枚举

八、Extension

类 功能
ArrayExtension 数组扩展类
ByteExtensions 字节扩展类
CheckExtension 检查扩展类
DateTimeExtension 日期时间扩展类
EntityExtension 实体扩展类
EnumExtension 枚举扩展类
ListExtension 列表扩展类
ObjectExtensions 对象扩展类
StringExtension 字符扩展类
TypeExtension 类型扩展类

九、Helper

接口/类 功能
IEncryptionHelper/EncryptionHelper 加密帮助接口/加密帮助类
IFileHelper/FileHelper 文件帮助接口/文件帮助类
IHostHelper/HostHelper 主机帮助接口/主机帮助类
IRandomHelper/RandomHelper 随机帮助接口/随机帮助类
IVerifyHelper/VerifyHelper 验证帮助接口/验证帮助类
ServiceProviderHelper 服务提供程序帮助类

十、Infrastructure

接口/类 功能
IRepository/Repository 仓储接口/仓储抽象类
IRepositoryContext 仓储上下文接口
SqlServerRepositoryContext SQLServer仓储上下文类
MySqlRepositoryContext MySQL仓储上下文类
IRepositoryContextProvider 仓储上下文提供程序接口
SqlServerRepositoryContextProvider SqlServer仓储上下文提供程序类
MySqlRepositoryContextProvider MySQL仓储上下文提供程序类

十一、Swagger

类 功能
HiddenApiAttribute 隐藏Swagger接口特性

十二、其他

类 功能
AneConsts 常量类
HostExtension 主机扩展类

HostExtension包含的扩展方法如下：

  • RegisterDependencyInjection：注册依赖注入
  • RegisterAutoMapper：注册AutoMapper
  • ConfigureModelState：配置模型状态
  • RegisterCors：注册跨域
  • ConfigureForwardedHeaders：配置转发头（读取客户端真实IP地址）
  • UseSqlServer：使用SqlServer数据库
  • UseMySql：使用MySql数据库
  • RegisterSwagger：注册Swagger
  • RegisterLocalization：注册本地化
  • RegisterExceptionHandling：注册异常处理
  • RegisterModelValidation：注册模型验证
  • RegisterNewtonsoftJson：注册JSON
  • RegisterNLog：注册NLog
  • ApplyDependencyInjection：应用依赖注入
  • ApplyCors：应用跨域
  • ApplyForwardedHeaders：应用转发头
  • ApplyAuthorization：应用授权
  • ApplyLocalization：应用本地化
  • ApplySwagger：应用Swagger
  • ApplyStaticFiles：应用静态文件
  • ApplyRoute：应用路由

示例代码如下：

public class Program
{

    public static void Main(string[] args)
    {
        // 读取配置
        var builder = WebApplication.CreateBuilder(args);
        var configuration = builder.Services.RegisterConfiguration();

        #region 配置主机端口
        var host = configuration["Site:Host"] ?? "http://localhost";
        var port = int.Parse(configuration["Site:Port"] ?? "5000");
        builder.WebHost.ConfigureKestrel(opt =>
        {
            opt.ListenAnyIP(port);
        });
        builder.WebHost.UseUrls($"{host}:{port}");
        #endregion

        builder.Services
            .RegisterDependencyInjection()          // 注册依赖注入
            .RegisterAutoMapper()                   // 注册AutoMapper
            .RegisterCors()                         // 允许跨域
            .ConfigureForwardedHeaders()            // 配置转发头
            .UseSqlServer(
                connectionStringName: "Shop")       // 使用SqlServer数据库
            .RegisterSwagger(
                "Shop Apis",
                "v1",
                "Shutter.Domain.xml")               // 注册Swagger
            .RegisterLocalization();                // 注册本地化
        builder.Services.AddControllersWithViews(opt =>
        {
            opt.RegisterExceptionHandling();        // 注册异常处理
            // 注册模型验证
            opt.RegisterModelValidation(
                "Shutter.DomainAdapter",
                "Shutter.DomainAdapter.Resources.DataAnnotations");
        })                                          // 注册控制器
            .RegisterNewtonsoftJson();              // 注册JSON
        builder.Services.ConfigureModelState();     // 配置模型验证
        builder.RegisterNLog();                     // 注册NLog

        var app = builder.Build();
        app.ApplyDependencyInjection();             // 应用依赖注入
        app.ApplyCors()                             // 应用跨域
            .ApplyForwardedHeaders()                // 应用转发头
            .UseHttpsRedirection()                  // HTTPS重定向
            .ApplyStaticFiles(
                FileExtensions.Png,
                FileExtensions.JPG)                 // 应用静态文件
            .ApplyAuthorization()                   // 应用授权
            .ApplyLocalization(
                AneConsts.DefaultCultureName,
                "en-US")                            // 本地化
            .ApplySwagger(
                "Shop Apis V1",
                "v1");                              // 应用Swagger

        app.ApplyRoute();                           // 应用路由

        app.Run();                                  // 运行
    }
}
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.2.1 76 1/25/2025
1.1.2 71 1/25/2025
1.1.1.1 83 1/24/2025
1.1.1 82 1/19/2025
1.0.3.2 68 1/19/2025
1.0.3.1 110 12/30/2024
1.0.3 109 12/19/2024
1.0.2 134 12/14/2024
1.0.1 115 12/14/2024
1.0.0 119 12/14/2024