返回

Laravel 动态修改时区：三种实用方案解析

php

Laravel 中动态修改时区

开发过程中遇到一个需求，管理员能在后台通过下拉框选择时区（如 PT, CST 等），选择后整个管理面板显示的时间要立刻按照新时区进行调整。问题来了，怎么根据管理员的选择，动态更改 Laravel 应用的时区配置 (config/app.php 中的 timezone 项)？

问题分析

Laravel 默认的时区配置是写死在 config/app.php 文件里的。直接修改这个文件不现实，因为这需要修改代码文件，重新部署。我们需要一种不用改代码，就能即时生效的方法。

问题的关键在于，Laravel 应用启动后，配置项就被加载到内存中了。我们需要在运行时修改这些配置项，并让框架使用新的时区设置。

解决方案

这里提供了几种方法，从简单到复杂，大家按需取用：

方案一：Config::set() + 中间件

这是最直接的方案。通过 Config::set() 可以在运行时设置配置项，然后利用中间件在每个请求中设置应用的时区。

  1. 创建中间件：

    php artisan make:middleware SetTimezone

  2. 中间件代码 (app/Http/Middleware/SetTimezone.php)：

    <?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\Date;

class SetTimezone
{
    public function handle($request, Closure $next)
    {
        // 从 session 或数据库读取管理员设置的时区。
        // 这里假设时区设置存储在 session 的 'timezone' 键中。
        if (session()->has('timezone')) {
            $timezone = session('timezone');
            Config::set('app.timezone', $timezone);
           Date::setDefaultTimezone($timezone); //关键, 更新 Carbon/Date 默认时区.

        }

        return $next($request);
    }
}

  3. 注册中间件 ( app/Http/Kernel.php)：

    在 $middleware 或 $middlewareGroups 中注册。如果只需要在管理后台生效，可以在 $middlewareGroups 的 web 中注册：

    protected $middlewareGroups = [
    'web' => [
        // ... 其他中间件 ...
        \App\Http\Middleware\SetTimezone::class,
    ],

    // ...
];

    或者放到routeMiddleware 属性下，在路由上应用此中间件.

  4. 保存时区选择 (示例)：

    管理员选择时区后，你需要将选择的时区保存下来（比如保存到 session）。下面是一个简单的示例：

    // 在你的控制器中
public function setTimezone(Request $request)
{
    $timezone = $request->input('timezone'); // 获取用户选择的时区
    session(['timezone' => $timezone]);      // 将时区保存在 session 中

    return redirect()->back()->with('success', '时区设置成功！');
}

原理和作用:

  • Config::set('app.timezone', $timezone)：动态修改了应用的 timezone 配置。
  • Date::setDefaultTimezone($timezone): 更新 Carbon 和 原生 date_default_timezone_set() 使用的默认时区，确保新请求时间计算都使用此新时区.
  • 中间件：保证每个请求都读取并设置了最新的时区。

安全提示：
务必对用户提交的时区值进行校验, 只允许合法的时区字符串 (例如通过timezone_identifiers_list()获得的列表).防止恶意用户提交非法值导致错误.

方案二：自定义 Date/Carbon 类

这个方法稍微复杂些，它不直接修改全局配置，而是通过创建自定义的日期/时间类来控制时区的显示。

  1. 创建自定义 TimeService 类:
<?php

namespace App\Services;
use Carbon\Carbon;
use Illuminate\Support\Facades\Date;

class TimeService
{

    public function now($timezone = null)
    {
    	   $tz = $timezone ?? $this->getUserTimezone();
        return Date::now($tz);
    }
   public function parse($time,$timezone=null){
     	   $tz = $timezone ?? $this->getUserTimezone();
        return Date::parse($time,$tz);
   }
  protected function getUserTimezone()
  {
  	  //获取用户自定义时区, 比如从Session, 数据库等等.
  	  //这里做个演示，如果获取不到, 使用默认的。
  	  return  session('timezone', config('app.timezone'));
  }

    // ... 你可以在这里添加更多常用的日期/时间处理方法，并使用用户设置的时区 ...
     public function format($date, $format,$timezone=null)
    {
	     $tz = $timezone ?? $this->getUserTimezone();

	       if (! $date instanceof \DateTimeInterface) {
            $date = new Carbon($date); //Or Date::parse()
       	 }
       return  $date->tz($tz)->format($format);
    }
}
  1. ** 在需要显示时间的地方，调用 TimeService:**
 //假设你已把 TimeService 注册到 Service Container. (AppServiceProvider)

  /** @var  \App\Services\TimeService $timeService*/
  $timeService = app(\App\Services\TimeService::class);

  echo  "当前时间: ". $timeService->now();
  //或者用你自己的方式格式化输出时间
   echo "创建时间: " . $timeService->format($model->created_at, 'Y-m-d H:i:s');

原理和作用：

这个方案的思路是，创建一个服务类去专门处理时间。避免了污染全局配置。更灵活地控制时间显示格式和时区。

安全提示： 和方案一相同。

方案三: .env + 数据库配置 (进阶)

此方案可用于你不想使用Session，而是通过.env 文件或者 数据库表保存时区.

  1. .env+ Config :

如果你用.env文件来存配置，那么不能直接改.env文件，因为Laravel加载.env文件只在应用初始化的时候加载一次，修改后不会立即生效。 但是可以修改 config.

//.env 文件可以设置一个默认时区
APP_TIMEZONE=UTC

//config/app.php 中，使用 env 函数获取：
'timezone' => env('APP_TIMEZONE', 'UTC'),

更新的时候, 可以借助Config::set()。 （参考前面方案）。

  1. 数据库表 + Config:
    比上面 .env 更好的是将配置存在数据库表中。可以随时变更。

    1. 新建配置表( settings 表为例, 单行配置):
    php artisan make:migration create_settings_table

     // database/migrations/xxxx_create_settings_table.php
 use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;

   return new class extends Migration
   {
    public function up(): void
     {
 		  Schema::create('settings', function (Blueprint $table) {
      		 $table->string('key')->unique();
       	$table->string('value')->nullable();
  		 });

  		 //初始化默认配置
 		  DB::table('settings')->insert([
       	['key' => 'app_timezone', 'value' => 'UTC'],            
  		 ]);
   }
}

  2. 修改配置： `config/app.php`

  ```php
    // 从数据库读取配置.  如果读取失败或者没有数据，则用 'UTC' 作为默认值.
   'timezone' => \App\Models\Setting::getValueByKey('app_timezone', 'UTC'),
  ```
    假设你已经有一个`Setting` Model 以及对应的`getValueByKey()`方法从`settings`表中读取配置。

    ```php
      //app/Models/Setting.php 示例.
 	namespace App\Models;
 	use Illuminate\Database\Eloquent\Model;
    use Illuminate\Support\Facades\Cache;

 	class Setting extends Model
 	{
 		  public $timestamps = false; //不需要时间戳
			 protected $primaryKey = 'key';// 主键是 key
 		  public $incrementing = false;//主键不是自增
 		 protected $fillable = ['key','value'];

			 public static function getValueByKey($key, $default = null)
 		  {
    		 // 使用缓存, 提高性能 (缓存1小时)
    		 return Cache::remember('setting_'.$key, 60, function () use ($key, $default) {
        		 $setting = self::find($key);
        		 return $setting ? $setting->value : $default;
   		  });
			 }
 
 	}
 	```
 3. 更新数据库配置：
 当你需要更新时区，更新`settings`表中的值，同时清除对应的缓存：
 	```php
     	//  $timezone 为新的时区
       $setting = \App\Models\Setting::find('app_timezone');
      if(!$setting){
       	$setting =  new \App\Models\Setting(['key'=>'app_timezone']);
      }
    	$setting->value = $timezone;
     $setting->save();
     \Illuminate\Support\Facades\Cache::forget('setting_app_timezone'); //删除旧配置缓存
  	//更新默认的Date/Carbon 的时区.
 	\Illuminate\Support\Facades\Date::setDefaultTimezone($timezone);
		```

**原理和作用：** 
通过数据库管理配置有更大的灵活度,更方便进行修改. 而且利用了缓存，优化性能.

**安全提示：** 
同前面的方案，需要对输入时区字符串进行校验。

### 总结

修改时区的方法很多, 具体看项目的复杂度和自己的喜好.  通常使用中间件配合 Session/数据库的方式比较多。进阶的话，使用服务类,或从数据库读取，更能体现代码的设计能力。