介绍
搜集.neter开发常用的功能,运行环境:.net4.7;.netstandard2.0;net5.0;
得益于在BC公司负责维护底层框架代码,自己的精力逐渐从 “全栈” 转移到专注于后端。
于是,以BC公司的公共类库为基础,搜集整理再加上自己的补充便有了现在的一个类库。
功能列表
通用数据模型;
树状结构&平铺数据的访问;
序列化;
注册表;
编码和加解密;
分布式id&分布式流水号;
校验框架;
压缩&解压缩;
验证码生成;
汉字转拼音;
Dto和Entity转换之Mapper扩展;
递归篡改对象的属性值之Modify扩展;
将Dto属性投影到Entity之ModifyByDto扩展;
不同数据类型间的转换之To方法;
随机数;
对象池;
基于内存的并发消息队列;
反射工具;
主机诊断报告;
对象深度比对工具;
网络帮助类;
单位转换器(B/KB/MS/GB);
金额大小写转换;
枚举类型扩展方法;
常用扩展方法;
更多功能介绍
查看Wiki:https://gitee.com/jackletter/DotNetCommon/wikis/
快速开始
1.安装包
dotnet add package DotNetCommon --version 1.1.0
2. 引入命名空间
using DotNetCommon;
using DotNetCommon.Extensions;
3. 功能示例
3.1 数据模型
public Result<Person> GetUserNameById(int id)
{
if (id < 0) return Result.NotOk("id必须大于0!");
//...
return Result.Ok(new Person());
}
3.2 加解密
public void EncryptTest()
{
var sensitiveData = "敏感信息";
var key = "12345678";
//加密
var res = DESEncrypt.Encrypt(sensitiveData, key);
//解密
var res2= DESEncrypt.Decrypt(res, key);
}
3.3 分布式Id & 分布式流水号
public void Test()
{
//首先设置当前机器id: 0-1023
Machine.SetMachineId(1);
//生成分布式id
//输出示例: 185081270290616320
long id = DistributeGenerator.NewId("key");
//生成分布式流水号
//输出示例: sno202105250001000001
string sno = DistributeGenerator.NewSNO("sno", SerialFormat.CreateDistributeFast("sno", "yyyyMMdd", 6));
}
3.4 序列化
/// <summary>
/// 指定常用的设置,序列化为json字符串
/// </summary>
/// <param name="obj"></param>
/// <param name="dateFormatString">日期时间格式</param>
/// <param name="isLongToString">是否将long型转为字符串</param>
/// <param name="IgnoreNull">是否忽略null值的属性</param>
/// <param name="enum2String">是否将枚举转换为字符串</param>
/// <param name="lowerCamelCase">属性名称的首字母是否小写</param>
/// <param name="isIntend">是否格式缩进</param>
/// <param name="isAllToString">是否将所有数据类型转换为字符串</param>
/// <param name="allNumDigit">设定的所有数字的最大小数位数(默认为null,即: 不限制)</param>
/// <param name="decimalDigit">仅针对decimal设定的最大小数位数(默认为null,即: 不限制)</param>
/// <param name="otherSettings">其他的设置</param>
/// <returns></returns>
public static string ToJsonFast(this object obj, string dateFormatString = "yyyy-MM-dd HH:mm:ss", bool IgnoreNull = false, bool enum2String = true, bool lowerCamelCase = false, bool isIntend = false, bool isLongToString = false, bool isAllToString = false, int? allNumDigit = null, int? decimalDigit = null, Action<JsonSerializerSettings> otherSettings = null)
3.5 压缩&解压缩
//压缩单个文件
ZipHelper.ZipFile("c:\\tmp.zip","d:\\test.txt");
//压缩多个文件
ZipHelper.ZipFile("c:\\tmp.zip","d:\\test.txt","d:\\test2.txt");
//压缩单个目录
ZipHelper.ZipFolder("c:\\tmp.zip","d:\\test1");
//压缩多个目录
ZipHelper.ZipFolder("c:\\tmp.zip","d:\\test1","d:\\test2");
//压缩多个文件,并为每个文件指定名称
ZipHelper.ZipFile("c:\\tmp.zip",
("c:\\testfolder-中文B.txt", "重命名1.txt"),
("c:\\testsubfolder-suba.txt", "\\sub\\重命名2.txt"))
3.6 类似AutoMapper的转换
public class Cat
{
public int Id { get; set; }
public string Name { get; set; }
public int Age { get; set; }
public DateTime Birth { get; set; }
}
public class CatDto
{
public int Id { get; set; }
public string Name { get; set; }
public int Age
{
get
{
return DateTime.Now.Year - Birth.Year;
}
}
public DateTime Birth { get; set; }
}
//转换示例
var cat = new Cat()
{
Id = 1,
Name = "小明",
Birth = DateTime.Parse("1989-01-02"),
Age = 20
};
var dto = cat.Mapper<CatDto>();
dto.ShouldNotBeNull();
dto.Id.ShouldBe(1);
dto.Name.ShouldBe("小明");
dto.Age.ShouldNotBe(20);
3.7 类FluentValidation校验组件
//Service层方法,添加实体
public Result<bool> AddStudent(Student student)
{
var res = ValidateModelHelper.ValidResult(student, Student.ValidAdd);
if (!res.Success) return res;
//...新增操作
return Result.Ok(true);
}
public class Student
{
public int Id { get; set; }
public string Name { get; set; }
public int? Age { get; set; }
public DateTime? Birth { get; set; }
public string IdCard { get; set; }
public string Addr { get; set; }
public string Phone { get; set; }
public string Email { get; set; }
/// <summary>
/// 校验新增Student
/// </summary>
/// <param name="ctx"></param>
public static void ValidAdd(ValidateContext<Student> ctx)
{
//请求实体不能为null,否则直接中断校验
ctx.MustNotNull().IfFailThenExit();
//Id必须为0
ctx.RuleFor(i => i.Id).MustEqualTo(0);
//姓名不能为空且长度在1-4之间
ctx.RuleFor(i => i.Name).MustNotNullOrEmptyOrWhiteSpace().MustLengthInRange(1, 4);
//年龄要么为null,要么>=0
ctx.RuleFor(i => i.Age).When(i => i != null, ctx => ctx.MustGreaterThanOrEuqalTo(0));
//出生日期要么为null,要么>=1800-01-01
ctx.RuleFor(i => i.Birth).When(i => i != null, ctx => ctx.MustGreaterThanOrEuqalTo(DateTime.Parse("1800-01-01")));
//校验身份证号
ctx.RuleFor(i => i.IdCard).MustIdCard();
//如果手机号码不为null就校验格式
ctx.RuleFor(i => i.Phone).When(i => i != null, ctx => ctx.MustCellPhone());
//如果邮箱不为null就校验格式
ctx.RuleFor(i => i.Email).When(i => i != null, ctx => ctx.MustEmailAddress());
}
}
3.8 注册表
public void Test2()
{
var path = @"HKEY_CURRENT_USER\TestApplication\Res";
//判断是否存在
RegistryHelper.Exists(path);
//删除项
RegistryHelper.DeletePath(path);
//设置值
RegistryHelper.SetString(path, "name", "小明");
//读取值
var name = RegistryHelper.GetString(path, "name");
}
更多介绍,参考Wiki:https://gitee.com/jackletter/DotNetCommon/wikis/