21、Drupal模块部署与Windows开发环境搭建指南-优快云博客

Drupal模块部署与Windows开发环境搭建指南

1. .install文件与更新注意事项

在处理Drupal模块的 .install 文件和更新时，有几个要点需要牢记：
- 更新模块架构 ：当更新模块的架构时，这些更改应反映在架构钩子中。即使更新函数会对架构进行更改，但对于在多次更新后才安装模块的新用户，函数会加载最新的架构，然后从该点开始应用更新。
- 更新函数编号 ：不要重新编号更新函数。更新函数末尾的数字是增量值，模块的最高应用更新版本会存储在数据库中。如果在应用更新后重新编号，可能会引发问题。只需遵循编号约定，就不会有问题。
- 安装代码与模块代码同步 ：安装代码必须与模块代码保持同步，反之亦然。例如，如果更改模块以更新表名并添加字段，用户在运行更新脚本之前安装并运行新模块，模块可能会失败。用户需要在加载新模块时运行更新脚本，而程序员则要确保一切同步。
- 充分测试 ：更新函数的完美运行比初始安装更为重要。更新意味着用户正在使用模块，他们可能有依赖于该模块的数据。如果更新程序失败，模块将变得无用，甚至可能导致用户数据丢失。

2. 模块交付

创建 .info 和 .install 模块后，已向Drupal核心详细描述了模块，以便进行安装。但为帮助用户理解模块及其使用方法，还需做更多工作。
- Drupal.org托管服务 ：Drupal官方网站drupal.org提供模块托管服务，任何人都可访问。该网站有搜索功能，用户可查找所需功能的模块并下载最新版本。不过，若想让模块在该网站列出，需同意其准则，即要参与模块维护，并允许他人加入项目以改进它。
- 模块文档开发 ：无论是否在drupal.org上托管模块，都应遵循一些准则来维护模块。以下是开发模块时的基本要求：
- README文件 ：除最简单的模块外，项目目录中都应有 README.txt 文件，提供模块的基本概述以及用户安装后可能获得的好处。例如，Services模块的 README.txt 文件示例如下：

// $Id:$

Goals
==============
- Provide weather information for a geographical location on Earth.
- Provide a block that can be placed in any region.
- Allow users to define their own location, language, and display
  units that will be displayed when they log on.

This module uses the profile module and creates new profile fields
so each user can specify his or her own location for weather.

Documentation
==============
http://drupalforwidows.com/docs/weather_info

- **hook_help()函数**：除最简单的模块外，都应实现帮助钩子，为管理员和用户提供模块信息。可参考嵌入式文档风格指南（http://drupal.org/node/24566 ）。以下是一个简单示例：

/**
 * Implements hook_help().
 */
function weather_info_help($section) {
  switch ($section) {
    case 'admin/help#weather_info':
      // Return a line-break version of the module README
        return _filter_autop(
          file_get_contents( dirname(__FILE__) . "/README.txt"));
  }
}

- **告知用户模块功能**：README和帮助文件应让用户了解模块的功能、管理菜单路径、创建或访问的文件目录，以及可能对其他模块或Drupal核心产生的影响。
- **合理命名包**：大多数模块不应创建自己的包，以免使模块管理页面混乱。若模块功能与其他模块类似，应使用知名的包名；若为独特的独立模块，可省略包名，它将在模块管理页面的“其他”类别下列出。
- **正确文档化函数**：Drupal社区采用Doxygen文档约定作为从内联注释生成文档的标准方法。使用Doxygen风格的注释可让各种脚本将注释整理成社区成员熟悉的标准格式。更多信息可参考http://drupal.org/node/1354 。
- **编写并交付测试**：为模块开发测试套件非常重要。
- **考虑安装配置文件**：如果要安装多个模块，或模块依赖于潜在用户站点上可能未安装的其他模块，可创建一个增强型配置文件，批量安装一组模块，甚至是Drupal核心本身。更多信息可参考http://drupal.org/node/159730 。

3. Windows开发环境搭建

对于习惯使用Microsoft开发工具的开发者来说，Drupal的LAMP（Linux/Apache/MySQL/PHP）栈可能有些陌生。不过，可以用Windows替代Linux，但用IIS替代Apache、SQL Server替代MySQL会更困难，也不能用C#或Visual Basic替代PHP。以下是在Windows工作站上设置调试环境的步骤：
- WAMP栈 ：Drupal通常运行在LAMP栈上，但也可在Windows上使用WAMP（Windows/Apache/MySQL/PHP）栈。常见的WAMP栈有XAMPP和WampServer，它们使用相同的核心包（Apache、MySQL和PHP），但控制面板不同。这里推荐WampServer，因为它便于在PHP 5.2和5.3版本之间切换。
- 安装WampServer ：可从http://wampserver.com 下载并安装WampServer。安装时，若安装Skype，需先关闭它，因为Skype可能使用端口80，会与WampServer冲突。若想同时使用WAMP和Skype，可在Skype的“工具…选项…高级连接”面板中取消选择“使用80和443作为传入连接的替代端口”。安装完成后，启动服务器，确保WampServer图标显示在任务栏，且指示灯为绿色。若Apache未启动，最常见的原因是其他应用（如IIS）正在使用端口80。可通过WampServer控制面板的“测试端口80”选项检查，若IIS占用端口80，可通过计算机管理关闭默认网站。
- 开发环境选择 ：在Windows平台上，有几种不同的开发环境可供选择：
| 开发环境 | 特点 | 价格 |
| ---- | ---- | ---- |
| Eclipse | 开源开发环境，可用于几乎任何语言开发，但配置复杂，学习成本高 | 免费 |
| NetBeans | 开源解决方案，与Eclipse类似，也存在学习曲线问题 | 免费 |
| Komodo IDE | 商业产品，由ActiveState提供支持，易于上手，但需付费（当前价格为295美元） | 295美元 |
| VS.Php | 商业扩展，适用于Visual Studio，利用了Visual Studio的所有功能，提供调试、智能感知和团队协作等功能（当前价格为99美元，需配合Visual Studio使用） | 99美元 |

4. 配置Visual Studio和VS.Php

若选择VS.Php作为开发环境，可按以下步骤操作：
1. 安装兼容版本的Visual Studio。
2. 从http://www.jcxsoftware.com/VS.Php 下载VS.Php并运行安装程序，可暂时使用默认设置。
3. 启动VS.Php，它会启动Visual Studio并将自身添加到开发环境中。可能会弹出提示输入许可证的窗口，若有许可证可立即激活，否则可继续使用。
4. 在Visual Studio中，通过“工具➤选项”，展开到“文本编辑器➤PHP➤制表符”，确保制表符设置与Drupal的代码格式约定一致（使用两个空格缩进，不使用制表符）。
5. 告诉Visual Studio识别PHP代码文件的其他扩展名，如 .info 和 .module 。
6. WampServer自带MySQL和phpMyAdmin，可通过WampServer控制台访问phpMyAdmin来管理数据库。若想使用Visual Studio管理数据库，可免费下载并安装MySQL Connector for .NET，它会集成到Visual Studio中，提供与Visual Studio服务器资源管理器类似的功能。

以下是安装和配置过程的流程图：

graph LR
    A[开始] --> B[安装WampServer]
    B --> C{WampServer启动成功?}
    C -- 是 --> D[安装Visual Studio]
    C -- 否 --> E[检查端口80占用情况]
    E --> F{是否IIS占用?}
    F -- 是 --> G[关闭IIS默认网站]
    G --> B
    F -- 否 --> H[排查其他问题]
    H --> B
    D --> I[安装VS.Php]
    I --> J[启动VS.Php]
    J --> K[配置Visual Studio的PHP设置]
    K --> L[配置文件扩展名]
    L --> M[选择数据库管理方式]
    M --> N[完成]

通过以上步骤，你可以在Windows环境下顺利开发和部署Drupal模块。

Drupal模块部署与Windows开发环境搭建指南（续）

5. 数据库管理与操作

在使用Drupal开发过程中，数据库管理是至关重要的一环。前面提到了WampServer自带的phpMyAdmin以及MySQL Connector for .NET这两种数据库管理方式，下面详细介绍它们的操作流程。
- 使用phpMyAdmin管理数据库
1. 启动WampServer，确保其正常运行，图标在任务栏显示且指示灯为绿色。
2. 打开WampServer控制台，在控制台中找到并点击“phpMyAdmin”选项。
3. 点击后会自动打开默认浏览器，显示phpMyAdmin的登录界面。默认情况下，用户名和密码可能为空或为“root”，具体取决于安装时的设置。输入正确的用户名和密码登录。
4. 登录成功后，即可看到数据库管理界面。在该界面中，可以进行以下操作：
- 创建数据库：点击界面左侧的“新建”按钮，输入数据库名称，选择字符集和排序规则后，点击“创建”即可创建新的数据库。
- 删除数据库：在左侧数据库列表中，选择要删除的数据库，点击数据库名称后面的“删除”按钮，在弹出的确认对话框中点击“确定”即可删除数据库。
- 创建和查询表：进入具体的数据库后，点击“SQL”选项卡，在输入框中输入创建表的SQL语句，如“CREATE TABLE test_table ( id int(11) NOT NULL AUTO_INCREMENT, name varchar(255) NOT NULL, PRIMARY KEY ( id )) ENGINE=InnoDB DEFAULT CHARSET=utf8;”，点击“执行”按钮即可创建表。查询表数据时，同样在“SQL”选项卡中输入查询语句，如“SELECT * FROM test_table ;”，点击“执行”查看查询结果。
- 管理用户和权限：点击界面上方的“用户账户”选项卡，在该页面可以进行用户的创建、删除、权限设置等操作。例如，创建新用户时，点击“添加用户账户”按钮，输入用户名、主机、密码等信息，选择相应的权限后，点击“执行”完成用户创建。
- 使用MySQL Connector for .NET在Visual Studio中管理数据库
1. 确保已经安装了兼容版本的Visual Studio和VS.Php。
2. 从http://dev.mysql.com/downloads/connector/net 下载并安装MySQL Connector for .NET。
3. 打开Visual Studio，在“视图”菜单中选择“服务器资源管理器”。
4. 在“服务器资源管理器”中，右键点击“数据连接”，选择“添加连接”。
5. 在“添加连接”对话框中，选择“MySQL数据库”，点击“更改”按钮，在弹出的“更改数据源”对话框中选择“MySQL数据提供程序”，点击“确定”。
6. 输入服务器名称、用户名、密码等连接信息，点击“测试连接”按钮，确保连接成功。
7. 连接成功后，点击“确定”，即可在“服务器资源管理器”中看到连接的数据库。在该界面中，可以进行创建、删除表，执行SQL查询等操作，操作方式与在phpMyAdmin中类似，但界面是在Visual Studio内。

6. 常见问题及解决方法

在搭建Drupal开发环境和进行模块部署过程中，可能会遇到一些常见问题，以下是一些问题及解决方法的总结：
| 问题 | 可能原因 | 解决方法 |
| ---- | ---- | ---- |
| WampServer安装失败 | Skype占用端口80、系统缺少必要依赖库等 | 关闭Skype；检查系统是否安装了必要的运行库，如Visual C++ Redistributable等 |
| WampServer启动后Apache未启动 | 端口80被其他应用占用、配置文件错误等 | 通过WampServer控制台的“测试端口80”选项检查占用情况，若为IIS占用，关闭IIS默认网站；检查Apache配置文件是否存在语法错误 |
| VS.Php安装后无法正常使用 | Visual Studio版本不兼容、VS.Php安装文件损坏等 | 确保安装的是兼容版本的Visual Studio；重新下载并安装VS.Php |
| 数据库连接失败 | 用户名、密码错误，服务器地址错误等 | 检查数据库连接信息是否正确，可在phpMyAdmin或MySQL Connector for .NET中测试连接 |

7. 最佳实践与建议

为了更高效地进行Drupal模块开发和部署，以下是一些最佳实践和建议：
- 代码管理 ：使用版本控制系统（如Git）来管理代码，方便团队协作和代码回溯。可以在本地创建代码仓库，将开发的模块代码上传到远程仓库（如GitHub、GitLab等）。
- 定期备份 ：定期备份数据库和代码，以防数据丢失或代码损坏。可以编写脚本定期自动备份数据库和代码文件。
- 持续测试 ：在开发过程中，持续编写和执行测试用例，确保模块的功能正常。可以使用PHPUnit等测试框架进行单元测试和集成测试。
- 遵循社区规范 ：遵循Drupal社区的规范和最佳实践，编写高质量、可维护的代码。参考Drupal官方文档和社区论坛，学习其他开发者的经验和技巧。

8. 总结

通过本文的介绍，我们了解了Drupal模块部署过程中 .install 文件和更新的注意事项，以及如何将模块交付给用户。同时，详细介绍了在Windows环境下搭建Drupal开发环境的步骤，包括安装WampServer、选择开发环境、配置Visual Studio和VS.Php，以及数据库管理和常见问题解决方法等内容。希望这些信息能够帮助开发者在Windows平台上顺利进行Drupal模块的开发和部署。

以下是整个开发和部署过程的总结流程图：

graph LR
    A[开始Drupal开发] --> B[了解模块部署注意事项]
    B --> C[创建模块并编写文档]
    C --> D[选择模块交付方式]
    D --> E[搭建Windows开发环境]
    E --> F[安装WampServer]
    F --> G{WampServer正常运行?}
    G -- 是 --> H[选择开发环境]
    G -- 否 --> I[解决WampServer问题]
    I --> F
    H --> J[安装VS.Php（若选择）]
    J --> K[配置Visual Studio和VS.Php]
    K --> L[管理数据库]
    L --> M[进行模块开发和测试]
    M --> N[部署模块]
    N --> O[持续维护和优化]

按照以上步骤和建议，开发者可以在Windows环境下构建一个稳定、高效的Drupal开发和部署环境，为开发出高质量的Drupal模块奠定基础。