README

Symfony基于注解的services.yml生成器

使用场景

最小化基于单文件services.yml依赖注入产生的冲突问题

安装

1. 使用composer安装

   composer require metglobal/composer-service-handler

2. 在composer.json中将"symfony-scripts"列表中的"Metglobal\\ServiceHandler\\ScriptHandler::buildServices"命令定义。它应该看起来像以下这样

    "scripts": {
        ...
        "post-install-cmd": [
           "Metglobal\\ServiceHandler\\ScriptHandler::buildServices",
           "@auto-scripts"
        ],
        "post-update-cmd": [
           "Metglobal\\ServiceHandler\\ScriptHandler::buildServices",
           "@auto-scripts"
        ],
        "post-autoload-dump": [
           "Metglobal\\ServiceHandler\\ScriptHandler::buildServices"
        ],
    }
   

3. 定义哪些包将在应用目录中自动生成services.yml

   service.yml

   parameters:
       locale: en
       service_handler:
           App\:
               resource: 'src/'
               exclude: 'src/{Controller,Entity,Exclude,Repository,Kernel.php}'
   
   
   
   

4. 在composer.json文件extra部分中将要处理的文件定义为metglobal-services

   composer.json

   "extra": {
        ...
        "metglobal-services": {
           "file": "config/services.yaml"
        }
   }
   
   

5. 将services.yml添加到.gitignore

用法

每次执行composer install或composer update命令后，services.yml将自动生成

在仓库类中使用@Service注解的用法

namespace App\Repository;

use Metglobal\ServiceHandler\Annotation\Service;

/**
 * @Service(
 *     id="app.repository.my_repository",
 *     factory= {"@doctrine.orm.default_entity_manager", "getRepository"},
 *     arguments={"App:MyEntity"},
 *     calls={
 *          {"setSender", {"@App\Mailer\Sender"}}
 *     }
 *    )
 */
class MyRepository {

}

在事件监听类中使用@Service注解的用法

namespace App\EventListener;

use Metglobal\ServiceHandler\Annotation\Service;
use Metglobal\ServiceHandler\Annotation\Tag;

/**
 * @Service(
 *     id="app.event_listener.my_listener",
 *     arguments={
 *          "@App\Repository\MyRepository",
 *          "@App\Mailer\Sender"     
 *     },
 *     tags={
 *          @Tag(name="kernel.event_listener", event="success", method="onSuccess"),
 *          @Tag(name="kernel.event_listener", event="fail", method="onFail")
 *     }
 *    )
 */
class MyListener {

}

@Service注解的用法与基于services.yml的定义没有区别。