Symf欧宝娱乐app下载地址ony框架最佳实践

5.3版本
欧宝娱乐app下载地址symfony 5.3支持通过JoliCode

Symf欧宝娱乐app下载地址ony框架最佳实践

本文介绍了使用Symfony开发web应用程序的最佳实践欧宝娱乐app下载地址这适合原始Symfony创作者设想的哲学。欧宝娱乐app下载地址

如果您不同意其中一些建议,他们可能是一个好的初始点那你可以扩展并适应您的特定需求.您甚至可以完全忽略它们并继续使用您自己的最佳实践和方法。欧宝娱乐app下载地址Symfony足够灵活,以适应您的需求。

本文假设您已经有开发Symfony应用程序的经验。欧宝娱乐app下载地址如果你不知道,那就先读开始文件的一部分。欧宝体育电话

提示

欧宝娱乐app下载地址Symfony提供了一个调用示例应用程序欧宝娱乐app下载地址Symfony演示这遵循所有这些最佳实践,所以你可以在实践中体验它们。

创建项目

使用symfon欧宝娱乐app下载地址y二进制文件来创建Symfony应用程序

Symf欧宝娱乐app下载地址ony二进制文件是在您的机器上创建的可执行命令OB体育 .它提供了多种实用工具,包括创建新的Symfony应用程序的最简单方法:欧宝娱乐app下载地址

1
欧宝娱乐app下载地址symfony新my_project_name

在引擎盖下,此Symfony Binary欧宝娱乐app下载地址命令执行所需的作曲家命令创建一个新的Symfony欧宝娱乐app下载地址应用程序基于当前稳定版本。

使用默认目录结构

除非您的项目遵循强加某种目录结构的开发实践,否则请遵循默认的Symfony目录结构。欧宝娱乐app下载地址它是扁平的,不言自明的,没有与Symfony关联:欧宝娱乐app下载地址

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
your_project /├─资产/├─SRC /│├─kernel.php│├──控制器/│├───枝/├─模板/├─测试/├─翻译/├─var /│├─cache/│└─log /└─供应商/

配置

使用环境变量进行基础架构配置

这些选项的值从一台机器更改为另一台计算机(例如,从您的开发机到生产服务器),但它们不会修改应用程序行为。

在项目中使用env vars要定义这些选项并创建多个选项.env.文件配置每个环境的env变量

对敏感信息使用秘密

当你的应用程序有敏感的配置-像一个API密钥-你应该安全地存储这些通过欧宝娱乐app下载地址Symfony的秘密管理系统

使用参数配置应用程序

这些是用于修改应用程序行为的选项,例如电子邮件通知的发件人或已启用功能切换.它们的值不会每台计算机更改,因此请勿将其定义为环境变量。

定义这些选项参数配置/ services.yaml文件。您可以覆盖每个选项环境配置/ services_dev.yaml配置/ services_prod.yaml文件。

使用短且带前缀的参数名称

考虑使用应用程序。作为你的前缀参数避免与symfony和第三方捆绑/库参数碰撞。欧宝娱乐app下载地址然后,只使用一个或两个单词来描述参数的目的:

1 2 3 4 5 6 7 8 9 10
#配置/ services.yaml参数#不要这样做:'dir'太普通了,它没有传达任何含义app.dir'...'#这样做:简短但容易理解的名字app.contents_dir'...'#可以使用点,下划线,破折号或任何东西,但总是可以#保持一致,所有参数使用相同的格式app.dir.contents'...'app.contents-dir.'...'

使用常量定义很少更改的选项

配置选项(如要在某些清单中显示的项数)很少改变。而不是把它们定义为配置参数,将它们定义为相关类中的PHP常量。例子:

/ / src /实体/ Post.php名称空间App \实体帖子公共const项目数10.// ......

常量的主要优点是可以在任何地方使用它们,包括Twig模板和Doctrine实体,而参数只能在访问服务容器

使用这种配置值的常量的唯一值得注意的缺点是重新定义测试中的值是复杂的。

业务逻辑

不要创建任何捆绑包以组织您的应用程序逻辑

当Symf欧宝娱乐app下载地址ony 2.0发布时,使用的应用程序捆绑将他们的代码划分成逻辑特性:UserBundle, ProductBundle, InvoiceBundle等等。但是,bundle意味着可以作为独立的软件部分重用。

如果您需要在您的项目中重用某些特性,那么为它创建一个bundle(在私有存储库中,不让它公开)。对于应用程序代码的其余部分,使用PHP名称空间来组织代码,而不是绑定包。

使用Autowiring自动执行应用程序服务的配置

服务自动装配是一个要在构造函数(或其他方法)上的类型提示的功能,并自动将正确的服务传递给每个方法,这使得不必明确配置服务并简化应用程序维护。

与它结合使用服务自动配置还添加服务标签到需要它们的服务,如Twig扩展、事件订阅者等。

服务应该是私人的

使服务私密防止您通过访问这些服务$ contains-> get().相反,您需要使用适当的依赖注入。

使用yaml格式来配置您自己的服务

如果你使用默认的服务。yaml的配置,大多数服务将自动配置。然而,在某些边缘情况下,您需要手动配置服务(或服务的一部分)。

yaml是建议配置服务的格式,因为它对新人和简洁方面很友好,但Symfony也支持XML和PHP配置。欧宝娱乐app下载地址

使用注释来定义学说实体映射

教义实体是您存储在某些“数据库”中存储的普通PHP对象。Doctrine仅通过为模型类配置的映射元数据了解您的实体。

Doctrine支持几种元数据格式,但建议使用注释,因为它们是迄今为止最方便、最敏捷的设置和查找映射信息的方式。

控制器

使您的控制器扩展AbstractController.基础控制器

欧宝娱乐app下载地址Symfony提供了一个基本控制器其中包括最常见的需要的快捷方式,例如呈现模板或检查安全权限。

从此管理控制器扩展控制器将您的应用程序耦合到Symfony。欧宝娱乐app下载地址耦合通常是错误的,但在这种情况下可能还可以,因为控制器不应包含任何业务逻辑。控制器应该包含超过几行胶水代码,因此您不耦合应用程序的重要部分。

使用属性或注释配置路由、缓存和安全性

使用属性或注释进行路由,缓存和安全性简化了配置。您无需浏览具有不同格式创建的多个文件(yaml,XML,PHP):所有配置只是您需要它的位置,它只使用一种格式。

不要使用注释来配置控制器模板

@模板注释是有用的,但也涉及一些魔法.而且,大部分时间@模板在没有任何参数的情况下使用,这使得可以更难以知道正在呈现的模板。它还隐藏了控制器应始终返回的事实响应目的。

使用依赖注入来获取服务

如果延长基础AbstractController.,您只能访问最常见的服务(例如枝条路由器教义等),直接从集装箱通过$ this - >容器> get ()或者$ this - > get ().相反,您必须使用依赖注入来获取服务类型提示动作方法参数或构造函数参数。

如果方便的话,使用参数转换器

如果您正在使用教义,那么你可以(可选)使用ParamConverter自动查询实体并将其传递为控制器的参数。如果没有找到实体,它还将显示一个404页面。

如果从路由变量获取实体的逻辑更复杂,那么与其配置ParamConverter,不如在控制器内部进行Doctrine查询(例如,通过调用教义存储库方法).

模板

使用蛇盒进行模板名称和变量

使用Depoised Snake_Case进行模板名称,目录和变量(例如用户资料而不是userProfile产品/ edit_form.html.twig.而不是Product / EditForm.html.twig.).

前缀模板片段与下划线

模板碎片,也称为“部分模板”,允许重用模板内容.用下划线前缀他们的名称以更好地将它们与完整模板区分开(例如_user_metadata.html.twig或者_caution_message.html.twig.).

形式

将您的表单定义为PHP类

创造形式类允许在应用程序的不同部分重用它们。此外,不在控制器中创建表单简化了控制器的代码和维护。

在模板中添加表单按钮

表格类应不可知论于它们将使用它们的位置。例如,用于创建和编辑项目的表单的按钮应根据所用的位置,“添加新”改变为“保存更改”。

与其在表单类或控制器中添加按钮,不如在模板中添加按钮。这还改进了关注点的分离,因为按钮样式(CSS类和其他属性)是在模板中而不是在PHP类中定义的。

但是,如果您创建一个具有多个提交按钮的形式您应该在控制器而不是模板中定义它们。否则,当在控制器中处理表单时,您将无法检查单击了哪个按钮。

在基础对象上定义验证约束

附加验证约束要形成字段而不是映射对象可防止验证在其他表单中重用或使用对象的其他位置。

使用单个动作呈现并处理表单

呈现形式处理形式处理表格时是两个主要任务。两者都太相似(大多数时间,几乎相同),因此可以让单个控制器动作句柄更简单。

国际化

使用xliff格式进行翻译文件

Symfony支持的所有翻译格式(PHP, Qt,欧宝娱乐app下载地址.po..mo.,json,csv,Ini等),XLIFFGetText.在专业翻译人员使用的工具中具有最佳支持。由于它基于XML,您可以验证XLIFF在编写内容时对其进行文件化。

欧宝娱乐app下载地址Symfony还支持XLIFF文件中的注释,使它们对翻译人员更加友好。最后,好的翻译都与上下文有关,这些XLIFF注释允许您定义该上下文。

使用键翻译而不是内容字符串

使用密钥简化了翻译文件的管理,因为您可以更改模板、控制器和服务中的原始内容,而不必更新所有翻译文件。

钥匙应该始终描述他们的目的不是他们的位置。例如,如果表单具有标签“用户名”的字段,则将是一个很好的键label.username.不是edit_form.label.username.

安全

定义单个防火墙

除非您有两个合法的不同身份验证系统和用户(例如,仅为您的API的主站点和令牌系统进行登录),否则它建议只有一个防火墙来保持简单。

此外,您应该使用匿名的在你的防火墙下密钥。如果您要求用户登录站点的不同部分,请使用访问控制选择。

使用汽车密码哈尔

自动密码哈尔根据您的PHP安装自动选择最佳的编码器/ Hasher。从symfony 5.3开始欧宝娱乐app下载地址,默认的自动哈尔是Bcrypt.

使用投票者来实现细粒度的安全限制

如果您的安全逻辑很复杂,则应创建自定义安全的选民而不是在里面定义长长的表达@安全注释。

网络资产

使用WebPack Encore来处理Web资产

Web资产是像CSS, JavaScript和图像文件这样的东西,使你的网站的前端看起来和工作很好。网客是领先的JavaScript模块Bundler,可在浏览器中编译,转换和包装资产。

Webpack安可是一个JavaScript库,可以摆脱大多数网站复杂性,而不隐藏其任何功能或扭曲其使用和哲学。它最初是为Symfony应用程序创建的,但它适用于使用任何技欧宝娱乐app下载地址术的任何应用程序。

测试

烟雾测试你的网址

在软件工程中,冒烟测试由组成“初步测试揭示了严重的简单失败,以拒绝预期软件释放”.使用PHPUNIT数据提供者你可以定义一个功能测试来检查所有的应用程序url是否成功加载:

/ /测试/ ApplicationAvailabilityFunctionalTest.php名称空间app \ test.欧宝娱乐app下载地址Symfony \包\ FrameworkBundle \ \ WebTestCase测试ApplicationAvailabilityFunctionaltest.延伸WebTestCase./ *** @dataProvider urlProvider* /公共功能testpageissuccessful.$ url$客户自己::createClient();$客户- >请求'得到'$ url);$这一点- >assertrecesteSiseucesfess();公共功能URLProvider.()屈服' / '];屈服'/ posts'];屈服' / post / fixture-post-1 '];屈服' /博客/类别/ fixture-category '];屈服'/档案'];// ......

创建应用程序时添加此测试,因为它需要很少的努力并检查您的任何页面是否返回错误。稍后,您将为每个页面添加更具体的测试。

功能测试中的硬核代码URL

在Sy欧宝娱乐app下载地址mfony应用程序中,它建议使用生成的url使用路由在URL更改时自动更新所有链接。但是,如果公共URL更改,除非您为新URL设置重定向,否则用户将无法浏览它。

这就是为什么建议在测试中使用原始url,而不是从路由生成url的原因。每当路由更改时,测试将失败,您将知道必须设置重定向。

这项工作,包括代码样本,是在一个Creative Commons by-SA 3.0许可证。