一、WebApi能为您做什么?

二、产品介绍

    CSFramework.WebApi是服务端快速开发框架（后端框架），基于ASP.NET提供的WebAPI底层架构强大的编程能力，封装成为可复用、可扩展、可定制开发的服务端软件开发框架，助力您快速轻松搭建基于HTTP/HTTPS等协议以及支持多种客户端（如：APP、B/S、C/S、微信公众号、微信小程序等）各种跨平台移动终端的服务端应用程序。

    服务端开发、WebApi接口开发是软件项目重要工作环节，服务端注重业务逻辑、数据处理和数据分析、算法等方面的设计和服务，前端主要体现在用户体验、界面操作和数据采集方面。前端软件系统和后端服务架构共同搭建跨平台大型数据管理应用系统。

CSFramework.COM致力于C/S架构快速开发框架及后端WebApi开发框架产品方面的技术研究与深耕，开发团队积累了大量的项目经验。我们秉着分享成功经验，坚持创新的原则，专业，专心、专注的工匠精神，致力于打造更完美的产品。

三、WebApi应用场景

四、架构图 （Architecture）

CSFramework.WebApi 封装多个通用功能，为搭建Web服务端软件提供强大的技术支持。

客户端请求以命令形式传递到服务端的API接口，命令也就是请求的数据包，包含有请求编号、数据签名以及提交的业务数据。服务端接收到请求，首先要进行数据格式分析以及安全检查，比如数据签名、用户令牌或用户账号信息等。检查通过后，系统自动将请求传递到命令处理处理程序，系统将拒绝非法请求，抛出异常或返回错误回应信息给客户端。

命令处理层即业务逻辑层，主要负责数据校验和提取业务数据，将Request的数据（JSON或XML）文本内容转换为实体对象，最后传递到数据访问层提交到数据库。

数据访问层是整个逻辑处理的最后一个流程，负责将数据模型持久化到数据库。数据层使用开发框架内置的数据更新机制，根据表结构模型自动生成SQL脚本，无论是提交单条或批量数据，无需手工编写SQL脚本，系统自动实现数据的持久化。框架支持其他数据模型，如Entity Framework等。

五、客户端请求流程 （Client Request）

流程说明：

客户端发起请求 -> 构建Request对象，封装账号信息以及业务数据 -> 序列化成为JSON/XML文本格式 -> 使用HTTPPOST 或 HTTPGET 方式向服务端提交数据 -> 服务端接收到请求信息。

六、服务端处理流程 (Server Process)

流程说明：

服务端接收请求 -> 记录IP访问日志（可配置） -> 进行安全检查 -> 命令工厂创建命令实例(Command Object)  -> 由命令处理程序(CommandHandler)执行命令 -> 调用数据访问层 -> 提交数据。

七、命令处理机制 (Commands)

命令处理机制是CSFramework.WebApi后端开发框架采用的最新设计模式，本质上命令就是业务逻辑层。Api接口是暴露给客户端访问的端点(Endpoint)，假设我们要设计一个含有几百个功能的大型系统，是不是要设计数百个Api接口？用命令模式可以解决这个问题，设计一个通用的接口来处理所有客户端的请求，然后用编号区分具体功能，比如编号80100代表客户订单，80200代表采购订单。服务端接收到请求后，通过命令工厂和编号创建对应的命令实例，对于三层架构来说，就是创建了具体的业务逻辑层。

八、数据访问层(DAL Data Access Layer)

数据访问层(Data Access Layer)分为单表操作数据层和主从表操作数据层，开发人员根据功能区分来选择继承方式。若提交一张资料表，使用dalBaseBusiness基类的功能完全兼容dalBaseDataDict基类的功能。主从表操作数据层实现要复杂一点，比如更新主外键、自动生成流水号、事务处理等。



业务逻辑层（命令）将处理传递到数据访问层，首先根据数据库提供者创建数据库对象实例，因此开发框架支持跨数据库操作。然后通过SQL命令生成器分析ORM模型，自动生成三种SQL脚本（INSERT,UPDATE,DELETE）。最后调用数据库对象(IDatabase)的相关方法提交或获取数据。

九、安全机制 (System Security)

系统安全保障机制由以下九个部分组成：

 1.User - 用户账号：通过用户账号和密码确保有效访问，系统支持用户账号、手机号、邮箱登录。
 2.Token - 令牌机制：通过令牌机制确保有效访问。用户登录成功，系统自动分配随机令牌编号。
 3.ApiKey - 开发者账号：WebApi接口常用安全机制，使用公钥+私钥加密方式，确保系统安全。
 4.Data Sign - 数据签名：WebApi接口常用安全机制，使用公钥+私钥加密方式，确保系统安全。
 5.Blacklist - 黑名单：针对黑名单用户限制访问或操作，此功能可配置使用。
 6.Throttle - 限流控制：有效避免频繁访问、恶意访问WebApi接口，此功能可配置使用。
 7.ApiLog - 接口访问日志：针对任何Http请求，服务端会记录接口访问记录，此功能可配置使用。
 8.Login Log - 系统登录日志：记录用户登入或登出系统的信息。
 9.数据加密/解密：提供CryptoHelper工具类，以及4种对称加密工具。

十、ORM模型（ORM Model）

对象关系映射（Object Relational Mapping，简称ORM），是随着面向对象的软件开发方法发展而产生的。用来把对象模型表示的对象映射到基于S Q L 的关系模型数据库结构中去。这样，我们在具体的操作实体对象的时候，就不需要再去和复杂的 SQ L 语句打交道，只需简单的操作实体对象的属性和方法 。O R M 技术是在对象和关系之间提供了一条桥梁，前台的对象型数据和数据库中的关系型的数据通过这个桥梁来相互转化。

ORM模型主要作用是传递给SQL命令生成器自动生成三种SQL脚本(INSERT/UPDATE/DELETE)，开发人员不需要编写冗余复杂的SQL语句。若使用静态类(Static Class)的ORM模型，属性（字段名）还可以作为常量使用。

十一、跨平台服务端 (Cross Platform Server)

开发框架为用户提供多种数据库支持，目前已封装三种底层数据驱动，支持SqlServer、Oracle、MySql三种常用数据库。Multi-DB架构采用策略模式设计，定义IDatabase通用接口，并实现DatabaseMSSQL, DatabaseMySql,DatabaseOracle三个数据库操作类。引用的类库名称：CSframework.DB.dll。

操作数据库代码示例：

十二、WebApi服务器宿主(Server Hosting)

自承载 (Self Hosting)

开发模式必须使用自承载模式，主要方便开发人员进行系统调试、功能测试、断点跟踪和开发。

Self Hosting承载：https://www.csframework.com/archive/1/arc-1-20200217-2722.htm


IIS承载 (IIS Hosting)

基于IIS（Internet Information Server）服务器承载WepApi服务。要求IIS版本在7.0或更高，应用程序池设置为.NetFramework 4.5。

IIS承载：https://www.csframework.com/archive/1/arc-1-20200217-2721.htm


Windows服务承载

基于Windows服务承载WebApi服务。首先要安装服务，运行程序目录下的_Install.bat批处理文件，命令窗体显示安装情况，安装完成后，打开Windows服务管理器，找到安装的服务（如：CSFramework.WebAPI.服务器，见下图），在属性页将启动类型设置为“自动（延迟启动）”。

Win服务承载：https://www.csframework.com/archive/1/arc-1-20200217-2723.htm

十三、解决方案(VS2015 Solution)

CSFramework.WebApi包含三个解决方案：



CSFramework.WebApi.Foundation





CSFramework.WebApi.Demo







《CSFramework.WebApi开发人员手册》.docx

十四、压力测试报告(Testing Report)

测试目的：测试CSFramework.WebApi服务器的并发承受能力以及高负荷请求的稳定性。

测试环境：



注：红色字体的用时(s)：是指所有异步任务处理数据的耗时时间，并不代表本次测试用的时间。

测试程序截图：








阿里云服务器监控：






 

测试完成后查询系统日志：

---

如下图所示：随着用户请求数量递增，SQL Server数据库服务器占用内存巨大(达到87%)，这也是应用程序服务器与数据库服务器必须分开的主要原因。本次压力测试CPU最高峰值不到60%。

---

如下图所示：本次测试完成后，日志数据库暴增超过7GB，因此建立独立的日志服务器非常必要。

十五、开发环境与配置

1. 操作系统：Windows 8,10或更高版本；
2. 开发工具：Visual Studio 2017或更高版本；
3. 数据库：Microsoft SQL Server 2008R2/Oracle11g/MySQL 5.7.34或更高版本；
4. WebApi IIS承载：IIS 7.0或更高版本；
5. .Net Framework运行环境：4.0或更高版本

十六、软件著作权登记证书

基于B/S架构的WebApi后端管理工具，用户可以通过Admin Tool工具，管理和维护WebApi后台数据以及快速生成WebApi服务端源码。

扫一扫加微信：