简单干净的C#方法设计案例:SFCUI.AjaxValue()之二

简介:

 先重温一下原则:

最小信息原则:方法接口应只传递最必须的业务信息。

包括两个层面:

1. 技术信息不要暴露

2. 业务信息不能重复

业务信息分析

先别管技术问题,想一想做这个事情需要哪些数据才能完成?

1. 原来的值是多少(显示用)

2. 可能的值有哪些(选择用)

3. 点一个值后,应该执行什么操作(这个是核心业务)

4. 返回后做什么(刷新用)

还有一些问题哪去了?

5. 返回的值刷新到哪里?这个调用者不管,他让我们安排,显示也是我们显示(比如一个DIV),刷新自然就是刷新我们显示的那个位置。

6. 如果返回后什么都不做怎么办?看着办。

最终方法接口设计为:

 
  1. print?public static MvcHtmlString AjaxValue(int id, string value, string[] values, string urlFormat, string ajaxOnSuccess = null)   

怎么多了个ID?因为要显示很多个这种Ajaxalue, 用ID来区分。
urlFormat是什么?他是用来定义生成的Ajax链接的格式的,请看下面的调用(略微存在一些问题的):

 
  1. print?@SFCUI.AjaxValue(story.ID, effortValue.ToString(), Effort.EffortPlannedValues, "/SFC/Efforts/AjaxSetEffortPlanned?itemID=" + story.ID + "&value={0}", ajaxOnSuccess: "refreshLeftPad");   

这几个参数顺序说明是:story.ID修改谁的值,effrotValue当前值,...EffortPlannedValues可能的值,"...."AjaxLink的href格式{0}里边未来将放着被选择的value,ajaxOnSuccess是正确返回调用的函数。

接口设计原则的分析

从理论上说,在任何 cshtml中放置这句话,就具备了所有的业务信息,剩下的全是技术问题,在这个方法里边解决,外面一概不管,这就叫做“技术信息不要暴露”的子原则。
怎么前面说“略微存在一些问题”呢?因为story.ID在这个里边出现了两遍,第一次是一个整数参数传递进去了,第二次是用来生成了urlFormat传递进去了,第二次多余,应该改成:

 
  1. print?@SFCUI.AjaxValue(story.ID, effortValue.ToString(), Effort.EffortPlannedValues, "/SFC/Efforts/AjaxSetEffortPlanned?itemID={0}&value={1}", ajaxOnSuccess: "refreshLeftPad");   

这样里边在0放置id,1放置value,就能拼凑出AjaxLink来。

现在,再删除任何一个字母和标点符号信息就不够了,这就叫做“业务信息不能重复”子原则。

掌握了这个原则,就能在第一时间确认接口的参数(本人喜欢称之为“外观”),然后开工编写。

当然有时候不能第一次就写出最简练的接口,那么可以尝试先“散装”一下,是一个函数,还是一堆DIV,先写出来再说,写完了,再封装成最简形式。

下一篇,会大致说一下AjaxLink里边的实现。



本文转自火星人陈勇 51CTO博客,原文链接:http://blog.51cto.com/cheny/1101536

相关文章
|
3月前
|
JSON 程序员 C#
使用 C# 比较两个对象是否相等的7个方法总结
比较对象是编程中的一项基本技能,在实际业务中经常碰到,比如在ERP系统中,企业的信息非常重要,每一次更新,都需要比较记录更新前后企业的信息,直接比较通常只能告诉我们它们是否指向同一个内存地址,那我们应该怎么办呢?分享 7 个方法给你!
|
3月前
|
C# UED SEO
C# 异步方法async / await任务超时处理
通过使用 `Task.WhenAny`和 `Task.Delay`方法,您可以在C#中有效地实现异步任务的超时处理机制。这种方法允许您在指定时间内等待任务完成,并在任务超时时采取适当的措施,如抛出异常或执行备用操作。希望本文提供的详细解释和代码示例能帮助您在实际项目中更好地处理异步任务超时问题,提升应用程序的可靠性和用户体验。
121 3
|
4月前
|
存储 C#
【C#】大批量判断文件是否存在的两种方法效率对比
【C#】大批量判断文件是否存在的两种方法效率对比
80 1
|
4月前
|
C#
C#的方法的参数传递
C#的方法的参数传递
45 0
|
4月前
|
数据可视化 程序员 C#
C#中windows应用窗体程序的输入输出方法实例
C#中windows应用窗体程序的输入输出方法实例
79 0
|
4月前
|
编译器 C#
C#多态概述:通过继承实现的不同对象调用相同的方法,表现出不同的行为
C#多态概述:通过继承实现的不同对象调用相同的方法,表现出不同的行为
148 65
|
5月前
|
开发框架 .NET 程序员
C# 去掉字符串最后一个字符的 4 种方法
在实际业务中,我们经常会遇到在循环中拼接字符串的场景,循环结束之后拼接得到的字符串的最后一个字符往往需要去掉,看看 C# 提供了哪4种方法可以高效去掉字符串的最后一个字符
475 0
|
2月前
|
存储 安全 编译器
学懂C#编程:属性(Property)的概念定义及使用详解
通过深入理解和使用C#的属性,可以编写更清晰、简洁和高效的代码,为开发高质量的应用程序奠定基础。
116 12
|
3月前
|
设计模式 C# 图形学
Unity 游戏引擎 C# 编程:一分钟浅谈
本文介绍了在 Unity 游戏开发中使用 C# 的基础知识和常见问题。从 `MonoBehavior` 类的基础用法,到变量和属性的管理,再到空引用异常、资源管理和性能优化等常见问题的解决方法。文章还探讨了单例模式、事件系统和数据持久化等高级话题,旨在帮助开发者避免常见错误,提升游戏开发效率。
117 4
|
3月前
|
C# 开发者
C# 一分钟浅谈:Code Contracts 与契约编程
【10月更文挑战第26天】本文介绍了 C# 中的 Code Contracts,这是一个强大的工具,用于通过契约编程增强代码的健壮性和可维护性。文章从基本概念入手,详细讲解了前置条件、后置条件和对象不变量的使用方法,并通过具体代码示例进行了说明。同时,文章还探讨了常见的问题和易错点,如忘记启用静态检查、过度依赖契约和性能影响,并提供了相应的解决建议。希望读者能通过本文更好地理解和应用 Code Contracts。
61 3