【转】Web API项目中使用Area对业务进行分类管理

在之前开发的很多Web API项目中，为了方便以及快速开发，往往把整个Web API的控制器放在基目录的Controllers目录中，但随着业务越来越复杂，这样Controllers目录中的文件就增加很快，难以管理，而且如果有不同业务模块有重复的控制器名的话，还需要尽量避免。引入Area的作用就是把控制器按照不同的业务模块进行区分，方便管理，而且控制器名称可以重名。

1、Web API项目引入Area进行分类

Area在项目中可以称之为区域，每个Area代表应用程序的不同功能模块，Area 使每个功能模块都有各自的文件夹，文件夹中有自己的Controller、View和Model，但对于管理也增加了一定的难度。如果是Web API项目，我们可以把不必要的目录移除即可，简化对目录的管理。
引入Area可以是我们不同的业务模块可以重名，而且各个业务模块管理起来也更加方便，在原先的Web API项目里面，它们的目录是这样的。


虽然我们把它们的目录归类，但是它们还是存放在一个命名空间下的。

namespace MyWebApi.Controllers

 


这样使用虽然也没有什么问题，但是还是存在一些弊端，因此引入Area的方式对不同业务模块的控制器进行管理，以达到我们分类管理的目的。
引入Area前，我们的API路径如下所示

http://localhost:9001/api/User

引入Area后，我们把常规的权限管理、字典管理等基础模块放到Framework的Area里面，那么这个时候API路径和具体的Area相关，地址则变成了如下：

http://localhost:9001/api/Framework/User

我们再来看看具体的项目目录，Web API项目中使用Area后，Controller的目录如下所示。


除了在各个不同Area下有不同的控制器，而且也增加了一个**AreaRegistration.cs的文件，如对应Framework的Area，有一个FrameworkAreaRegistration.cs文件
这样对应下面的控制器，它的命名空间如下所示。

namespace WebAPI.Areas.Framework.Controllers

 

2、Web API项目对Area控制器的路径映射

上面小节介绍了使用Area来对Web API控制器的分类管理，并介绍了引入Area后对控制器位置、命名空间、Web API的URL等方面的不同。这样如果我们要解析对应地址的Web API，那么也需要做一定的处理，否则是无法找到对应的控制器，从而出现错误信息。
首先我们需要修改Web API里面WebApiConfig的配置信息，如下所示。


上面指定了默认的Web API映射，并指定结果只做JSON格式的输出（移除XML输出）。
为了对不同的Area实现API的地址处理，我们先设计一个基类，然后让不同的Area注册类继承它，方便统一处理。


其中基类Area注册类的CustomAreaRegistration类代码如下所示。


有了上面的基类映射 RegisterArea函数，我们只需要在子类设置对应的AreaName基类实现不同Area子类的正确映射API路径处理了。

复制代码

/// <summary>
/// 框架基础Area的注册类
/// </summary>
public class FrameworkAreaRegistration : CustomAreaRegistration 
{public override string AreaName {get {return "Framework";}}
}

复制代码

 

当然为了实现对Area的Web API控制器的URL正确解析，获取属于Action、Controller、以及对应命名空间的对象，那么还需要在global.asa.cs里面添加一行代码，如下所示。

 //对Web API的Area进行支持
GlobalConfiguration.Configuration.Services.Replace(typeof(IHttpControllerSelector),  new AreaHttpControllerSelector(GlobalConfiguration.Configuration));

 

其中AreaHttpControllerSelector是我们自定义的HTTP控制器地址解析器，需要根据我们的地址提取出具体的控制器、Area名称、程序集类型等，方便构建对应的解析器。

复制代码

private HttpControllerDescriptor GetApiController(HttpRequestMessage request)
{var controllerName = base.GetControllerName(request);var areaName = GetAreaName(request);if (string.IsNullOrEmpty(areaName)){return null;}var type = GetControllerTypeByArea(areaName, controllerName);if (type == null){return null;}return new HttpControllerDescriptor(_configuration, controllerName, type);
}

复制代码

 

有了这些基础的管理，我们就可以定义好我们所需要Area，然后构建具体业务范畴下的控制器接口即可。

3、Web API在客户端的接口调用

所有的Web API地址，都是与具体的Area有关系，例如在Framework业务下的字典模块，它们Web API配置的地址如下所示。

<!--字典Web API模块配置-->

<add key="DictType" value="http://localhost:27206/api/Framework/DictType"/>

<add key="DictData" value="http://localhost:27206/api/Framework/DictData"/>

<add key="CorpDictData" value="http://localhost:27206/api/Framework/CorpDictData"/>

<add key="City" value="http://localhost:27206/api/Framework/City"/>

<add key="District" value="http://localhost:27206/api/Framework/District"/>

<add key="Province" value="http://localhost:27206/api/Framework/Province"/>

<add key="UserParameter" value="http://localhost:27206/api/Framework/UserParameter"/>

我们在客户端，只需要对Web API进行封装即可，这个部分可以使用Database2Sharp代码生成工具进行统一的生成，所有继承关系统一处理好，我们所做的就是进行新增接口的处理即可。
例如对于字典模块DictData的处理，它对于Web API的封装类如下所示。

/// <summary>
/// DictData, 基于API服务的Facade接口实现类
/// </summary>
public class DictDataCaller : BaseApiService<DictDataInfo>, IDictDataService

 

这个基类，默认封装了对常规数据表业务Web API接口方式的增删改查以及各种复杂的接口处理。
如果对于一般的Web API（非数据表业务），那么只需要继承的基类做调整即可。

/// <summary>
/// 基于API服务的Facade接口实现类
/// </summary>
public class TestCaller : NormalApiService, ITestService

 

这个NormalApiService基类，默认只是封装了对token和签名的读取处理，没有特殊的业务接口，具体特定的接口我们来实现处理。

对于WebAPI客户端的调用，我们主要就是需要构建对应的URL，然后通过GET传递或者POST传递一些参数，并读取HTML结果，把它解析为对应的类型数据即可，如下代码所示。

复制代码

/// <summary>
/// 根据字典类型名称获取对应的字典记录
/// </summary>
/// <param name="dictTypeName">字典类型名称</param>
/// <returns></returns>
public List<DictDataInfo> FindByDictType(string dictTypeName)
{var action = System.Reflection.MethodBase.GetCurrentMethod().Name;string url = GetTokenUrl(action) + string.Format("&dictTypeName={0}", dictTypeName);List<DictDataInfo> result = JsonHelper<List<DictDataInfo>>.ConvertJson(url);return result;
}

复制代码

 

通过GetTokenUrl(action) 函数获取对应的URL地址，由于传入一个参数，接口这里没有发生数据修改，是GET方式提交参数数据，因此把参数附加在URL即可。
也就是下面代码实现了完整Web API地址的构建。

string url = GetTokenUrl(action) + string.Format("&dictTypeName={0}", dictTypeName);

构建好这些URL地址后，我们通过获取对应Web API的结果并进行序列号到具体对象即可。如下代码所示。

List<DictDataInfo> result = JsonHelper<List<DictDataInfo>>.ConvertJson(url);

关于Web API接口的设计文章，可以参考我的随笔。

  • Web API接口设计经验总结
  • Web API应用架构设计分析（1）
  • Web API应用架构设计分析（2）
    具体的Web API接口的使用，可以参考随笔：
  • Web API应用架构在Winform混合框架中的应用（1）
  • Web API应用架构在Winform混合框架中的应用（2）--自定义异常结果的处理
  • Web API应用架构在Winform混合框架中的应用（3）--Winfrom界面调用WebAPI的过程分解
  • Web API应用架构在Winform混合框架中的应用（4）--利用代码生成工具快速开发整套应用
  • Web API应用架构在Winform混合框架中的应用（5）--系统级别字典和公司级别字典并存的处理方式

通过以上的封装处理，那么对于业务表的Web API接口调用，具体使用客户端的代码如下所示。

var dictType = CallerFactory<IDictTypeService>.Instance.GetTree();
Console.WriteLine(dictType.ToJson());var dictData = CallerFactory<IDictDataService>.Instance.GetAllDict();
Console.WriteLine(dictData.ToJson());

 

如果对于非数据表业务的Web API接口调用，具体使用客户端的代码如下所示。

var testAction = CallerFactory<ITestService>.Instance.TestAction();
Console.WriteLine(testAction.ToJson());var test = CallerFactory<ITestService>.Instance.Test("123");
Console.WriteLine(test.ToJson());

 

这样，不管是在Web项目里面，还是在Winform项目里面，或者在跨平台的IOS项目里面（或者安卓项目），都可以以相同的方式消费Web API，这样我们所有的数据入口在一个地方，可以集中业务接口的统一开发，并且可以有效管理我们的数据提供的性能问题，如统一缓存处理，统一权限处理...
感谢大家对本文章的细心阅读，希望对您的开发有所启发或帮助。

主要研究技术：代码生成工具、会员管理系统、客户关系管理软件、病人资料管理软件、Visio二次开发、酒店管理系统、仓库管理系统等共享软件开发
专注于Winform开发框架/混合式开发框架、Web开发框架、Bootstrap开发框架、微信门户开发框架的研究及应用。
  转载请注明出处：
撰写人：伍华聪  http://www.iqidi.com 

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/437192.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

centos部署python flask_用Dockerfile部署你的Flask Web应用

centos部署python flask_用Dockerfile部署你的Flask Web应用

背景故事话说去年年底给另外一个组的同事写了一个简单的工单查询系统&#xff0c;用flask写的&#xff0c;当时是部署在我们组的一台测试物理机上&#xff0c;操作系统是Redhat 7。后来我们组的这台测试物理机要做其它用途&#xff0c;领导给两天时间让把应用迁走&#xff0c;问…
阅读更多...
计算机组成与系统原理中的节拍是什么意思？

计算机组成与系统原理中的节拍是什么意思？

《计算机组成与系统原理》裘雪红&#xff0c;李伯成&#xff0c;这本书里面第六章有一个节拍的概念&#xff0c;节拍和时钟有什么区别呢&#xff1f; 时钟是计算机的心跳&#xff0c;这个大家都知道。但是具体怎么实现控制的呢&#xff1f;就是通过转换成节拍来控制的。 时钟…
阅读更多...
centos7安装flink集群_《从0到1学习Flink》—— Flink 写入数据到 Kafka

centos7安装flink集群_《从0到1学习Flink》—— Flink 写入数据到 Kafka

前言之前文章 《从0到1学习Flink》—— Flink 写入数据到 ElasticSearch 写了如何将 Kafka 中的数据存储到 ElasticSearch 中&#xff0c;里面其实就已经用到了 Flink 自带的 Kafka source connector&#xff08;FlinkKafkaConsumer&#xff09;。存入到 ES 只是其中一种情况&a…
阅读更多...
【转】C#字节数组_字符串相互转换

【转】C#字节数组_字符串相互转换

https://www.cnblogs.com/Asa-Zhu/archive/2012/11/08/2761137.html 如果还想从 System.String 类中找到方法进行字符串和字节数组之间的转换&#xff0c;恐怕你会失望了。为了进行这样的转换&#xff0c;我们不得不借助另一个类&#xff1a;System.Text.Encoding。该类提供了…
阅读更多...
Qt中的私有信号

Qt中的私有信号

一、什么是Qt私有信号&#xff1f; 直接引用Qt文档中的描述&#xff1a; 二、私有信号的作用 私有信号只能被响应&#xff0c;不能被用户代码来发射&#xff08;emit&#xff09;。这是一种对某些信号的权限控制&#xff0c;也就是用户代码没有权力“发号施令”&#xff0c;只…
阅读更多...
opencv获取图片像素坐标_利用OpenCV从图片中提取矩形并标注坐标（室内平面地图）（一）

opencv获取图片像素坐标_利用OpenCV从图片中提取矩形并标注坐标（室内平面地图）（一）

​某城市会展中心室内地图背景一名室内设计师的日常工作从设计一张会展地图开始。常常有这样的场景&#xff1a;划分除规范的展位后&#xff0c;进入销售阶段&#xff0c;频繁的需要修改这张地图&#xff0c;如展示拆分、合并、换位置、标记已交易。问题从上图中标记色块的是有…
阅读更多...
【转】C#中ToString()格式详解

【转】C#中ToString()格式详解

以下内容均摘自博客园&#xff0c;仅供资料查询。 ToString格式化 在很多对象显示为字符串的时候都会使用到ToString中的格式化&#xff0c;由于以前没怎么注意到这个问题&#xff0c;想总结一下各个基础结构对象的格式化&#xff0c;以便后备之用&#xff01;&#xff01;&am…
阅读更多...
【编译原理】入门总结

【编译原理】入门总结

教程资源 入门教程在&#xff1a;手把手教你做一个 C 语言编译器 学习过程 19年尝试学了一下&#xff0c;中途看不懂放弃了。20年底从头再看一遍&#xff0c;经过一年的知识积累&#xff0c;在仔细研读之下&#xff0c;终于算是学懂了。此文中记录了我在最初学习时遇到的问题…
阅读更多...
python数据可视化从入门到实战_《Python编程从入门到实践》json数据可视化练习详解...

python数据可视化从入门到实战_《Python编程从入门到实践》json数据可视化练习详解...

《Python编程从入门到实践》16.2中&#xff0c;计算收盘价均值的程序有些不易看懂&#xff0c;结合我自己的理解进行一些说明。使用的数据集&#xff1a;join格式的数据&#xff0c;数据集是由多个字典为元素组成的列表。每个字典包含如下信息[{"date": "2017-0…
阅读更多...
【转】C# WebAPI中为自定义模型设置JSonConverter

【转】C# WebAPI中为自定义模型设置JSonConverter

我的WebAPI应用程序中有一个模型,用.NET 4.0编写,含有一个System.Net.Mime.ContentType类型的属性,如下所示&#xff1a; [Serializable] public class FileData {private ContentType contentType;private long size;private string name;public ContentType ContentType{get …
阅读更多...
Qt添加翻译文件

Qt添加翻译文件

以在Qt Creator中开发为例&#xff1a; 第一步 在.pro文件中添加一行 TRANSLATIONS projectName_zh.ts 保存&#xff0c;执行一次qmake。 注&#xff1a;ts文件是xml文件保存了需要翻译的信息。 第二步 选择菜单&#xff1a;工具->外部->Qt预言家->更新翻译。 可…
阅读更多...
python爬虫淘宝手机_【Python3 爬虫】14_爬取淘宝上的手机图片

python爬虫淘宝手机_【Python3 爬虫】14_爬取淘宝上的手机图片

现在我们想要使用爬虫爬取淘宝上的手机图片&#xff0c;那么该如何爬取呢&#xff1f;该做些什么准备工作呢&#xff1f;首先&#xff0c;我们需要分析网页&#xff0c;先看看网页有哪些规律我们可以看到左侧是主题市场&#xff0c;将鼠标移动到【女装/男装/内衣】这一栏目&…
阅读更多...
【转】WebSocket初探

【转】WebSocket初探

定义&#xff1a; 遵循RFC6544协议的通信协议。Webcoket协议和http协议属于并行关系&#xff0c;但是websocket是以http协议为基础开发出来的&#xff08;微软用IhttpHandler接口中同时处理这两种协议&#xff09;&#xff0c;同时他们都是以TCP协议为基础。可以进行双向通信、…
阅读更多...
应用程序标准输入输出、Shell、程序界面的关系

应用程序标准输入输出、Shell、程序界面的关系

发展史 计算机在发展初期&#xff0c;电脑上的软件是没有窗口的&#xff0c;只有一个命令行&#xff0c;这个软件叫Shell&#xff0c;中文的意思是外壳。Shell是一个统一的叫法&#xff0c;实际在不同的系统中&#xff0c;又有很多种Shell软件&#xff0c;如下表所示&#xff…
阅读更多...
安卓简单天气预报app源码_七个个小众但实用的APP，效率翻倍~

安卓简单天气预报app源码_七个个小众但实用的APP，效率翻倍~

推荐7个小众但实用的APP1、PDF处理助手下面就是软件的启动图&#xff0c;没有任何广告。并且直接标明了这个软件的三大特点&#xff1a;简单、免费、快捷下面就是软件的启动图&#xff0c;没有任何广告。而且免注册登录即可使用&#xff0c;简直是一款良心软件了。2、菜鸟教程菜…
阅读更多...
【转】Jenkins详细教程

【转】Jenkins详细教程

最近花了一段时间研究jenkins这个工具。所以写下这篇文章&#xff0c;算是当做记录吧&#xff01; 一、jenkins是什么&#xff1f; Jenkins是一个开源的、提供友好操作界面的持续集成(CI)工具&#xff0c;起源于Hudson&#xff08;Hudson是商用的&#xff09;&#xff0c;主要…
阅读更多...
【Github】怎么在README.md中添加图片？

【Github】怎么在README.md中添加图片？

原理是将图片作为文档上传&#xff0c;在README.md中引用即可。 参考博客&#xff1a;【GitHub】给GitHub上的ReadMe.md文件中添加图片怎么做 、 gitHub创建文件夹
阅读更多...
拼接符 防注入正则校验_Apache Kylin 命令注入漏洞调试分析(CVE-2020-1956)

拼接符 防注入正则校验_Apache Kylin 命令注入漏洞调试分析(CVE-2020-1956)

1、前言Apache Kylin是一个开源的、分布式的分析型数据仓库&#xff0c;提供Hadoop/Spark 之上的 SQL 查询接口及多维分析(OLAP)能力以支持超大规模数据。近日&#xff0c;百度云安全团队监测到Apache官方发出了一个漏洞通告&#xff0c;披露了Apache kylin多版本存在命令注入漏…
阅读更多...
【转】一个ASP.NET MVC中ajax调用WebApi返回500 Internal Server Error的调错方法。

【转】一个ASP.NET MVC中ajax调用WebApi返回500 Internal Server Error的调错方法。

ASP.NET MVC 引入的WebApi自然且较好地满足了ajax的交互需求&#xff0c;但使用jQuery ajax调用WebApi返回500 Internal Server Error时却不太好查找错误。在一个实际项目中&#xff0c;WebApi方法全部使用了try-catch捕获异常&#xff0c;并返回定制的错误消息&#xff0c;想当…
阅读更多...
【Github】开源项目xterm.js

【Github】开源项目xterm.js

项目github地址&#xff1a; xterm.js on github 学习笔记 从项目介绍中进行知识拓展 名称资料npmnpm 是干什么的&#xff1f;&#xff08;非教程&#xff09;semversemver&#xff1a;语义化版本规范在 Node.js 中的实现Hyper软件官网 >Theia官网 >Electron官网 >…
阅读更多...
最新文章

Copyright @ 2022~2023