README

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

使用场景

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

安装

1. 使用composer安装

1. 在composer.json中添加"symfony-scripts"列表中的"Compass\ServiceHandler\ScriptHandler::buildServices"命令。它应该看起来像下面这样

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

2. 定义哪个包将自动在app文件夹中生成services.yml

   service.yml

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

1. 在composer.json文件的extra部分作为compass-services定义将处理哪个文件

   composer.json

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

2. 将services.yml添加到.gitignore

使用方法

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

在仓库类中使用@Service注解

namespace App\Repository;

use Compass\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 Compass\ServiceHandler\Annotation\Service;
use Compass\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的定义没有区别。