Laravel自定义Mailable主题导致其他邮件样式混乱问题

问题背景 #

在Laravel项目中，我创建了继承TablerMailable的邮件类来使用自定义Tabler主题，但发现发送这类邮件后，直接继承原生Mailable的邮件（如注册通知）样式会被自动改成Tabler主题，导致样式混乱。

相关代码 #

TablerMailable基类

class TablerMailable extends Mailable
{
    use Queueable, SerializesModels;

    /**
     * Instruct to use tabler theme.
     *
     * @var string
     */
    public $theme = 'tabler';

    /**
     * Build the Markdown view for the message.
     *
     * @return array
     */
    protected function buildMarkdownView()
    {
        $markdown = Container::getInstance()->make(Markdown::class);
        $markdown->loadComponentsFrom([resource_path('views/vendor/tabler-mail')]);

        if (isset($this->theme)) {
            $markdown->theme($this->theme);
        }
        
        $data = $this->buildViewData();

        $views= [
            'html' => $markdown->render($this->markdown, $data),
            'text' => $this->buildMarkdownText($markdown, $data),
        ];
        
        return $views;
    }
}

使用自定义主题的DailyUpdate邮件

class DailyUpdate extends TablerMailable
{
    use Queueable, SerializesModels;

    public $user;
    
    public function __construct(User $user)
    {
        $this->user = $user;
    }
    
    public function build()
    {
      return $this->markdown('emails.marketing.daily-update-notification');
    }
}

原生Mailable的UserRegistered邮件

class UserRegistered extends Mailable
{
    use Queueable, SerializesModels;

    public $user;
    
    public function __construct(User $user)
    {
        $this->user = $user;
    }
    
    public function build()
    {
      return $this->markdown('emails.new-users');
    }
}

问题原因 #

Laravel容器中，Markdown类是单例绑定的。当TablerMailable的buildMarkdownView方法从容器获取Markdown实例并调用loadComponentsFrom()和theme()时，这些修改会作用于全局的单例实例。后续所有使用Markdown的邮件（包括直接继承原生Mailable的UserRegistered）都会复用这个已经被修改配置的实例，从而导致样式被强制切换为Tabler主题。

解决方案 #

要避免全局单例被修改，我们需要为TablerMailable创建独立的Markdown实例，而不是复用容器中的单例。修改TablerMailable的buildMarkdownView方法如下：

use Illuminate\Mail\Markdown;
use Illuminate\View\Compilers\BladeCompiler;
use Illuminate\View\Factory;
use Illuminate\Filesystem\Filesystem;

class TablerMailable extends Mailable
{
    use Queueable, SerializesModels;

    public $theme = 'tabler';

    protected function buildMarkdownView()
    {
        // 创建全新的Markdown实例，而非使用容器单例
        $markdown = new Markdown(
            $this->container->make(BladeCompiler::class),
            $this->container->make(Factory::class),
            $this->container->make(Filesystem::class)
        );
        
        $markdown->loadComponentsFrom([resource_path('views/vendor/tabler-mail')]);

        if (isset($this->theme)) {
            $markdown->theme($this->theme);
        }
        
        $data = $this->buildViewData();

        return [
            'html' => $markdown->render($this->markdown, $data),
            'text' => $this->buildMarkdownText($markdown, $data),
        ];
    }
}

原理说明 #

通过直接实例化Markdown类，我们为每封Tabler主题邮件创建独立的配置上下文，不会污染全局的Markdown单例。这样，原生Mailable邮件依然会使用默认的Markdown配置，样式不会被干扰。

验证 #

发送DailyUpdate邮件后，再触发UserRegistered邮件，后者将恢复使用Laravel默认邮件主题，样式正常显示。

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