Symfony 4：如何组织文件夹结构（即您的业务逻辑）

Question

在Symfony Best Practices建议不要使用bundle来组织业务逻辑。

只有当其中的代码要在其他应用程序中按原样重用时，才应使用这些包：

But a bundle is meant to be something that can be reused as a stand-alone piece of software. If UserBundle cannot be used "as is" in other Symfony apps, then it shouldn't be its own bundle.

所以，当我将我的应用程序从 Symfony 3.3 升级到 Symfony 4 时，我认为现在是重组我的代码的正确时机。

目前我已经关注了"bundled-structure":

- src
   - AppBundle
      - Controller
      - Entity
      - Repository
      - Resources
      - ...
   - MyNamespace
      - Bundle
          - BundleTodo
              - Controller
              - Entity
              - Repository
              - Resources
              - ...
          - BundleCatalog
              - Controller
              - Entity
              - Repository
              - Resources
              - ...
          - BundleCart
              - Controller
              - Entity
              - Repository
              - Resources
              - ...
          - ...

现在，有了新的目录结构，我应该如何组织我的代码？

我想这样组织：

-src
   - Core
      - Controller
      - Entity
      - Repository
      - ..
   - Todos
      - Controller
      - Entity
      - Repository
      - ..
   - Catalog
      - Controller
      - Entity
      - Repository
      - ..
   - Cart
      - Controller
      - Entity
      - Repository
      - ...

但是，这是正确的吗？ Symfony 4 和 Flex 预期的文件夹结构有问题吗？

或者像这样更好：

-src
   - Controller
       - Core
       - Todos
       - Catalog
       - Cart
       - ...
   - Entity
       - Core
       - Todos
       - Catalog
       - Cart
       - ...
   - Repository
       - Core
       - Todos
       - Catalog
       - Cart
       - ...
   - ...

这同样适用于 project directory structure（关于如何覆盖它）中描述的其他根文件夹。

在决定我的新文件夹结构时是否需要考虑任何规则或限制？

正在尝试解决问题

所以，为了解决这个问题，我将更深入地阅读文档，并将在这里写下我会发现的内容。

控制器：使用 fine grained configuration of controllers。
树枝：
实体：使用orm.entity_managers.some_em.mappings.mapping_name

Answer 1

如评论中所述，Symfony 可以很好地处理所有这些结构，所以我们确实不能在这里有一个可接受的答案，但这是我的两分钱。

老实说，最好的做法是独立于框架来组织架构（主要是因为这个原因，Symfony 4 不再强制捆绑）。

但事实上，除了非常具体或复杂的项目，有一个"symfony-oriented"组织会更实际。

以下是我的个人喜好，并且也受到我项目类型的强烈影响（面向 CRUD，Rest API，没有很强的业务逻辑）

总的来说，我正在朝着这样的结构发展：

-src
   - Controller
       - Core
       - Todos
       - ...
   - Entity
       - Core
       - Todos
       - ...
   - Repository
       - Core
       - Todos
   - Validator (or other Symfony oriented components)
       - Core
       - Todos
   - Others (depend on project)
       - Core
       - Todos
   - ...

原因是：

使用自动装配减少服务定义 - 是的，我很懒 ;-)

如果您需要将存储库或控制器注册为服务，只需声明一次即可。
在 Symfony Flex 配方中，通常使用这种结构。

DoctrineBundle 例如初始化 src/Entity 和 src/Repository 包含实体的文件夹和配方也使用此结构。

但请记住，Symfony Flex 不是强制性的。其目的主要是为了简化项目的初始化，让框架更容易被初学者使用

Answer 2

康威定律：

organizations which design systems ... are constrained to produce designs which are copies of the communication structures of these organizations.

您应该围绕组织工作的方式来设计目录结构。

如果您或您的同事在每个功能的基础上进行全栈工作，您应该按功能对代码进行分组。它将使导航和代码发现更加容易。

如果您或您的同事非常擅长后端、前端、翻译等，您应该围绕这些来组织代码。基于每个功能的目录结构将支持明确的职责划分。

此外，深度应该取决于您预见的项目有多大。如果这将是 5 人以上的 5 年以上的努力，那么您可能应该根据工作组织对每个特性和每个功能进行拆分并嵌套，如前所述。如果这将是一个人的 3 个月项目，即一些简单的内部工具，你可能应该使用更扁平的结构。我还建议坚持默认设置。

此外，我发现这篇文章内容丰富：https://blog.nikolaposa.in.rs/2017/01/16/on-structuring-php-projects/

Answer 3

第二种结构比较适合应用复杂，业务领域分散。
使用 Symfony 4 可以很容易地以这种方式配置其应用程序。

├─ assets/
├─ bin/
│  └─ console
├─ config/
│  ├─ doctrine/ 
│  │    ├─ core/
│  │    └─ sample/
│  ├─ packages/
│  ├─ routes/
│  └─ validator/
│  │    ├─ core/
│  │    └─ sample/
├─ public/
│  └─ index.php
├─ src/
│  ├─ Core/         
│  │  ├─ Controller/
│  │  ├─ Entity/
│  │  ├─ Repository/
│  │  └─ ...
│  ├─ Sample/      
│  └─ ...
├─ templates/
│  ├─ core/
│  └─ sample/
├─ tests/
├─ translations/
├─ var/
│  ├─ cache/
│  ├─ log/
│  └─ ...
└─ vendor/

只需一点配置：服务自动连接、自动配置等...工作起来非常棒。

# config/packages/doctrine.yaml
doctrine:
    # ...
    orm:
        # ...
        auto_mapping: true
        mappings:
            App\Core:
                is_bundle: false
                type: yml
                dir: '%kernel.project_dir%/config/doctrine/core'
                prefix: 'App\Core\Entity'
                alias: 'AppCore'


#config/routes/annotations.yaml
core_controllers:
    resource: ../../src/Core/Controller/
    type: annotation


# config/services.yaml
# But I prefer to put this on a separate config/services/_auto.yaml
services:
    App\:
        resource: '../../src/*/*'
        exclude: '../../src/*/{Entity,Migrations,Tests,Kernel.php}'

    app_controller:
        namespace: App\
        resource: '../../src/*/Controller'
        tags: ['controller.service_arguments']

Symfony 4：如何组织文件夹结构（即您的业务逻辑）

Symfony 4: How to organize folder structure (namely, your business logic)

symfony

symfony4