ShopNC学习笔记.doc

ShopNC学习笔记一、 目录结构：1代码0012代码0012二、 核心文件及常量介绍：31) 主要类文件及简要说明42) 系统函数53) 系统常量参考5三、 表单数据验证：7四、 缓存设计9五、 二次开发代码规范的建议11六、 图片处理12七、 二次开发之地区开发141、 目录结构：/根目录/admin后台目录（目录名可更改）/apiAPI文件目录，存放ucenter、PHPWind、QQ互联、新浪微博、支付方式（支付宝，财付通、预存款等）和商品等API文件/cache缓存文件目录/control控制器目录（C）/data常用公共数据（地区、发言表情等）/framework核心框架目录/install安装程序目录/language语言包目录/model模型文件目录（M）/resource资源目录（字体、JS文件、HTML编辑器、验证码用字体图片、二维码依赖文件等）/templates模板文件目录，视图文件（V）/templdate/default默认的模板风格/upload附件目录（商品图、店铺认证、会员头像、促销活动图等上传的所有图片）ShopNC商城系统采用MVC模式，控制器文件位于control目录,模型文件位于model目录,视图文件位于templates目录，系统框架依据act和op参数（GET/POST过来的）完成控制器调度。控制器类文件名一般为业务名称，类名称一般为“业务名称+Control”，例如品牌控制器（control/brand.php）类名为brandControl。模型类文件名一般为“表名称+.model”,类名称“表名+Model”，例如广告模型（model/adv.mode.php）类名称为advModel。跟据商城业务需要，系统内置三个控制器父级类，BaseHomeControl、BaseMemberControl和BaseMemberStoreControl分别适用于前台展示、会员中心、店铺中心三类控制器。代码001控制器：Language:read(home_brand_index); /使用模型获得品牌列表 $model=Model(); $brand_list=$model-table(brand)-select(); /向模板抛出内容 Tpl:output(brand_list,$brand_list); /设置页面标题 Tpl:output(html_title,Language:get(brand_index_brand_list); /输出SEO设置信息 Model(seo)-type(brand)-show(); /调用模板展示 Tpl:showpage(brand);代码001模板代码view： 所有品牌 -$val)? a href=brand,op=list,brand=$brandbrand_id);? img src= alt= / 2、 核心文件及常量介绍：ShopNC商城程序的框架文件主要由类文件和函数文件组成。系统类库主要存放在framework下的libraries、cache、core和tpl目录中，librarites存放的是一些类库，cache下是存放多种缓存驱动类，core下存放的是核心基类和模型处理类，tpl只存放视图类Tpl。1) 主要类文件及简要说明libraries/email.php 邮件发送类libraries/ftp.php ftp处理类libraries/gdimage.php 水印类libraries/json.php json处理类libraries/language.php 语言包处理类libraries/log.php 日志类libraries/page.php 分页类libraries/resizeimage.php 图片裁切类libraries/seccode.php 验证码处理类libraries/security.php 字符过滤类libraries/sphinx.php sphinx全文检索类libraries/upload.php 上传类libraries/validate.php php后端验证类cache/ cache.php 缓存统一处理类，它是每种缓存类的操作入口cache/cache.file.php 文件缓存类cache/ cache.apc.php apc缓存类cache/cache.xcache.php xcache缓存类cache/cache.memcache.php memcache缓存类cache/ cache.eaccelerator.php eaccelerator缓存类cache/cache.table.php table缓存类 core/model.php 模型类 core/db.php 数据库操作中间层，界于模型和数据驱动中间的中间处理类 db/mysql.php mysql扩展MySQL数据库驱动 db/mysqli.php mysqli扩展MySQL数据库驱动 db/pdo_mysql.php pdo_mysql扩展MySQL数据库驱动 db/oci8.php oci8扩展ORACLE数据库驱动 tpl/nc.php 模板类(视图类)2) 系统函数均存放在framework/function目录中，考虑到以后的扩展，系统跟据功能将函数拆分进入不同的文件中，core.php 存放系统的通用函数goods.php 存放处理商品、订单、店铺相关的信息的函数ftp.php 存放ftp操作的相关函数seccode.php 存放验证码操作的函数build.php 存放框架压缩的函数系统引用的第三方开源程序放在了/resource目录中，主要包含以下子目录avatar 存放头像上传组件clickswf 存放点击量统计FLASH组件font 存放字体js 存放js文件kindeditor 存放kindeditor编辑器phpqrcode 存放二维码组件seccode 存放验证所需要元素web_config 存放首编辑模块编辑所需要组件3) 系统常量参考ProjectName= 项目名称BUILDCORE= 是否压缩框架（true/false）BasePath= 系统所在基准目录（如 /var/www/shopnc）DS = 目录分隔符 /InShopNC= 合法调用判断标志StartTime= 系统开始运行时间（如1350096132.6587）TIMESTAMP= 系统当前时间（如1350096132）RUNCOREPATH=压缩后的框架所在目录 (如 /var/www/shopnc/cache/shopnc.php)SiteUrl= 商城URL地址（）CHARSET= 系统编码（UTF-8/GBK）DBDRIVER= 数据库访问驱动（mysqli、mysql、pdo_mysql、oci8）SESSION_EXPIRE= 缓存周期，单位（秒）LANG_TYPE= 语言包，默认简体中文zh_cnCOOKIE_PRE= cookie前缀，系统自动生成CORE_PATH= 框架所在目录(如 /var/www/shopnc /framework)TPL_NAME= 模板风格，默认defaultBASE_TPL_PATH= 模板文件目录(如 /var/www/shopnc /templates/default)RESOURCE_PATH= 外部资源目录地址（如 /resource）DBPRE =数据库表前缀 默认shopnc_ATTACH_PATH= 附件目录，默认uploadATTACH_COMMON= 通用附件目录 默认upload/commonATTACH_AVATAR= 头像目录 默认 upload/avatarATTACH_STORE= 店铺信息目录 默认 upload/storeATTACH_GOODS= 店铺产品目录 默认 upload/store/goodsATTACH_AUTH= 店铺证件目录 默认 upload/authATTACH_MOBILE= 手机客户端内容目录 默认upload/mobileATTACH_LINK= 友情链接logo目录 默认upload/linkATTACH_ARTICLE= 文章附件目录 默认 upload/articleATTACH_BRAND= 品牌附件目录 默认 upload/brandATTACH_ADV= 广告图片目录 默认 upload/advATTACH_ACTIVITY= 促销活动目录 默认 upload/activityATTACH_COUPON= 优惠券目录 默认 upload/couponATTACH_WATERMARK= 水印图片目录 默认 upload/watermarkATTACH_POINTPROD= 积分商品图片目录 默认 upload/pointprodATTACH_SPEC= 自定义规格图片目录 默认 upload/specATTACH_GROUPBUY= 团购图片目录 默认 upload/groupbuyATTACH_SLIDE= 店铺二维码目录 默认 upload/store/slideATTACH_VOUCHER= 代金券模板目录 默认upload/voucherTEMPLATES_PATH= 模板URL访问地址（如/templates/default）MD5_KEY= MD5_KEY值 系统自动生成3、 表单数据验证：数据安全是程序开发中至关重要一点，特别是对商城程序而言，一般对表单数据验证都是采用前端JS与后端PHP验证相结合的方式，ShopNC商城系统在表单数据验证上也是如此， ShopNC系统的后台PHP验证分为两部分：控制器层验证和框架底层验证，Validate验证类的作用就是完成在控制器里的验证。下面是登录时的一段使用Validate类验证程序：if (chksubmit() $obj_validate = new Validate(); $obj_validate-validateparam = array( array(input=$_POSTusername, require=true, message=请输入用户名), array(input=$_POSTpassword, require=true, message=请输入密码), array(input=$_POSTcaptcha, require=(C(captcha_status_login) ? true : false), message=请输入验证码), ); $error = $obj_validate-validate(); if ($error != )/输入信息有误，验证失败！ showValidateError($error); else /* * 程序继续向下执行 */ 代码分析：首先由chksubmit函数判断表单提交是否合法，令牌是否正确，判断通过后，使用Validate类进行数据验证，Validate类的validateparam属性数组存放待验证的信息，其中，input为待验证的数据，require为是否为必填项(true/false），message为如果验证未通过，返回的提示信息。可以看出上例的用户名和密码均为必填项，验证码视系统开关captcha_status_login的值而定。C函数作用是取得系统配置项。准备工作都完后成，开始调用类的validate方法进行验证，如果验证未过通，返回错误信息，否则返回空。错误信息的输出由showValidateError函数完成，该函数跟据是否是异步提交返回不同的提示形式。除可以验证是否为必填外，Validate类还可以完成一些常用的数据类型验证。如验证邮件、电话、网址、货币、邮编、QQ、数字、英文、汉字、两数值比较等。如:$obj_validate = new Validate();$obj_validate-validateparam = array( array(input=$_POSTpassword1, require=true, validator=compare, operator=, to=$_POSTpassword2, message=两次密码输入要一致),array(input=$_POSTinput0, require=true, validator=email, message=邮件验证),array(input=$_POSTinput1, require=true, validator=phone, message=固话验证),array(input=$_POSTinput2, require=true, validator=mobile, message=手机验证),array(input=$_POSTinput3, require=true, validator=url, message=网址验证),array(input=$_POSTinput4, require=true, validator=currency, message=价格验证),array(input=$_POSTinput5, require=true, validator=number, message=数字验证),array(input=$_POSTinput6, require=true, validator=zip, message=邮编验证),array(input=$_POSTinput6, require=true, validator=qq, message=QQ验证),array(input=$_POSTinput6, require=true, validator=english, message=英文字母验证),array(input=$_POSTinput6, require=true, validator=chinese, message=中文验证),);$error = $obj_validate-validate();4、 缓存设计系统可以对数据进行多种形式缓存，包括文件方式、共享内存方式和数据库方式。目前已支持的缓存方式包括：file、apc 、eAccelerator 、memcache 和 xcache，开发者也可以开发更加适合自己的缓存。系统由Cache缓存类进行缓存操作，由Cache:getInstance方法完成缓存类型实例化： /取得memcache缓存实例$obj_cache = Cache:getInstance(memcache);/缓存赋值$obj_cache-set(uid,1000);/读取缓存$obj_cache-get(uid);/删除缓存$obj_cache-rm(uid);系统需要将部分常用表信息（如基本配置表、商品分类表、快递表、SEO表等）生成缓存，为了便于操作，系统对这些表的缓存处理封装到专有的cache模型中，使用Model(cache)-call(表名) 即可得到符合缓存格式的表信息。为了方便对缓存的操作，系统新增了H和F方法，H方法对缓存类操作再次进行封装。如取得系统cache/setting.php缓存信息：H(setting);内部执行过程为：首先取得file缓存实例$obj_cache = Cache:getInstance(file)判断操作类型（删除缓存？、缓存赋值？缓存读取？），然后执行$obj_cache-get(setting);取得缓存内容，至此执行完毕。使用H方法将setting表信息生成到文件缓存：H(setting,true,file);内部执行过程为：首先取得file类型缓存实例，$obj_cache = Cache:getInstance(file)判断操作类型（删除缓存？、缓存赋值？缓存读取？），然后执行$obj_cache-rm(setting);删除原有setting缓存，实例化cache模型并执行_setting方法来取得setting表中的内容，$list = Model(cache)-call($key); 使用set方法写入缓存 $obj_cache-set($key, $list, null, $expire); 最后返回true，至此缓存生成成功。 F 方法也可以操作缓存，但它与H方法不同，F只是一种快速度读、写文件缓存的方法，不可用于内存缓存的操作，F方法不能直接将数据表内容生成缓存，只可将PHP中已经存的内容（如数组、字符串等）生成到文件缓存，在读取文件缓存时，推荐使用效率更高的F方法。F(setting); /取得setting缓存F(setting,$data); /将$data数组生成到setting文件缓存5、 二次开发代码规范的建议关于PHP书写：1. 代码标记建议使用标准形式（），不建议使用简写形式（），如果服务器未开启对短标记的支持（short_open_tag = Off），将会有暴露源码的危险。2. 模板中输出变量使用“echo” 输出,以分号结尾，不建议使用“=”输出。3. 对于函数级、类类及文件头注释使用C样式的注释“/* */”，对于代码行（段）的注释可使用标准C+注释”/”。4. 建议使用缩进保持代码的层级关系，每个缩进的单位约定是一个TAB(4个空白字符宽度)，开发工具建议使用Zend Studio、UltraEdit、EditPlus等编辑器。5. 关于PHP变量的命名规则，建议以英文拼写为蓝本，遵循简洁和可读性原则，至于采用C风格还是Java风格还是其它，可跟据自己习惯，本人不做强制建议。6. 全局常量的定义要统一使用大写，单词之间使用下划线连接。7. 开发时，代码的error_reporting报错级别建议设置为E_ALL & E_NOTICE。8. Include，require包含文件时建议使用绝对路径，框架底层引入文件可使用Include，require（不带once效率高一些），在业务逻辑层引入文件时可使用Include_once，require_once。关于数据库：1. 表和字段命名同样应以英文拼写为蓝本，遵循简洁和可读性原则，长度适中，建议长度在30个字符内，否则跨库迁移可能会存在麻烦。2. 字段类型设置应遵循足够用不浪费的原则。3. SQL语句中，除了表名、字段名称以外，全部语句和函数均应大写。4. 尽可能避免直接编写SQL语句去执行，提倡使用系统数据库操作层相应入口来完成。5. 索引可以加快检索速度，但不易过多，单个表建议不超过5个索引。关于目录的安全：1. 文件与目录命名均使用小写字母，php文件后缀均为“.php”，2. 请在敏感目录中放置一个1字节的index.html文件，内容为一个空格，以避免当http服务器的Directory Listing打开时，服务器文件被索引和列表。3. 根目录创建一个空格为内容的robots.txt文件，防止搜索蜘蛛抓取时，因找不到该文件而产生一个error信息而产生大量的无效WEB日志。6、 图片处理首先实例化上传类$upload = new UploadFile();然后设置上传商品图片上传目录$upload-set(default_dir,ATTACH_GOODS.DS.$upload-getSysSetPath();设置上传图片宽高最大尺寸，多出部分将被按比例裁切$upload-set(max_size,C(image_max_filesize);跟据业务需要，系统将图片裁剪为4张缩略图，4张图的最大宽度设置从配置文件中取得$thumb_width =sprintf(%s,%s,%s,%s,C(thumb_tiny_width),C(thumb_small_width),C(thumb_mid_width),C(thumb_max_width);设置最大高度$thumb_height =sprintf(%s,%s,%s,%s,C(thumb_tiny_height),C(thumb_small_height),C(thumb_mid_height),C(thumb_max_height);$upload-set(thumb_width, $thumb_width);$upload-set(thumb_height,$thumb_height);设置4张图片的名称后缀$upload-set(thumb_ext, _tiny,_small,_mid,_max);系统还支持设置文件名称前缀$upload-set(fprefix,$store_id);系统允许上传哪些类型的图片$upload-set(allow_type,array(gif,jpg,jpeg,png);调用upfile方法开始上传操作$result = $upload-upfile($_POSTproduct_thumb);如果上传错误，输出json格式的错误信息if (!$result) 如果系统是GBK格式，则转成utf-8编码，再输出json信息 if(strtoupper(CHARSET) = GBK) $error= Language:getUTF8($upload-error); $output= json_encode(array(error=$error); 输出json信息,(商品图片上传是异步上传) exit($output);如果上传无误，返回图片新路径$img_path =$upload-getSysSetPath().$upload-file_name;以上是商品图片上传处理的主要代码（裁剪由uploadfile类内部完成），得到商品图片新路径后，保存入库即可。保存到商品表的商品图片只是缩略图一种尺寸，商城使用封装的图片调用函数来满足不同页面对不同尺寸图片的要求，这些函数位于framework/function/goods.php中，分别为thumb ,cthumb,gthumb，这些函数的具体使用可查看官方手册。系统支持多种图片存储方式配置，打开商城根目录下的config.ini.php，找到$configthumbsave_type项，默认为$configthumbsave_type = 1;表示本地存储，使用商城域名访问。$configthumbsave_type= 2;表示图片存储目录不变，但支持使用图片域名指向存储目录，如指向upload目录（也适用于CDN加速的情况）。7、 二次开发之地区开发最近碰到一个基于ShopNC商城系统二次开发成支持多城市运营的项目，客户其中一个需求就是总平台可以开设各城市分站，IP地址系统自动识别，游客或会员只能查看某一城市分站的商品店铺等信息，而不是全国的信息，各城市分站拥有自己的会员与店铺。开发过程与大家分享一下。 第1步：搭建一个城市运营商使用的后台 首先创建一个城市表city，主要字段包括：城市ID（主键），城市名称、城市二级名称、状态、城市管理员登录账号和密码。系统管理员可以对这个表进行CURD操作，也就是管理城市表。 然后建立各城市分站后台，如命名后台目录为city_manage，复制现有admin目录中的入口文件index.php到city