centos开发套件_替代的Laravel套件开发工作流程

centos 开发套件

This article was peer reviewed by Francesco Malatesta. Thanks to all of SitePoint’s peer reviewers for making SitePoint content the best it can be!

本文由Francesco Malatesta进行同行评审。 感谢所有SitePoint的同行评审人员使SitePoint内容达到最佳状态&＃xff01;

Every framework gives developers a way to extend the system using packages / extensions. We can generally hook in our logic at any point where we want to provide specific functionality, and Laravel is no exception! Following the article of my fellow author Francesco Malatesta about his Laravel package development workflow, I noticed that mine is a bit different and I wanted to share it with you!

每个框架都为开发人员提供了使用包/扩展来扩展系统的方法。 通常&＃xff0c;我们可以在希望提供特定功能的任何地方加入我们的逻辑&＃xff0c;Laravel也不例外&＃xff01; 下面的文章我的同胞作家弗朗西斯马爱德他Laravel包的开发流程&＃xff0c;我注意到我的是一个有点不同&＃xff0c;我想与大家分享吧&＃xff01;

演示包 (Demo Package)

As a demo package, we’re going to build a Laravel two factor authentication package for this article. The package will handle the user authentication with a verification code being sent through a medium like Nexmo, Twilio, etc. You can check out the final package here.

作为一个演示程序包&＃xff0c;我们要建立一个Laravel双因素身份验证软件包这一文章 。 该软件包将通过通过Nexmo &＃xff0c; Twilio等介质发送的验证码来处理用户身份验证。您可以在此处查看最终软件包。

设置存储库 (Setting up the Repository)

Before we start the development, we need to create a new repository inside GitHub so we can push/pull from it through the development phase.

在开始开发之前&＃xff0c;我们需要在GitHub内创建一个新的存储库&＃xff0c;以便我们可以在开发阶段将其推入/拉出。

Composer supports a repositories key inside the composer.json file. We can use this to specify our custom packages that don’t yet exist on Packagist.

Composer在composer.json文件中支持repositories密钥。 我们可以使用它来指定Packagist尚不存在的自定义软件包。

{
// ....
"repositories": [
{
"type": "vcs",
"url": "https://github.com/Whyounes/laravel-two-factor-auth-demo"
}
],
// ....
}

Now, we can require our package as usual.

现在&＃xff0c;我们可以照常要求包装。

{
// ....
"require": {
"php": ">&＃61;5.6.4",
"laravel/framework": "5.4.*",
"laravel/tinker": "~1.0",
"Whyounes/laravel-two-factor-auth-demo": "dev-master"
},
// ....
}

We can specify a branch or a version number. In case we want to use a branch, it should be prefixed with dev-. You can read more about configuring repositories on the Packagist website.

我们可以指定分支或版本号。 如果我们要使用分支&＃xff0c;则应在其前面加上dev- 。 您可以在Packagist网站上阅读有关配置存储库的更多信息 。

包装骨架 (Package Skeleton)

Since Composer identifies packages using the composer.json file, we need to create one for our package and push it to the repository.

由于Composer使用composer.json文件识别软件包&＃xff0c;因此我们需要为我们的软件包创建一个并将其推送到存储库。

{
"name": "whyounes/laravel-two-factor-auth",
"type": "library",
"description": "Laravel two factor authentication",
"keywords": [
"auth",
"passwordless"
],
"homepage": "https://github.com/whyounes/laravel-two-factor-auth",
"license": "MIT",
"authors": [
{
"name": "Rafie Younes",
"email": "younes.rafie&＃64;gmail.com",
"homepage": "http://younesrafie.com",
"role": "Developer"
}
],
"require": {
"php": "^5.5.9 || ^7.0",
"illuminate/database": "5.1.* || 5.2.* || 5.3.* || 5.4.*",
"illuminate/config": "5.1.* || 5.2.* || 5.3.* || 5.4.*",
"illuminate/events": "5.1.* || 5.2.* || 5.3.* || 5.4.*",
"illuminate/auth": "5.1.* || 5.2.* || 5.3.* || 5.4.*",
"twilio/sdk": "^5.4"
},
"require-dev": {
"phpunit/phpunit": "^4.8 || ^5.0",
"orchestra/testbench": "~3.0",
"mockery/mockery": "~0.9.4"
},
"autoload": {
"psr-4": {
"Whyounes\\TFAuth\\": "src"
},
"classmap": [
"tests"
]
}
}

After running the composer update command inside the Laravel project’s root folder, we see an error that no tests were found under the tests folder. This won’t halt the installation process, so we’re fine to continue!

在Laravel项目的根文件夹中运行composer update命令后&＃xff0c;我们看到一个错误&＃xff0c;即在tests文件夹下找不到任何测试。 这不会停止安装过程&＃xff0c;因此我们可以继续&＃xff01;

The last part of our package configuration is to link the downloaded package to the GitHub repository.

软件包配置的最后一部分是将下载的软件包链接到GitHub存储库。

// assuming you&＃39;re inside your project folder
cd vendor/whyounes/laravel-two-factor-auth
git init origin git&＃64;github.com:Whyounes/laravel-two-factor-auth.git
git commit -am "Init repo"
git push origin master -f // force push for the first time

包装结构 (Package Structure)

This part is a little bit controversial, we can’t all agree on one single structure. Here’s our package structure:

这部分有一点争议&＃xff0c;我们不能在一个单一的结构上达成一致 。 这是我们的包结构&＃xff1a;

▶ config/
auth.php
services.php
▶ migrations/
2014_10_1_000000_add_tfa_columns_to_users_table.php
2016_12_1_000000_create_tokens_table.php
▶ resources/
▶ views/
verification_code.blade.php
▶ src/
▶ Contracts/
VerificationCodeSenderInterface.php
▶ Controllers/
TFAController.php
▶ Exceptions/
TFANotEnabledException.php
UserNotFoundException.php
▶ Models/
TFAuthTrait.php
Token.php
▶ Providers/
TwoFAProvider.php
▶ Services/
Twilio.php
▶ tests/

To install the package we use a Laravel provider:

要安装软件包&＃xff0c;我们使用Laravel提供程序&＃xff1a;

// config/app.php
// ...
&＃39;providers&＃39; &＃61;> [
// ...
Whyounes\TFAuth\TwoFAProvider::class,
};

The provider class looks like this:

提供程序类如下所示&＃xff1a;

// src/Providers/TwoFAProvider.php
namespace Whyounes\TFAuth;
use Illuminate\Auth\Events\Authenticated;
use Illuminate\Routing\Router;
use Illuminate\Support\Facades\App;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\ServiceProvider;
use Twilio\Rest\Client;
use Whyounes\TFAuth\Contracts\VerificationCodeSenderInterface;
use Whyounes\TFAuth\Services\Twilio;
/**
* Class TwoFAProvider
*
* &＃64;package Whyounes\TFAuth
*/
class TwoFAProvider extends ServiceProvider
{
public function boot()
{
$this->loadMigrationsFrom(__DIR__ . &＃39;/../../migrations&＃39;);
$this->mergeConfigFrom(
__DIR__ . &＃39;/../../config/auth.php&＃39;, &＃39;auth&＃39;
);
$this->mergeConfigFrom(
__DIR__ . &＃39;/../../config/services.php&＃39;, &＃39;services&＃39;
);
$this->loadViewsFrom(__DIR__.&＃39;/resources/views&＃39;, &＃39;tfa&＃39;);
$this->publishes([
__DIR__.&＃39;/../../resources/views&＃39; &＃61;> resource_path(&＃39;views/vendor/tfa&＃39;),
]);
}
public function register()
{
$this->registerBindings();
$this->registerEvents();
$this->registerRoutes();
}
public function registerBindings()
{
$this->app->singleton(Client::class, function () {
return new Client(config(&＃39;services.twilio.sid&＃39;), config(&＃39;services.twilio.token&＃39;));
});
$this->app->bind(VerificationCodeSenderInterface::class, Twilio::class);
}
public function registerEvents()
{
// Delete user tokens after login
if (config(&＃39;auth.delete_verification_code_after_auth&＃39;, false) &＃61;&＃61;&＃61; true) {
Event::listen(
Authenticated::class,
function (Authenticated $event) {
$event->user->tokens()
->delete();
}
);
}
}
public function registerRoutes()
{
/** &＃64;var $router Router */
$router &＃61; App::make("router");
$router->get("/tfa/services/twilio/say/{text}", ["as" &＃61;> "tfa.services.twilio.say", "uses" &＃61;> function ($text) {
$response &＃61; "" . $text . "";
return $response;
}]);
}
}

Let’s go through every method here:

让我们在这里浏览每种方法&＃xff1a;

• The boot method will be publishing our package assets (config, migrations, views).

  boot方法将发布我们的程序包资产(配置&＃xff0c;迁移&＃xff0c;视图)。

• The registerBindings method binds the VerificationCodeSenderInterface to a specific implementation. The package uses the Twilio service as a default, so we create a src/Services/Twilio class which implements our interface and defines the necessary methods.

  registerBindings方法将VerificationCodeSenderInterface绑定到特定的实现。 该软件包默认使用Twilio服务&＃xff0c;因此我们创建了一个src/Services/Twilio类&＃xff0c;该类实现了我们的接口并定义了必要的方法。

// src/Services/Twilio.php
namespace Whyounes\TFAuth\Services;
use Twilio\Rest\Client;
use Whyounes\TFAuth\Contracts\VerificationCodeSenderInterface;
class Twilio implements VerificationCodeSenderInterface
{
/**
* Twilio client
*
* &＃64;var Client
*/
protected $client;
/**
* Phone number to send from
*
* &＃64;var string
*/
protected $number;
public function __construct(Client $client)
{
$this->client &＃61; $client;
$this->number &＃61; config("services.twilio.number");
}
public function sendCodeViaSMS($code, $phone, $message &＃61; "Your verification code is %s")
{
try {
$this->client->messages->create($phone, [
"from" &＃61;> $this->number,
"body" &＃61;> sprintf($message, $code)
]);
} catch (\Exception $ex) {
return false;
}
return true;
}
public function sendCodeViaPhone($code, $phone, $message &＃61; "Your verification code is %s")
{
try {
$this->client->account->calls->create(
$phone,
$this->number,
["url" &＃61;> route(&＃39;tfa.services.twilio.say&＃39;, ["text" &＃61;> sprintf($message, $code)])]
);
} catch (\Exception $ex) {
return false;
}
return true;
}
// getters and setter
}

• The registerEvents method will delete the previously used token upon authentication if the config value is set to true.

  如果config值设置为true &＃xff0c;则registerEvents方法将在身份验证后删除以前使用的令牌。

• The registerRoutes method adds a route for sending a verification code via a phone call.

  registerRoutes方法添加了用于通过电话发送验证码的路由。

If, for example, we wanted to switch from Twilio to Nexmo, we only need to create a new class that implements the VerificationCodeSenderInterface and bind it to the container.

例如&＃xff0c;如果我们想从Twilio切换到Nexmo&＃xff0c;我们只需要创建一个新类来实现VerificationCodeSenderInterface并将其绑定到容器即可。

Finally, we add a trait to the User model class:

最后&＃xff0c;我们向User模型类添加一个特征&＃xff1a;

// app/User.php
class User extends Authenticatable
{
use \Whyounes\TFAuth\Models\TFAuthTrait;
// ...
}

测验 (Tests)

Tests are mandatory before releasing any code publicly, not just for Laravel. DO NOT use any packages that don’t have tests. For Laravel, you may use the orchestra/testbench package to help you out, and the documentation provides a really nice flow for testing Laravel components like Storage, Eloquent, etc.

在公开发布任何代码之前(不仅限于Laravel)&＃xff0c;必须进行测试。 不要使用任何没有测试的软件包。 对于Laravel&＃xff0c;您可以使用orchestra/testbench方案&＃xff0c;帮助你&＃xff0c;和文档提供了用于测试Laravel组件就像一个非常好的流动Storage &＃xff0c; Eloquent等

For our package, we have tests for our controller, model and service classes. Check the repository for more details about our tests.

对于我们的程序包&＃xff0c;我们对控制器&＃xff0c;模型和服务类进行了测试。 检查存储库以获取有关我们测试的更多详细信息。

标记 (Tagging)

We can’t keep just a master branch for our package. We need to tag a first version to start with. This depends on how far along are we in the feature development stage, and what the goal is here!

我们不能只为包保留master分支。 我们需要标记一个开始的版本。 这取决于我们在功能开发阶段的进展情况以及目标是什么&＃xff01;

Since our package is not that complicated and doesn’t have a lot of features to build, we can tag it as a first stable version (1.0.0). You can check the Git documentation website for more details about tagging, and here’s the list of commands for adding a new tag to our repository:

由于我们的软件包不是那么复杂&＃xff0c;并且没有很多功能要构建&＃xff0c;因此我们可以将其标记为第一个稳定版本( 1.0.0 )。 您可以访问Git文档网站以获取有关标记的更多详细信息&＃xff0c;这是用于将新标记添加到我们的存储库的命令列表&＃xff1a;

git tag
git tag -a v1.0.0 -m "First stable version"
git push origin --tags

We should now see the tag on GitHub under the branch select box:

现在&＃xff0c;我们应该在分支选择框下的GitHub上看到标签&＃xff1a;

持续集成 (Continuous Integration)

Continuous Integration tools help us integrate new parts into our existing code and send a notification about any infringements. It also gives us a badge (image with a link) for the status of the code. For this package, we use TravisCI as our CI tool.

持续集成工具可帮助我们将新零件集成到现有代码中&＃xff0c;并发送有关任何侵权的通知。 它还为我们提供了代码状态的标志(带有链接的图像)。 对于此软件包&＃xff0c;我们使用TravisCI作为CI工具。

// .travis.yml
language: php
php:
- 5.6
- 7.0
- 7.1
sudo: true
install:
- travis_retry composer install --no-interaction --prefer-source

This config file will be picked up by TravisCI to know how to test the code and what versions to test on. You can read more about how to integrate it here.

TravisCI将提取此配置文件&＃xff0c;以了解如何测试代码以及​​要测试的版本。 您可以在此处阅读有关如何集成它的更多信息。

结论 (Conclusion)

The development workflow is not that complicated. In fact, we can develop a package without needing to install the Laravel framework; just include the necessary Illuminate components and test drive your package’s implementation. At the end, you can do an integration test as a demo that the package is working as expected. I hope this helps you create some packages to give back to the community :)

开发工作流程并不那么复杂。 实际上&＃xff0c;我们可以开发一个软件包&＃xff0c;而无需安装Laravel框架。 仅包括必要的Illuminate组件并测试驱动程序包的实现。 最后&＃xff0c;您可以进行集成测试&＃xff0c;以演示该软件包是否按预期工作。 我希望这可以帮助您创建一些可以回馈社区的软件包&＃xff1a;)

If you have any questions or comments you can post them below! What’s your package development workflow?

如果您有任何疑问或意见&＃xff0c;可以在下面发布&＃xff01; 您的包装开发工作流程是什么&＃xff1f;

翻译自: https://www.sitepoint.com/alternative-laravel-package-development-workflow/

centos 开发套件