Laravel 的十八个最佳实践

摘要：本文翻译改编自的十八个最佳实践这篇文章并不是什么由改编的原则模式等。只是为了让你注意你在现实生活的项目中最常忽略的内容。单一职责原则正在帮助你避免重复。当然，这也包括了模板的范围等。此外，也拥有很棒的内置工具，比如软删除事件范围等。

本文翻译改编自 Laravel 的十八个最佳实践

这篇文章并不是什么由 Laravel 改编的 SOLID 原则、模式等。

只是为了让你注意你在现实生活的 Laravel 项目中最常忽略的内容。

一个类和一个方法应该只有一个职责。
错误的做法：

public function getFullNameAttribute()
{
    if (auth()->user() && auth()->user()->hasRole("client") && auth()->user()->isVerified()) {
        return "Mr. " . $this->first_name . " " . $this->middle_name . " " $this->last_name;
    } else {
        return $this->first_name[0] . ". " . $this->last_name;
    }
}

推荐的做法：

public function getFullNameAttribute()
{
    return $this->isVerifiedClient() ? $this->getFullNameLong() : $this->getFullNameShort();
}

public function isVerfiedClient()
{
    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 模型或存储库类中。

坏：

public function index()
{
    $clients = Client::verified()
        ->with(["orders" => function ($q) {
            $q->where("created_at", ">", Carbon::today()->subWeek());
        }])
        ->get();

    return view("index", ["clients" => $clients]);
}

好：

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();
    }
}

将验证从控制器移动到请求类。

很常见但不推荐的做法：

public function store(Request $request)
{
    $request->validate([
        "title" => "required|unique:posts|max:255",
        "body" => "required",
        "publish_at" => "nullable|date",
    ]);

    ....
}

最好是这样：

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)
{
    if ($request->hasFile("image")) {
        $request->file("image")->move(public_path("images") . "temp");
    }
    
    ....
}

好：

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");
        }
    }
}

尽可能重用代码。 SRP（单一职责原则）正在帮助你避免重复。当然，这也包括了 Blade 模板、Eloquent 的范围等。

坏：

public function getActive()
{
    return $this->where("verified", 1)->whereNotNull("deleted_at")->get();
}

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

好：

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();
}

Eloquent 可以编写可读和可维护的代码。此外，Eloquent 也拥有很棒的内置工具，比如软删除、事件、范围等。

比如你这样写：

SELECT *
FROM `articles`
WHERE EXISTS (SELECT *
              FROM `users`
              WHERE `articles`.`user_id` = `users`.`id`
              AND EXISTS (SELECT *
                          FROM `profiles`
                          WHERE `profiles`.`user_id` = `users`.`id`) 
              AND `users`.`deleted_at` IS NULL)
AND `verified` = "1"
AND `active` = "1"
ORDER BY `created_at` DESC

还不如这样写：

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

比如你这样写：

$article = new Article;
$article->title = $request->title;
$article->content = $request->content;
$article->verified = $request->verified;
// Add category to article
$article->category_id = $category->id;
$article->save();

是不是还不如这样写：

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

不好的地方在于，这对于100 个用户来说，等于执行 101 个 DB 查询：

[@foreach](https://laravel-china.org/users/5651) (User::all() as $user)
    {{ $user->profile->name }}
@endforeach

下面的做法，对于 100 个用户来说，仅仅只执行 2 个 DB 查询：

$users = User::with("profile")->get();

...

[[@foreach](https://laravel-china.org/users/5651)](https://laravel-china.org/users/5651) ($users as $user)
    {{ $user->profile->name }}
@endforeach

坏：

if (count((array) $builder->getQuery()->joins) > 0)

好：

// 确定是否有任何连接。
if (count((array) $builder->getQuery()->joins) > 0)

最好：

if ($this->hasJoins())

坏：

let article = `{{ json_encode($article) }}`;

好：

Or

{{ $article->name }}

最好的方法是使用在 Javascript 中这样来传输数据：

let article = $("#article").val();

坏：

public function isNormal()
{
    return $article->type === "normal";
}

return back()->with("message", "Your article has been added!");

好：

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

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

最好使用内置的 Laravel 功能和社区软件包，而不是其他第三方软件包和工具。因为将来与你的应用程序一起工作的开发人员都需要学习新的工具。另外，使用第三方软件包或工具的话，如果遇到困难，从 Laravel 社区获得帮助的机会会大大降低。不要让你的客户为此付出代价！

遵循 PSR 标准。 另外，请遵循 Laravel 社区接受的命名约定：

坏：

$request->session()->get("cart");
$request->input("name");

好：

session("cart");
$request->name;

更多示例：

新的 Class 语法创建类时，不仅使得类与类之间紧密耦合，还加重了测试的复杂度。推荐改用 IoC 容器或 facades。

坏：

$user = new User;
$user->create($request->all());

好：

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

....

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

将数据传递给配置文件，然后使用辅助函数 config() 在应用程序中使用数据。

坏：

$apiKey = env("API_KEY");

好：

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

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

坏：

{{ Carbon::createFromFormat("Y-d-m H-i", $object->ordered_at)->toDateString() }}
{{ Carbon::createFromFormat("Y-d-m H-i", $object->ordered_at)->format("m-d") }}

好：

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

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

千万不要在路由文件中放置任何逻辑。

在 Blade 模板中最小化 vanilla PHP 的使用。

更多现代化 PHP 知识，请前往 Laravel / PHP 知识社区