SonarQube扫描Laravel代码提示EligibilityImport类实例化无用如何解决

问题原因 #

SonarQube触发这个报错的核心原因是你将全部业务逻辑都写在了EligibilityImport类的构造方法中，实例化对象后没有对生成的实例做任何赋值、调用操作，静态扫描工具无法识别构造方法里的副作用逻辑，会判定这是无意义的实例化操作。

另外把重IO、业务操作逻辑放在构造函数本身就不符合面向对象设计规范，构造函数的职责仅应该用来初始化对象属性，后续你要加日志、异常捕获、获取导入结果都会非常麻烦。

最优修复方案：重构EligibilityImport类 #

把业务逻辑从构造函数中拆分出来，单独作为公开方法对外调用：

final class EligibilityImport
{
    const MODE_APPEND = 1;
    const MODE_PURGE = 2;

    const MODES = [
        self::MODE_APPEND => 'append',
        self::MODE_PURGE => 'purge'
    ];

    /** @var string */
    protected $file;

    /** @var int */
    protected $mode;

    /** @var array */
    protected $cache = [];

    public function __construct($file, $mode = self::MODE_APPEND)
    {
        $this->file = $file;
        $this->mode = $mode;
    }

    // 将原有的process方法改为public对外暴露
    public function process()
    {
        // 原有process逻辑保持不变
        $file = $this->file;
        $mode = $this->mode;
        $path = storage_path('app/imports/' . $file);

        if (is_file($path)) {
            $csv = Reader::createFromPath($path, 'r');
            $csv->setHeaderOffset(0);

            $records = $csv->getRecords();

            foreach ($records as $record) {
                $companyName = $record['company'] ?? null;

                if ( ! empty($companyName)) {
                    $company = $this->cache['companies'][$companyName] ?? null;

                    if (empty($company)) {
                        $company = Company::where('name', $companyName)->first();

                        if ($company !== null) {
                            $this->cache['companies'][$companyName] = $company;
                        }
                    }

                    if ($company !== null) {
                        $eligibility = null;
                        $skip = false;

                        $firstName = $record['first_name'] ?? null;
                        $lastName = $record['last_name'] ?? null;
                        $email = $record['email'] ?? null;
                        $ein = $record['ein'] ?? null;

                        if ( ! empty($email)) {
                            $eligibility = $company
                                ->eligibilities()
                                ->where('email_hash', sha1($email))
                                ->first();

                            if ($eligibility !== null) {
                                $skip = true;

                                if ($mode == self::MODE_PURGE) {
                                    $eligibility->delete();
                                }
                            }
                        }

                        if ( ! empty($ein)) {
                            $eligibility = $company
                                ->eligibilities()
                                ->where('ein_hash', sha1($ein))
                                ->first();

                            if ($eligibility !== null) {
                                $skip = true;

                                if ($mode == self::MODE_PURGE) {
                                    $eligibility->delete();
                                }
                            }
                        }

                        if ($mode == self::MODE_APPEND && ! $skip) {

                            if ( ! empty($firstName) && ! empty($lastName) && ( ! empty($email) || ! empty($ein))) {
                                $eligibility = new Eligibility();
                                $eligibility->fill($record);

                                $company->eligibilities()->save($eligibility);
                            }
                        }
                    }
                }
            }

            @unlink($path);
        }
    }
}

接着修改EligibilityImportJob的handle方法：

public function handle(): void
{
    $import = new EligibilityImport($this->file, $this->mode);
    $import->process();
}

临时修复方案（不推荐） #

如果暂时不想重构原有代码，可以直接把实例赋值给一个变量骗过静态扫描，直接消除告警：

public function handle(): void
{
    // 赋值给未使用的变量即可消除SonarQube报错
    $unusedImport = new EligibilityImport($this->file, $this->mode);
}

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