Laravel 代码开发最佳实践
我们这里要讨论的并不是 Laravel 版的 SOLID 原则(想要了解更多 SOLID 原则细节查看这篇文章)亦或是设计模式,而是 Laravel 实际开发中容易被忽略的最佳实践。
内容概览
- 单一职责原则
- 胖模型,瘦控制器
- 验证
- 业务逻辑应该放到服务类
- DRY(Don't Repeat Yourself,不要重复造轮子)
- 优先使用 Eloquent 而不是查询构建器和原生 SQL 查询,优先使用集合而不是数组
- 批量赋值
- 不要在 Blade 模板中执行查询 & 使用渴求式加载(避免 N+1 问题)
- 注释代码
- 不要把 JS 和 CSS 代码放到 Blade 模板里面,不要在 PHP 类中写 HTML 代码
- 使用配置、语言文件、常量而不是在代码中写死
- 使用社区接受的标准 Laravel 工具
- 遵循 Laravel 命名约定
- 使用更短的、可读性更好的语法
- 使用 IoC 容器或门面而不是创建新类
- 不要直接从
.env
文件获取数据 - 以标准格式存储日期,使用访问器和修改器来编辑日期格式
- 其他好的实践
单一职责原则
一个类和方法只负责一项职责。
坏代码:
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 查询的话将所有 DB 相关逻辑都放到 Eloquent 模型或 Repository 类。
坏代码:
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
尽可能复用代码,单一职责原则可以帮助你避免重复,此外,尽可能复用 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 可以编写出可读性和可维护性更好的代码,此外,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 执行查询 & 使用渴求式加载
坏代码:
@foreach (User::all() as $user)
{{ $user->profile->name }}
@endforeach
好代码:
$users = User::with('profile')->get();
...
@foreach ($users as $user)
{{ $user->profile->name }}
@endforeach
注释你的代码
坏代码:
if (count((array) $builder->getQuery()->joins) > 0)
好代码:
// Determine if there are any joins.
if (count((array) $builder->getQuery()->joins) > 0)
最佳:
if ($this->hasJoins())
将前端代码和 PHP 代码分离:
不要把 JS 和 CSS 代码写到 Blade 模板里,也不要在 PHP 类中编写 HTML 代码。
坏代码:
let article = `{{ json_encode($article) }}`;
好代码:
<input id="article" type="hidden" value="{{ json_encode($article) }}">
或者
<button class="js-fav-article" data-article="{{ json_encode($article) }}">{{ $article->name }}<button>
在 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 内置功能和社区版扩展包,其次才是第三方扩展包和工具。这样做的好处是降低以后的学习和维护成本。
任务 | 标准工具 | 第三方工具 |
---|---|---|
授权 | 策略类 | Entrust、Sentinel等 |
编译资源 | Laravel Mix | Grunt、Gulp等 |
开发环境 | Homestead | Docker |
部署 | Laravel Forge | Deployer等 |
单元测试 | PHPUnit、Mockery | Phpspec |
浏览器测试 | Laravel Dusk | Codeception |
DB | Eloquent | SQL、Doctrine |
模板 | Blade | Twig |
处理数据 | Laravel集合 | 数组 |
表单验证 | 请求类 | 第三方扩展包、控制器中验证 |
认证 | 内置功能 | 第三方扩展包、你自己的解决方案 |
API认证 | Laravel Passport | 第三方 JWT 和 OAuth 扩展包 |
创建API | 内置功能 | Dingo API和类似扩展包 |
处理DB结构 | 迁移 | 直接操作DB |
本地化 | 内置功能 | 第三方工具 |
实时用户接口 | Laravel Echo、Pusher | 第三方直接处理 WebSocket的扩展包 |
生成测试数据 | 填充类、模型工厂、Faker | 手动创建测试数据 |
任务调度 | Laravel Task Scheduler | 脚本或第三方扩展包 |
DB | MySQL、PostgreSQL、SQLite、SQL Server | MongoDB |
遵循 Laravel 命名约定
遵循 PSR 标准。此外,还要遵循 Laravel 社区版的命名约定:
What | How | Good | Bad |
---|---|---|---|
控制器 | 单数 | ArticleController | |
路由 | 复数 | articles/1 | |
命名路由 | 下划线+'.'号分隔 | users.show_active | |
模型 | 单数 | User | |
一对一关联 | 单数 | articleComment | |
其他关联关系 | 复数 | articleComments | |
数据表 | 复数 | article_comments | |
中间表 | 按字母表排序的单数格式 | article_user | |
表字段 | 下划线,不带模型名 | meta_title | |
外键 | 单数、带_id后缀 | article_id | |
主键 | - | id | |
迁移 | - | 2017_01_01_000000_create_articles_table | |
方法 | 驼峰 | getAll | |
资源类方法 | 文档 | store | |
测试类方法 | 驼峰 | testGuestCannotSeeArticle | |
变量 | 驼峰 | $articlesWithAuthor | |
集合 | 复数 | $activeUsers = User::active()->get() | |
对象 | 单数 | $activeUser = User::active()->first() | |
配置和语言文件索引 | 下划线 | articles_enabled | |
视图 | 下划线 | show_filtered.blade.php | |
配置 | 下划线 | google_calendar.php | |
契约(接口) | 形容词或名词 | Authenticatable | |
Trait | 形容词 | Notifiable |
使用缩写或可读性更好的语法
坏代码:
$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 容器或门面
自己创建新的类会导致代码耦合度高,且难于测试,取而代之地,我们可以使用 IoC 容器或门面。
坏代码:
$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 模板中尽量不要编写原生 PHP。
https://laravelacademy.org/post/8464.html
Laravel 代码开发最佳实践的更多相关文章
- Salesforce 开发整理(五)代码开发最佳实践
在Salesforce项目实施过程中,对项目代码的维护可以说占据极大的精力,无论是因为项目的迭代,还是需求的变更,甚至是项目组成员的变动,都不可避免的需要维护之前的老代码,而事实上,几乎没有任何一个项 ...
- Web前端开发最佳实践(9):CSS代码太太乱,重复代码太多?你需要精简CSS代码
前言 提高网站整体加载速度的一个重要手段就是提高代码文件的网络传输速度.之前提到过,所有的代码文件都应该是经过压缩了的,这可提高网络传输速度,提高性能.除了压缩代码之外,精简代码也是一种减小代码文件大 ...
- Web前端开发最佳实践(2):前端代码重构
前言 代码重构是业内经常讨论的一个热门话题,重构指的是在不改变代码外部行为的情况下进行源代码修改,所以重构之前需要考虑的是重构后如何才能保证外部行为不改变.对于后端代码来说,可以通过大量的自动化测试来 ...
- Web前端开发最佳实践(3):前端代码和资源的压缩与合并
一般在网站发布时,会压缩前端HTML.CSS.JavaScript代码及用到的资源文件(主要是图片文件),目的是加快文件在网络中的传输,让网页更快的展现.当然,CDN分发.缓存等方式也是加快代码或资源 ...
- web前端开发最佳实践笔记
一.文章开篇 由于最近也比较忙,一方面是忙着公司的事情,另外一方面也是忙着看书和学习,所以没有时间来和大家一起分享知识,现在好了,终于回归博客园的大家庭了,今天我打算来分享一下关于<web前端开 ...
- [转]Android开发最佳实践
——欢迎转载,请注明出处 http://blog.csdn.net/asce1885 ,未经本人同意请勿用于商业用途,谢谢—— 原文链接:https://github.com/futurice/and ...
- Hadoop MapReduce开发最佳实践(上篇)
body{ font-family: "Microsoft YaHei UI","Microsoft YaHei",SimSun,"Segoe UI& ...
- Android开发最佳实践《IT蓝豹》
Android开发最佳实践 移动开发Android经验分享应用GoogleMaterial Design 摘要:前 段时间,Google公布了Android开发最佳实践的一系列课程,涉及到一些平时 ...
- Android和PHP开发最佳实践
Android和PHP开发最佳实践 <Android和PHP开发最佳实践>基本信息作者: 黄隽实丛书名: 移动应用开发技术丛书出版社:机械工业出版社ISBN:9787111410508上架 ...
随机推荐
- 【php设计模式】组合模式
定义: 是用于把一组相似的对象当作一个单一的对象.组合模式依据树形结构来组合对象,用来表示部分以及整体层次.这种类型的设计模式属于结构型模式,它创建了对象组的树形结构. 应用场景: 部分.整体场景,如 ...
- JS实现旋转的魔方
js <script> window.onload = function () { let cube = document.querySelector('.cube') let timer ...
- ES6 map与filter
ES6 map与filter 1.map let arr1 = [1,2,3]; let arr2 = arr1.map((value,key,arr) => { console.log(val ...
- Python 嵌套列表解析
将一个3*4矩阵转为4*3矩阵Matrix = [ [1, 2, 3, 4], [5, 6, 7, 8], [9, 10, 11, 12],]afterMatrix = [[row[i] for ro ...
- 阿里云服务执行mysql_install_db报错
问题描述:阿里云服务执行mysql_install_db报错解决方案:安装autoconf库(yum -y install autoconf)然后在执行:mysql_install_db就会出现这样, ...
- idea配置代码注释模板
从eclipse换成idea后,有点不习惯,其中之一就是代码注释,感觉不如eclipse好用,下面是一些配置方法,配完之后差不多能实现eclipse的效果. 1.以配置Class的注释为例,其他文件的 ...
- SQLSERVER EXISTS IN 优化
数据量: 首先我们看看待优化的SQL: 简单的分析下来发现: EXISTS 这部分执行比较慢,我们来看一下, 这种写法比较便于理解,但是执行起来却很慢.既然这里慢,我们就要优化这部分. 首先我是想把拼 ...
- Gym - 101492I 区间限制费用流
https://cn.vjudge.net/problem/Gym-101492I 如果用单个点代表每个区间 利用拆点来限制区间的流量的话 点是 n^2/2+m个 边是2*n^2条 但是这样会T 解法 ...
- BCB 如何拦截TAB键消息
最近项目中一个需求,按下Tab键,按照指定的顺序进行跳转. 在实现的过程中发现,Tab按下的时候,会让当前控件失去焦点.并跳转到其他可焦点控件 例如 TEdit,TButton 等. 究其原理,是因为 ...
- Vue学习日记(三)——Vue路由管理vue-router
前言 为了给读者更好的体验,去理解vue-router和下一篇介绍vuex,决定还是来一个实战教程来带大家更加的去深入理解vue-router,在这之前,读者先自行了解和去官网下载npm和node,附 ...