如何基于基础文件批量更新衍生文件？（Git解决方案）

问题描述 #

我有一个名为base.php的基础文件，用它生成了多个不同名称的衍生文件（如file1.php、file2.php、file3.php等）。示例如下：

base.php 代码：

class Base {
    public function baseFunction1(){ 
        // do somethings 
    }
    public function baseFunction2(){ 
        // do somethings 
    }
}

项目1中的file1.php：

<?php
class File1 {
    public function baseFunction1(){ 
        // do somethings 
    }
    public function baseFunction2(){ 
        // do somethings 
    }
    // some other functions
}

项目2中的file2.php：

<?php
class File2 {
    public function baseFunction1(){ 
        // do somethings 
    }
    public function baseFunction2(){ 
        // do somethings 
    }
    // some other functions
}

现在我更新了base.php文件，请问是否有办法通过Git更新其他衍生文件？我希望无需手动对比修改所有文件。

解决方案 #

这是个典型的重复代码维护痛点，我给你几个从临时快速解决到长期架构优化的方案：

1. 用Git补丁+脚本批量同步（临时应急）

如果只是临时要同步base.php里的函数修改，可以先提取修改内容，再批量替换到衍生文件：

• 先获取base.php的修改内容，比如刚提交过修改的话，用git diff HEAD^ base.php查看变更，或者生成补丁文件：

  git diff HEAD^ base.php > base.patch
  

• 写个简单的shell脚本（比如sync-derivatives.sh），遍历所有衍生文件，把base.php里的目标函数替换进去：

  #!/bin/bash
  # 遍历所有file*.php文件
  for target_file in file*.php; do
      # 提取baseFunction1的完整内容（从函数定义到闭合花括号）
      func1_content=$(sed -n '/public function baseFunction1()/,/^}/p' base.php)
      # 替换目标文件里的baseFunction1
      sed -i "/public function baseFunction1()/,/^}/c\\$func1_content" "$target_file"
      
      # 同理处理baseFunction2
      func2_content=$(sed -n '/public function baseFunction2()/,/^}/p' base.php)
      sed -i "/public function baseFunction2()/,/^}/c\\$func2_content" "$target_file"
  done
  

• 给脚本加执行权限：chmod +x sync-derivatives.sh，运行后用git diff检查修改是否正确，没问题就提交所有衍生文件。

2. 重构代码用继承（长期最优解）

最根本的解决方法是避免重复代码——让衍生类继承Base类：

• 保留base.php不变，然后修改所有衍生文件：
  file1.php 重构后：

  <?php
  require_once 'base.php'; // 引入基础类文件
  class File1 extends Base {
      // 只保留File1独有的函数，baseFunction1和baseFunction2会自动继承
      // some other functions
  }
  

这样以后修改base.php的函数时，所有衍生类都会自动使用最新的实现，完全不用手动更新衍生文件，符合代码复用的最佳实践。

3. Git钩子自动同步（自动化方案）

如果需要每次修改base.php时自动同步，可以用Git的钩子实现自动化：

• 在项目的.git/hooks目录下创建pre-commit文件（注意没有后缀）：

  #!/bin/bash
  # 检查暂存区里是否修改了base.php
  if git diff --cached --name-only | grep -q 'base.php'; then
      # 执行同步脚本
      ./sync-derivatives.sh
      # 将更新后的衍生文件加入暂存区，一起提交
      git add file*.php
  fi
  exit 0
  

• 给钩子文件加执行权限：chmod +x .git/hooks/pre-commit
  这样每次提交base.php的修改时，钩子会自动同步所有衍生文件的对应函数，并把变更一起提交到Git。

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