# MagicCube

**Repository Path**: vxuan/magiccube

## Basic Information

- **Project Name**: MagicCube
- **Description**: 魔方框架，通用标准web api框架，ORM采用SmartSql，未来尝试扩展为ORM自由配置支持
- **Primary Language**: C#
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2019-06-21
- **Last Updated**: 2023-12-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MagicCube

#### 介绍
魔方框架，通用标准工具层框架

#### 使用说明
##### 1，MagicCube.Utility
- 功能说明：提供常用的工具类、扩展方法
- 依赖包
    + [Microsoft.Extensions.Logging.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.Logging.Abstractions/ "Microsoft.Extensions.Logging.Abstractions")
    + [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json/ "Newtonsoft.Json")
- 命名空间和类的说明
    + MagicCube.Utility.CheckExtenssion.Check
        提供常用的参数检查辅助方法，调用对应的方法时，如果不符合检查规则，则抛出对应的异常信息。
    ``` c#
    //示例：如下代码如果参数为空，将抛出ArgumentNullException异常；
    Check.Null(value);
    ```
    + MagicCube.Utility.Extension.ExtenssionMethod 提供常用的扩展方法
    ``` c#
    //示例：如下代码将DateTime对象格式化为yyyy-MM-dd HH:mm:ss的字符串
    var time=DateTime.Now;
    var str=time.ToFormat();//TIP：str为格式化后的值，ToFormat包含可选参数：f（可以指定自定义的格式化）
    ```
    + MagicCube.Utility.Helper.Encryption
        提供常见的加密辅助方法（MD5、HMACSHA256等）。
    + MagicCube.Utility.Helper.EnumHelper
        提供枚举辅助方法ToList()，将枚举的所有元素转换为List<EnumItemInfo>类型（方便读取Enum的value和description）。
    + MagicCube.Utility.Helper.HttpRequestHelper
        提供Http请求的常用方法，如：Get、Post、Delete、Put方法。
    + MagicCube.Utility.Helper.IdGenerator
        提供编号生成器（支持生成纯数字的编号、字母数字组合的编号）。
    + MagicCube.Utility.Helper.RandomHelper
        提供随机数辅助方法。
#### 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request


#### 码云特技

1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5. 码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)