重构Web Api程序(Api Controller和Entity)

时间:2023-01-10 18:33:53

Insus.NET较习惯做法,是在程序完成之后,抽一些少时间对写好的代码重新审视。比如这些天写的Web Api的程序来说,发现有很多值得重构代码。

开发ASP.NET MVC程序,与数据相关有关联的一般是在控制器与Entity实体之间。

初步重构是把Api控制器OrdersController.cs的程序移至实体OrderEntity.cs中去:
第一
重构public IEnumerable<Order> Get()方法,
重构Web Api程序(Api Controller和Entity)

此方法移至Entity:
重构Web Api程序(Api Controller和Entity)

这样一移动,那在控制器的Get()方法,就可以改为:
重构Web Api程序(Api Controller和Entity)

第二
 重构public void Post(Order o)方法:
重构Web Api程序(Api Controller和Entity)

在实体添加
重构Web Api程序(Api Controller和Entity)

控制器方法重构之后:
重构Web Api程序(Api Controller和Entity)

第三
重构控制器OrderController另一个方法public void Post(Order o):
重构Web Api程序(Api Controller和Entity)

把引方法移至实体:
重构Web Api程序(Api Controller和Entity)

在控制器中的方法被重构之后:
重构Web Api程序(Api Controller和Entity)

第四
重构public void Put(Order order)方法,把此方法移至Entity中去,并创建一个新方法,稍作一些小修改:
重构Web Api程序(Api Controller和Entity)

在实体OrderEntity中新建的public void Update(Order order, string fileVirtualPath)方法:
重构Web Api程序(Api Controller和Entity)

重构之后,方法体内代码,可使用2句即可,并删除移走的代码:
重构Web Api程序(Api Controller和Entity)

第五,最后一个需要搬移的是Delete()方法:
重构Web Api程序(Api Controller和Entity)

在实体类中,创建一个全新的Delete()方法:
重构Web Api程序(Api Controller和Entity)

被重构之后,在控制器看到的Delete()方法,简洁多了。更多的逻辑处理代码不必在控制方法呈现。
重构Web Api程序(Api Controller和Entity)

最后OrderController.cs类别重构好的类,如下,删除注解的代码,下机标记1至标记5就是我们上面所重构过的方法:
重构Web Api程序(Api Controller和Entity)

现在我们可以关闭OrderControler.cs类,打开OrderEntity类,对这个类进行重构。找到下面三个方法中
public void AppendDataToExistingJsonFile(Order order, string fileVirtualPath)
public void Update(Order order, string fileVirtualPath)
public void Delete(Order order, string fileVirtualPath)

下面的代代码有冗余,如:
重构Web Api程序(Api Controller和Entity)

把它写成一个私有方法:
重构Web Api程序(Api Controller和Entity)

看到上面代码示例中的红色箭头否,说明三个方法内已经引用了重构好的代码了。
重构Web Api程序(Api Controller和Entity)

接下来我们又发现四个方法
public void PostAndSaveToFile(Order order, string fileVirtualPath)
public void AppendDataToExistingJsonFile(Order order, string fileVirtualPath)
public void Update(Order order, string fileVirtualPath)
 public void Delete(Order order, string fileVirtualPath)
中,下面这段代码是将List<Order>对象写成json文件,它们在这个OrderEntity类中,已经显冗余了:
重构Web Api程序(Api Controller和Entity)

写成一个私有方法:
重构Web Api程序(Api Controller和Entity)

这样四个方法均可以删除冗余部分的代码,引用这个私有的方法即可,不过第一个方法,public void PostAndSaveToFile(Order order, string fileVirtualPath)
引用此方法,有些问题,因为重构好的方法传入的参数是List<Order>,因此需要做些修改,如下:
重构Web Api程序(Api Controller和Entity)

还有
public void AppendDataToExistingJsonFile(Order order, string fileVirtualPath)
public void Update(Order order, string fileVirtualPath)
public void Delete(Order order, string fileVirtualPath)
三个方法中有一个功能是相同的,就是读取Json文件,并转换为List<Order>对象,虽然代码不一相同,但是我们是可以把它写成一个统一的:
重构Web Api程序(Api Controller和Entity)

这样子,三个方法就可以引用此方法:
重构Web Api程序(Api Controller和Entity)

在Update()和Delete()方法,还有2句,是实现删除文件的功能:

 if (System.IO.File.Exists(newFilePhysicalPath))
{
File.Delete(newFilePhysicalPath);
}

可以重构写成一个私有方法并对程序重构如下:
重构Web Api程序(Api Controller和Entity)

OK,最后整理一下4个私有方法:
重构Web Api程序(Api Controller和Entity)

重构Web Api程序(Api Controller和Entity)的更多相关文章

  1. 重构Web Api程序&lpar;Api Controller和Entity&rpar;续篇

    昨天有写总结<重构Web Api程序(Api Controller和Entity)>http://www.cnblogs.com/insus/p/4350111.html,把一些数据交换的 ...

  2. 张小龙的野心:用小程序重构web&vert;小程序好处及可能的不足

    一:张小龙的野心:用小程序重构web 一 很多年以前,张小龙写了一款软件:Foxmail. 这款软件当年有数百万用户,这是一个相当庞大的量,因为彼时网民也只有千万当量级的规模. 我是一个非常忠实的用户 ...

  3. 重构Web Api程序&lpar;Api Controller和Entity&rpar; 续篇&lpar;2&rpar;

    一代好的程序,是几经修改与重构出来的.有关此篇Insus.NET对前面所在修改与重构,还是没有觉得很完美简洁.特别对是存在的json文件进行修改或是删除时,我们原先是从文件读取数据,修改或是删除数据, ...

  4. 重构Web Api程序&lpar;Api Controller和Entity&rpar; 续篇&lpar;1&rpar;

    经过一系列重构,你眼明的话,还是可以看到还有重构的地方,如: string newFileName = "~/Temp/" + Guid.NewGuid().ToString() ...

  5. 002&period;Create a web API with ASP&period;NET Core MVC and Visual Studio for Windows -- 【在windows上用vs与asp&period;net core mvc 创建一个 web api 程序】

    Create a web API with ASP.NET Core MVC and Visual Studio for Windows 在windows上用vs与asp.net core mvc 创 ...

  6. 使用MVC 5、Web API 2、KnockoutJS、Ninject和NUnit开发、架构和测试Web应用程序

    做一名微软软件开发人员就像在国际煎饼屋订早餐一样.每道菜都有一堆煎饼,你必须从各种各样的煎饼和糖浆口味中选择.对于web应用程序,解决方案堆栈是一组软件子系统或组件,用于交付功能完整的解决方案(无论是 ...

  7. 【转载】ASP&period;NET MVC Web API 学习笔记---第一个Web API程序

    1. Web API简单说明 近来很多大型的平台都公开了Web API.比如百度地图 Web API,做过地图相关的人都熟悉.公开服务这种方式可以使它易于与各种各样的设备和客户端平台集成功能,以及通过 ...

  8. ASP&period;NET MVC Web API 学习笔记---第一个Web API程序

    http://www.cnblogs.com/qingyuan/archive/2012/10/12/2720824.html GetListAll /api/Contact GetListBySex ...

  9. ASP&period;NET Core 1&period;0开发Web API程序

    .NET Core版本:1.0.0-rc2Visual Studio版本:Microsoft Visual Studio Community 2015 Update 2开发及运行平台:Windows ...

随机推荐

  1. H5 表格标签的其它标签

    <!DOCTYPE html><html lang="en"><head> <meta charset="UTF-8" ...

  2. Nonblocking I&sol;O and select&lpar;&rpar;

    This sample program illustrates a server application that uses nonblocking and the select() API. Soc ...

  3. ACM&colon; Mr&period; Kitayuta&&num;39&semi;s Colorful Graph-并查集-解题报

    Mr. Kitayuta's Colorful GraphTime Limit:1000MS Memory Limit:262144KB 64bit IO Format:%I64d & %I6 ...

  4. 类string的构造函数、拷贝构造函数和析构函数

    原文:http://www.cnblogs.com/Laokong-ServiceStation/archive/2011/04/19/2020402.html   类string的构造函数.拷贝构造 ...

  5. Java web 项目搭建

    Java web 项目搭建 简介 在上一节java web环境搭建中,我们配置了开发java web项目最基本的环境,现在我们将采用Spring MVC+Spring+Hibernate的架构搭建一个 ...

  6. 回传值&lpar;代理、通知、block&rpar;

    回传值问题,一直都是困扰初学者的问题,今写者 代理.通知.block 三者的回传值做了一个小小的总结, Main.storyboard 视图: 通过代码分别创建三个代表 代理.通知.block 的按钮 ...

  7. Winform远程更新代码

    本软件具备以下形: 1.通过http形式在客户端更新winform代码文件 2.在服务端通过软件生成xml配置文件,客户端通过比对xml配置文件来更新代码文件. 服务端: 在服务器上建立一个IIS发布 ...

  8. python&sol;零起点(一、字符串)

    python/零起点(一.字符串) 字符串(str) 字符串是可迭代的 str()强制转成字符串类型 字符串是有序的,且不可变的数据类型. 字符串转换整型的案例: 1 name=['guobaoyua ...

  9. vs调试的时候,指定的参数已超出有效值的范围。参数名:sit ,先仔细看看错误和我的一样不一样

    https://www.cnblogs.com/pei123/p/7694947.html 指定的参数已超出有效值的范围.参数名:sit ,先仔细看看错误和我的一样不一样 更新了1709就这样了,的确 ...

  10. homework1-201521410029

    姓名:孙浩学号: 201521410029指导教师:高见                实验日期:2018年8月9日 1. 虚拟机安装与调试 安装好xp和kali虚拟机之后,查看这三者(包括主机)的i ...