Nacos 解決 laravel 多環境下配置切換

未定義發表於2021-02-19

Laravel

前言

對於應用程式執行的環境來說，不同的環境有不同的配置通常是很有用的。例如，你可能希望在本地使用的快取驅動不同於生產伺服器所使用的快取驅動。

痛點

.env 配置不能區分多環境(開發，測試，生產)
.env 配置共享太麻煩(團隊區域網環境)
配置不能實時管理，增刪改配置
自動化部署配置 .env 檔案過於繁瑣

Nacos 簡介

Nacos 是阿里巴巴最新開源的專案，核心定位是 “一個更易於幫助構建雲原生應用的動態服務發現、配置和服務管理平臺”，專案地址：nacos.io/zh-cn/

應用

這裡主要使用了 Nacos 的配置管理，並沒有使用到動態服務等功能。原理也很簡單，透過介面直接修改 .env 檔案。Nacos 服務可以直接使用使用阿里雲提供的 應用配置管理，無須安裝。連結如下: acmnext.console.aliyun.com/

程式碼

<?php

namespace App\Console\Commands;

use GuzzleHttp\Client;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Validator;

class NacosTools extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'nacos {action?}';

    private $accessKey;
    private $secretKey;
    private $endpoint = 'acm.aliyun.com';
    private $namespace;
    private $dataId;
    private $group;
    private $port = 8080;
    private $client;

    private $serverUrl;

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Nacos 管理工具';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     * @throws \Exception
     */
    public function handle()
    {
        $this->accessKey = env('NACOS_ACCESS_KEY');
        $this->secretKey = env('NACOS_SECRET_KEY');
        $this->endpoint = env('NACOS_ENDPOINT');
        $this->namespace = env('NACOS_NAMESPACE');
        $this->port = env('NACOS_PORT', $this->port);
        $this->dataId = env('NACOS_DATA_ID');
        $this->group = env('NACOS_GROUP');

        if (!$this->validate()) {
            $this->error('請檢查配置引數');

            return;
        }

        $this->client = new Client(['verify' => false]);

        $this->info('Nacos 配置工具');

        $actions = [
            '獲取配置',
            '釋出配置',
            '刪除配置',
        ];

        if (is_null($this->argument('action'))) {
            $action = $this->choice('請選擇操作',
                $actions,
                $actions[0]);
        } else {
            if (in_array($this->argument('action'), array_keys($actions))) {
                $action = $actions[$this->argument('action')];
            } else {
                $action = $this->choice('請選擇操作',
                    $actions,
                    $actions[0]);
            }
        }

        $this->do($action);
    }

    public function do($action = '獲取配置')
    {
        switch ($action) {
            default:
            case '獲取配置':
                $config = $this->getConfig();

                if ($config) {
                    file_put_contents('.env', $config);
                    $this->info('獲取配置成功');
                } else {
                    $this->error('獲取配置失敗');
                }

                break;
            case '釋出配置':
                if ($this->publishConfig()) {
                    $this->info('釋出配置成功');
                } else {
                    $this->error('釋出配置失敗');
                }

                break;

            case '刪除配置':
                if ($this->removeConfig()) {
                    $this->info('刪除配置成功');
                } else {
                    $this->error('刪除配置失敗');
                }

                break;
        }
    }

    /**
     * 驗證配置引數
     *
     * Date: 2020/6/10
     * @return bool
     */
    private function validate()
    {
        $data = [
            'accessKey' => $this->accessKey,
            'secretKey' => $this->secretKey,
            'endpoint'  => $this->endpoint,
            'namespace' => $this->namespace,
            'dataId'    => $this->dataId,
            'group'     => $this->group,
        ];

        $rules = [
            'accessKey' => 'required',
            'secretKey' => 'required',
            'endpoint'  => 'required',
            'namespace' => 'required',
            'dataId'    => 'required',
            'group'     => 'required',
        ];

        $messages = [
            'accessKey.required' => '請填寫`.env`配置 NACOS_ACCESS_KEY',
            'secretKey.required' => '請填寫`.env`配置 NACOS_SECRET_KEY',
            'endpoint.required'  => '請填寫`.env`配置 NACOS_ENDPOINT',
            'namespace.required' => '請填寫`.env`配置 NACOS_NAMESPACE',
            'dataId.required'    => '請填寫`.env`配置 NACOS_DATA_ID',
            'group.required'     => '請填寫`.env`配置 NACOS_GROUP',
        ];

        $validator = Validator::make($data, $rules, $messages);

        if ($validator->fails()) {
            foreach ($validator->getMessageBag()->toArray() as $item) {
                foreach ($item as $value) {
                    $this->error($value);
                }
            }

            return false;
        }

        return true;
    }

    /**
     * 獲取配置
     *
     * Date: 2020/6/10
     * @return bool
     */
    private function getConfig()
    {
        $acmHost = str_replace(['host', 'port'], [$this->getServer(), $this->port],
            'http://host:port/diamond-server/config.co');

        $query = [
            'dataId' => urlencode($this->dataId),
            'group'  => urlencode($this->group),
            'tenant' => urlencode($this->namespace),
        ];

        $headers = $this->getHeaders();

        $response = $this->client->get($acmHost, [
            'headers' => $headers,
            'query'   => $query,
        ]);

        if ($response->getReasonPhrase() == 'OK') {
            return $response->getBody()->getContents();
        } else {
            return false;
        }
    }

    /**
     * 釋出配置
     *
     * Date: 2020/6/10
     * @return bool
     */
    public function publishConfig()
    {
        $acmHost = str_replace(
            ['host', 'port'],
            [$this->getServer(), $this->port],
            'http://host:port/diamond-server/basestone.do?method=syncUpdateAll');

        $headers = $this->getHeaders();

        $formParams = [
            'dataId'  => urlencode($this->dataId),
            'group'   => urlencode($this->group),
            'tenant'  => urlencode($this->namespace),
            'content' => file_get_contents('.env'),
        ];

        $response = $this->client->post($acmHost, [
            'headers'     => $headers,
            'form_params' => $formParams,
        ]);

        $result = json_decode($response->getBody()->getContents(), 1);

        return $result['message'] == 'OK';
    }

    public function removeConfig()
    {
        $acmHost = str_replace(['host', 'port'], [$this->getServer(), $this->port],
            'http://host:port/diamond-server//datum.do?method=deleteAllDatums');

        $headers = $this->getHeaders();

        $formParams = [
            'dataId' => urlencode($this->dataId),
            'group'  => urlencode($this->group),
            'tenant' => urlencode($this->namespace),
        ];

        $response = $this->client->post($acmHost, [
            'headers'     => $headers,
            'form_params' => $formParams,
        ]);

        $result = json_decode($response->getBody()->getContents(), 1);

        return $result['message'] == 'OK';
    }

    /**
     * 獲取配置伺服器地址
     *
     * Date: 2020/6/10
     * @return string
     */
    private function getServer()
    {
        if ($this->serverUrl) {
            return $this->serverUrl;
        }

        $serverHost = str_replace(
            ['host', 'port'],
            [$this->endpoint, $this->port],
            'http://host:port/diamond-server/diamond');

        $response = $this->client->get($serverHost);

        return $this->serverUrl = rtrim($response->getBody()->getContents(), PHP_EOL);
    }

    /**
     * 獲取請求頭
     *
     * Date: 2020/6/10
     * @return array
     */
    private function getHeaders()
    {
        $headers = [
            'Diamond-Client-AppName' => 'ACM-SDK-PHP',
            'Client-Version'         => '0.0.1',
            'Content-Type'           => 'application/x-www-form-urlencoded; charset=utf-8',
            'exConfigInfo'           => 'true',
            'Spas-AccessKey'         => $this->accessKey,
            'timeStamp'              => round(microtime(true) * 1000),
        ];

        $headers['Spas-Signature'] = $this->getSign($headers['timeStamp']);

        return $headers;
    }

    /**
     * 獲取簽名
     *
     * @param $timeStamp
     * Date: 2020/6/10
     * @return string
     */
    private function getSign($timeStamp)
    {
        $signStr = $this->namespace.'+';

        if (is_string($this->group)) {
            $signStr .= $this->group."+";
        }

        $signStr = $signStr.$timeStamp;

        return base64_encode(hash_hmac(
            'sha1',
            $signStr,
            $this->secretKey,
            true
        ));
    }
}

使用示例

註冊賬號，開通服務這些就不說了
.env 新增配置項 NACOS_ACCESS_KEY NACOS_SECRET_KEY 等
php artisan nacos 0 獲取配置
php artisan nacos 1 釋出配置
php artisan nacos 2 刪除配置

配置項說明

NACOS_ENDPOINT= #nacos節點 如使用阿里雲服務 即:acm.aliyun.com
NACOS_DATA_ID= #專案ID 可以填專案名
NACOS_GROUP= #分組ID 這裡可以用於區分環境 建議 local production test 等值
NACOS_NAMESPACE= # 名稱空間 建議用來區分伺服器 server-A server-B
NACOS_ACCESS_KEY= #阿里雲access_key 建議使用子賬號access_key
NACOS_SECRET_KEY= #阿里雲secret_key 建議使用子賬號secret_key

總結

使用 nacos 後，再也不用擔心 .env.example 忘記加配置項，共享配置也不是件麻煩事了，自動部署也不需要頻繁的改動配置了。

本作品採用《CC 協議》，轉載必須註明作者和本文連結

Be the one you want to be.

Nacos 多環境配置
2020-11-19
yml檔案中使用profile配置切換多環境
2024-08-25
Windows 下 Laravel 環境配置
2018-09-08
WindowsLaravel
springboot系列學習（八）：yml配置檔案，多環境下的相互切換
2020-09-29
Spring Boot
【原創】vs2022配置切換多個ollvm環境
2024-12-03
LVM
深圳java培訓：SpringBoot的yml配置及多環境切換
2019-11-13
JavaSpring Boot
Laravel 配置多環境env檔案
2021-04-26
Laravel
Mac環境下WingIDE切換python版本
2019-01-04
MacIDEPython
分享MacBook下laravel多版本docker開發環境配置方案
2023-04-05
MacLaravelDocker開發環境
window環境下安裝和切換兩個python環境
2024-07-09
Python
webpack介面環境切換的配置-超簡單
2020-09-28
Web
pycharm切換conda環境
2024-06-17
PyCharm
Spring Cloud Alibaba基礎教程：Nacos配置的多環境管理
2019-01-31
SpringCloud
docker下springboot的多環境配置
2020-12-09
DockerSpring Boot
Webpack下多環境配置的思路
2018-06-26
Web
jenkins動態切換環境
2024-08-31
Jenkins
Docker下的Nacos環境開發
2022-10-04
Docker
SpringBoot多環境配置
2024-04-01
Spring Boot
Maven多環境配置
2019-06-05
Maven
vue 多環境配置
2020-12-24
Vue
多執行緒環境下 PyQtGraph 繪畫解決方案
2024-03-05
執行緒QT
關於使用springboot的application.yml切換dev配置環境
2020-09-25
Spring BootAPPdev
WSL2配置laravel環境
2020-10-05
Laravel
【Linux】gnome桌面環境切換KDE Plasma
2024-08-21
LinuxASM
vue 構建環境切換指令碼
2019-04-23
Vue指令碼
app 測試環境切換問題
2020-12-19
APP
Homestead 環境中 PHP 版本快速切換
2018-12-04
PHP
springboot多環境下如何進行動態配置
2022-06-08
Spring Boot
Windows 環境下安裝 Laravel
2019-05-29
WindowsLaravel
Pytest 如何使用切換被測試環境
2024-05-15
含有replication環境的sqlserver切換到standby
2019-04-30
SQLServer
jupyter notebook中切換不同的Python環境
2020-11-24
Python
SpringBoot多環境日誌配置
2024-08-26
Spring Boot
WIndows環境配置多版本Java
2024-05-29
WindowsJava
SpringBoot配置Profile多環境支援
2018-11-07
Spring Boot
kubeconfig 多個叢集配置如何切換
2024-06-01
CentOS下Ant環境配置
2021-04-04
CentOS
Maven環境下MyBatisGenerator 配置
2019-04-13
MavenMyBatis

Nacos 解決 laravel 多環境下配置切換

前言

痛點

Nacos 簡介

應用

程式碼

使用示例

配置項說明

總結

相關文章