使用 Laravel 和 Docker 创建 CLI 应用程序

什么是 cli 应用程序？

cli（命令行界面）应用程序是一种计算机程序，它通过在终端或控制台中输入的文本命令与用户进行交互。与依赖图形用户界面 (gui) 的 web 应用程序不同，cli 应用程序基于文本，通常用于自动化、系统管理和数据处理任务。

为什么选择 laravel 和 docker？

laravel 是一个强大的 php 框架，可以简化 web 应用程序开发。其优雅的语法、强大的功能和广泛的生态系统使其成为构建 cli 应用程序的绝佳选择。使用 laravel 的 artisan 命令行工具，您可以快速创建和管理命令，从而轻松自动化任务和脚本。

docker 是一个容器化平台，它将应用程序及其依赖项打包到可移植容器中。通过使用 docker，我们可以为 laravel 应用程序创建隔离的环境，确保不同开发和生产环境之间的一致性和可重复性。

在本文中，我们将探讨如何利用 laravel 和 docker 构建健壮且高效的 cli 应用程序。

设置 laravel 项目

创建一个新的 laravel 项目

首先，让我们创建一个新的 laravel 项目。您可以使用 laravel 安装程序快速设置新项目：

laravel new my-cli-app

此命令将创建一个名为 my-cli-app 的新目录，并在其中初始化一个新的 laravel 项目。

配置 artisan 命令

laravel 的内置命令行工具 artisan 是框架的核心。我们可以使用它来创建和管理应用程序的各个方面。要创建新命令，我们将使用 make:command artisan 命令：

php artisan make:command greetuser

此命令将在 app/console/commands 目录中生成一个名为 greetuser 的新命令类。命令类的基本结构如下所示：

<?php

namespace app\console\commands;

use illuminate\console\command;

class greetuser extends command
{
    /**
     * the name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'greet:user {name?}';

    /**
     * the console command description.
     *
     * @var string
     */
    protected $description = 'greet a user';

    /**
     * execute the console command.
     *
     * @return int
     */
    public function handle()
    {
        $name = $this->argument('name');

        if ($name) {
            $this->info("hello, {$name}!");
        } else {
            $this->info('hello, world!');
        }

        return command::success;
    }
}

在此示例中：

- $signature：定义命令的名称和任何可选参数或选项。 {name?} 部分表示名为 name 的可选参数。
- $description：提供命令的简短描述。
-handle()：包含命令的核心逻辑。它使用 $this->argument('name') 访问 name 参数，并将问候消息打印到控制台。

要运行此命令，请在终端中使用以下命令：

php artisan greet:user johndoe

这将输出：

hello, johndoe!

编写命令逻辑

核心命令逻辑

handle() 方法是真正神奇的地方。您将在这里定义命令的核心逻辑。您可以访问命令参数和选项，与 laravel 框架交互，并执行各种任务。

以下是从 api 获取数据并处理数据的命令示例：

<?php

namespace app\console\commands;

use illuminate\console\command;
use illuminate\support\facades\http;

class fetchdata extends command
{
    protected $signature = 'fetch:data {url}';

    protected $description = 'fetch data from a given url';

    public function handle()
    {
        $url = $this->argument('url');

        $response = http::get($url);

        if ($response->successful()) {
            $data = $response->json();
            // process the data here
            $this->info('data fetched and processed successfully!');
        } else {
            $this->error('failed to fetch data.');
        }
    }
}

在此示例中：

- 获取数据：我们使用 http 外观将 http get 请求发送到指定的 url。
- 处理数据：如果请求成功，我们将解析 json 响应并根据需要处理数据。
- 输出：我们使用 info 和 error 方法向控制台显示消息。

测试命令

要测试您的命令，只需使用 php artisan 命令执行它：

php artisan fetch:data https://api.example.com/data

请记住将 https://api.example.com/data 替换为实际的 api 端点。

这将触发 fetchdata 命令的 handle() 方法，您应该在终端中看到适当的输出。

使用 docker 将应用程序容器化

docker 是一个用于容器化应用程序的强大工具。通过容器化您的 laravel 应用程序，您可以确保不同开发和生产设置之间的环境一致。

创建 dockerfile

dockerfile 是一个文本文档，其中包含有关如何构建 docker 映像的说明。这是 laravel 应用程序的基本 dockerfile：

# use the official php image as the base
from php:8.2-fpm-alpine

# set the working directory
workdir /app

# copy the composer.json and composer.lock files
copy composer.json composer.lock ./

# install dependencies
run composer install --no-interaction --no-ansi

# copy the rest of the application code
copy . .

# expose the container port
expose 9000

# start the application
cmd ["php", "artisan", "serve", "--host", "0.0.0.0"]

创建 docker compose 文件

docker compose 文件定义并运行多容器 docker 应用程序。这是 laravel 应用程序的基本 docker compose 文件：

version: '3.8'

services:
  app:
    build: .
    ports:
      - '8000:9000'
    volumes:
      - .:/app
    depends_on:
      - db

  db:
    image: mysql:8.0
    environment:
      mysql_root_password: root
      mysql_database: my_laravel_db
      mysql_user: my_laravel_user
      mysql_password: my_laravel_password

这个 docker compose 文件定义了两个服务：

• app：使用 dockerfile 构建 docker 映像，并将主机的端口 8000 映射到容器的端口 9000。它还将当前目录作为卷安装到容器中，从而允许实时代码更改。
• 数据库：提取 mysql 映像并使用指定的凭据设置数据库。

构建并运行 docker 镜像

树立形象

要构建 docker 映像，请导航到终端中项目的根目录并运行以下命令：

docker-compose build

此命令将构建 dockerfile 中定义的 docker 映像，并使用名称对其进行标记（通常是 docker-compose.yml 文件中的服务名称）。

运行容器

构建镜像后，您可以使用以下命令启动容器：

docker-compose up -d

此命令将以分离模式启动应用程序和数据库容器，允许您在浏览器中访问应用程序。您可以通过http://localhost:8000.

要停止容器，请使用以下命令：

docker-compose down

最佳实践和高级主题

指挥组织和模块化

随着 cli 应用程序的增长，保持命令的组织性和模块化非常重要。考虑将复杂的命令分解为更小、更集中的命令。您可以使用服务提供者和外观来注入依赖项并在命令之间共享逻辑。

错误处理和日志记录

实现强大的错误处理和日志记录对于调试和监控 cli 应用程序至关重要。 laravel 提供了一个强大的日志系统，您可以使用它来记录错误、警告和信息性消息。您还可以使用 loggly 或 papertrail 等外部日志记录工具来获得更高级的日志记录功能。

测试 cli 应用程序

为命令逻辑编写单元测试对于确保代码质量和可维护性至关重要。您可以使用 phpunit 或其他测试框架来编写涵盖不同场景和边缘情况的测试。

部署和 ci/cd

要部署 dockerized laravel 应用程序，您可以使用 kubernetes 或 docker swarm 等容器编排工具。这些工具允许您跨多个主机管理和扩展应用程序。
您还可以将应用程序与 ci/cd 管道集成，以自动执行构建、测试和部署流程。流行的 ci/cd 工具包括 jenkins、gitlab ci/cd 和 circleci。

通过遵循这些最佳实践和先进技术，您可以使用 laravel 和 docker 构建强大且高效的 cli 应用程序。

结论

在本文中，我们探索了如何使用 laravel 和 docker 构建健壮且高效的 cli 应用程序。通过利用这些工具的强大功能，您可以创建命令行工具来自动执行任务、处理数据以及与应用程序的基础架构交互。

我们已经介绍了创建 laravel 命令、编写命令逻辑以及使用 docker 容器化应用程序的基础知识。我们还讨论了命令组织、错误处理、测试和部署的最佳实践。

当您继续构建和增强 cli 应用程序时，请记住保持代码干净、经过良好测试且可维护。通过遵循这些指南并探索 laravel 和 docker 的高级功能，您可以创建强大且灵活的 cli 工具来简化您的工作流程。

以上就是使用 Laravel 和 Docker 创建 CLI 应用程序的详细内容，更多请关注php中文网其它相关文章！