Magento项目开发规范.doc

MagentoVersion Magento项目开发规范项目开发规范 Prepare by Eric Huang Silk Software 08/29/2010 Version History NameDateReason for ChangeVersion Eric(黄光华)08/29/2010Initial Draft1.0.0 Eric(黄光华)10/13/2010Product import and export1.0.1 Eric(黄光华)10/26/2010Magento upgrade(ce1.3.2 professional)1.0.2 2 / 11 2009-2010 Silk Software Inc. Table of Contents 1MAGENTO 开发设计遵循原则开发设计遵循原则 .3 1.1CODE开发设计原则3 1.2THEME开发设计原则.3 1.2.1Design开发设计原则.3 1.2.2Skin开发设计原则4 1.3PLUGIN开发设计原则5 2SVN 使用遵循原则使用遵循原则.5 2.1SVN 目录结构说明.5 2.2SVN 开发人员文件包存放原则.6 2.3SVN 设计人员文件包存放原则.6 2.4整合设计人员文件包遵循原则.6 3客户生产机更新遵循原则客户生产机更新遵循原则7 3.1生产机数据库更新遵循原则7 3.2生产机代码更新遵循原则.7 4数据库遵循原则数据库遵循原则.7 4.1数据库备份与恢复遵循原则7 4.2开发环境数据库遵循原则.7 4.3测试环境数据库遵循原则.8 4.4生产环境数据库遵循原则.8 5产品导入更新遵循原则产品导入更新遵循原则8 5.1产品信息导入遵循原则8 5.2产品信息备份遵循原则8 5.3产品属性批量更新遵循原则8 6MAGENTO 升级遵循原则升级遵循原则8 6.1MAGENTO数据库升级遵循原则.9 6.2MAGENTO PLUGIN升级遵循原则.9 6.3MAGENTO THEME升级遵循原则.9 6.3.1Layout XML文件升级遵循原则9 6.3.2Phtml模板文件升级遵循原则10 6.3.3Skin文件升级遵循原则11 7其它其它11 3 / 11 2009-2010 Silk Software Inc. 1 Magento 开发设计遵循原则开发设计遵循原则 1.1 Code 开发设计原则开发设计原则 a.必需遵循原有 Theme 模板框架，进行功能和流程的配置开发。如果客户提供有 Mockup 页，则字体、字体大小、颜色以 Mockup 为准，页面模块的间距则以原 有 Theme 模板的结构块为准。 b.必需保持原有 Theme 的结构块(例如：Header、Left、Content、Right 和 Footer) 不变，将 Mockup 根据原有 Theme 的对应内容块的要求进行切图，并做局部的 内容 块的替换。 c. 禁止修改 Magento 中的任何核心 PHP 文件，可以修改的文件目录如下: appcodelocal appcodecommunity (在组长同意的情况下，可修改此目录中的文件) d. 需要修改 Magento 代码去适应业务需求时，不能修改 Magento 的核心代码，可 以在 appcodelocal中修改、扩展、重写与业务紧密相关部分的 Magento 代码， 去掉与业务不紧密相关的代码。 注：注：这里有很多原因，例如将来还希望升级 Magento、还想使用更多的 Magento 代码。 e.自定义功能性的 php 文件统一存放到 appcodelocalsilk 文件夹下。文件、类和函数命名必需按照 Magento 的命名规范进行统一命名。 f. 第三方的插件统一存放到 appcodecommunity g.所有的 PHP 代码，必需按照 Magento 的注释要求进行注释。 h.当需要开发新功能模板时，首先到 magento 的官方网站上找是否有 stable 版的 插件，FREE 的优先，付费的也可以考虑;其次，看是否能利用 magento 的现在 功能来实现;最后才自己开发新模块。 1.2 Theme 开发设计原则开发设计原则 1.2.1 Design 开发设计原则开发设计原则 Template开发设计原则开发设计原则 a.禁止修改 appdesignfrontendbasedefaulttemplate 中的任何文件。 b.警慎修改 templatepagehtml 文件夹下的 .phtml 文件,避免覆盖或 错改 UI 设计人员的修改。 4 / 11 2009-2010 Silk Software Inc. c. 自定义的 Theme 统一命名原则，主网站的 Theme 用网站的名称做为 Theme 名 称，如果有子网店，则用子网店的名称做为子网店的 Theme 名称. d. 自定义的 Theme 统一存放到 appdesignfrontenddefault e.第三方插件的.phtml 统一存放到 appdesignfrontenddefaultdefaulttemplate 中; .xml 文件统一存放到 appdesignfrontenddefaultdefaultlayout 中。 f. 需要修改、扩展、重写与业务紧密相关部分的.phtml 模板文件，如果原有 Theme 中对应部分，则可以在原有 Theme 中修改;如果原有 Theme 中没有对应 的模板，则从 appdesignfrontendbasedefaulttemplate 中复制对应的模板中， 然后才进行修改。 Layout开发设计原则开发设计原则 a.禁止修改 appdesignfrontendbasedefaultlayout 中任何文件 b.需要修改模块的.xml 时，首先将对应的.xml 文件拷贝到网站对应的 Theme 中， 然后做修改。建议在Layout 下新建一个 local.xml 文件， 用于存放所有修改的 xml. c.项目组长同意情况下才能修改 layout 中的 .xml 文件 1.2.2 Skin 开发设计原则开发设计原则 CSS开发设计原则开发设计原则 a. 禁止开发人员修改 Magento 原有的任何.css 文件 b. 禁止开发人员修改原有 Theme 中的任何.css 文件。 c. 整合 UI 设计时，禁止开发人员修改 UI 设计文件包中的任何.css 文件。 d. 开发人员整合 UI 设计后，发现页面布局不正确，应通知相关的 UI 设计人员进行个 修改。 e. 自定义.css 文件和 css 的命名必需以网站或网店名称为前缀。 比如：“ProjectName-name.css”或“StoreName-name.css”或 “ProjectName- 需要重写原 css 的名称”；CSS 的层次结构必需要与 Theme 中原 css 的层次结构 一致。 f.自定义的 css,必需为每一个页面定义一个单独的.css 文件，如：asweett- home.css、asweett-contacts.css、asweett-about.css 等。 g. 自定义的 css 文件统一放到 skinfrontenddefaultcss 中。 JS开发设计原则开发设计原则 a. 自定义 js 文件统一放到 skinfrontenddefaultjs 中。 b. 在 appdesignfrontenddefaultlayoutpage.xml 中引用自定 义的 js 文件，并放到原有的 js 文件之后。 c. js 中的类和函数命名需要添加项目名称为其前缀，避免与原有的 js 代码冲突;例如： asweett_xxx.js 5 / 11 2009-2010 Silk Software Inc. d. 能用 flowplayer 的都用 flowplayer 的 jquerytool URL: /tools/ Images设计原则设计原则 a.Images 应统一放到 skinfrontenddefaultimages 中 b.客户提供的每一个 Mockup 页面的切图应在 images 中单独建一个文件夹存放，比 如 imageshome、imagesaboutus、imagescontacts 等等。 c.Home Banners 的图片,如果客户需要在 magento 的后台维护图片，则统一存放到 mediahomebanners 或mediahomebanners 中;如果不需要在 magento 的后台管理中维护图片，则统 一存放到 skinfrontenddefaultimagesmedia 中。 d.Images 切图时应切成 JPG 格式，尽量少用 PNG 格式的图片 e.Images 切图后的所有的图片都应做优化处理，将图片大小控制在 1M 以内 1.3 Plugin 开发设计原则开发设计原则 a.项目组长许可的情况下可以安装必要插件和修改 XML 文件。 b.需要开发新 Plugin 时，首先到 magento 的官方网站上找是否有 stable 版的 Plugin，FREE 的优先，付费的也可以考虑;其次，看是否能利用 magento 的现在 功能来实现;最后才考虑自己开发 Plugin。 2 SVN 使用遵循原则使用遵循原则 2.1 SVN 目录结构说明目录结构说明 描述Svn 中只保存改动过的文件和该版本数据 SQL 文件, 不包括 magento 核心代码。 Svn 目录结构说明权限设置 trunk：用于存放当前测试版本全部文件组长/QA - RW, 组员/UI - R release: 用于存放已发布版本全部文件。只 保存改动过的文件和该版本 数据 SQL 文件, 不包括 magento 核心代码。 组长/QA - RW tags: 各版本的历史备份。组长 - RW branch: 为每名成员创建个人文件夹，保存 个人提交的代码。 组长/组员自己 RW QA - R docs: 保存项目文档资料文件以及 SQL 脚本。组长/组员/UI/QA - RW Docs-Database: 用于存放 DB 备分的 sql 脚本 Docs-Download: 用于网上下载的一些技术文章或文档 Docs-Email: 用于存放与该项目相关的重要 email Docs-Meeting Minutes: 用于存放做项目过程中产生的各种会议记录 6 / 11 2009-2010 Silk Software Inc. Docs-Mockup: 用于存放该项目原始的 JPG 和 PSD 文件 Docs-Plugin: 用于存放该项目所有用到的插件 Docs-Requirement: 用于存入项目相关的一些需要文档 Docs-Sourcecode: 用于存放代码备份的.zip 或.rar 包 Docs-Theme: 用于存放项目所用到的 Theme 和原始版 magento 的代 码 2.2 SVN 开发人员文件包存放原则开发人员文件包存放原则 a.开发人员的修改过的程序文件统一存放到 trunkCode中,按 magento 的原有目录层次结构组织内容。 b.开发环境的最新 SQL 脚本统一存放到 trunkSqlScript中,需要指明当前数据库的 版本号 c. 填写功能开发文件修改清单的清单文件统一存放到 trunkCode 中 注：注： 新增插件应放入功能文件包;提交的 SQL 脚本需要替换其 BaseURL,使其指向公 司测试机。 2.3 SVN 设计人员文件包存放原则设计人员文件包存放原则 a.UI 设计人员的文件包统一存放到 trunkUI中 b.填写UI 设计文件修改清单的清单文件统一存放到 trunkUI 中 c. 文件包中只能包括以下类型文件： css, jpg, png, swf, flv, phtml, xml. 其他文件视 为非法。 2.4 整合设计人员文件包遵循原则整合设计人员文件包遵循原则 a.从 SVN 同步 UI 设计文件包后，整合代码时，禁止开发人员修改 UI 设计包中的 css 文件 b.开发人员只能将整合 UI 设计包的文件 Check In 到自己的 SVN 目录下，并填写 功能开发文件修改清单 c. 开发人员整合 UI 设计包并已经 Check In 到 SVN 中，发现 css 样式不对，应通知 相关的 UI 设计人员，而不能自己直接修改 css 文件 d.UI 设计人员收到开发人员的 css 样式修改通知后，应从 trunkCode 中同步已整 合前一版的 UI 的文件包到自己的 UI 设计环境中，用 trunkCodeSqlScript 的脚 本更新 UI 设计环境的 DB，然后进行 css 调整。调整完以后，再将新一版的 UI 文件包放到 trunkUI 中，并填写UI 设计文件修改清单 7 / 11 2009-2010 Silk Software Inc. 3 客户生产机更新遵循原则客户生产机更新遵循原则 3.1 生产机数据库更新遵循原则生产机数据库更新遵循原则 a.禁止用开发机环境的数据库脚本去覆盖客户生产机环境的数据库 b.更新客户生产机环境数据库前，首先将生产机的数据库备份，然后用 SQL 脚本 做局部（相关信息表级或记录级）的更新 c. 在开发环境的 Magento 后台做的配置操作，需要同步更新到客户生产机环境数 据库时，则应在客户生产机环境 Magento 后台参考开发环境的配置重新做一遍， 禁止用开发机环境的 SQL 脚本去直接更新生产机的数据库。 3.2 生产机代码更新遵循原则生产机代码更新遵循原则 a. 更新代码前，必需将原有的代码备份。 b. 禁止在生产机环境上做批量代码的更新，只能做局部模块级且分阶段的更新。 注注： 批量代码指的很多功能模块的代码 c. 其它 4 数据库遵循原则数据库遵循原则 4.1 数据库备份与恢复遵循原则数据库备份与恢复遵循原则 a.禁止用 phpMyAdmin 的 Export 功能备份数据库 b.用 Magento 后台SystemToolsBackups 工具进行备份，用 phpMyAdmin 或 其它 mysql 管理工具进行恢复。 注：注：因用 phpMyAdmin 导出 magento 的数据库 sql，有时会有外键问题。用 Magento 自带的工具备份数据库，会自动处理相关的外键问题 4.2 开发环境数据库遵循原则开发环境数据库遵循原则 a.每天至少备份开发环境数据库一次,统一放于目录 docsDatabaseDevelopEnv_Databasev1.0.1下 b.数据库的命名: 项目名称_版本号，例如：asweett_v101 c. 备份数据库 SQL 脚本文件命名：数据库名称_日期_时间，例如： asweett_09252010_16h26m 4.3 测试环境数据库遵循原则测试环境数据库遵循原则 a.在测试环境数据库做任何更新以前，必需备份数据库,SQL 脚本统一放于目录 docsDatabaseTestEnv_Databasev1.0.1 下 8 / 11 2009-2010 Silk Software Inc. b.数据库的命名: 项目名称_版本号，例如：asweett_v101 c. 备份数据库 SQL 脚本文件命名：数据库名称_日期_时间，例如： asweett_09252010_16h26m d.其它 4.4 生产环境数据库遵循原则生产环境数据库遵循原则 a. 在生产环境数据库做任何更新以前，必需备份数据库,SQL 脚本统一放于目录 docsDatabaseProductEnv_Databasev1.0.2 下 b. 数据库的命名: 项目名称_版本号，例如：asweett_v101 c. 备份数据库 SQL 脚本文件命名：数据库名称_日期_时间，例如： asweett_09252010_16h26m d. 其它 5 产品导入更新遵循原则产品导入更新遵循原则 5.1 产品信息导入遵循原则产品信息导入遵循原则 a.每次导入产品前，必需要将 DB 备份 b.首先将需要导入的产品和图片信息整理成.csv 格式，然后用 magento 后台的导 入工具导入 c. 导入产品成功以后，将 DB 中对应的表导出 sql 进行备份 5.2 产品信息备份遵循原则产品信息备份遵循原则 a.每次导入产品成功以后，需要将对应的表导出 sql，进行备份 b.将对应导入产品的.csv、备份的.sql 文件和产品图片信息统一放到 svn 中存档 5.3 产品属性批量更新遵循原则产品属性批量更新遵循原则 a.产品属性批量更新，如果能用 magento 自带批量更新功能的，就用 magento 自 带的更新功能 b.产品属性批量更新,不能 magento 自带批量更新功能的，就将数据库对应的表导 出为 sql，然后根据需要调整 sql,最后将调整好的 sql 重新导入数据库中 6 Magento 升级遵循原则升级遵循原则 例：upgrade magento from ce to pro 9 / 11 2009-2010 Silk Software Inc. 6.1 Magento 数据库升级遵循原则数据库升级遵循原则 a.用 magento 后台toolsbackup 工具备份原有网站的数据库，不推荐用 phpmyadmin 的 export 导出 magento 整个网站的数据库。 b.新建一个空的数据库，将 a 中备份的 SQL 导入新建数据库,可以用数据库管理工 具或者 mysql 的命令 c. 下载指定目标升级的 magento 版本 d.将原来网站的 media 文件夹复制到目标升级的 magento 中 (安将完成后，magento 会自动原来老的数据库的表结构调整为目录升级 magento 的数据库表结构) e.执行标准的 magento 的安装流程 f. 用 magento 的数据库修复工具，修复一下升级以后的新版数据库 6.2 Magento Plugin 升级遵循原则升级遵循原则 a.禁止改动 appcodecore 中的任何文件 b.分别将 appcodecommunity 和 appcodelocal 中的文件复制到目标升级 magento 的 appcodecommunity 和 appcodelocal 中 c. 新 appcodecommunity 和 appcodelocal 中 plugin 对应的. xml,.phtml,.css,Image 和.js 文件复制到目标升级 magento 对应的位置 appdesignadminhtmldefaultdefaultlayout appdesignadminhtmldefaultdefaulttemplate appdesignfrontendprodefaultlayout appdesignfrontendprodefaulttemplate skinadminhtmldefaultproimages skinadminhtmldefaultprocss skinfrontendprodefaultcss skinfrontendprodefaultjs skinfrontendprodefaultimages 6.3 Magento Theme 升级遵循原则升级遵循原则 6.3.1 Layout XML 文件升级遵循原则文件升级遵循原则 a.禁止修改目标升级 magento 中 appdesignfrontendbasedefaultlayout 下的 任何.xml 文件 b.目标升级 magento 中，appdesignadminhtmldefaultdefaultlayout 和 appdesignfrontendprodefaultlayout 下的 xml 文件只允许增加，禁止删除 任何内容 10 / 11 2009-2010 Silk Software Inc. c.用文