# xycn.framework

**Repository Path**: feiyumain/xycn.framework

## Basic Information

- **Project Name**: xycn.framework
- **Description**: No description available
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: developer
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2021-04-20
- **Last Updated**: 2025-07-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

**xycn-framework框架使用手册**

**Ver.0.7**

**科技有限公司**

**2021-03**

**  
**

**文件控制**

**文件控制**

| 拟制 | Mrking | 日期 | 2019-03-09 |
|------|--------|------|------------|
| 审核 |        | 日期 |            |
| 批准 |        | 日期 |            |

**变更记录**

| 日 期      | 作 者    | 版 本 | 更 改 说 明                        |
|------------|----------|-------|------------------------------------|
|            |          | V0.1  | 原始版本                           |
|            |          | V0.2  | 增加数据库基础接口                 |
|            |          | V0.3  | 数据库基于Sugar分页                |
| 2019-03-14 | Codemain | V0.4  | **添加多表关联查询，详见5.2**      |
| 2019-12-14 | Mrking   | V0.5  | **修改开发环境准备、配置文件内容** |
| 2020-01-02 | Codemain | V0.7  | 增加Jwt权限，详见5.1.11            |
|            |          |       |                                    |
|            |          |       |                                    |

**  
目录**

[1.	概述	4](#_Toc67833796)

[2.	开发环境准备	5](#_Toc67833797)

[3.	程序运行	14](#_Toc67833798)

[4.	配置文件说明	15](#_Toc67833799)

[5.	开发说明	17](#_Toc67833800)

>   [5.1.	Controller插件开发说明	17](#_Toc67833801)

>   [5.1.1.	创建Controller	17](#_Toc67833802)

>   [5.1.2.	创建http处理方法	17](#_Toc67833803)

>   [5.1.3.	输入参数说明	17](#_Toc67833804)

>   [5.1.4.	返回值的说明	18](#_Toc67833805)

>   [5.1.5.	属性标签说明	21](#_Toc67833806)

>   [5.1.6.	继承基类说明	25](#_Toc67833807)

>   [5.1.7.	文件上传	27](#_Toc67833808)

>   [5.1.8.	文件下载	29](#_Toc67833809)

>   [5.1.9.	实例代码	30](#_Toc67833810)

>   [5.1.10.	注意事项	42](#_Toc67833811)

>   [5.2.	数据库访问接口插件使用方法说明	42](#_Toc67833812)

>   [5.2.1.	多表关联	51](#_Toc67833813)

>   [5.3.	基础工具使用说明	56](#_Toc67833814)

>   [5.3.1.	xycn.common	56](#_Toc67833815)

[6.	框架软件包结构说明	56](#_Toc67833816)

# 概述

为适应系统灵活扩展，降低开发者技能要求，提升项目开发效率，特此开发本框架。框架结构如下图所示：

xycn-framework框架（下称框架）以ASP.NetCore WebAPI(.net
5.0)框架为基础，进行二次封装，为业务开发人员提供基于基础C\#知识即可进行开发的框架。框架封装了跨平台HTTP服务器，对外隐藏了HTTP请求及响应的整个过程，并利用插件技术自动加载业务模块，调用业务模块入口方法，并根据方法返回结果自动生成响应信息。

xycn-framework框架按照约定接口，动态加载ORM、Cache等基础插件模块，为业务模块提供集成的基础功能模块。各个基础插件模块按照约定接口进行实现，使得框架能够灵活加载、替换不同的ORM插件、Cache插件等，以灵活应对不同的业务场景。

开发人员使用本框架，无需了解太深入的WEB开发技术，着重于业务逻辑的实现。开发人员通过建立.net
5基本类库，通过类似ASP.NetCore
WEBAPI的APIController的属性标记方式，定义供框架调用的控制器类（Controller），接收框架发送过来的请求数据，使用服务运行支撑模块提供的各个接口，实现业务逻辑，并将操作结果通过定义的控制器类库，返回给框架，自动进行HTTP请求响应。同时，开发人员使用标准的接口，服务运行支撑模块提供的集成工具，当某工具插件替换为同类其他插件时，业务模块不受影响。

为面向微服务架构，xycn-framework以exe形态独立运行（可根据需要修改可执行程序名称），根据配置，动态加载指定的1个或多个业务模块（控制器），并根据加载的业务模块提供业务服务。同时，xycn-framework支持在一台或多台机器上部署若干个框架程序，提供WEB
API接口，从而灵活实现集中或分布式部署，后续可自行研发微服务网关或改造框架接入成熟微服务网关，实现完整的微服务架构。如下图所示

# 开发环境准备

开发者启动开发环境（下面以VS 2019为例）

#### 创建项目

在创建新项目对话框中，选择类库，如下图所示

![](media/ca812568d1995d1284ff43bc12aefdf0.png)

录入项目名称等，创建项目（示例代码以E:\\为例）

![](media/974f4f93aa6b1e30cddd02d5292227bd.png)

#### 创建选项

在其他信息界面中的目标框架选项中，选择.NET 5.0，点击创建按钮，创建项目。

![](media/72ca353a8b4c81f0f7f78175035a6b45.png)

#### 安装框架

拷贝框架软件包“xycn-framework.v.xxxx.7z”，到项目生成目录（以当前示例项目为例，默认为E:\\TestController\\TestController\\bin\\Debug\\net5.0）进行解压，解压后该生成目录如下图所示：

![](media/e7484547b62f79f7d2c969b8424ee532.png)

#### 添加项目依赖

打开项目界面，选择依赖项右键代开，为项目添加框架依赖。需要添加的框架依赖主要是以下两个：

1.  **xycn.pluginsupport.dll**

位于为框架运行目录中的utility/xycn.pluginsupport/xycn.pluginsupport.dll

1.  **xycn.base.dll**

位于为框架运行目录中的utility/xycn.base/xycn.base.dll

![](media/98039c907c27124e9478804279b4f271.png)

![](media/e653cb9ef17b308898fd0a5c14e32069.png)

添加xycn.pluginsupport.dll依赖

位于为框架运行目录中的utility/xycn.pluginsupport/xycn.pluginsupport.dll

![](media/3b5f0dfa69abbb927cfae47ca76b0a07.png)

添加xycn.base.dll依赖

![](media/69c622cf848aedec848f08c493000b5c.png)

添加后项目依赖项中将出现如下依赖项

![](media/489c617aa14b28167e815f5238d564f5.png)

#### 运行调试

设置项目属性，将项目的调试选项，指向框架可执行程序，即可运行调试。

![](media/309b026ca5ebdcd4ffabdbf03508ea98.png)

![](media/b76614c0fabf7b4f48d73dc6a122a86d.png)

![](media/94615fad02a151cd0de90dfc49ced9b7.png)

**注：该程序名称可根据需要修改为指定名称，修改后自动加载的配置文件也需要改为同名.xml。如，修改后程序名称为test.exe，则配置文件名称需改为test.exe.xml。**

增加启动程序调试参数，以便显示程序运行界面，查看启动情况

![](media/8a103bd05c93c1b3ebd72dcf07a35943.png)

# 程序运行

通过命令行（cmd）执行命令xycn.framework.exe后，程序开始运行，正常情况不会显示运行界面。执行命令xycn.framework.exe
\-d后，显示程序运行界面。界面显示如下信息，标识启动正常

![](media/b52b8305908d6f0e2bc1dd8f9cea04fd.png)

错误信息说明（后续补充）

# 配置文件说明

整个框架和业务模块使用同一个配置文件，配置文件同框架可执行程序同名。

**注：如框架可执行程序名称修改后，配置文件也需要改为同名.xml。如，修改后程序名称为test.exe，则配置文件名称需改为test.exe.xml。**

配置文件说明如下：

\<?xml version="1.0" encoding="utf-8"?\>

\<Config\>

\<!-- 框架运行环境配置项 --\>

\<FrameworkConfig\>

\<!-- WEBAPI的版本号 --\>

\<APIVersion\>v1.0\</APIVersion\>

\<!-- 服务路由所在的基地址，框架自动将基地址和WEB
API版本信息，作为访问本服务接口基本地址。

具体用法如下：

假设APIVersion取值为：V1.0，BasePath取值为：Test

在类库中定义的的标记为APIController的类（以类名sample为例）某访问方法设定路由为"/[controller]/{id}"

则该方法接口真实地址为："https://xxxxxxx:yy/Test/V1.0/sample/任意值"

\--\>

\<BasePath\>/\</BasePath\>

\<!-- 跨域访问策略 --\>

\<CorsPolicies\>

\<!-- 允许跨域访问的来源，“\*”代表允许所有来源进行跨域访问 --\>

\<AllowOrigins\>

\<AllowOrigin\>\*\</AllowOrigin\>

\<AllowOrigin\>http://127.0.0.1:3721\</AllowOrigin\>

\</AllowOrigins\>

\<!-- 允许跨域访问的方法，“\*”代表允许所有方法进行跨域访问 --\>

\<AllowMethods\>

\<AllowMethod\>\*\</AllowMethod\>

\<AllowMethod\>GET\</AllowMethod\>

\</AllowMethods\>

\<!--
允许跨域访问携带的非基本请求头，“\*”代表允许携带所有非基本请求头进行跨域访问
\--\>

\<AllowHeaders\>

\<AllowHeader\>\*\</AllowHeader\>

\<AllowHeader\>ContentType\</AllowHeader\>

\</AllowHeaders\>

\<!-- 是否允许跨域访问时，携带cookie，

注意：当AllowOrigins中某项为“\*”时，该选项固定为false --\>

\<AllowCredentials\>false\</AllowCredentials\>

\</CorsPolicies\>

\<!-- 定义服务访问地址，使用类似如下方式进行定义 --\>

\<HostUrls\>

\<Url\>http://localhost:3006\</Url\>

\<Url\>https://0.0.0.0:3001\</Url\>

\<Url\>https://0.0.0.0:7001\</Url\>

\<Url\>http://0.0.0.0:3000\</Url\>

\<Url\>http://0.0.0.0:3005\</Url\>

\</HostUrls\>

\<!-- 设置HTTPS证书文件（含路径） --\>

\<HttpsCertificate\>\</HttpsCertificate\>

\<!-- 回应最大长度 --\>

\<MaxResponseBufferSize\>0\</MaxResponseBufferSize\>

\<!-- 请求体Body最大长度 --\>

\<MaxRequestBodySize\>0\</MaxRequestBodySize\>

\</FrameworkConfig\>

\<!-- 用于配置Asp.Net框架原生Service插件 --\>

\<Asp.netServicePlugins\>

\</Asp.netServicePlugins\>

\<!-- 用于配置Asp.Net框架原生中间件插件 --\>

\<Asp.netMidwarePlugins\>

\</Asp.netMidwarePlugins\>

\<!-- Orm插件配置，允许加载多个ORM插件，以便提供同时访问多种数据库的能力 --\>

\<ORMPlugins\>

\<!-- 配置加载的ORM插件 --\>

\<ORMPlugin name="SqlSugarInterface"
lib=".\\orm_plugins\\xycn.SqlSugarInterface\\xycn.SqlSugarInterface.dll"\>

\<!-- 数据库接口库配置项，该项将由框架自动传递给数据库接口模块，

格式可变，由接口库自行取用--\>

\<DataBaseType\>sqlserver\</DataBaseType\>

\<ConnString\>server=192.168.10.11;uid=sa;
pwd=cdzhht1!;database=CY\</ConnString\>

\</ORMPlugin\>

\</ORMPlugins\>

\<!-- 系统日志记录插件配置，仅配置一项 --\>

\<LogPlugins\>

\<LogPlugin name="CommonLog" lib =".\\utility\\xycn.common\\xycn.common.dll"/\>

\</LogPlugins\>

**\<!-- 权限插件配置，仅配置一项 --\>**

**\<AuthHelperPlugins\>**

**\<AuthPlugin name="AuthHelperPlugin" lib
=".\\authorize_plugins\\xycn.JwtAuthorize\\xycn.JwtAuthorize.dll"/\>**

**\</AuthHelperPlugins\>**

**\<JwtSignInfo\>**

**\<!--签名签发单位--\>**

**\<FromUser\>www.cdxltech.com\</FromUser\>**

**\<ToUser\>www.cdxltech.com\</ToUser\>**

**\<!--签名密钥--\>**

**\<UserKey\>df8a7b8b72e3b9677ddd632a175f6d35\</UserKey\>**

**\<!--过期时间 天--\>**

**\<ExpiresDays\>30\</ExpiresDays\>**

**\</JwtSignInfo\>**

\<!-- Orm插件配置，允许加载多个ORM插件，以便提供同时访问多种数据库的能力 --\>

\<FileHelperPlugins\>

\<!-- 配置加载的ORM插件 --\>

\<FileHelperPlugin name="LocalFileHelper"
lib=".\\filehelper_plugins\\xycn.localfilehelper\\xycn.localfilehelper.dll"\>

\</FileHelperPlugin\>

\</FileHelperPlugins\>

\<!-- 控制器插件配置项，该配置项其结构可在ControllersConfig节点下，

按照各插件名称自行定义读取使用 --\>

\<ControllerPlugins\>

\<!--\<Controller name="ChangYingMes" lib=".\\ChangYingMes.dll"\>

\</Controller\>--\>

\<Controller name="SampleController"
lib=".\\controller_plugins\\SampleController\\SampleController.dll"\>

\<!-- Controller配置选项 --\>

\</Controller\>

\<Controller name="xl.demo.webapi.dll"
lib=".\\controller_plugins\\xl.demo.webapi\\xl.demo.webapi.dll"\>

\<!-- Controller配置选项 --\>

\</Controller\>

\</ControllerPlugins\>

\</Config\>

# 开发说明

## Controller插件开发说明

### 创建Controller

创建一个类，如果可继承了BaseController，则直接表明该类为一个Controller类（**推荐方法**），或是使用[ApiController]属性进行标记来表明该类为一个Controller（不推荐），框架将自动加载。

如果该类未使用[ApiController("xxxxxx")]或[Route("xxxxxxx")]的方式，显式定义其路由，默认路由将为：

<http://xxx.xxx.xxx.xxx:port/BasePath/ApiVersion/>类名

类中方法如未显示定义绝对路由，则会继承该路由。

使用方法，详见对应属性说明。

### 创建http处理方法

使用

[HttpMethod]、[HttpMethodWithContext]、[ActionMethod]（直接响应POST请求）、[ActionWithContext]
（直接响应POST请求）

属性对方法进行标记，则指名该方法为http请求处理的方法。

使用方法，详见对应属性说明。

方法名为Get、Put、Post、Delete的Controller，可以不用使用[HttpMethod]属性进行标记，默认将其标记为对应HTTP请求的处理方法，其路由如未指定，则默认提供"/[Controller]"路由提供访问服务。

### 输入参数说明

定义Http请求方法时，如果在方法的输入参数前，选择了[FromQuery]、[FromForm]、[FromBody]、[FormHeader]、[FromRoute]等属性进行标记（不可重叠），则表明该输入参数，需要从Http请求中的某部分进行自动提取、转化。

其中如果输入参数为某类的实例对象，则必须用[FromBody]进行标记。框架将自动从Body中提取json（默认为Utf-8编码），进行反序列化后作为输入参数。

如果输入参数为Stream对象，需指定为POST方法，且参数需要使用[FromBody]来获取流对象，如下所示：

[HttpMethod(HttpMethodType.POST, "file/{id}")]

public void Post(int id, [FromBody]Stream stream)

{

using (FileStream file = new FileStream("d:\\\\ttt"+id.ToString() + ".txt",
FileMode.Create))

{

byte[] buffer = new byte[1024 \* 1024];

int start_pos = 0;

for (int i = 0; ; i++) {

int read_count = stream.Read(buffer, 0, 1024 \* 1024);

if (read_count \<= 0)

break;

file.Write(buffer, 0, read_count);

}

}

}

### 返回值的说明

Api返回数据默认为标准json，json命名规则采用驼峰命名法，返回的json首字母小写，
格式参考如下

| 字段名称   | 是否可空 | 默认 | 说明                                                                               |
|------------|----------|------|------------------------------------------------------------------------------------|
| Status     | 否       | 0    | 框架层请求状态 200成功 可参照Http响应状态对应                                      |
| Code       | 否       | 0    | 框架层错误码 0无错误 500服务器错误 404未找到 503服务器不可用 302用户认证信息已过期 |
| Message    | 是       | Null | 框架层描述信息                                                                     |
| ResultBody | 是       | Null | 接口实际响应数据实体                                                               |

其中ResultBody为Controller插件的返回数据，Controller虽然可以返回任意类型的数据，为了框架统一，建议统一返回**RequestContext**对象，参考示例：

/// \<summary\>

/// 查询所有数据

/// \</summary\>

/// \<returns\>\</returns\>

[HttpMethod(HttpMethodType.POST, "/Members/GetAllList”) ]

public **ReponseContext** GetAllList()

{

try

{

var req = model.Data.ToDictionaryWithKeyToLower();

var res = \_dbhelper.GetListByDic(req);

return \_success(res);

}

catch (Exception ex)

{

return \_error(ex, "/Members/GetList");

}

}

返回**ReponseContext 说明**

| **参数名称** | **是否可空** | **默认** | **说明**                                                                              |
|--------------|--------------|----------|---------------------------------------------------------------------------------------|
| ErrorCode    | 否           | 0        | 返回编码 0表示成功 500服务器异常 404未找到 503服务器不可用 其他编码请参考官网帮助文档 |
| RowCnt       | 否           | 0        | 返回数据条数                                                                          |
| Message      | 是           | Null     | 描述信息                                                                              |
| Data         | 是           | Null     | 回应数据实体                                                                          |

完整示例：

请求：**POST** http://localhost:3000/v1.0/members/GetAllList

回应：

{

"status": 200, \#框架层请求状态 200成功 可参照Http响应状态对应

"code": 0,

"message": "OK",

"resultBody": {

"errorCode": 0,

"rowCnt": 0,

"message": "操作成功",

"data": [

{

"kid": 28,

"wxNickName": "1",

"createTime": "2021-03-08 18:02:47"

},

{

"kid": 29,

"wxNickName": "2",

"createTime": "2021-03-08 18:02:48"

},

{

"kid": 30,

"wxNickName": "3",

"createTime": "2021-03-08 18:02:48"

},

{

"kid": 31,

"wxNickName": "4",

"createTime": "2021-03-08 18:02:48"

},

{

"kid": 32,

"wxNickName": "6",

"createTime": "2021-03-08 18:02:49"

},

{

"kid": 33,

"wxNickName": "7",

"createTime": "2021-03-08 18:02:49"

},

{

"kid": 34,

"wxNickName": "8",

"createTime": "2021-03-08 18:02:50"

}

]

}

}

对于文件下载时，返回值**必须**固定为流对象，如下所示：

[HttpMethod(HttpMethodType.GET, "/file")]

public Stream GetFile()

{

FileStream file = new FileStream("d:\\\\ttt.txt", FileMode.Open);

return file;

}

### 属性标签说明

#### ApiController属性

用途：用于标记Controller实体类，使用该属性标记的类，指明该类会由框架程序在自动加载时，自动加入到框架中，并按照处理HTTP请求

使用方式：

[ApiController]

public class Class1{…}

#### Route属性

用途：用于Controller实体类及类成员函数的路由设置属性路由格式同标准Asp.net
core含义及格式均保持一致，如/[controller]/{id}/{other}。

上述路由如果作为请求处理函数的路由的标记时，会由框架自动将id、other提取出来，转化为函数的输入参数，该函数需要定义为"xxxx(int
id, string
other)",其中xxxx为定义的函数名，该函数id、other则需要同路由中的对应变量同名，框架会根据该函数输入参数的类型，进行自动转换，来调用函数。

Route的申明方式，同ASP.NetCore WEBAPI方式一致。

**使用方法：**Route可用于类或方法上，并可在一个类或一个方法上进行叠加，标识该类或方法，提供多个路由地址供访问

1.  用于标记类

[ApiController]

[Route("路由地址1")]

[Route("路由地址2")]

public class Class1{…}

1.  用于标记类中方法

[Route("/v1/v3/v4/v6")]

[Route("/v1/v3/v4/v7")]

[Route("/v1/v3/v4/v8")]

public SampleResult Get()

{……}

#### HttpMethod属性

用途：针对类中成员函数的属性，用于标记该类处理 HTTP
请求的函数，本属性标记方法为：

[HttpMethod(HttpMethodType)]

或

[HttpMethod(HttpMethodType, route)]

其中HttpMethodType为枚举，定义处理函数对应的HTTP请求方法，包括 POST, DELETE,
PUT, GET。

route为字符串，显示定义处理函数的路由，路由格式同标准Asp.net
core含义及格式均保持一致，如/[controller]/{id}/{other}

函数被标记为本属性后，会由框架根据路由自动调用该函数，并根据路由信息自动向该函数传递参数。

以上述路由为例，框架自动将id、other提取出来，转化为函数的输入参数，该函数需要定义为"xxxx(int
id, string
other)"，其中xxxx为定义的函数名，该函数id、other则需要同路由中的对应变量同名

**注：该属性仅有一个生效，如某个函数存在多个该属性，则仅有一个生效**

**使用方法：**

[HttpMethod(HttpMethodType.GET, "[controller]/{id}/{test}/{y}/{cc}")]

public SampleResult GetWithMultiParameter(int id, int test, string y)

{

>   SampleResult ret = new SampleResult();

>   ret.test1 = "Sample4:Get 方法属性指定路由（相对路径）:" + y;

>   return ret;

}

#### HttpMethodWithContext属性

用途：针对类中成员函数的属性，用于标记该类处理 HTTP
请求的函数，本属性标记方法为：

[HttpMethodWithContext(HttpMethodType)]

或

[HttpMethodWithContext(HttpMethodType, route)]

其中HttpMethodType为枚举，定义处理函数对应的HTTP请求方法，包括 POST, DELETE,
PUT, GET。

route为字符串，显示定义处理函数的路由，路由格式同标准Asp.net
core含义及格式均保持一致，如/[controller]/{id}/{other}。函数被标记为本属性后，会由框架根据路由自动调用该函数，并根据路由信息自动向该函数传递参数。

**注：**

**1.适应该属性的函数，其输入参数固定为一个HttpContext类型，返回值固定为Task；**

**2.该属性仅有一个生效，如某个函数存在多个该属性，则仅有一个生效；**

**使用方法：**

[HttpMethodWithContext(HttpMethodType.GET)]

public Task Get(HttpContext context)

{

>   Console.WriteLine(context.Request.Path);

>   return Task.CompletedTask;

}

#### ActionMethod属性

用途：针对类中成员函数的属性，默认将函数标记为处理HTTP
POST请求。具有[Action]标记的函数，如果没有特别指定路由如使用[Action("xxxxxx")]或使用Route进行标记，则以"[controller]/函数名"作该方法的路由

使用方法：

[ActionMethod]

public string GetAction()

{

>   return "GetAction";

}

#### ActionWithContext属性

用途：针对类中成员函数的属性，默认将函数标记为处理HTTP
POST请求。具有[Action]标记的函数，如果没有特别指定路由如使用[Action("xxxxxx")]或使用Route进行标记，则以"[controller]/函数名"作该方法的路由。

**注：
1.适应该属性的函数，其输入参数固定为一个HttpContext类型，返回值固定为Task**

**2.该属性仅有一个生效，如某个函数存在多个该属性，则仅有一个生效**

#### FromQuery属性

用途：用于标记Controller类处理函数输入参数的来源。定义请求处理函数的输入参数取值为请求中的query字符串即"?"后面的对应字段（与参数同名）的值。

使用方法：

public SampleResult GetWithMultiParameter(int id, int test, string y)

{

>   SampleResult ret = new SampleResult();

>   ret.test1 = "SampleController:Get 方法属性指定路由（相对路径）:" + y;

>   return ret;

}

#### FromForm属性

用途：定义请求处理函数的输入参数取值为Form中的对应字段（与参数同名）的值。

使用方法：同上。

#### FromBody属性

用途：定义请求处理函数的输入参数，该参数必须同请求体重Body反序列化后的对象一致

注意：用此属性标记参数时，一个函数中仅能有一个参数用此属性进行标记

#### FromHeader属性

用途：定义请求处理函数的输入参数取值为Http
Header中的对应字段（与参数同名）的值。

使用方法：同上。

#### FromRoute属性

用途：定义请求处理函数的输入参数取值为Route中的对应字段（与参数同名）的值。

使用方法：同上。

### 继承基类说明

Controller插件类继承基类BaseController，其中BaseController封装默认方法\_success，\_error，\_fail方便业务插件直接调用。

如下：

/// \<summary\>

/// controller基类

/// \</summary\>

[ApiController]

public class BaseController

{

//错误代码

protected int \_execCode = 0;

public int execCode { get { return \_execCode; } }

/// \<summary\>

/// 错误信息

/// \</summary\>

protected string \_errorInfor = "";

public string errInfo { get { return \_errorInfor; } }

/// \<summary\>

/// 返回基类封装的对象数据实体

/// \</summary\>

/// \<param name="data"\>\</param\>

/// \<param name="msg"\>\</param\>

/// \<param name="retcnt"\>\</param\>

/// \<param name="code"\>\</param\>

/// \<returns\>\</returns\>

public ReponseContext \_success(object data, int code = 0, string msg =
"操作成功", int retcnt = 0)

{

return new ReponseContext() { Data = data, Message = msg, RowCnt = retcnt,
ErrorCode = code };

}

/// \<summary\>

/// 返回基类封装的对象数据实体

/// \</summary\>

/// \<param name="data"\>\</param\>

/// \<param name="msg"\>\</param\>

/// \<param name="retcnt"\>\</param\>

/// \<param name="code"\>\</param\>

/// \<returns\>\</returns\>

public ReponseContext \_success(Result\<object\> data, int code = 0, string msg
= "操作成功", int retcnt = 0)

{

return new ReponseContext() { Data = data, Message = msg, RowCnt = retcnt,
ErrorCode = code };

}

/// \<summary\>

/// 操作失败 统一返回

/// \</summary\>

/// \<param name="ex"\>\</param\>

/// \<param name="errormsg"\>\</param\>

/// \<param name="errorcode"\>\</param\>

/// \<returns\>\</returns\>

public ReponseContext \_error(Exception ex, string errormsg, int errorcode =
500)

{

//统一写日志

//Log.Write()

Console.WriteLine(ex.Message);

return new ReponseContext() { Message = ex.Message, ErrorCode = errorcode };

}

/// \<summary\>

/// 操作失败 统一返回

/// \</summary\>

/// \<param name="ex"\>\</param\>

/// \<param name="errormsg"\>\</param\>

/// \<param name="errorcode"\>\</param\>

/// \<returns\>\</returns\>

public ReponseContext \_fail(string errormsg, int errorcode = 500)

{

//统一写日志

//Log.Write()

Console.WriteLine(errormsg);

return new ReponseContext() { Message = errormsg, ErrorCode = errorcode };

}

}

### 文件上传

文件上传时，由于需要传递相关文件的信息，因此须使用xycn.pluginsupport库中提供的类对象作为输入参数，以便通过标准formdata方式来接收上传文件。

典型实例如下所示：

/// \<summary\>

///

/// \</summary\>

/// \<param name="id"\>\</param\>

/// \<param name="stream"\>\</param\>

[HttpMethod(HttpMethodType.POST, "files")]

public void PostFiles(int id, [FromForm]UploadFiles
upload_files,[FromQuery]string jjj)

{

foreach (UploadFile uploadfile in upload_files.uploadFiles)

{

using (FileStream file = new FileStream("d:\\\\" + uploadfile.fileName,
FileMode.Create))

{

byte[] buffer = new byte[1024 \* 1024];

int start_pos = 0;

for (int i = 0; ; i++)

{

int read_count = uploadfile.fileReaderStream.Read(buffer, 0, 1024 \* 1024);

if (read_count \<= 0)

break;

file.Write(buffer, 0, read_count);

}

}

//手动释放上传文件流对象

uploadfile.fileReadStream.Dispose()

}

}

**注：用于读取的上传文件流，需要由使用者自行创建并释放。**

如上实例所示，函数中，输入参数“**[FromForm]UploadFiles
upload_files**”，指名需要接收的上传文件（允许一次性传送多个文件）。其中，**[FromForm]**指明文件流通过Form格式上传，**UploadFiles**为xycn.pluginsupport提供的用于描述上传文件列表的类。使用时，须根据UploadFiles中的上传文件列表，依次创建并将输入UploadFiles中包括的各个UploadFile.写入文件即可。UploadFiles定义如下：

/// \<summary\>

/// 上传文件列表

/// \</summary\>

public class UploadFiles

{

/// \<summary\>

/// 上传文件数量

/// \</summary\>

public int FileCount { get { return uploadFiles.Count; } }

//上传文件列表信息

public List\<UploadFile\> uploadFiles = new List\<UploadFile\>();

}

其中UploadFile定义如下：

/// \<summary\>

/// 上传文件

/// \</summary\>

public class UploadFile

{

/// \<summary\>

///

/// \</summary\>

public string contentType = "";

/// \<summary\>

/// 文件名

/// \</summary\>

public string fileName = "";

/// \<summary\>

/// 文件长度

/// \</summary\>

public long length = 0;

/// \<summary\>

/// 名称

/// \</summary\>

public string name = "";

/// \<summary\>

/// 用于读取的上传文件流，该流需要由使用者手动释放

/// \</summary\>

public Stream fileReaderStream;

}

### 文件下载

通过使用xycn.pluginsupport库中提供的DownloadFile类，实现标准的文件下载。典型实例如下所示：

[HttpMethod(HttpMethodType.GET, "/download/{file_name}")]

public DownloadFile DownloadFile()

{

DownloadFile ret = new DownloadFile();

IFileHelper.IFileHelper fileHelper =

FileHelper.CreateFileService("LocalFileHelper");

Stream file = fileHelper.OpenRead("d:\\\\ttt.txt");

//FileStream file = new FileStream("d:\\\\ttt.txt", FileMode.Open);

ret.fileName = "ttt.txt";

ret.fileLength = file.Length;

ret.fileStream = file;

return ret;

}

**注：用于下载的文件流，由框架程序在下载完成后，自动关闭。使用者需要手动打开下载文件流，但是不能自己进行释放**

如上实例所示，使用文件下载，只需定义函数返回值为DownloadFile类型后，框架程序会自动根据返回值类型进行文件下载处理。在该函数中，使用者需要根据请求，打开指定的文件流（windows下，请使用System.IO.FileStream
file = new System.IO.FileStream("d:\\\\ttt.txt", FileMode.Open, FileAccess.Read,
FileShare.ReadWrite);来打开待下载文件，其中FileShare.ReadWrite选项指名允许读写共享，这样才能支持多个客户端同时下载同一文件），并将打开的文件流赋给DownloadFile对象中的fileStream字段。返回给框架后，由框架进行文件流传输，并负责关闭打开的文件流。

DownloadFile定义如下：

/// \<summary\>

/// 下载文件信息

/// \</summary\>

public class DownloadFile

{

/// \<summary\>

/// 文件长度

/// \</summary\>

public long fileLength = 0;

/// \<summary\>

/// 文件名

/// \</summary\>

public string fileName = "";

/// \<summary\>

/// 文件续传起始位置

/// \</summary\>

public int offsetPosition = 0;

/// \<summary\>

/// 供下载的文件流,该流会由框架自动进行释放

/// \</summary\>

public Stream fileStream = null;

}

### 实例代码

1.  **继承BaseController类的实例（使用了IDbService插件）代码：**

/// \<summary\>

/// 会员管理

/// \</summary\>

public class MembersController : BaseController

{

/// \<summary\>

/// 基类数据查询类

/// \</summary\>

//public DbHelper\<Members\> \_dbhelper = new DbHelper\<Members\>();

IDbService \_dbhelper = DbHelper.CreateDbService();

/// \<summary\>

/// 查询所有数据

/// \</summary\>

/// \<returns\>\</returns\>

[HttpMethod(HttpMethodType.POST, "/Members/GetAllList")]

public ReponseContext GetAllList()

{

try

{

var res = \_dbhelper.GetList\<Members\>(null);

if (res.IsSucceed)

{

return \_success(res.Data);

}

return \_fail(res.Message);

}

catch (Exception ex)

{

return \_error(ex, "/Members/GetList");

}

}

/// \<summary\>

/// 查询所有数据

/// \</summary\>

/// \<returns\>\</returns\>

[HttpMethod(HttpMethodType.POST, "/Members/GetList")]

public ReponseContext GetListAsync([FromBody] RequestContext model)

{

try

{

var req = model.Data.ToDictionaryWithKeyToLower();

var res = \_dbhelper.GetListByDic\<Members\>(req);

return \_success(res);

}

catch (Exception ex)

{

return \_error(ex, "/Members/GetList");

}

}

/// \<summary\>

/// 分页查询数据

/// \</summary\>

/// \<returns\>\</returns\>

[HttpMethod(HttpMethodType.POST, "/Members/GetListPage")]

public ReponseContext GetListPage([FromBody] RequestContext model)

{

try

{

var res = \_dbhelper.GetListByPage\<Members\>(p =\> p.KID == 1, model.Page,
model.Limit);

if (res.IsSucceed)

{

return \_success(res.Data);

}

return \_fail(res.Message);

}

catch (Exception ex)

{

return \_error(ex, "/Members/GetListPage");

}

}

/// \<summary\>

/// 分页查询数据

/// \</summary\>

/// \<returns\>\</returns\>

[HttpMethod(HttpMethodType.POST, "/Members/GetOne")]

public ReponseContext GetOne()

{

try

{

var res = \_dbhelper.GetOne\<Members\>(p =\> p.KID == 1);

if (res.IsSucceed)

{

return \_success(res.Data);

}

return \_fail(res.Message);

}

catch (Exception ex)

{

return \_error(ex, "/Members/GetOne");

}

}

/// \<summary\>

/// 修改数据

/// \</summary\>

/// \<returns\>\</returns\>

[HttpMethod(HttpMethodType.POST, "/Members/UpdateItem")]

public ReponseContext UpdateItem([FromBody] RequestContext model)

{

try

{

//暂未实现

return \_success(model);

}

catch (Exception ex)

{

return \_error(ex, "Members/GetListByPage请求异常");

}

}

/// \<summary\>

/// 添加数据

/// \</summary\>

/// \<param name="model"\>\</param\>

/// \<returns\>\</returns\>

[HttpMethod(HttpMethodType.POST, "/Members/AddItem")]

public ReponseContext AddItem([FromBody] RequestContext model)

{

var entity = model.Data.GetModelByJson\<Members\>();

entity.CreateTime = DateTime.Now;

var res = \_dbhelper.AddItem(entity);

return \_success(res);

}

/// \<summary\>

/// 删除数据

/// \</summary\>

/// \<param name="model"\>\</param\>

/// \<returns\>\</returns\>

[HttpMethod(HttpMethodType.POST, "/Members/DeleteItem")]

public ReponseContext DeleteItem([FromBody] RequestContext model)

{

var res = \_dbhelper.DeleteItem\<Members\>(p =\> p.KID == 2);

return \_success(res);

}

/// \<summary\>

/// 修改数据

/// \</summary\>

/// \<param name="model"\>\</param\>

/// \<returns\>\</returns\>

[HttpMethod(HttpMethodType.POST, "/Members/UpdateFields")]

public ReponseContext UpdateFields([FromBody] RequestContext model)

{

var res = \_dbhelper.UpdateFields\<Members\>(p =\> new Members()

{

WxNickName = "修改sss",

CreateTime = DateTime.Now

}, p =\> p.KID == 1);

return \_success(res);

}

/// \<summary\>

/// 修改数据

/// \</summary\>

/// \<param name="model"\>\</param\>

/// \<returns\>\</returns\>

[HttpMethod(HttpMethodType.POST, "/Members/UpdateOneField")]

public ReponseContext UpdateOneField([FromBody] RequestContext model)

{

var res = \_dbhelper.UpdateOneField\<Members\>(p =\> p.WxNickName ==
"sdssdfsdfsdf", p =\> p.KID == 2);

return \_success(res);

}

[HttpMethod(HttpMethodType.POST, "/Members/TestApi")]

public ReponseContext TestApi([FromQuery] string api, [FromBody] RequestContext
model)

{

switch (api.ToLower())

{

case "getdatatable":

{

var res = \_dbhelper.GetDataTable(model.Data.ToString());

return \_success(res.ToDictionary());

}

case "getdatasetall":

{

var res = \_dbhelper.GetDataSetAll(model.Data.ToString());

return \_success(res.ToJsonString());

}

case "getscalar":

{

var res = \_dbhelper.GetScalar(model.Data.ToString());

return \_success(res.ToJsonString());

}

case "getstring":

{

var res = \_dbhelper.GetString(model.Data.ToString());

return \_success(res.ToJsonString());

}

case "executecommand":

{

var res = \_dbhelper.ExecuteCommand(model.Data.ToString());

return \_success(res.ToJsonString());

}

case "sqlquery":

{

var res = \_dbhelper.SqlQuery\<Members\>(model.Data.ToString());

return \_success(res.ToJsonString());

}

case "tran_aud":

{

var sb = new StringBuilder();

sb.AppendLine("tran_aud事务开始");

\_dbhelper.BeginTran();

var addret = \_dbhelper.AddItem(new Members()

{

WxNickName = DateTime.Now.ToString(),

CreateTime = DateTime.Now

});

sb.AppendLine("添加数据：" + addret.ToJsonString());

var newname = "修改wxnickname" + DateTime.Now.ToString();

var kid = Convert.ToInt32(addret.Data);

var upret = \_dbhelper.UpdateOneField\<Members2\>(p =\> p.WxNickName == newname

, p =\> p.KID == kid);

sb.AppendLine("修改数据：" + upret.ToJsonString());

if (!upret.IsSucceed)

{

sb.AppendLine("失败");

\_dbhelper.RollbackTran();

}

else

{

\_dbhelper.CommitTran();

}

//var delret = \_dbhelper.DeleteItem(p =\> p.KID ==
Convert.ToInt32(addret.Data));

//sb.AppendLine("删除数据：" + delret.ToJsonString());

sb.AppendLine("提交事务");

return \_success(addret, 500, sb.ToString());

}

case "tran_error":

{

var sb = new StringBuilder();

sb.AppendLine("tran_error事务开始");

\_dbhelper.BeginTran();

var addret = \_dbhelper.AddItem(new Members()

{

WxNickName = DateTime.Now.ToString(),

CreateTime = DateTime.Now

});

sb.AppendLine("添加数据：" + addret.ToJsonString());

var newname = "修改wxnickname" + DateTime.Now.ToString();

var kid = Convert.ToInt32(addret.Data);

var upret = \_dbhelper.UpdateOneField\<Members\>(p =\> p.WxNickName == newname

, p =\> p.KID == kid);

sb.AppendLine("修改数据：" + upret.ToJsonString());

\_dbhelper.RollbackTran();

sb.AppendLine("提交事务");

return \_success(addret, 0, sb.ToString());

}

}

return \_fail("无执行分支");

}

}

1.  **直接申明的Controller类**

[ApiController]

publicclassSample1

{

public SampleResult Get()

{

SampleResult ret = new SampleResult();

ret.test1 = "Sample1:Get不带任何属性";

return ret;

}

[HttpMethod(HttpMethodType.GET, "/test2/{text}")]

public SampleResult GetWithAbsolutePath(string text)

{

SampleResult ret = new SampleResult();

ret.test1 = "Sample1:Get 方法属性指定路由（绝对路径）:" + text;

return ret;

}

// GET api/values/5

[HttpMethod(HttpMethodType.GET, "[controller]/{id}/{test}/{y}/{cc}")]

public SampleResult GetWithMultiParameter(int id, int test, string y)

{

SampleResult ret = new SampleResult();

ret.test1 = "Sample1:Get 方法属性指定路由（相对路径）:" + y;

return ret;

}

[HttpMethod(HttpMethodType.POST)]

publicvoid Post(int id, [FromQuery] int test, [FromQuery] string y, [FromQuery]
string cc)

{

}

[HttpMethod(HttpMethodType.PUT)]

publicvoid Put()

{

}

}

### 注意事项

Controller中同名函数，需要显示标注为不同访问路由的

### 框架权限说明

接口访问权限基于访问Header透传信息实现，流程参考，框架自带基于Jwt的授权认证，业务若需自行实现授权可基于接口实现接口。

-   无权限接口访问后端接口，获取认证Token信息。

-   前端将获取到的授权Token信息附带到Header里面。

-   框架约定 授权信息在Header里面存储方式Key固定为 Authorization

-   Value的值固定为Bearer空格{Token}

#### 权限基类

>   权限基于插件实现，自定义权限需要继承基类接口xycn.IAuthorize，分别实现签发，和认证。

>   接口示例代码

>   /// \<summary\>

>   /// 权限验证接口

>   /// \</summary\>

>   public interface IAuthorize

>   {

>   /// \<summary\>

>   /// 获取签名信息 Authorization 授权后访问需带上 Authorization：Bearer
>   {Token}

>   /// \</summary\>

>   /// \<param name="authInfo"\>用户信息\</param\>

>   /// \<returns\>\</returns\>

>   string CreateSign(SignInfo authInfo);

>   /// \<summary\>

>   /// 判断认证是否通过

>   /// \</summary\>

>   /// \<param name="token"\>\</param\>

>   /// \<returns\>\</returns\>

>   bool IsSuccess(string token);

>   /// \<summary\>

>   /// 获取授权信息

>   /// \</summary\>

>   /// \<param name="token"\>\</param\>

>   /// \<returns\>\</returns\>

>   SignInfo GetSignInfo(string token);

>   }

#### 配置插件加载

在主框架配置中配置实现的实体

>   配置参考如下，配置与xml配置文件节点中

>   \<!-- 权限插件配置，仅配置一项 --\>

>   \<AuthHelperPlugins\>

>   \<AuthPlugin name="AuthHelperPlugin" lib
>   =".\\authorize_plugins\\xycn.JwtAuthorize\\xycn.JwtAuthorize.dll"/\>

>   \</AuthHelperPlugins\>

>   \<JwtSignInfo\>

>   \<!--签名签发单位--\>

>   \<FromUser\>www.cdxltech.com\</FromUser\>

>   \<ToUser\>www.cdxltech.com\</ToUser\>

>   \<!--签名密钥--\>

>   \<UserKey\>df8a7b8b72e3b9677ddd632a175f6d35\</UserKey\>

>   \<!--过期时间 天--\>

>   \<ExpiresDays\>30\</ExpiresDays\>

\</JwtSignInfo\>

仅当在主框架配置了权限实体，整个系统访问将具备权限拦截，不配置默认不启用权限拦截。

#### 业务授权

业务实现在原有框架基础上，继承的BaseController已透传了HttpContext，

对于不做权限验证的接口，需要在方法实体实体上增加[AllowAnonymous]属性，如：

/// \<summary\>

/// 登录认证

/// \</summary\>

/// \<returns\>\</returns\>

[HttpMethod(HttpMethodType.POST, "/Members/Login")]

**[AllowAnonymous]**

public ReponseContext Login()

{

try

{

var token = AuthHelper.CreateSign(new xycn.IAuthorize.SignInfo()

{

id = "123123",

name = "desdf",

groupid = "123123123",

extend1 = "ex1"

});

return \_success("签发Token: Bearer {Token} " + token);

}

catch (Exception ex)

{

return \_error(ex, "/Members/Login");

}

}

其中签发认证的实体类SignInfo
内置id，name，groupid，和4个自定义字段，业务可自行分配使用。

/// \<summary\>

/// 签名信息

/// \</summary\>

public class SignInfo

{

/// \<summary\>

/// 身份ID

/// \</summary\>

public string id { get; set; }

/// \<summary\>

/// 身份名称

/// \</summary\>

public string name { get; set; }

/// \<summary\>

/// 分组信息

/// \</summary\>

public string groupid { get; set; }

/// \<summary\>

/// 自定义信息1

/// \</summary\>

public string extend1 { get; set; }

/// \<summary\>

/// 自定义信息2

/// \</summary\>

public string extend2 { get; set; }

/// \<summary\>

/// 自定义信息13

/// \</summary\>

public string extend3 { get; set; }

/// \<summary\>

/// 自定义信息4

/// \</summary\>

public string extend4 { get; set; }

}

对于未增加[AllowAnonymous]属性的方法实体，系统默认都是需要权限的，将做权限拦截，无权限访问时，接口返回401Unanthorized。

{

"Status": 401,

"Code": 401,

"Message": "401Unanthorized",

"ResultBody": **null**

}

#### 业务获取访问权限

开启授权后，业务接口方法可以通过base.GetAuthInfo()获取授权信息，返回的是业务授权的基础信息，供业务使用。参考如下代码。

/// \<summary\>

/// 查询所有数据

/// \</summary\>

/// \<returns\>\</returns\>

[HttpMethod(HttpMethodType.POST, "/Members/HelloWord")]

public ReponseContext HelloWord([FromQuery] string token)

{

try

{

**var auth = base.GetAuthInfo();**

return \_success("这是一个测试消息" + DateTime.Now.ToString() +
auth.ToJsonString());

}

catch (Exception ex)

{

return \_error(ex, "/Members/HelloWord");

}

}