RabbitMqBundle 技术文档

1. 安装指南

1.1 安装要求

• 确保已安装并运行 RabbitMQ 服务器。
• 项目支持 Symfony 4.4 及以上版本。

1.2 使用 Composer 安装

在项目根目录下运行以下命令，使用 Composer 安装 RabbitMqBundle：

$ composer require php-amqplib/rabbitmq-bundle

1.3 注册 Bundle

在 app/AppKernel.php 文件中注册 Bundle：

public function registerBundles()
{
    $bundles = array(
        new OldSound\RabbitMqBundle\OldSoundRabbitMqBundle(),
    );
}

1.4 配置 Symfony Console 应用

如果你的项目是一个使用 Symfony Console、Dependency Injection 和 Config 组件的控制台应用，可以按照以下步骤配置：

1. 在 composer.json 文件中添加依赖：

{
    "require": {
        "php-amqplib/rabbitmq-bundle": "^2.0"
    }
}

2. 注册扩展和编译器：

use OldSound\RabbitMqBundle\DependencyInjection\OldSoundRabbitMqExtension;
use OldSound\RabbitMqBundle\DependencyInjection\Compiler\RegisterPartsPass;

$containerBuilder->registerExtension(new OldSoundRabbitMqExtension());
$containerBuilder->addCompilerPass(new RegisterPartsPass());

2. 项目使用说明

2.1 配置连接和消息端点

在 Symfony 配置文件中添加 old_sound_rabbit_mq 配置节，定义连接和消息端点：

old_sound_rabbit_mq:
    connections:
        default:
            host: 'localhost'
            port: 5672
            user: 'guest'
            password: 'guest'
            vhost: '/'
            lazy: false
            connection_timeout: 3
            read_write_timeout: 3
            channel_rpc_timeout: 0.0
            keepalive: false
            heartbeat: 0
            use_socket: true
            login_method: 'AMQPLAIN'
    producers:
        upload_picture:
            connection: default
            exchange_options: {name: 'upload-picture', type: direct}
            service_alias: my_app_service
            default_routing_key: 'optional.routing.key'
            default_content_type: 'content/type'
            default_delivery_mode: 2
    consumers:
        upload_picture:
            connection: default
            exchange_options: {name: 'upload-picture', type: direct}
            queue_options: {name: 'upload-picture'}
            callback: upload_picture_service
            options:
                no_ack: false

2.2 发布消息

在 Symfony 控制器中发布消息：

$msg = array('user_id' => 1235, 'image_path' => '/path/to/new/pic.png');
$this->get('old_sound_rabbit_mq.upload_picture_producer')->publish(serialize($msg));

2.3 消费消息

在命令行中运行消费者：

$ ./app/console rabbitmq:consumer -m 50 upload_picture

3. 项目 API 使用文档

3.1 生产者 API

生产者用于发布消息到 RabbitMQ。通过 old_sound_rabbit_mq.upload_picture_producer 服务发布消息：

$producer = $this->get('old_sound_rabbit_mq.upload_picture_producer');
$producer->publish(serialize($msg));

3.2 消费者 API

消费者用于从 RabbitMQ 队列中消费消息。通过 old_sound_rabbit_mq.upload_picture_consumer 服务消费消息：

$ ./app/console rabbitmq:consumer -m 50 upload_picture

4. 项目安装方式

4.1 通过 Composer 安装

使用 Composer 安装 RabbitMqBundle：

$ composer require php-amqplib/rabbitmq-bundle

4.2 注册 Bundle

在 app/AppKernel.php 文件中注册 Bundle：

public function registerBundles()
{
    $bundles = array(
        new OldSound\RabbitMqBundle\OldSoundRabbitMqBundle(),
    );
}

4.3 配置 Symfony Console 应用

如果你的项目是一个使用 Symfony Console、Dependency Injection 和 Config 组件的控制台应用，可以按照以下步骤配置：

1. 在 composer.json 文件中添加依赖：

{
    "require": {
        "php-amqplib/rabbitmq-bundle": "^2.0"
    }
}

2. 注册扩展和编译器：

use OldSound\RabbitMqBundle\DependencyInjection\OldSoundRabbitMqExtension;
use OldSound\RabbitMqBundle\DependencyInjection\Compiler\RegisterPartsPass;

$containerBuilder->registerExtension(new OldSoundRabbitMqExtension());
$containerBuilder->addCompilerPass(new RegisterPartsPass());

通过以上步骤，你可以成功安装并使用 RabbitMqBundle 进行消息队列的管理和操作。