一.本文目标与声明
本文可以说是笔者用phplib进行开发的经验与技巧总结。在开发期间,本人用phplib和自己写的一些核心函数库和 类,用很短时间就开发了很多高效而强大的程序工具,足以表明模块化面向对象编程的好处。
由于笔者使用phplib做开发的时间并不很长,而且程序本身很多高级的算法并没采用phplib,因此 phplib的很多核心高级功能也没有完全使用。水平有限,所以如果出现任何的错误疏漏,请各位不吝赐教。
本文的目标是期望读者可以在短时间内熟悉phplib的基本功能,并能够利 用它进行中小型程序,例如简单的新闻发布,数据查询,简单留言本和小论坛等。由于篇幅关系,phplib的一些高级应用本文并未提及,请各位原谅。
声明:凡是参考本文章后如果出现任何错误或者失误,本人并不提供任何技术支持。
凡是发现本文的任何错误,请给笔者发email或者oicq告诉,帮助笔者完善本文档。
凡是与标准的phplib有出入的地方,请大家以标准phplib的为依据。二.phplib的概述
现在互联网上流行着很多优秀的嵌入式的脚本语言,例如perl,php,asp,jsp等。其中最流行的一种就是 php,它以全部公开代码、开发容易、跨平台、功能强大以及支持数据库类型繁多等特点赢得了网上众多程序员的青睐。 而随着php的应用和推广,php的众多开发人员和很多爱好者在php的基础上开发了很多php的程序库,这些程 序库包括了大量的类、方法、变量和方法,能够处理复杂的web资源和提供强大的功能,大大简化了程序设计和提高了代码的可重用性。其中phplib就是这 些库中相当优秀的产品,它特别在数据库访问、数据库驱动以及访问认证和模板等方面具有很高的价值和实用性。用来开发大中型程序是相当适合的。 利用phplib可以非常轻易的开发出跨硬件、操作系统平台和数据库无关的 程序,其中很多优秀的程序都是采用了phplib来开发的。例如著名的phpslash就是一个例子。由于有了面向对象库和类的支持,数据库驱动都由类来 完成,因此写程序的时候基本上不需要考虑用的是什么数据库和如何驱动数据库,只需要懂得标准SQL语言就可以了。phpslash一旦安装好后就可以很好 的运行,提供优异的用户认证功能。即使在不支持session的php3下也可以很正常的使用session。并且它可以运行在nt或者unix平台下, 支持多达7种数据库而程序从一个平台或者系统转移到另外一个平台或者系统上的时候,程序行本身一个字也不需要改动。 有关phplib的详细信息和文档可以到http://phplib.netuse.de 查找。 |
三.phplib的基本功能介绍
phplib包含了很多功能,提供了众多的函数。然后根据笔者经验,觉得只要很好掌握其中的基本类和方法后,平时的工作 几乎都不需要那些额外的高级类就可以完成了。 1.将数据库驱动和对数据库操作完全分离,这样的好处是对数据库的操作你需要的知识仅仅是SQL语言而不需要去估计各 个不同数据库间的函数不同,如果需要将程序移植的话,那么phplib的优势非常明显。需要修改的仅仅是数据库驱动文件,而程序行几乎都不需要修改任何一 行。如果是采用具体数据库函数操作的程序(例如用MySQL函数编写),那么移植起来几乎是等于重新编写。区别一看就知道了。 2.支持Session,这个功能可以创建一个受保护的页面。它可以广泛的应用 到需要进行登陆或者依靠帐号和权限来判别的程序。例如论坛、虚拟社区、新闻发布、用户管理、电子商务等。而且这个和纯粹的cookie不同,采用了 base_64的编码和解码。因此一般并不容易破译。为了加强安全性,用户可以自己编写自己的编码方式取代它原来的编码方式。 同时phplib还将每一个会话都保存到数据库中,因此可以通过查询数据库值得 有多少用户在线上。 3.权限许可(Perm),这个功能可以定义一系列具有不同级别和权限的用户。不需要编 程人员额外地自己编写相应功能的代码就可以实现了分级管理和限制。同时可以利用phplib中page/admin目录中的管理程序创建用户和修改相关信 息。编程人员可以修改这些程序来服务自己的系统,节省了大量时间。 4.模板templete,和 FastTemplete类似的是,phplib也有自己的模板功能类和文件。让用户可以方便的创建和修改html模板,并且将php代码和html代码 分离。便于让程序员和美工良好的合作。phplib的模板采用了定义标记和语法分析、模式匹配等技术,从而实现了和FastTemplete类似的功能。 编程人员可以根据实际的需要对这个功能代码进行修改以满足自己需求。 5.购物车Cart,这个是个比较简易的 购物车,各种物品和项目可以存放到车中,也可以被取出来,通过一些改造后也可以将这个功能做成电子商务中流行的购物系统的。 6.Html部件,在phplib中还有一些称为"HTML Widgets"的东西,可以方便地生成窗口/表格等。具体可以参考phplib手册。这里不再赘述。 |
四.phplib基本安装和使用
要想使用phplib强大的功能,有几种途径可以达到目的。
1.采用phplib建议的安装方式,说安装,其实就是把phplib的类预先让解析器加载到内存,这样使用的时候就 不需要做任何设置,这样的好处显而易见。不过缺点也是很多的,如果程序按照这个方式直接引用phplib的函数的话,对于一些采用虚拟主机的用户来说,如 果ISP的服务器没有安装phplib的话,就不可以直接使用phplib了。所以这个方式的前提是:你的ISP支持phplib或者你有权限控制web 服务器,对于一般用户在自己机器上调试的话,这个方式比较好。
详细做法这里不再赘述,只简单说个过程而已:
a.下载phplib最新包,并解压好。
b.将里面的php目录的内容放 到一个安全的地方,例如/usr/local/phplib下
c.将这个目录的路径名添加到 php3.ini/php.ini的include关键字段后
include .:/usr/local/phplib
然后在找到auto_prepend_file关键字改成:
auto_prepend_file = prepend.php3
重新启动一次web服务器,用phpinfo()函数检查包含路径和自动预加载参数,如果显示的值和刚才设定的一样的话就证明成功了。
更加详细的安装/设定可以参考phplib的文档。
2.包含的方式。这个方式就是 比较麻烦,但是好处就是对于使用虚拟主机的用户来说,可以不需要ISP支持phplib就能享受phplib的功能。基本方法很简单,可以在使用到 phplib功能的程序最顶部加入相应的包含文件。不过要注意文件之间的相互依赖关系,下面是一个简单例子,它可以调用到基本的MySQL数据库驱动功能 和Session功能:
$LIBDIR = " /usr/local/phplib ";
require($LIBDIR . "db_mysql.inc");
require($LIBDIR . "ct_sql.inc");
require($LIBDIR . "session.inc");
require($LIBDIR . "local.inc");
require($LIBDIR . "page.inc");
五.如何使用phplib数据库驱动(一)
第一部份:数据库连接/查询
a.四步曲:
【ChinaByte 教程】1.要根据库中的DB_Sql来编写一个类,这个只需要在你的顶层包含文件中定义好就行了,同一个程序使用时不需要重定义,例子是:
class slashDB extends DB_Sql
{
var $classname="slashDB";
/**** Remember to change the below items to match your db *****/
var $Host = "localhost";
var $Database = "abc";
var $User = "abc";
var $Password = "abc";
function halt($msg){
printf("数据库出现错误!: %s \n", $msg);
printf("MySQL 错误!: %s (%s) \n", $this->Errno, $this->Error);
printf("请联系WebMaster并报告此出错信息得详细内容。\n ");
die("Session 挂起。");
}
}
其中slashDB的名字是任意的,根据编程者的喜好设定,不过都建议 用extends语句生成的类的名字 最好都有DB两个字。例如userDB,slashDB。并且$classname要和class slashDB extends DB_Sql中 slashDB一样!否则类定义出错。其他需要修改的仅仅是类的名字,$classname,$Host,$Database ,$User,$Password等需要修改。函数halt是错误提示。你可以自定义到一个页面。
2.使用编写好的类的时候,用new关键字 $abc = new slashDB; 其中$abc是个变量名,这代表你要使用slashDB类的功能。
3.查询数据库
一般有2个方法,短的查询直接将语句写到函数,长的就先用一个变量分别储存再查询。
a. 短语句:
$abc->query("SELECT * FROM user WHERE username='kk' AND passwd='kk' ");
注意的是这里是一个调用slash类中的 方法query,并且数据库查询语句不能漏了" ",否则出错。
b.长语句
$q = "SELECT username,passwd,email,nation,url,edulev";
$q .= ",seclev FROM user WHERE username='$username' ";
$q .= "AND aid='$aid' ORDER BY ID DESC";
$abc->query($q); //这里才执行查询
采用了短语句 合成长语句的方法。其中需要注意的是第一个$q是起始的语句,不能跟“.”号!
接着同名的$q就是需要和第一 个$q合成的变量,其实是同一个变量但是分别赋一个长语句的不同 部分。因为为了避免互相覆盖就用“.”号!!切记切记!
另外查询语句中该有空格的必须有空格,即使该行没有,下一行也必须有。例如$q .= ",seclev FROM user WHERE username='$username' ";句中最后有一个空格如果他没有,而接着的行开头没有的话,数据库查询会出错的。
4.取得结果
$abc->next_record();
这个是一个没有返回值的 语句,他只会让Record[];这个方法产生相应的查询 结果。如果没有这句话就不会产生相应的结果。next_record()是将当前指针向前移动并更新Record 、Error、Row、Errno的函数。因此不运行他一定不能够产生你需要的结果。
$temail = $abc->Record["email"];
$turl = $abc->Record["url"];
这几句 就是将查询后的结果赋值给指定的变量。
注意:一般如果返回的row超过一行,你就要用习惯方法: while($abc->next_record()) { php代码 } 来进行处理了。这个方法就是便历了所有查询到的结果。
六.如何使用phplib数据库驱动(二)
第二部份:数据库插入/删除 b. 插入/两步曲: 【ChinaByte 教程】1.创建一个调用类的变量 2.进行数据库查询操作(实际上无论是SELECT还是INSERT等语句都是调用query方法和MySQL交互的) 注意这里其实INSERT语句有很多写法,其中最多用的就是以下几种: (1).直接赋值:INSERT INTO 表名字 VALUES (值列表,用''号包含,用,号分隔); 例子: (2).指定插入字段:INSERT INTO 表名字 (指定字段名字列表) VALUES (对应字段值); 例子: 两者差别在于第一种必须给所有字段赋值,无论是空还是非空都要赋值,如果数据表 有很多字段 而你开始只需要插入很少几个字段,那么就会浪费很多人力了。第一种适合于字段少的情况。第二种就是为了处理第一种的缺陷的。但是不适合于数据表字段少的情 况。 删除/两步曲: 1.创建一个调用类 的变量 2.查询操作 一般这是删除某一条特定记录。如果要删除全 部内容更加容易。只需要DELETE FROM 数据库表名字可以了。 c.数据库内容更新 更新/两步曲: 1.创建一个调用类的变量 2.查询操作 这里UPAATE就没有什么 特殊的格式,基本上都是UPDATE 数据库表 SET 字段名='字段值' 判断条件(WHERE语句)。这个加入了WHERE语句是为了更新某一条特定的记录。 |
七.如何使用phplib的Session功能
基本的Session使用方法 【ChinaByte 教程】以下就是一个以用户登陆和注销为例子的Session使用例子,通过它你就会明白如何使用session以及Session是如何起作用的。你也会 体会到使用了Phplib/Zsulib的好处和带来的便利。 a.建立一个Session的类 注意:其中slashSess这个名字可随便修改的,但是和定义 DB_Sql的extends一样要保证和$classname名字一样就可以了。其中这个定义了类slashSess的式子中,$magic的字串建议 使用随机函数产生独立的字串以避免重复。以下我给出一个小函数,以生成一个指定字长的独立随机串:
b.使用Session功能 本 部分配合例子Login.php来说明如何运用Phplib/Zsulib中session.inc文件中相关函数/类,这里分几个部分: 利用page_open函数打开一个类对应方法的数组; 1.初始化页面 这里需要用到两个类slashDB和slashSess;其中这两个类都在前面文档中提到。这两个类假定存放在config.php 文件里。因此首先必须包含这个文件以便可以调用这两个类。 2.page_open调用Session开始 注 意:尽量不要在page_open前require一些会产生html代码或者进行输出html代码的操作。否则会出现提示说已经发送了Header信息 而不能再次发送的错误。 3.如果$op=login,进行登陆操作并注册信息: 4.如果$op=logout,进行注销信息操作 5.结束本程序 在结束前必须调 用page_close();这样就完成了一个完整的Session会话。 如果已经执行了logout操作就不要执行了。所以完整语句是: 结束: 一定要注意程序编写顺序,否则会产生逻辑错误。本例子就是一个最简单的用户登陆的模型所有采用Phplib的用户管理模式都和这个差不多。 |
八.使用phplib编程具体例子
1.一些声明
关于本例子,本例子原来是为本协会(中山大学GNU/Linux协会)内部会员编写的,因此从比较长远的角度考虑 来编写,考虑比较多的是代码编写规范和习惯与算法。考虑到这些因素对编程也是很重要的,因此相关的章节与内容我并没有删除,如果读者觉得这部分没必要的话 请email通知笔者,谢谢。
2.代码的编写风格
这里讲的 不是如何写注释或者是如何写版权信息,而是提出若干比较有代表性和比较优美的编程习惯(这里称做风格)。一般来说,php和perl等web脚本程序,都 不可避免地和html等扯上关系。而相当多的程序员并没有很好地注意自己的php/perl代码和html代码的关系,造成了程序行艰涩难懂,结构混乱最 后连自己都懒得看的结局。
本人从开发ZSU-Slash-Pro的这一个月里发现,优秀的程序不仅仅有优 秀的算法,还有优美而易懂的程序结构。尤其对于大型程序来说,如果代码含糊,结构混乱的话,即使是程序开发者本人,看起代码也会觉得格外费力,其他人看起 来就更加辛苦了。
因此很有必要摸索并制订出一套合适的编写代码的规范,用这套规范来约束和统 一程序开发人员开发的代码风格。使之易于阅读和修改,方便日后维护和进一步开发的人员,使调试程序简单化成为可能。
这里,我主要参考了PHPSlash和phplib和FreeTrade等几个中大型程序,结合自己的一点小经验,总结出了以下几点:
(1).通用内容做成包含文件
这个方法是将每个生成的页面都会包含的通用内 容做成包含文件,这样减少了程序的长度。便于统一修改例如phpslash中它每个页面都要使用一个统一的Header/Footer,因此只需要创建两 个包含文件slashhead.inc和slashfoot.inc文件,然后在每个php程序中使用require语句包含它们进入代码内部就可以了。
注意:并不是只规定使用header和footer,如果你愿意,你可以添 加任意多个require的部分。
(2).公共函数库
对于那 些经常使用的函数和变量,没必要在每个程序内都定义和声明,而只需要将它们放到一个公共的函数/配置文件内就行了。
例如PHPSlash中有几十个函数,这些函数都统一地存放到functions.inc中,并被包含在了配置文件config.php3 中。这样所有页面调用到里面的函数时候就不需要定义而只需要直接调用就可以了。
(3).html代码生成函数(库)
对于一些经常需要编写的html代码,可以用一个专门的函数生成这些html代码。
例如一个显示登陆的 对话框,你就可以将这个对话框的内容编写一个函数叫dsp_login()。这样每次你需要显示的时候只需要直接调用这个函数就可以了。同样道理,你可以 将生成页面的头部和尾部都做成一个函数,例如叫put_header()和put_footer()等。这样就很轻松地将html代码和php代码分离 了。
(4).封装过程
尽量隐藏具体操作的过程,取代的是面 向对象的类或者某个操作函数。这样的好处就是将过程封装起来,使主程序简洁明快、层次清楚。
例如某个注册 程序,它需要完成显示注册窗口、检索用户、显示出错、插入用户、发送电子邮件等5个功能。如果把这5个功能都全部用一般的过程设计的话,代码相对难懂。如 果换成5个操作函数(或者说把具体分析操作过程封装起来的话)那么就非常简洁而易懂。
以下是程序主体:
dsp_reg();
check_user();
if ($return=="true")
{
insert_user();
mail_user();
}
else dsp_error();
可见这样的程序即使是初学者都很 容易看懂。
(5).功能分块化
尽量将程序需要执行的功能分 化成对应的操作/动作,也就是分块化,好处是易于程序调试,条理清楚。
一个最好的例子就是 PHPSlash的admin.php3。它将所有的功能都归纳成了一个op值。 例如要删除一个用户-->$op="userdelete"。其实它这里还有一个小技巧:就是不是直接调用某个op而是在表单发送的时候发的是另外 一个值user_ops,这个值有几个可能:删除/添加/更新。那么它在程序内有一个判断阵列,判断出这个user_ops应该对应什么op,因此方便设 计程序。这里假设一个发布新闻的简单系统,所需要的功能就是发布新闻,删除新闻,更新新闻。
那么归纳成以下3个op:post/delete/update,以下是结 构流程(用swich语句):
swich($op) {
case "post":
postnews();
break;
case "delete":
delete();
break;
case "update":
update();
break;
default:
dsp_news();
}
由以上几点可以看出,如果是能够按照上面提到的几点设计程序的话, 那么你设计的就会是个结构良好,代码优美易懂的好程序。不过,这还必须取决于良好的程序设计构思。以下给出一个注册程序的例子,它体现了本文和本编程规范 提到的大部分内容。整个程序从设计到完工的时间仅仅用了5个小时。
虽然并不快,但是基本上是一写好就运转 正常,没有什么逻辑错误,结构也比较清楚。
接下来读者将看到如何利用以上技巧和原则编写一个具体的程 序。九.使用phplib编程具体例子(二)
3.具体程序设计
(1).功能要求:
这里需要做的是一个注册程序,它的功能要求是:能够 自动注册一个合法用户,并且将自动为用户生成一个8位的密码并发送到用户的邮箱。其中标识用户的是唯一的用户名字和唯一且真实的电子邮箱。
申请的流程是:先输入用户想注册的用户名字和他的真实电子邮箱。
------> 然后系统查询这个用户的名字和邮箱是否存在于数据库中
------> 如果其中一者存在,则显示错误并返回重新输入
------> 如果两者都在系统数据库中没有记录,说明用户可以注册,显示欢迎画面
------> 显示确认画面并注册用户信息
------> 自动生成密码并发送到用户邮箱。
(2).程序流 程:
基本上都和申请流程类似。根据每个功能的不同设计不同的函数进行操作:
a.显示查询页面
dsp_query();//空白模式
输入查询数据,下一步
b.执行查询函数query();
如果成功,则下一步
如果不成功则显示错误并返回
c.显示确认页面
confirm_reg();
dsp_reg();//保存模式 发送表单
d.插入用户
reg();
加入判断:是否多次刷新页面,如果是就不显示“恭喜”字样。
insert();
mail_user();
success();
(3).功能函数:
这里动用到10个函数。各个函数的功能如下:
dsp_query();//显示查询画面和确认画面 并自动根据不同画面选择不同op
查询: op=check 确认: op=insert
query();//查询函数,查询输入的用户和邮箱是否存在
confirm_reg();//确认要注册的函数
reg();插入用户的主函数,完成主要的动作
make_passwd();//生成8位随机密码
insert();//插入用户信息的函数
mail_user();发送注册信息和用户密码到用户信箱的函数
success();//注册成功函数,显示成功信息
error_msg();//拥有各种模式的错误提示函数
current_time();//提示当前系统时间的函数
(4).页面 结构:
采用了header和footer包含的技术。并且所有和数据库连接的类和配置都定义在 config.php3中并且使用Zsulib。其中调用到Zsulib中的面向对象的数据库连接技术。
主体结构是:
Header.inc
register.php3 -------> require "config.php3";
Footer.inc
十.使用phplib编程具体例子(三)
(5).开始具体编写
编写Header.inc,Footer.inc(略)
编写具体函数和相关接口
(6).解决关键的技术问题
a.如何编写query()呢?
这个函数需要的功能就是查询发送过来的用户名和邮箱 是否已经给注册,如果其中之一或者全部都给注册了后就返回错误信息,否则进入confim_reg()函数。
设 计思路:先向数据库查询发送过来的$username和$email看是否返回空值。然后判断两个字段的查询值是否==""。这就完成了基本的查询功能 了。
以下是query();的完整代码:
function query($username,$email)
{
$sl_q = new userDB;
$sl_q->query("SELECT username,email FROM user WHERE username='$username' or email='$email'");
$sl_q->next_record(); $tusername = $sl_q->Record["username"];
$temail = $sl_q->Record["email"];
if ($username==$tusername && $tusername!="") error_msg("user_exist");
elseif ($email==$temail && $temail!="") error_msg("mail_exist");
elseif ($tusername=="" && $tmail=="" && $username!="" && $email!="")
confirm_reg($username,$email);
else error_msg("unknown");
}
b.如何编写make_passwd()呢?
此函数负责生成随机的8位密码。 设计思路:可以利用unix系统的random守护进程产生的随机因子,也可以利用php的随机函数rand同时为了获得指定的8为密码必须采用一个能够 从字符串中切取到给定长度字符串的函数。这里我们采用substr。
以下是make_passwd();基本 代码
function make_passwd()
{
$ran = rand();
$passwd = substr($ran,0,8);
return $passwd;
}
c.如何编写confim_reg()?
要达到能够提示你确认这个功能并不容易。因为必须两次调用dsp_query()而两次dsp_query()却需要完成不同的功能。因此 必须让confim_reg()传送若干参数给dsp_query()让它知道应该如何操作。
设计思路:让 confim_reg()传一个$msg给dsp_query(),让它知道这是确认的信息以转换功能。
以下 是confim_reg()完整代码:
function confirm_reg($un,$em)
{$time = current_time();
$msg ="<center>恭喜你!在<font color=red>$time</font>这一刻你的用户名和邮箱还没有给注册!<br>
如果你确实想成为本站会员,请按<font color=red><b>注册</b></font>按钮。
<p></center>";
dsp_query($un,$em,"我要注册","$msg");
}
d.如何编写dsp_query()呢?
该函数功能稍微要复杂点,就是需要根据$msg来决定它自己要实现什么任务。
设计思路:由于 查询和确认注册两者是不同的,因此查询按钮应该自动换成注册按钮。这个利用参数$botton实现。判断到底是处于查询还是确认,可以利用$msg是否空 来判断(因为确认函数会发一个$msg过来)。另外要区分两者的话,必须在发标单的时候自动选择$op=?因此也可以通过$msg是否空来给$op赋值。 查询是:check,确认是insert。
以下是dsp_query()的基本代码:
function dsp_query($un,$em,$botton,$msg)
{
$head = "<tr>";
if ($botton == "" ) $botton="查询";
if ($msg !="") $action="insert";//如果有确认信息就insert
else $action="check";//否则就只是一般查询
$cation = "欢迎到本站注册。一旦帐号生效你就可以享受到本站提供给会员第一流的服务";
$post ="<td align=left width=40%><form method=\"POST\" action=\"$PHP_SELF\">
<input type=\"hidden\" name=op value=$action>
<p>用户名:<input type=text name=\"un\" size=20 value=$un></p>
<p>信箱名:<p><input type=text name=\"em\" size=20 value=$em></p>
<p> <input type=submit value=\"$botton\" name=submit>
<input type=reset value=\"复原\"></p>
</form></td>";
$foot = "</tr>";
if ($msg =="") fancybox("100%","查询",$head.$post."
<td width=60%>". $cation ."</td>".$foot,"r");
else {
fancybox("100%","确认",$head.$post."<td width=60%>".$msg."</td>".$foot,"r");
}
}
e.最后的判断语句:
判 断程序的操作流程和函数调用。这里仅仅给出代码(非常简单的代码):
switch ($op) {
case "check":
query($un,$em);
break;
case "insert":
reg($un,$em);
case "null":
break;
default:
dsp_query();
}