Yii2-DynaGrid修改列属性后列隐藏，需实现自动修复

问题原因 #

DynaGrid会将每个用户的个性化列配置（可见性、宽度等）存储在数据库中，默认通过列的attribute、class等属性作为唯一标识匹配列。当你修改这些标识属性后，系统会把该列判定为「新列」，默认隐藏，而旧的列配置仍留在数据库中但无法匹配，导致用户需要手动调整。

解决方案 #

方案1：批量更新现有用户的个性化配置（一次性处理） #

如果是一次性修改列属性，可以写脚本遍历所有用户的DynaGrid配置，将旧的列属性替换为新值，确保配置与新列匹配。

假设用户配置存储在user_settings表（字段key为DynaGrid唯一标识，value为JSON格式的配置）：

// 替换为你的DynaGrid标识，比如'dynagrid_user_list'
$dynagridKey = 'dynagrid_your_grid_id';
$settings = \app\models\UserSettings::find()->where(['key' => $dynagridKey])->all();

foreach ($settings as $setting) {
    $config = json_decode($setting->value, true);
    if (!isset($config['columns'])) continue;

    foreach ($config['columns'] as &$col) {
        // 示例：将旧attribute替换为新值，同步更新header/label
        if ($col['attribute'] === 'old_attribute') {
            $col['attribute'] = 'new_attribute';
            $col['header'] = '新表头文本';
            $col['label'] = '新标签文本';
        }
        // 示例：替换列的class
        if ($col['class'] === 'app\grid\OldColumnClass') {
            $col['class'] = 'app\grid\NewColumnClass';
        }
    }

    $setting->value = json_encode($config);
    $setting->save(false); // 跳过验证，快速更新
}

执行这个脚本后，所有用户的配置会同步更新，打开页面时列会自动保持可见。

方案2：自定义DynaGrid列匹配逻辑（长期避免问题） #

通过给每个列添加自定义唯一id，让DynaGrid基于id匹配列，而不是默认的attribute或class，这样后续修改列属性不会影响用户配置。

步骤1：给列添加自定义id

在DynaGrid的列配置中，给每个列加上唯一id：

echo \kartik\dynagrid\DynaGrid::widget([
    'columns' => [
        [
            'id' => 'user_name_column', // 自定义唯一ID，不要修改
            'attribute' => 'username',
            'header' => '用户名',
            // 其他属性可随意修改
        ],
        [
            'id' => 'user_email_column',
            'attribute' => 'email',
            'header' => '邮箱',
        ],
        // 其他列
    ],
    // 其他DynaGrid配置
]);

步骤2：重写DynaGrid类，基于id匹配列

创建自定义DynaGrid类，覆盖默认的用户配置加载逻辑：

namespace app\components;

use kartik\dynagrid\DynaGrid as BaseDynaGrid;

class DynaGrid extends BaseDynaGrid
{
    protected function loadUserSettings()
    {
        parent::loadUserSettings();
        
        if (empty($this->_userSettings['columns']) || empty($this->columns)) {
            return;
        }

        // 将用户配置的列按id索引
        $userColsById = [];
        foreach ($this->_userSettings['columns'] as $col) {
            if (isset($col['id'])) {
                $userColsById[$col['id']] = $col;
            }
        }

        // 匹配当前列与用户配置，同步可见性等设置
        foreach ($this->columns as &$col) {
            if (isset($col['id']) && isset($userColsById[$col['id']])) {
                $userCol = $userColsById[$col['id']];
                // 同步可见性
                $col['visible'] = $userCol['visible'] ?? true;
                // 可同步其他配置：宽度、排序优先级等
                $col['width'] = $userCol['width'] ?? $col['width'] ?? '';
            }
        }
    }
}

步骤3：使用自定义DynaGrid类

后续页面中使用你自定义的类代替官方类：

echo \app\components\DynaGrid::widget([
    // 你的配置
]);

这样以后无论修改列的attribute、header等属性，只要id不变，系统就能正确匹配用户的原有配置，列不会被自动隐藏。

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