pffp(一个JavaScript公共函数接口规范)的简介

Public Functions for Page 拥有一个兼具对称与不对称美的缩写 —— pffp

声明:

pffp不是什么? pffp 不是一个框架;pffp不是一个特定的插件或工具。

pffp是什么? pffp 是页面公共函数集;pffp 拥有一个关于 JavaScript描述的 页面公共逻辑 处理函数的 编写风格的 定义。

pffp被分享的理由(存在的意义): 它所定义的函数(接口)编写规则 兼具 使用的便捷性,阅读的清晰性 和 维护的可扩展性。故,在这里,与其说是在分享这么一个页面公共函数集,不如说是在分享这个函数集的函数规范定义。

 

pffp 的由来:

pffp 函数规范定义来自于一个同名的JavaScript公共函数集。 這个函数集出身于一个过渡性的项目。它为一个 相对于业务需求不太完善的 前端UI框架而生,主要目的是封装/抽象关于 调用框架组件实现页面交互行为的 程序逻辑。以便开发者能够专注于处理业务方面的问题。

简而言之,它为苛刻的开发环境而生,而且很好 适应并改善 所在的开发环境。由于项目的过渡性决定了它可能被遗弃的命运,故在这里将其记录并分享,希望其生命能够得到延续。

pffp函数一大特点:

第一个入参为 入参集对象。其后的入参基本都是必须的或基础的。非必须的及作开关用的入参 通过第一个入参中传入。

先看个例子,尝点鲜:

一个函数的3种调用方法:

(既然省去了不少代码,就不用再在名称上太过节省了,需保证意义的完整,还需顾及全局内函数命名的统一性,故不随意简化。)
例 子中的函数代码是在pffpTools中定义的,当然它也属于pffp。他们的关系在后文中再作说明。说这点的目的是说明,這个函数并非前面所说的交互行 为逻辑函数(至少不是页面级的)。它及其他pffpTools都服务于pffp中页面交互行为逻辑公共函数。简而言之,简化代码,强壮逻辑。

Public Function for Page 简介

Public Function For Page(pffp),页面公共函数。主要基于组件,按照设计来执行相关页面行为。(即在组件上将页面交互行为进行了统一的设计与封装,减少开发人员开发时对页面基本行为逻辑的思考与处理工作量,统一了产品的整体风格,便于组件的更新和页面行为的统一更改。)

pffp开发人员根据具体需求通过修改mypffp来重载pffp中的函数,并通过pffp来调用重载或新增的函数,如通调用pffp自身的函数一样。

pffp使用时的风格如同编写面向过程的程序一样,在面向页面组件对象的程序处理逻辑中,以过程的思考方式来生成页面元素。

pffp根据使用需要,细分为负责处理基本数据的工具函数集pffpTools、负责程序交互行为的pffpInteractive、负责业务逻辑的函数集pffpBusiness。在使用时它们将通过pffp函数集对象来调用。

如下:

# 函数风格说明 #

Public Function for Page(pffp),中的函数,其主要用于封装页面组件元素的行为逻辑。不包含数据处理的基本工具函数。

函数入参:

第一个入参:一定是称作v的入参对象。其包括了所有函数需要接收的入参(这些入参是以v对象的属性形式存在)。

优点是,使用者无需关心函数接收各个入参的位置顺序,对于一些非必要参数,可优先考虑这样的方式。

缺点是,使用者必须明确入参在函数内部是的名称是什么,建议各个函数在相同属性的入参命名上,采用统一名称,以防混淆。

其余位置入参:由于各个函数的用途不同,所需入参不同,所以没有固定的顺序。但是存在一个入参的顺序制定原则。

必要入参优先。

基础入参优先。

当以上原则冲突时,满足靠前的原则的参数位置优先。

必要入参:调用此函数时,必须赋值的参数(无论以何种形式)。

基础入参:属于此函数所操纵对象的属性(包括属性名称)或者行为(包括行为名称),甚至是对象本身,使用者自定义扩展事件(如ajax提交数据成功时执行的successFunc)。

配置性入参:这里的配置是指针对此函数的配置,比如某个控制函数逻辑走向的开关入参,建议像这样的对于所操作对象没有直接实际意义的参数只通过第一位置入参集对象传入。

另,不建议使用objToBeHide、objToBeDraw这样的(仅仅为简单的操作生的)入参。建议将其包括在successFunc(操作成功时执行的函数)或extendFunc(操作外扩展执行的逻辑函数)的处理逻辑中。

当入参即出现在第一位置的入参集对象中,又出现在后面位置的入参中时,以后面位置中的入参值为为准。

所有参数都可以直接在入参集对象中赋值,只有基础入参(必要或非必要,一定是对象的属性或行为变量,而非一些开关变量)才可以拥有函数第一入参后的某个入参位置。

函数入参的初始处理原则:

为实现支持通过入参对象集传入参数的方式,故在函数的起始部分需要有一个囊括在if(typeOf(v.’object’)){}中的入参处理逻辑(typeOf 为common中的一个自定义检测入参类型的公共方法)。遵循函数入参优先级原则,只当函数入参中没有所要入参时,才在入参集对象中去寻找对应的入参值。通常每个可能的入参都需要在此“注册”(处理)一次,原则上不改变函数使用者原本希望传入的入参值。

函数返回值:

通常函数用于封装页面交互逻辑行为并没必要返回任何值。但是对于初始化组件的函数,则需要将初始化的组件对象返回,这是pffp中默认的规则。

推荐阅读:《网易邮箱前端Javascript编码规范:基础规范

 

本文由 computerScience 博主 Will 投递于伯乐在线。也欢迎其他朋友投稿哦~

【如需转载,请标注并保留原文链接、译文链接和译者/作者等信息,谢谢合作!】

 

收藏 5 评论

相关文章

可能感兴趣的话题



直接登录
最新评论
  • 說:oh, what a lovely birthday gift.

    • 原文有别字校正更新,编者可重新加载文章内容。

      • 黄利民 站长 2012/06/10

        ① 请问你有新浪微博么? :) ② 哪些地方修改了呢? 谢谢

        • 恩,有点杂,几处(由于文章改自自己的说明文档草稿,加上系统输入法不智能,所以别字较多),简单的读一下便能发现。你可以重新从原文复制粘贴。
          这里,我尽量细致的说明下。
          1.第一句…… “对成与不对称美的”中的“对成”应该为"对称"。
          2.第一个代码示例后:“例 子中的函数代码是在pffpTools中定义的,当日它也属于pffp。”中"当日"改为"当然"。
          3.“Public Function for Page 简介”下面“(即在组件上将页面交互行为进行了统一的设计与分装,”中“分装”改为"封装"。
          4."pffp使用时的风格如同编写面向过程的程序一样,在面向页面组件对象的程序处理逻辑中,以过程的思考方式来生成页面元素。"
          改为"pffp使用时的风格如同编写面向过程的程序一样,在面向页面组件对象的程序处理逻辑中,以过程的思考方式来生成页面元素。"

        • 5.# 函数风格说明 #下面:
          “所有参数都可以直接在入参集对象中赋值,只有基础入参(必要或非必要,一定时对象的属性或行为变量,而非一些开关变量)才可以拥有函数第一入参后的某个入参位置。”改为“所有参数都可以直接在入参集对象中赋值,只有基础入参(必要或非必要,一定是对象的属性或行为变量,而非一些开关变量)才可以拥有函数第一入参后的某个入参位置。”
          6.# 函数风格说明 #最后:“通常每个可能的入参都需要在此“注册”(处理)一次,原则上不该便函数使用者原本希望传入的入参值。”改为“通常每个可能的入参都需要在此“注册”(处理)一次,原则上不改变函数使用者原本希望传入的入参值。”

跳到底部
返回顶部