如何在Laravel薪资系统中实现薪资字段计算公式自定义？

1. 数据库设计 #

首先需要存储用户自定义的公式，创建payroll_formulas表来保存每个用户（或全局）对应薪资字段的计算公式：

// 生成迁移文件：php artisan make:migration create_payroll_formulas_table
Schema::create('payroll_formulas', function (Blueprint $table) {
    $table->id();
    $table->foreignId('user_id')->constrained()->onDelete('cascade'); // 按用户区分公式，全局公式可移除该字段
    $table->string('field_name'); // 对应薪资字段，如housing_allowance、transport_allowance
    $table->text('formula'); // 用户输入的公式字符串，如"basic_salary * 0.12"
    $table->boolean('is_active')->default(true);
    $table->timestamps();
    $table->unique(['user_id', 'field_name']); // 确保每个用户每个字段仅存一条有效公式
});

2. 模型与关联 #

创建PayrollFormula模型并设置关联：

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;

class PayrollFormula extends Model
{
    protected $fillable = ['user_id', 'field_name', 'formula', 'is_active'];

    public function user(): BelongsTo
    {
        return $this->belongsTo(User::class);
    }
}

在User模型中添加关联：

public function payrollFormulas()
{
    return $this->hasMany(PayrollFormula::class);
}

3. 公式解析与计算逻辑 #

使用symfony/expression-language组件安全解析执行用户输入的公式（Laravel默认已集成该组件），在Payroll模型中实现计算逻辑：

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Symfony\Component\ExpressionLanguage\ExpressionLanguage;

class Payroll extends Model
{
    // ... 原有模型代码

    protected static function booted()
    {
        // 替换原有硬编码的creating/updating逻辑
        static::creating(fn (Payroll $payroll) => $payroll->calculateCustomFields());
        static::updating(fn (Payroll $payroll) => $payroll->calculateCustomFields());
    }

    // 批量计算需要自定义的薪资字段
    private function calculateCustomFields()
    {
        $fields = ['housing_allowance', 'transport_allowance', 'bonus']; // 需计算的字段列表
        foreach ($fields as $field) {
            $this->$field = $this->calculateField($field);
        }
    }

    // 单个字段计算逻辑：优先用自定义公式，无则用默认逻辑
    public function calculateField(string $fieldName)
    {
        // 获取当前用户启用的自定义公式
        $formula = PayrollFormula::where('user_id', auth()->id())
            ->where('field_name', $fieldName)
            ->where('is_active', true)
            ->value('formula');

        // 无自定义公式时执行默认逻辑
        if (!$formula) {
            return $this->getDefaultFieldValue($fieldName);
        }

        // 安全解析执行公式
        $expressionLanguage = new ExpressionLanguage();
        // 传入Payroll模型的所有属性作为公式变量，可额外添加全局常量
        $variables = array_merge($this->attributes, [
            'tax_rate' => 0.05,
            'daily_wage' => $this->basic_salary / 22
        ]);

        try {
            return $expressionLanguage->evaluate($formula, $variables);
        } catch (\Exception $e) {
            // 公式执行出错时返回默认值，可根据需求抛出异常或提示用户
            return $this->getDefaultFieldValue($fieldName);
        }
    }

    // 原有硬编码的默认计算公式
    private function getDefaultFieldValue(string $fieldName)
    {
        return match ($fieldName) {
            'housing_allowance' => $this->basic_salary * 0.1,
            'transport_allowance' => $this->work_days * 50,
            'bonus' => $this->basic_salary * 0.05,
            default => 0,
        };
    }
}

4. 前端公式配置页面 #

提供表单让用户输入自定义公式，同时提示可用变量：

<form action="{{ route('payroll-formulas.store') }}" method="POST">
    @csrf
    <div class="form-group">
        <label>住房补贴公式</label>
        <input type="text" 
               name="formulas[housing_allowance]" 
               class="form-control"
               value="{{ old('formulas.housing_allowance', auth()->user()->payrollFormulas->where('field_name', 'housing_allowance')->first()?->formula ?? 'basic_salary * 0.1') }}">
        <small class="text-muted">可用变量：basic_salary, work_days, tax_rate, daily_wage</small>
    </div>

    <div class="form-group mt-3">
        <label>交通补贴公式</label>
        <input type="text" 
               name="formulas[transport_allowance]" 
               class="form-control"
               value="{{ old('formulas.transport_allowance', auth()->user()->payrollFormulas->where('field_name', 'transport_allowance')->first()?->formula ?? 'work_days * 50') }}">
    </div>

    <button type="submit" class="btn btn-primary mt-3">保存公式</button>
</form>

5. 控制器处理公式保存 #

编写控制器方法处理公式的新增/更新：

namespace App\Http\Controllers;

use App\Models\PayrollFormula;
use Illuminate\Http\Request;

class PayrollFormulaController extends Controller
{
    public function store(Request $request)
    {
        $validated = $request->validate([
            'formulas.*' => 'required|string',
        ]);

        foreach ($validated['formulas'] as $fieldName => $formula) {
            PayrollFormula::updateOrCreate(
                ['user_id' => auth()->id(), 'field_name' => $fieldName],
                ['formula' => $formula, 'is_active' => true]
            );
        }

        return back()->with('success', '公式已成功保存');
    }
}

安全注意事项 #

• 禁止使用eval()执行用户输入的公式，必须使用ExpressionLanguage这类安全的表达式解析器，限制可执行的变量和函数。
• 前端可添加公式实时验证，比如通过AJAX调用后端接口检查公式语法是否合法。
• 可限制用户输入的公式只能使用指定的变量，避免非法变量注入。

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