一种PHP设计模式：DPT.doc

一、DPT介绍PHP为什么在主流的应用中总是那么不出色，总是不如.Net/Java，就是因为在PHP处理大型应用的时候，那些不完整的面向对象机制、数据库处理的单一，不通用性等等，影响了PHP做大型应用。那么，如何来改变这个状况呢？当然就是需要引进一些新的设计方法，把PHP中不健全的面向对象机制完整起来，进行更好的PHP大中型应用的开发。从Java过来的MVC模式非常流行，而且已经有部分已经引伸进了PHP领域，设计模式的引进，就是为了更好的控制项目开发。今天我要说一种设计模式，类似于MVC，它叫DPT模式。其实有时候我也觉得有点象Java里面的DAO(Data Access Object)，不过DAO是夹在业务逻辑层和数据库资源层之间的，而DPT更多的是把业务逻辑也封装在类里，和DAO层在相同的内容中。D Data，数据收集层P Php，PHP数据调用层T Template，模板层首先，我们要对它进行简单的了解。Data，就是我们的数据层，它不是数据库抽象类，而是通过数据库接口，执行一些SQL，把数据获取的过程，一般把这种操作封装在类里面，就形成了我们的数据收集层。Php，就是对我们收集的数据进行整理，规划，同时解析模板进行数据的显示。Template，模板层，就是我们的HTML页，里面不包含任何PHP代码，只有模板标签的内容，通过它来控制数据在页面中有格式的显示。我们这里三层中，每一层都是鼓励由一个人来开发，然后通过PHPDoc之类的工具，把源代码中的API生成文档，由P层的人进行调用。那么，在实际的项目开发中，它是怎么运作的呢，我们又如何把这种设计模式引进我们的项目中呢？我们下面将运用一个实际的项目来讲解DPT模式。阅读一下内容必须具备基本的PHP4的面向对象编程、数据库抽象类、模板等知识。我们目前为了加速PHP的开发，都使用PHP封装了部分功能，比如数据库操作抽象类，模板类等等，这些都是为了开发复杂应用而应运而生的。目前比较主流的数据库抽象类有phplib db、PEAR:DB、ADODB等等，模板处理类有phplib template、smartTemplate、Smarty等等。本文中都是使用PHP Group推荐的产品，数据口抽象类使用PEAR:DB，模板处理类使用Smarty，如果对这两个类库不熟悉的读者，请参考文章后面的链接。二、项目体系结构下面我们来构建我们基于DPT模式的PHP应用。（以下部分内容参考MVC模式、类封装还是黑客代码）文件目录结构（只涉及到关键的目录）class 类库，包含所有的数据收集层template 模板文件存放目录include 常用库，包括PEAR、Smarty等类库，同时还有自己定义的基本函数config.inc.php 基本配置文件，包括数据库配置，其他基本信息配置security.inc.php 安全处理页，主要多传递的变量进行处理init.inc.phperror.php 错误处理页 class目录中存放了我们数据收集层中的内容，一般的建议是每个类文件只是针对一个表进行操作，比如cmsMessage.class.php，那么这个类就是属于功能CMS里面的，只负责操作Message这个表。所有的数据库交互和操作都是封装在类里的，在P层不允许出现任何直接操作数据库的语句。template目录中存放了我们的网页模板，模板中都是使用Smarty标签进行排列的，同时，在模板中，都是建议使用JSCSS来控制页面，模板中只有DIV标签来简单的排版，这样，非常利于网站改版和更换皮肤。include目录就是对常用文件的包含，比如PEAR:DB类、Smarty类库文件等。config.inc.php就是基本的配置文件，包括数据库、基本常量等等，security.inc.php是安全处理页，我们这里主要是做一个变量的安全检查，下面内容我们将仔细介绍。init.inc.php是一个初始化操作的页面，包括初始化数据库链接，实例化模板处理类等等操作，error.php是错误信息处理页，所有的错误信息通过URL编码后转到该页。三、项目基本配置代码关键页代码实例：/* * config.inc.php * 配置文件*/* 数据库配置 */define(DB_HOST, localhost); /数据库主机define(DB_USER, root); /数据库链接用户define(DB_PASS, ); /连接密码define(DB_NAME, cms); /默认数据库define(DB_PORT, 3306); /数据库端口define(DB_TYPE, mysql); /数据库类型define(DB_OPT, 1); /是否长期链接/* 模板信息配置 */define(TPL_TEMPLATE_DIR, ./template/); /模板目录define(TPL_COMPILE_DIR, ./template/templates_c/); /模板编译目录define(TPL_CONFIGS_DIR, ./template/configs/); /模板配置文件目录define(TPL_CACHE_DIR, ./template/cache/); /模板缓存目录define(TPL_LIFTTIME, 1); /缓存时间define(TPL_CACHEING, true); /是否缓存define(TPL_LEFT_DELIMITER, ); /左边界符define(TPL_RIGHT_DELIMITER, ); /右边界符/* 网站路径配置 */define(ROOT_PATH, dirname(_FILE_); /网站所在根目录define(URL_PATH, dirname($_SERVERPHP_SELF); /网站URL地址路径define(DB_PATH, ROOT_PATH./include/db); /PEAR:DB目录define(TPL_PATH, ROOT_PATH./include/smarty); /Smarty目录/* security.inc.php * 安全过滤文件*/* 过滤规则 */$arr_filtrate = array(, , );/* 过滤函数 */function var_filtrate($var) global $arr_filtrate; foreach ($arr_filtrate as $value) if (eregi($var, $value) return true; return false; /* 获取不同版本下的GET和POST数组 */if (phpversion() 4.1.0) $get = &$HTTP_GET_VARS; $post = &$HTTP_POST_VARS; else $get = &$_GET; $post = &$_POST;/* 检查GET变量 */if (count($get) foreach ($post as $get_var) if (var_filtrate($get_var) exit(Commit get parameter falsity); /* 检查POST变量 */if (count($post) foreach ($post as $post_var) if (var_filtrate($post_var) exit(Commit post parameter falsity); 其实，以上过滤的方法也不是最好的，建议参考我的另两篇防注入文章获取更好的方法，链接参考附录。/* error.php* 错误处理页面*/if (!isset($getmsg) exit(Not commit parameter);echo Error Message: . $getmsg;echo 返回上一页;就是一些错误处理的作用，一般出的GET方式传递过来的消息都是经过urlencode()过的字符。/* * init.inc.php* 初始化程序*/require_once(dirname(_FILE_).config.inc.php);require_once(ROOT_PATH.security.inc.php);require_once(DB_PATH.DB.php);require_once(TPL_PATH.Smarty.class.php);/* 初始化数据库链接 */$db = DB:connect(DB_TYPE:/DB_USERDB_PASS:DB_HOST/DB_NAME, DB_OPT);if (DB:isErro($db) return $dg-getMessage();$tpl = &new Smarty();/* 初始化模板 */$tpl-templates_dir = TPL_TEMPLATE_DIR;$tpl-compile_dir = TPL_COMPILE_DIR;$tpl-cache_dir = TPL_CACHE_DIR;$tpl-configs = TPL_CONFIGS_DIR;$tpl-lifetime = TPL_LIFTTIME;$tpl-caching = TPL_CACHEING;$tpl-left_delimiter = TPL_LEFT_DELIMITER;$tpl-right_delimiter = TPL_RIGHT_DELIMITER;基本文件描述完毕。代码写了不少，只是为了更好的理解这个模式。四、框架实际开发说明：我们以下项目代码都是以cms数据库中topic表做例子，代码只是为了演示框架结构，没有对代码进行测试，不保证能够正常运行。topic的表结构：CREATE TABLE topic ( id int(11) NOT NULL auto_increment, title varchar(255) NOT NULL default , addtime int(11) default NULL, author varchar(50) default NULL, type int(11) default NULL, option int(11) default NULL, PRIMARY KEY (id), KEY id (id);（一）Data层：数据采集层Data层主要就是针对数据库的所有操作都封装起来，然后通过接口的形式提供给Php层进行调用，同时在Data层里也封装了一些原始的数据库操作（类似于Java中的DAO）。一般Data层都是类的形式，保存在我们上面的 /class目录下，一般的准则是一个类文件操作一个数据表，就是说不管具体的业务逻辑如何，所有的数据表操作都是封装在一个类文件里的。比如说我们有一个数据表叫做topic，那么我们对应操作的类文件就是：topic.class.php。其实这里是可以做扩展的，比如说，我们的项目非常庞大，有很多内容，比如包括有CMS、Blog、BBS等等，那么我们就必须给每一个栏目分配一个数据库，那么针对当前操作数据库的话，就使用类中封装的链接方法进行链接，就可以抛弃我们上面init.inc.php中初始化的操作，而操作在类里面进行的链接。假设我们目前操作的栏目是CMS系统，数据库名叫做cms，那么我们下面构造一个操作cms数据库里面的topic表的类来。/* cms_topic.class.php* 文章处理类*/class cmsTopicvar cmsDBName; /数据库名var cTableName; /当前操作的表名var cDsn; /数据链接源var cDebug; /是否打开调试,1为是，0为否var cDbPointer /链接资源var cfetchMode /获取数据库资料的方式var cEncode /数据库中数据保存的编码格式，默认是UTF-8/* 构造函数 */function cmsTopic() /配置信息从config.inc.php中设置 $this-cfetchMode = DB_FETCHMODE_DEFAULT; $this-cTableName = topic; $this-cDsn = mysql:/. DB_USER.:. DB_PASS. DB_HOST./. DB_NAME; $this-cEncode = utf8;/* 链接数据库 */function connectDatabase() if (!is_object($cDbPointer) $this-cDbPointer = DB:connect($this-cDsn); if ($this-cEncode=utf8) $this-cDbPointer-query(set names utf8); $this-cDbPointer-setFetchMode($this-cfetchMode); if (DB:isError($this-cDbPointer) return false; return $this-cDbPointer; /* 关闭数据库连接 */function closeDatabase() if (is_object($this-cDbPointer) $this-cDbPointer-disconnect(); /*- 数据库基本操作 -*/* 插入操作 */function insert($arr) if(!is_array($arr) | count($arr) = 0) return false; if( = $this-cTableName) return false; $db = $this-connectDatabase(); $res = $db-autoExecute($this-cTableName,$arr,DB_AUTOQUERY_INSERT); if(DB:isError($res) return $res; else $insertId = ($db-getOne(select LAST_INSERT_ID();); if($insertId0) return $insertId; else return true; /* 更新操作 */function update($id,$arr) if( != $id & !(is_array($arr) return false; $db = $this-connectDatabase(); $res = $db-autoExecute($this-cTableName,$arr,DB_AUTOQUERY_UPDATE,id = $id); if(DB:isError($res) return false; else return true; /* 删除操作 */function delete($id) $db = $this-connectDatabase(); $res = $db-query(DELETE FROM .$this-cTableName. WHERE id = $id); if(DB:isError($res) return false; else return true; 上面的代码一个很基本的针对一个表操作的类雏形已经描述出来了，包括连接数据库，基本的数据库原始操作都有了。你肯定会问，为什么没有把select的操作封装进去？主要是因为select是SQL里最复杂的操作，不可能写那么通用的一个方法去操作它，所以好不如不写，自由发挥。那么我们需要加上一些基本的功能呢？比如读取内容、新增加一篇文章等操作，那么我们还必须在类里面添加一些方法，比如我们增加提取一篇文章内容、提取指定时间的文章、提取指定类别的文章、统计目前所有文章的总数等操作。/* cms_topic.class.php* 文章类增强*/class cmsTopic/ .上面已经描述的方法省略/* * 函数: getTopicContentById() * 功能: 获取指定ID的文章的内容 * 参数: $id 指定要获取的ID * $cols 要提取的字段值 * 返回: 成功返回数据集数组，失败返回错误信息 */function getTopicContentById($id, $cols=*) $db = $this-connectDatabase($this-cDsn); $sql = SELECT $cols FROM . $this-cTableName . WHERE id = $id; $result = $db-getAll($sql); if (DB:isError($result) return $result-getMessage(); else $db-disconnect(); return $result; /* * 函数: getTopicBySpecifyTime() * 功能: 获取指定时间的文章的列表 * 参数: $startTime 指定开始时间 * $endTime 结束时间 * $cols 要提取的字段值 * 返回: 成功返回数据集数组，失败返回错误信息 */function getTopicBySpecifyTime($startTime=0, $endTime=0, $cols=*) $db = $this-connectDatabase($this-cDsn); $start = ($startTime = 0) ? : WHERE addtime $startTime; $end = ($endTime = 0) ? : AND addtime cTableName . .$start . .$end; $result = $db-getAll($sql); if (DB:isError($result) return $result-getMessage(); else $db-disconnect(); return $result; /* * 函数: getTopicByType() * 功能: 获取指定类别的文章的列表 * 参数: $type 指定的类型 * $cols 要提取的字段值 * 返回: 成功返回数据集数组，失败返回错误信息 */function getTopicByType($type, $cols=*) $db = $this-connectDatabase($this-cDsn); $sql = SELECT $cols FROM . $this-cTableName . WHERE type = $type; $result = $db-getAll($sql); if (DB:isError($result) return $result-getMessage(); else $db-disconnect(); return $result; /* * 函数: getTopicSum() * 功能: 获取所有文章总数，如果指定类别，则获取指定类别总数 * 参数: $type 指定的类型 * 返回: 成功返回获取的总数，失败返回错误信息*/function getTopicSum($type=) $db = $this-connectDatabase($this-cDsn); $typeStr = ($type = ) ? : WHERE type = $type; $sql = SELECT count(id) FROM . $this-cTableName . .$typeStr; $result = $db-getOne($sql); if (DB:isError($result) return $result-getMessage(); else $db-disconnect(); return $result; 上面我们构造了一些数据提取类，这应该就是我们Data层的核心了。写方法的时候要尽量考虑到扩展性，比如对列的提取，比如一个方法适合多种情况，比如排序等等，考虑的越多，以后维护起来就比较容易，当然，我推荐的方法是一个方法尽量就做一件事情，如果一个函数要做多个事情，那么就写成多个函数，这样便于代码重用和维护性，我个人认为一个方法最用不要超过100行。如果函数中有涉及到数据库的操作，一定记得结尾的时候把数据关闭掉，不然很容易把服务器资源占用光。当然，你也可以在PHP层去关闭连接。比如，你需要很多次调用同一个方法，那么这个方法如果反复的连接数据库又关闭数据库，也很浪费资源，而且速度慢，这个时候就可以把关闭数据库的操作在Php层进行关闭，你可以先构造好一个方法来进行，比如我们上面的 closeDatabase() 方法。（二）Php层：数据调用层PHP层主要就是把从Data层收集的数据再这一层进行调用。因为我们基本的原则就是把所有跟数据库的操作都封装在Data层里，在其他层都不涉及到任何的直接对数据库的操作，这样能够进行良好的封装，这样有点类似于 JSP和Javabean，Javabean的类负责和数据库交互，JSP负责调用Javabean来输出数据。我们这里的PHP层就相当于JSP层，前面的Data层就相当于Javabean层，这样玻璃他们之间的耦合度，能够方便程序日后的维护。我们这里的PHP层主要就是复杂从数据库种提取数据，完成一些简单的逻辑，然后把数据输出到Template（模板层）。现在我们利用示例代码来看看PHP层是如何调用Data层的数据的。/* topic_list.php* 文章列表程序*/* 包含基本文件 */require_once(init.inc.php);require_once(class/cms_topic.class.php);/实例化Data层对象$topic = new cmsTopic();/获取文章类型变量$topicType = intval(get(type);/从Data层中把数据提取过来$topicList = getTopicByType($topicType);/给模板变量赋值后输出页$tpl-assign(topic, $topicList);$tpl-assign(topic.html);代码是不是很简单？就是把数据获取过来，然后解析到模板层中去处理，所以这样如果以后出现问题改起来比较容易，比如是数据获取的问题，那么直接改上面的类文件就行，如果是模板显示的问题，那么直接修改模板层中的对应的模板页就可以，非常便于维护。（三）Template层：模板层这个模板层就是我们常说的网页了，不过这里就是包含了一些Smarty的模板变量和HTML混和，模板页处理的时候就对页面中的模板变量进行替换，最后我们看到的结果就是模板页和PHP层中的程序输出混和的结果。一般模板页设计的时候，最好遵循Web标准，就是说尽量在页面中不使用表格等html标签来控制页面，而是使用div层来存放数据，使用css样式表来控制页面布局，这样对包括JavaScript脚本的编写，以后页面的改版等等非常有好处。而且如果要还模板也很简单，只需要把css文件替换就可以达到效果。当然，如果对web标准不了解，那么建议去阅读一下网站重构这本书。我们下面就简单的描述一下Template（模板层）的代码是如何的。* 加载头部文件 *include file=header.html* 模板主体 * 左边导航条 *文章列表section name=topicList loop=$topic 标题：$topictopicList.title|escape:html|truncate:30:.:true | 时间：$topictopicList.addtime|date_format:%Y年%m月%d日 | 作者：$topictopicList.author|escape:htmlsectionelse 暂时没有任何文章/section* 加载底部文件 *include file=foot.html模板页中大致可能有一些JavaScript程序，或者有样式文件，一般使用样式文件来控制页面的布局和显示效果。我们这里没有详细的描述，在实际项目中可以由网页制作人员去负责。五、使用DPT模式的项目规划一般在所有的软件项目或者是网站项目中，要保证一个项目能够顺利完整的完成，那么便需要技术主管或者架构师良好的设计和管理。一般所有项目中人是最难控制的因素，你可以把项目指定的非常完善，架构可以选择的非常合理，但是你不能控制人的因素，不能保证项目的中的某个成员可能在任何时候离开项目。当在PHP项目中，如果一个项目角色忽然的离去，可能导致项目要停顿，要重新找人来接替，影响了项目的进度，那么如何有效的控制和解决这些问题。在一个使用DPT设计模式的项目中，项目中个个角色分别有网页设计师、网页制作人员、客户端脚本JavaScript程序员、服务器端PHP程序员。他们的分工都是什么呢？网页设计师负责设计网页的界面，生成效果图，然后由网页制作人员去做成网页，当然，如果是遵循Web标准的项目的话，那么网页制作人员主要的任务就是负责页面布局样式的编写。客户端程序员主要是负责客户端脚本的编写，比如针对页面中需要使用的JavaScript进行编写，PHP程序员主要是负责我们上面Data & PHP & Template 三层的代码编写，当然，如果项目足够庞大，完全可以拆分出来，有PHP程序员负责Data层，有PHP程序员负责Php和Template层，分工清晰，Php层程序员只是需要调用Data层程序员已经写好的类库进行调用，不用关心类是如何实现的。这样一个项目架构下来，可以按照任务需要来安排某个模块的人的数量，最大限度的把项目规划好。当然，项目中一些必要的因素是要考虑的，比如，如何让网页制作人员、客户端脚本程序员和PHP程序员良好的合作，那么就是分离他们的责任，比如，模板页必须由PHP程序员来编写，然后提交给JavaScript程序员制作客户端脚本，最后再由网页制作人员通过CSS来控制布局，那么Php程序员在模板页中就必须使用div等标签来定义一个块的数据，如果任何一块出了问题，那么对应找相应责任人，就能够很好的避免彼此推卸责任，或者权责不分的情况，这样有利于管理，也有利于每个开发成员之间的良好合作。为了防止项目失控，或者不会因为项目成员的离开而影响项目的进度和管理，必须有相应的方法和规则。我们主要针对PHP程序员来进行描述，部分方法同样适用于网页制作人员和客户端脚本程序员。（1）编码规范项目开发中为了便于维护和以后其他人接手代码，必须统一编码规范，包括对目录、文件名、类、函数、变量、注释等等都必须遵循标准，而且为了代码的维护，必须要求PHP程序员编写注释。目前基本遵循的是Fredrik Kristiansen写的PHP 编码规范，或者是PEAR中代码的规范。如果代码为了做成接口，或者需要做成参考的文档方便以后维护代码，使用phpDoc等工具，那么为了能够使用PEAR包中的phpDoc能够正常识别，所以一般建议遵循PEAR包的规范，主要是DPT模式中Data层中类的的编码必须规范。PEAR中pear.php中基类的部分代码：class PEAR /* 属性的描述 */ / properties /* * Whether to enable internal debug messages. * * var bool * access private */ var $_debug = false; /其他属性省略. / /* 对方法的描述 */ / constructor /* * Constructor. Registers this object in * $_PEAR_destructor_object_list for destructor emulation if a * destructor object exists. * * param string $error_class (optional) which class to use for * error objects, defaults to PEAR_Error. * access public