Grace.Shared 1.0.0.10

Grace.Shared

基于 ABP（Volo.Abp）的通用 DTO、枚举、接口和业务模型的共享类库。

安装

dotnet add package Grace.Shared

内容

Records / DTOs

Enums

// 客户端平台
AppPlatform.Unknown = 0    // "未知"
AppPlatform.Android = 1    // "安卓"
AppPlatform.Ios = 2        // "苹果"
AppPlatform.WechatMiniProgram = 3 // "微信小程序"
AppPlatform.H5 = 5         // "H5"

// 性别
Gender.Unknown = 0  // "保密"
Gender.Male = 1     // "男"
Gender.Female = 2   // "女"

// 在线状态
OnlineStatus.Offline = 0  // "离线"
OnlineStatus.Online = 1   // "在线"

// 推送类型
PushType.Url = 1        // "跳转url"
PushType.Notice = 2     // "通知"
PushType.LaunchApp = 3  // "打开app"

// VIP
Vip.None = 0   // "普通会员"
Vip.VIP = 100  // "VIP"
Vip.SVIP = 200 // "超级VIP"

// 红包场景
RedPacketScene.Private = 100  // "私发红包"
RedPacketScene.Public = 200   // "群红包"

// 红包类型
RedPacketType.Lucky = 100    // "拼手气红包"
RedPacketType.Command = 200  // "口令红包"
RedPacketType.Normal = 300   // "普通红包"

// 启用/禁用
ActiveStatus.Disabled = 0  // "禁用"
ActiveStatus.Enabled = 1   // "启用"

// 是否判断
YesNo.No = 0  // "否"
YesNo.Yes = 1 // "是"

所有枚举均标注了 [Description]，配合 Grace.Extensions 的 EnumExtension.GetDescription() 可直接获取中文描述。

Interfaces

public interface IHasActive { bool IsActive { get; } }
public interface IHasSearchKey { string SearchKey { get; } }
public interface IHasTimeRange { DateTimeRange? TimeRange { get; } }
public interface IHasSearchParameter
{
    string SearchKey { get; }
    DateTimeRange? TimeRange { get; }
}

适用于查询入参、实体等场景的通用接口。

Constants

MaxLenghtConst.L1       // 1
MaxLenghtConst.L255     // 255
MaxLenghtConst.L1024    // 1024
MaxLenghtConst.L4096    // 4096

定义了从 1 到 4096 共 18 个常用长度常量（1 / 2 / 5 / 10 / 15 / 20 / 36 / 50 / 100 / 128 / 200 / 255 / 512 / 1024 / 2048 / 4096），用于 DTO 属性 [MaxLength] 校验。

使用示例

using Grace.Shared;
using Grace.Enums;

// 头像处理
var avatar = new Avatar("https://example.com/avatar.jpg");
avatar.Small;  // "https://example.com/avatar.jpg_s"
avatar.Medium; // "https://example.com/avatar.jpg_m"

// 业务键值对
var item = new BizItem(1, "活跃用户");

// 枚举 + Grace.Extensions 配合使用
Gender.Male.GetDescription(); // "男"

// 启用/禁用状态
var config = new SystemConfig { Status = ActiveStatus.Enabled };
var isDefault = YesNo.Yes; // 替代 bool 语义更清晰

// 位置信息
var location = new Coordinate(116.397128, 39.916527);

// 文件上传结果
var file = new FileItem("https://cdn.example.com/a.jpg", "photo.jpg", 102400, "image/jpeg");

// 时间范围查询入参
public class UserQuery : IHasSearchKey, IHasTimeRange
{
    public string SearchKey { get; set; }
    public DateTimeRange? TimeRange { get; set; }
}

// 字段长度约束
public class CreateUserDto
{
    [MaxLength(MaxLenghtConst.L50)]
    public string NickName { get; set; }

    [MaxLength(MaxLenghtConst.L255)]
    public string Bio { get; set; }
}

依赖

• Volo.Abp.Core — ABP 框架
• .NET 8 +