Laravel开发文档_laravel开发规范
一、解决方案简述
在Laravel项目开发中,遵循一定的开发规范能够提高代码的可读性、可维护性,并且有助于团队协作。围绕命名规范、文件结构、路由设置、控制器编写等方面阐述Laravel开发规范。
二、命名规范
(一)变量命名
变量名应尽量清晰地表达其含义,使用驼峰命名法(camelCase)。例如:
php
$userName = "张三";
对于常量则全部大写并用下划线分隔单词,如:
php
define("MAX_AGE", 100);
(二)函数命名
函数名同样采用驼峰命名法,以动词开头。例如有一个获取用户信息的函数:
php
function getUserInfo($userId){
// 获取用户信息逻辑
}
三、文件结构
按照Laravel默认的文件夹结构进行组织,在app目录下的Http/Controllers存放控制器类, Models存放模型类等。如果项目规模较大,可以创建子文件夹对功能模块进一步分类,比如在Controllers下创建Admin和User子文件夹分别存放后台和前台相关的控制器。
四、路由设置
(一)简单路由定义
php
Route::get('/hello', function () {
return 'Hello World';
});
(二)带参数路由
php
Route::get('/user/{id}', function ($id) {
return 'User '.$id;
});
还可以为参数设置正则限制:
php
Route::get('user/{id}', function ($id) {
//
})->where(['id' => '[0-9]+']);
五、控制器编写
(一)继承基础控制器
自定义的控制器一般要继承AppHttpControllersController这个基础控制器。
```php
namespace AppHttpControllers;
use AppHttpControllersController;
class UserController extends Controller{
public function showProfile($id){
return view('user.profile', ['user' => User::findOrFail($id)]);
}
}
```
(二)资源控制器
对于CURD操作较多的实体对象,可以使用资源控制器。通过一条命令就可以生成包含一系列方法(如index、create、store等)的控制器。
php
php artisan make:controller PhotoController --resource
这样就创建了一个PhotoController资源控制器,它已经包含了处理照片相关的各种操作的方法框架。在路由中只需简单定义:
php
Route::resource('photos', 'PhotoController');
这几种思路从不同的方面规范了Laravel项目的开发,有助于构建高质量的应用程序。