Drupal 8模块开发：检测开发环境URL并执行配置调整

Hey Chris, 我之前做过类似的Drupal环境自动配置工具，给你梳理几个关键方向，应该能帮到你：

一、站点环境检测的两种靠谱方式 #

你提到的检测URL是可行的，但还有更灵活的方案，两种都给你列出来：

• URL检测方案：直接获取当前站点的主机名，和预设的开发环境域名对比，代码示例：

  // 预设开发环境域名列表
  $dev_hosts = ['dev.yoursite.local', 'staging.yoursite.com'];
  $current_host = \Drupal::request()->getHost();
  $is_dev = in_array($current_host, $dev_hosts);
  

• 配置文件标记方案：更推荐在settings.php里定义环境标识，比如：

  // settings.php中添加
  $settings['my_module_is_dev'] = TRUE;
  

  然后在模块里读取这个配置：

  $is_dev = \Drupal::service('settings')->get('my_module_is_dev', FALSE);
  

  这种方式不用把域名硬编码在模块里，后期调整更方便。

二、开发环境自动配置的核心实现 #

确定是开发环境后，就可以执行你需要的配置操作了：

1. 自动安装Devel模块 #

用Drupal自带的模块安装API，建议在模块启用时执行（避免每次请求都跑），示例代码放在模块的.module文件里：

/**
 * Implements hook_install().
 */
function my_dev_config_install() {
  $is_dev = \Drupal::service('settings')->get('my_module_is_dev', FALSE);
  if ($is_dev) {
    $module_installer = \Drupal::service('module_installer');
    // 检查Devel是否已安装，避免重复操作
    if (!$module_installer->install(['devel'], TRUE)) {
      \Drupal::messenger()->addWarning('Devel模块安装失败，请手动检查');
    }
  }
}

2. 关闭缓存&调整开发相关配置 #

同样在hook_install()或者自定义的配置同步逻辑里执行，示例：

if ($is_dev) {
  // 关闭页面缓存
  \Drupal::configFactory()->getEditable('system.performance')
    ->set('cache.page.max_age', 0)
    ->save();
  
  // 禁用动态页面缓存
  \Drupal::configFactory()->getEditable('system.performance')
    ->set('cache.dynamic_page_cache.enabled', FALSE)
    ->save();
  
  // 开启详细错误日志
  \Drupal::configFactory()->getEditable('system.logging')
    ->set('error_level', 'verbose')
    ->save();
}

三、避坑要点 #

• 防止重复执行：可以用Drupal的state API记录配置是否已经应用过，避免模块每次启用都重复操作：

  if ($is_dev && !\Drupal::state()->get('my_dev_config.applied')) {
    // 执行所有配置逻辑
    \Drupal::state()->set('my_dev_config.applied', TRUE);
  }
  

• 权限要求：执行模块安装和配置修改需要管理员权限，所以建议由站点管理员操作模块启用，或者用Drush命令触发配置逻辑（比如drush en my_dev_config -y）。
• 替代思路：如果不想从零写模块，也可以组合现有模块：用Environment Indicator标记环境，配合Config Split实现不同环境的配置分离，不过自定义模块的灵活性更高，完全贴合你的需求。

内容的提问来源于stack exchange，提问作者Chris Archer