Laravel 最佳实践

单一职责原则

一个类和一个方法应该只有一个责任。

public function getFullNameAttribute()
{
    return $this->isVerifiedClient() ? $this->getFullNameLong() : $this->getFullNameShort();
}
public function isVerifiedClient()
{
    return auth()->user() && auth()->user()->hasRole('client') && auth()->user()->isVerified();
}
public function getFullNameLong()
{
    return 'Mr. ' . $this->first_name . ' ' . $this->middle_name . ' ' . $this->last_name;
}
public function getFullNameShort()
{
    return $this->first_name[0] . '. ' . $this->last_name;
}

保持控制器的简洁

如果您使用的是查询生成器或原始 SQL 查询，请将所有与数据库相关的逻辑放入 Eloquent 模型或 Repository 类中。

public function index()
{
    return view('index', ['clients' => $this->client->getWithNewOrders()]);
}
class Client extends Model
{
    public function getWithNewOrders()
    {
        return $this->verified()
            ->with(['orders' => function ($q) {
                $q->where('created_at', '>', Carbon::today()->subWeek());
            }])
            ->get();
    }
}

使用自定义 Request 类来进行验证

把验证规则放到 Request 类中。

public function store(PostRequest $request)
{    
    ....
}
class PostRequest extends Request
{
    public function rules()
    {
        return [
            'title' => 'required|unique:posts|max:255',
            'body' => 'required',
            'publish_at' => 'nullable|date',
        ];
    }
}

业务代码要放到服务层中

控制器必须遵循单一职责原则，因此最好将业务代码从控制器移动到服务层中。

public function store(Request $request)
{
    $this->articleService->handleUploadedImage($request->file('image'));
    ....
}
class ArticleService
{
    public function handleUploadedImage($image)
    {
        if (!is_null($image)) {
            $image->move(public_path('images') . 'temp');
        }
    }
}

DRY 原则，不要重复自己

尽可能重用代码，SRP 可以帮助您避免重复造轮子。 此外尽量重复使用 Blade 模板，使用 Eloquent 的 scopes 方法来实现代码。

public function scopeActive($q)
{
    return $q->where('verified', 1)->whereNotNull('deleted_at');
}
public function getActive()
{
    return $this->active()->get();
}
public function getArticles()
{
    return $this->whereHas('user', function ($q) {
            $q->active();
        })->get();
}

使用 ORM 而不是纯 SQL 语句，使用集合而不是数组

使用 Eloquent 可以帮您编写可读和可维护的代码。 此外 Eloquent 还有非常优雅的内置工具，如软删除，事件，范围等。

Article::has('user.profile')->verified()->latest()->get();

集中处理数据

$category->article()->create($request->validated());

不要在模板中查询，尽量使用惰性加载

$users = User::with('profile')->get();
...
@foreach ($users as $user)
    {{ $user->profile->name }}
@endforeach

注释你的代码，但是更优雅的做法是使用描述性的语言来编写你的代码

if ($this->hasJoins())

不要把 JS 和 CSS 放到 Blade 模板中，也不要把任何 HTML 代码放到 PHP 代码里

let article = $('#article').val();
<input id="article" type="hidden" value='@json($article)'>
Or
<button class="js-fav-article" data-article='@json($article)'>{{ $article->name }}<button>

在代码中使用配置、语言包和常量，而不是使用硬编码

public function isNormal()
{
  return $article->type === Article::TYPE_NORMAL;
}

return back()->with('message', __('app.article_added'));

使用社区认可的标准 Laravel 工具

强力推荐使用内置的 Laravel 功能和扩展包，而不是使用第三方的扩展包和工具。 如果你的项目被其他开发人员接手了，他们将不得不重新学习这些第三方工具的使用教程。 此外，当您使用第三方扩展包或工具时，你很难从 Laravel 社区获得什么帮助。

遵循 Laravel 命名约定

尽可能使用简短且可读性更好的语法

使用 IOC 容器来创建实例，而不是直接 new 一个实例

创建新的类会让类之间更加耦合，使得测试越发复杂。请改用 IoC 容器或注入来实现。

public function __construct(User $user)
{
    $this->user = $user;
}

....

$this->user->create($request->validated());

避免直接从 .env 文件里获取数据

将数据传递给配置文件，然后使用 config() 帮助函数来调用数据。

// config/api.php
'key' => env('API_KEY'),

// Use the data
$apiKey = config('api.key');

使用标准格式来存储日期，用访问器和修改器来修改日期格式

// Model
protected $dates = ['ordered_at', 'created_at', 'updated_at'];
public function getSomeDateAttribute($date)
{
    return $date->format('m-d');
}

// View
{{ $object->ordered_at->toDateString() }}
{{ $object->ordered_at->some_date }}

其他的一些好建议

永远不要在路由文件中放任何的逻辑代码。
尽量不要在 Blade 模板中写原始 PHP 代码。