Laravel CollectiveのremoteによるCSVデータ送信

title_laravel_collective

はじめに

こんにちは、インディバル・デベロップメント室のエンジニアです。今回は「Laravel Collective」のremoteについて紹介しようと思います。
これに触れたきっかけは、いま担当しているサービスのサーバから他のサーバへcsvデータを送信したいとの要望がきっかけです。Laravelで実現できる方法について調べていたところ、「Laravel Collective」について知ることが出来ました。

パッケージのインストール

まずは、 composer.jsonに「laravelcollective/remote」を追加します。

    "require": {
        "php": ">=7.1.0",
        "laravel/framework": "5.5.*",
        ...略
        "laravelcollective/remote": "5.5.*"

"require": {

"php": ">=7.1.0",

"laravel/framework": "5.5.*",

...略

"laravelcollective/remote": "5.5.*"

ご覧のとおり、私が担当しているサービスではLaravel5.5とphp7.1を使用しています。
そのためLaravelcollective/remoteのバージョンも5.5にしています。
他にバージョンがあるので、laravelcollective/remoteのgithubでチェックして適切なバージョンを使用するようにしましょう。

その後は「composer update」でパッケージをインストールします。インストールが完了したらvendor配下を確認しましょう。

vendor
 ㄴlaravelcollective
  ㄴremote

vendor

ㄴlaravelcollective

ㄴremote

このようなディレクトリ構成になっていれば成功です(´・ω・｀)

セッテイング

「config/app.php」に下記のように追加します。
まずは「providers」配列。

  'providers' => [
    // ...
    Collective\Remote\RemoteServiceProvider::class,
    // ...
  ],

'providers' => [

// ...

Collective\Remote\RemoteServiceProvider::class,

// ...

次に、「aliases」にも以下を追加します。

  'aliases' => [
    // ...
      'SSH' => Collective\Remote\RemoteFacade::class,
    // ...
  ],

'aliases' => [

// ...

'SSH' => Collective\Remote\RemoteFacade::class,

// ...

最後に、以下のaritsanを実行し、configファイルを公開しましょう。

php artisan vendor:publish --provider="Collective\Remote\RemoteServiceProvider"

1	php artisan vendor:publish --provider="Collective\Remote\RemoteServiceProvider"

上記を実行するとconfig/remote.phpファイルが生成されます。

return [

    /*
    |--------------------------------------------------------------------------
    | Default Remote Connection Name
    |--------------------------------------------------------------------------
    |
    | Here you may specify the default connection that will be used for SSH
    | operations. This name should correspond to a connection name below
    | in the server list. Each connection will be manually accessible.
    |
    */

    'default' => 'production',

    /*
    |--------------------------------------------------------------------------
    | Remote Server Connections
    |--------------------------------------------------------------------------
    |
    | These are the servers that will be accessible via the SSH task runner
    | facilities of Laravel. This feature radically simplifies executing
    | tasks on your servers, such as deploying out these applications.
    |
    */

    'connections' => [
        'production' => [
            'host'      => '',
            'username'  => '',
            'password'  => '',
            'key'       => '',
            'keytext'   => '',
            'keyphrase' => '',
            'agent'     => '',
            'timeout'   => 10,
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | Remote Server Groups
    |--------------------------------------------------------------------------
    |
    | Here you may list connections under a single group name, which allows
    | you to easily access all of the servers at once using a short name
    | that is extremely easy to remember, such as "web" or "database".
    |
    */

    'groups' => [
        'web' => ['production'],
    ],

];

return [

|--------------------------------------------------------------------------

| Default Remote Connection Name

|--------------------------------------------------------------------------

| Here you may specify the default connection that will be used for SSH

| operations. This name should correspond to a connection name below

| in the server list. Each connection will be manually accessible.

'default' => 'production',

|--------------------------------------------------------------------------

| Remote Server Connections

|--------------------------------------------------------------------------

| These are the servers that will be accessible via the SSH task runner

| facilities of Laravel. This feature radically simplifies executing

| tasks on your servers, such as deploying out these applications.

'connections' => [

'production' => [

'host' => '',

'username' => '',

'password' => '',

'key' => '',

'keytext' => '',

'keyphrase' => '',

'agent' => '',

'timeout' => 10,

|--------------------------------------------------------------------------

| Remote Server Groups

|--------------------------------------------------------------------------

| Here you may list connections under a single group name, which allows

| you to easily access all of the servers at once using a short name

| that is extremely easy to remember, such as "web" or "database".

'groups' => [

'web' => ['production'],

];

この「connections」のところに各環境や送信先のサーバにログインするための情報を入れて置きます。

データを送ってみよう

まずは、「$localFile」に送信元のファイルパス、「$remoteFile」に送信先ファイルパスを指定します。

$localFile = '/var/〇〇/data.csv';
$remoteFile = '/var/△△/data.csv';

1 2	$localFile = '/var/〇〇/data.csv'; $remoteFile = '/var/△△/data.csv';

そして、

   try{
       SSH::into(env('ENV'))->put($localFile, $remoteFile);
   }catch (\Exception $e){
       Logger::error($e);
   }

try{

SSH::into(env('ENV'))->put($localFile, $remoteFile);

}catch (\Exception $e){

Logger::error($e);

}

のように書いて実行するとデータを送信することができます！

おわり

執筆者プロフィール

インディバルに入社して２年目で、ちなみに国籍は中国。前職でもSEとして仕事していたが、本格的な開発をするのはインディバルに来てから。いい年して食べ物の好き嫌いが激しくて、お昼にはいつも自分が食べられるメニューばかりに付き合ってくれるランチ友に心から感謝している。

Laravel CollectiveのremoteによるCSVデータ送信

はじめに

パッケージのインストール

セッテイング

データを送ってみよう

関連する記事