首页 > 代码库 > 在Laravel中一步一步创建Packages

在Laravel中一步一步创建Packages

2024-07-13 05:47:49   227人阅读

首先要看一下Laravel官方文档，这是最新4.2的文档，如果想看中文的话点击此处，基本一样，这个github上的库setup-laravel4-package，也是一步一步介绍如何创建一个包，并关联相关资源。

这里以创建一个account包为例：

1、如果是首次使用php artisan workbench命令，需要配置app/config/workbench.php中的name和email，在生成包的时候会使用这些信息

2、在项目根目录使用，下面的命令生成最初始的包目录结构，其中--resources作用是生成相关的view、config和migrations等资源目录

1
php artisan workbench fstos/account --resources

包的根目录在workbench/fstos/account目录，其结构大概如下

1
2
3
4
5
6
7
8
9
10
/src
    /Fstos
        /Account
            AccountServiceProvider.php
    /config
    /lang
    /migrations
    /views
/tests
/public

3、将包的‘Fstos\Account\AccountServiceProvider‘加入到app/config/app.php中"providers"数组中，这样这个包会被加载到应用程序中

4、为本包添加独立路由文件，只需在AccountServiceProvider中的boot函数中添加如下代码，并在包的根目录创建routes.php文件

1
2
3
4
5
public function boot()
{
    $this->package(‘fstos/account‘);
    include __DIR__.‘/../../routes.php‘;
}

路由文件如下所示： 

1
2
3
Route::get(‘account/register‘,  function(){
    return "account register router";
});

5、OK，现在在你的浏览器测试吧，出现了"account register router"，接下来我们尝试使用controller

1
http://localhost/laravel/friends/public/account/register

6、修改routes如下所示：

1
2
3
4
Route::get(‘account/register‘, 
        array(‘as‘ => ‘account.register.get‘, 
            ‘uses‘ => ‘Fstos\Account\RegistrationController@getRegister‘)
        );

7、在controllers 中新建RegistrationController.php文件，代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<?php
 
namespace Fstos\Account;
 
use Illuminate\Routing\Controller as Controller;
use Illuminate\Support\Facades\View as View;
use Illuminate\Support\Facades\Config as Config;
 
class RegistrationController extends Controller
{
    /**
     * Display the registration form.
     *
     * @return \Illuminate\Http\Response
     */
    public function getRegister()
    {
        return "yes,use controller with route in packages!";
    }
    /**
     * 暂用不到
     */
    protected function setupLayout()
    {
        if (!is_null($this->layout)) {
            $this->layout = View::make($this->layout);
        }
    }
 
}

 

尝试刷新页面，啊哈，是不是报错了，找不到"Fstos\Account\RegistrationController"，Laravel默认是不自动查找任何目录的，需要开发者自己指定文件的存放目录，不过它也给出了建议路径，比如在使用artisan workbench的时候是不是生成了src/controllers目录呢，Ok，我们添加自动加载路径即可

8、在包的根目录的composer.json的autoload下classmap字段增加"src/controllers"，并在项目根目录运行 php artisan dump-autoload，OKOK，我们刷新页面，哈哈出现啦

9、接下来我们要使用views文件！嗯嗯，按照我们理解我们只需要修改controller中代码，是滴，如下：

1
2
3
4
5
    public function getRegister()
    {
        return View::make(‘account.register‘);
    //  return "yes,use controller with route in packages!";
    }

很显然他访问的是app/views/account/register.blade.php视图模板，我们创建这个文件并写入如下内容：

1
2
3
<div>
    we are shown in views!
</div>

继续刷新页面吧！哈哈哈，很幸运，是这个规则~，不过我们创建一个包并不期望把包中视图放在app/views目录吧，是滴，必须得集成到包中，记得src下也有个views呢，好滴好滴，我们把文件放到包src/views/account/register.blade.php中，内容如下：

1
2
3
<div>
    we are shown in views under workbench!
</div>

刷新页面吧，我擦，还是原来的页面，是不是Laravel优先载入app/views下的模板文件呢，我们删除app/views/account/，再次刷新页面，又失望了，再次出现了not found页面，在Laravel中，是不会自动索引包中的视图文件的，所以我们还需要做一点点工作！

10、在载入视图的时候指定他去包中寻找视图文件即可，修改controller中代码如下：

1
2
3
4
5
    public function getRegister()
    {
        return View::make(‘account::account.register‘);
    //  return "yes,use controller with route in packages!";
    }

再次刷新页面，我们期待的页面出现了，我们看到controller中使用到了account这个命令空间（具体含义可以看下laravel官方文档），那么这个空间是在哪里指定的呢？

11、我们看下AccountServiceProvider.php文件中boot函数中$this->package(‘fstos/account‘);这一行代码，其实指定了这个包的命令空间和其绑定的目录，神马，看不粗来，是滴，这个函数还有第二个（空间名）和第三个（目录）参数，不过这个两个参数都有默认值，命名空间的默认值就是account，目录默认值就是包根目录下的src目录，其实就相当于如下写法:

1
$this->package(‘fstos/account‘,"account",__DIR__.‘/../../‘);

Ok，你可以去尝试~

小插曲，从第7条往后写了两遍，第一遍保存的时候登录时间过长，保存丢失了，我勒个去，心中各种骂，想想数据备份是多么的重要~

这是我第一发布的位置：http://www.fstos.com/index.php/2014-05-26-09-01-36/81-laravel-packages

在Laravel中一步一步创建Packages


联系
我们