laravel php,Laravel 的十八个最佳实践

最新推荐文章于 2024-07-17 10:16:57 发布
最新推荐文章于 2024-07-17 10:16:57 发布
阅读量148 收藏
点赞数
文章标签： laravel php

8de477777032cb168320b5a3abdb45e5.png

这篇文章并不是什么由 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 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 模型或存储库类中。

坏：

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');

}

}

}

不要重复你自己(DRY)

尽可能重用代码。 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 而不是 Query Builder 和原生的 SQL 查询。要优先于数组的集合

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

不要在 Blade 模板中执行查询并使用关联加载(N + 1 问题)

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

@foreach (User::all() as $user)

{{ $user->profile->name }}

@endforeach

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

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

...

@foreach ($users as $user)

{{ $user->profile->name }}

@endforeach

与其花尽心思给你的代码写注释，还不如对方法或变量写一个描述性的名称

坏：

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

好：

// 确定是否有任何连接。

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

最好：

if ($this->hasJoins())

不要把 JS 和 CSS 放在 Blade 模板中，也不要将任何 HTML 放在 PHP 类中

坏：

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

任务

标准工具

第三方工具授权

Policies

Entrust, Sentinel and other packages

前端编译

Laravel Mix

Grunt, Gulp, 3rd party packages

开发环境

Homestead

Docker

部署

Laravel Forge

Deployer and other solutions

单元测试

PHPUnit, Mockery

Phpspec

浏览器测试

Laravel Dusk

Codeception

数据库操作

Eloquent

SQL, Doctrine

模板

Blade

Twig

数据操作

Laravel collections

Arrays

表单验证

Request classes

3rd party packages, validation in controller

认证

Built-in

3rd party packages, your own solution

API 认证

Laravel Passport

3rd party JWT and OAuth packages

创建 API

Built-in

Dingo API and similar packages

数据库结构操作

Migrations

Working with DB structure directly

局部化

Built-in

3rd party packages

实时用户接口

Laravel Echo, Pusher

3rd party packages and working with WebSockets directly

Generating testing data

Seeder classes, Model Factories, Faker

Creating testing data manually

生成测试数据

Laravel Task Scheduler

Scripts and 3rd party packages

数据库

MySQL, PostgreSQL, SQLite, SQL Server

MongoDB

遵循Laravel命名约定

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

类型

规则

正确示例

错误示例Controller

单数

ArticleController

ArticlesController

Route

复数

articles/1

article/1

Named route

带点符号的蛇形命名

users.show_active

users.show-active, show-active-users

Model

单数

User

Users

hasOne or belongsTo relationship

单数

articleComment

articleComments, article_comment

All other relationships

复数

articleComments

articleComment, article_comments

Table

复数

article_comments

article_comment, articleComments

Pivot table

按字母顺序排列的单数模型名称

article_user

user_article, articles_users

Table column

带着模型名称的蛇形命名

meta_title

MetaTitle; article_meta_title

Foreign key

带_id后缀的单数型号名称

article_id

ArticleId, id_article, articles_id

Primary key

-

id

custom_id

Migration

-

2017_01_01_000_create_xx_table

2017_01_01_0000_articles

Method

小驼峰命名

getAll

get_all

Method in resource controller

store

saveArticle

Method in test class

小驼峰命名

testGuestCannotSeeArticle

test_guest_cannot_see_article

Variable

小驼峰命名

$articlesWithAuthor

$articles_with_author

Collection

具描述性的复数形式

$activeUsers = User::active()->get()

$active, $data

Object

具描述性的单数形式

$activeUser = User::active()->first()

$users, $obj

Config and language files index

蛇形命名

articles_enabled

ArticlesEnabled; articles-enabled

View

蛇形命名

show_filtered.blade.php

showFiltered.blade.php, show-filtered.blade.php

Config

蛇形命名

google_calendar.php

googleCalendar.php, google-calendar.php

Contract (interface)

形容词或名词

Authenticatable

AuthenticationInterface, IAuthentication

Trait

形容词

Notifiable

NotificationTrait

尽可能使用更短、更易读的语法

坏：

$request->session()->get('cart');

$request->input('name');

好：

session('cart');

$request->name;

更多示例：

通用语法

更短、更可读的语法Session::get('cart')

session('cart')

$request->session()->get('cart')

session('cart')

Session::put('cart', $data)

session(['cart' => $data])

$request->input('name'), Request::get('name')

$request->name, request('name')

return Redirect::back()

return back()

is_null($object->relation) ? $object->relation->id : null }

optional($object->relation)->id

return view('index')->with('title', $title)->with('client', $client)

return view('index', compact('title', 'client'))

$request->has('value') ? $request->value : 'default';

$request->get('value', 'default')

Carbon::now(), Carbon::today()

now(), today()

App::make('Class')

app('Class')

->where('column', '=', 1)

->where('column', 1)

->orderBy('created_at', 'desc')

->latest()

->orderBy('age', 'desc')

->latest('age')

->orderBy('created_at', 'asc')

->oldest()

->select('id', 'name')->get()

->get(['id', 'name'])

->first()->name

->value('name')

使用 IoC 容器或 facades 代替新的 Class

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

坏：

$user = new User;

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

好：

public function __construct(User $user)

{

$this->user = $user;

}

....

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

不要直接从 .env 文件获取数据

将数据传递给配置文件，然后使用辅助函数 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 的使用。

本作品采用《CC 协议》，转载必须注明作者和本文链接

Stay Hungry, Stay Foolish.

weixin_39826809
关注
laravel5.3完整样例
02-18
laravel完整样例：里面大概包括：发送邮件附件、导出excel文件、增删改查
laravel-最佳实践：Laravel最佳实践
02-03
**Laravel最佳实践** 在开发基于PHP的Web应用程序时，Laravel框架因其优雅的语法、强大的功能和丰富的社区支持而备受推崇。为了充分利用Laravel的优势并确保代码的可维护性、可扩展性和性能，遵循最佳实践至关重要...
Laravel 最佳实践
Diors
08-23 1188
单一职责原则 一个类和一个方法应该只有一个责任。 例如: public function getFullNameAttribute() { if (auth()->user() && auth()->user()->hasRole('client') && auth()->user()->isVerified())...
Laravel 设计模式最佳实践（二）
最新发布
龙哥盟
07-17 940
在本章中，我们看到了在 Laravel 和一般开发过程中使用的设计模式和架构的基本和高级实践示例。我们学习了各种设计模式的优点，并为每一种设计模式引用了真实世界的例子。设计模式的存在是为了让你的生活更轻松。如果开发没有遵循任何模式或架构，随着应用程序的增长，每次重构和实现功能都会变得更加困难。此外，如果另一个开发人员加入项目，他或她首先需要了解各个方面。这可能会导致膨胀、性能不佳、缺乏灵活性以及一系列难以修复的错误。应用程序将成为一个随时准备爆炸的定时炸弹。设计和架构模式的存在是为了帮助您预防这些问题。
laravel 最佳实践
XJ58678的博客
08-27 160
单一职责原则 一个类和一个方法应该只有一个责任 保持控制器的简洁 如果您使用的是查询生成器或原始SQL查询，请将所有与数据库相关的逻辑放入Eloquent模型或Repository 业务代码要放到服务层中 尽可能使用简短且可读性更好的语法 $request->session()->get('cart'); $request->input('name')...
Laravel 设计模式最佳实践（一）
龙哥盟
07-17 736
本书介绍了如何使用 Laravel 4 设计模式开发不同的应用程序并解决重复出现的问题。它将引导您了解广泛使用的设计模式——生成器（管理器）模式、工厂模式、存储库模式和策略模式，并将使您能够在使用 Laravel 开发各种应用程序时使用这些模式。本书将帮助您找到稳定和可接受的解决方案，从而提高应用程序的质量。在本书的过程中，您将了解到关于 PHP 设计模式及其在各种项目中的使用的一些清晰实用的示例。您还将熟悉 Laravel 的最佳实践，这将极大地减少引入错误到您的 Web 应用程序中的可能性。
将“优雅”进行到底——laravel的最佳实践与建议
weixin_33800593的博客
05-08 286
Laravel已经是众所周知的“优雅”、“简洁”、“实用”、“敏捷”、“特性丰富”等的代名词，尤其是对PHP开发者来说。当然了，也正是因为它特性过于“丰富”，导致很多特性并没有列在文档里，或者曾经列出来过，但是出于某些原因，后来又移除了。很多时候，我们给新手学习建议的时候，都不会建议他直接去看文档，因为文档体系的展开，往往并不是新手能hold住的。我们往往会推荐他们从一些过来人的、真正优雅规范的教...
laravel-clean-code:最佳实践Laravel（清洁代码）
05-14
如果您不愿意阅读， Laracasts包含1100多个视频教程，涉及各种主题，包括Laravel，现代PHP，单元测试，JavaScript等。 通过进入我们全面的视频库，提高自己和整个团队的技能水平。 Laravel赞助商 我们要感谢以下...
laravel-swagger:自动基于最佳实践和简单假设生成laravel项目的详尽文档
05-06
对于参数，它将考虑请求是GET / HEAD / DELETE还是POST / PUT / PATCH请求，并对其应生成的参数对象的类型做出最佳猜测。 如果您的路线包含路径参数，它也会生成路径参数。 最后，该程序包还将扫描您在操作方法中...
基于laravel&workerman，php实现websocket的双向即时通讯的最佳实践.zip
06-07
为了确保安全性和稳定性，还需要考虑一些最佳实践。例如，使用SSL/TLS加密WebSocket连接（即使用wss://）可以防止数据在传输过程中被截取。另外，合理设计和实现错误处理机制，确保即使在服务器故障或网络问题时也能...
PHP开发框架laravel安装与配置教程
10-24
总结来说，Laravel 提供了灵活的配置选项，开发者可以根据具体项目需求对框架进行微调，以实现最佳性能和最佳实践。通过本文介绍的安装和配置步骤，开发者将能够搭建起一个适合开发的 Laravel 环境。
laravel 最佳实践代码片段
weixin_35753291的博客
12-29 107
Laravel 是一个 PHP 框架，专门用于开发 Web 应用程序。关于 Laravel 最佳实践，下面是一些建议： 使用 Artisan 命令行工具生成代码：Artisan 提供了很多有用的命令行工具，可以帮助你快速生成框架所需的代码，例如控制器、模型、迁移等。 使用 composer 管理依赖：Composer 是 PHP 的包管理工具，Laravel 使用 composer 来管理所有...
深入剖析 Laravel 框架：构建高效PHP应用的最佳实践
仰望苍穹
06-15 875
Laravel 诞生于 2011 年，由 Taylor Otwell 开发。它旨在为 Web 开发提供一个更优雅和简洁的工具集合。美观且易读的语法强大的 ORM，即 Eloquent多种数据库支持丰富的认证系统便捷的路由系统先进的缓存系统Laravel 的这些特性极大地提高了开发效率，同时保持了代码的可维护性和可扩展性。
Laravel 的十八个最佳实践
weixin_33881041的博客
06-04 302
本文翻译改编自 Laravel 的十八个最佳实践 这篇文章并不是什么由 Laravel 改编的 SOLID 原则、模式等。 只是为了让你注意你在现实生活的 Laravel 项目中最常忽略的内容。 单一责任原则 一个类和一个方法应该只有一个职责。错误的做法： public function getFullNameAttribute() ...
Laravel——Web开发实战之路（五）
weixin_38312031的博客
01-27 1302
Laravel——Web开发实战之路（五） @[Laraval|后端|框架] LaravelWeb开发实战之路五 前言 用户注册页面 数据库迁移 默认迁移文件 查看数据库表 模型文件 命名空间 用户对象的创建 对象的查询 对象的更新 最后 前言 搞定了静态页面和页面的美化工作，接下来要做的就是对用户的处理了，包括登录，注册等等 用户注册页面 首先注册路
laravel框架实践1
宁静之峰的博客
05-05 596
一、Laravel简介 Laravel是一套简洁，优雅的PHPWeb开发框架 具有富于表达性且简洁的语法 Laravel是易于理解且强大的，它提供了强大的工具用以开发大型，健壮的应用。 具有验证、路由、Session、缓存、数据库迁移工具、单元测试等常用的工具和功能。 注意：LTS、非LTS。 长期支持（Long Time Support） Laravel遵守‘早发布，常发布’的版本发布准则，这也...
laravel开发网站实例
xxx
07-25 4349
协会官网实现 这是一篇开源的基于laravel的网站开发项目博客，涉及的资源、工具、项目源代码，请访问我的github项目，地址为：还在开发中，敬请期待 后端 开发环境的搭建 在本机搭建laravel开发环境 1、安装 php 7 如果你是windows系统，前往 https://windows.php.net/download 下载 PHP 7 最新版本 如果你是Lin...
php+larvael,PHP+Laravel的使用示例
weixin_35853363的博客
04-01 215
PHP+Laravel的使用示例发布时间：2020-12-14 14:19:15来源：亿速云阅读：66作者：小新小编给大家分享一下PHP+Laravel的使用示例，希望大家阅读完这篇文章后大所收获，下面让我们一起去探讨吧！声明本文只是零散的应用教程，默认 Laravel 项目已经安装完成，并正常运行；Ajax 的使用创建控制器在项目根目录下运行命令phpartisanmake:controll...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值