.net core 工具类库 UtilsSharp.Standard

UtilsSharp.Standard工具类库 详细文档：UtilsSharp框架文档

UtilsSharp.Standard工具类库简介：该工具类是基于UtilsSharp.Standard2.0封装的，里面包括：小驼峰法命名出参规范类、出入参规范类、阿里oss帮助类、钉钉机器人帮助类、图片帮助类、文件帮助类、下载类、随机数帮助类、对象映射帮助类、字符串帮助类、验证码生成、时间帮助类、中国日历帮助类、任务下发帮助类等，后面将持续更新中…

一、命名规范

1、小驼峰：

除第一个单词之外，其他单词首字母大写

例如： int myStudentCount;

用于：变量名

2、大驼峰：

相比小驼峰法，大驼峰法（即帕斯卡命名法）把第一个单词的首字母也大写了

例如： public class DataBaseUser

用于：命名空间、类名、方法名、属性名 

3、方法命名规范

获取单个对象的方法用Get作为前缀，如：GetRecord。

获取多个对象的方法用Search作为前缀，如：SearchRecord。

添加的方法用Add作为前缀，如：AddRecord。

修改的方法用Modify作为前缀，如：ModifyRecord。

(添加+修改)的方法用Save作为前缀，如：SaveRecord。

删除的方法用Delete作为前缀，如：DeleteRecord。

清空的方法用Clear作为前缀，如：ClearRecord。

判断类的方法用Is作为前缀，如：IsRegister,IsExist。

4、变量命名规范

变量取名应见名识意,尽量用英文单词,而不是缩写.

example：pageIndex, pageSize

5、入参、出参类名统一，入参+Request，出参+Response

例如：

    /// <summary>
    /// 获取密码盐参数
    /// </summary>
    public class GetSaltRequest
    {
        /// <summary>
        /// 手机号码
        /// </summary>
        public long MobilePhone { set; get; }
    }


    /// <summary>
    /// 会员登录参数
    /// </summary>
    public class LoginResponse
    {
        /// <summary>
        /// 访问口令
        /// </summary>
        public string Token { set; get; }
    }

二、接口返回格式：BaseResut<T>

{
code:200, //数字
msg:"请求成功", //成功时为"success"，错误时则是错误信息
result:{}, //对象
}

三、操作类返回格式:BaseResut<T>

增删改都返回对应ID，查询返回完整模型

{
code:200, //数字
msg:"请求成功", //字符串
result:{},
}

四、列表接口基础出入参,入参：BasePage，出参：BasePagedResult<T>

分页请求的基础参数

{
keyword:"", //关键词搜索
pageIndex:1, //当前页码
pageSize:10, //分页数量
}

分页返回的基础内容

{
code:200,
msg:"请求成功",
result:{
list:[{},{}], //返回的列表
pageIndex:1, //当前页码
pageSize:10, //分页数量
totalCount:100,//总条数
totalPages:10 //总页数 
}
}

五、错误码

返回码	标识	说明
200	success	请求成功
999	defaultTips	业务提示
2000	apiError	接口异常
3000	networkError	网络异常
4000	notLogin	未登录
4010	authExpire	授权过期
5000	exception	TryCatch异常错误
6000	dataNotFound	数据找不到
6010	dataNotValid	数据验证不通过
7000	businessError	默认业务性异常
7010	parameterCannotBeEmpty	参数不能为空
7020	invalidParameter	非法参数
8000	dbError	数据库异常
9000	systemError	系统错误

UtilsSharp.Standard工具类库 详细文档：UtilsSharp框架文档