Symfob娱乐下载ony框架最佳实践

5.2版本
维护 没有维护的

Symfob娱乐下载ony框架最佳实践

本文描述了使用Symfony开发Web应用程序的最佳实践ob娱乐下载这符合交响乐最初创始者的设想。ob娱乐下载

如果你不同意其中的一些建议,它们可能是好的起点然后你就可以延长并适合您的特定需求。您甚至可以完全忽略它们,继续使用您自己的最佳实践和方法。ob娱乐下载Symfony非常灵活,能够满足您的需求。

本文假设您已拥有开发Symfony应用程序的经验。ob娱乐下载如果你没有,请先阅读入门部分文档。欧宝官网下载app

小费

ob娱乐下载Symfony提供了一个示例应用程序ob娱乐下载symfony演示它遵循了所有这些最佳实践,所以您可以在实践中体验它们。

创建项目

使用Symfonob娱乐下载y二进制文件创建Symfony应用程序

Symfob娱乐下载ony二进制文件是当您在机器中创建的可执行命令下载Symfonyob娱乐下载。它提供多个实用程序,包括创建新Symfony应用程序的最简单方法:ob娱乐下载

1
$ob娱乐下载symfony new my_project_name.

在底层,这个Symfony二进制命令执行所ob娱乐下载需的命令作曲家命令创建一个新的symfonyob娱乐下载应用程序基于当前的稳定版本。

使用默认的目录结构

除非您的项目遵循强加某个目录结构的开发实践,否则请遵循默认的Symfony目录结构。ob娱乐下载这是平坦的,不言自明的,而不是耦合到Symfony:ob娱乐下载

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 18 19 20 21 21 22 23 22 22 22 22 22 28 22
│├─rammstein - du hast(2)——cat sound效果器整理www.catsound.com.cn│├─du hast(2)——cat sound效果器整理www.catsound.com.cnyaml├─迁移/├─公共/│├─构建/│└─index . php├─src /│├─Kernel.php│├─命令/│├─控制器/│├─DataFixtures /│├─实体/│├─EventSubscriber /│├─形式/│├─库/│├─安全/│└─树枝/├─模板/├─测试/├─翻译/├─var /│├─缓存/│└─日志/└─供应商/

配置

使用环境变量进行基础设施配置

这些选项的值在不同的机器之间会发生变化(例如,从开发机器到生产服务器),但是它们不会修改应用程序的行为。

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

敏感信息使用Secret

当您的应用程序具有敏感的配置时 - 就像API键 - 您应该通过安全性存储ob娱乐下载Symfony的秘密管理系统

使用应用程序配置参数

这些是用于修改应用程序行为的选项,例如电子邮件通知的发送者,或启用功能切换。它们的值不会在每台机器上更改,因此不要将它们定义为环境变量。

将这些选项定义为参数在里面配置/服务.YAML.文件。您可以覆盖这些选项环境在里面config / services_dev.yaml.config / services_prod.yaml.文件。

使用简短和前缀参数名称

考虑使用应用程序。作为你的前缀参数避免与Symfony和第三方bundle /库参数ob娱乐下载发生冲突。然后,用一两个词来描述参数的目的:

1 2 3 4 5 6 7 8 9 10
#配置/服务.YAML参数#不要这样做:'dir'太过通用,它不会传达任何含义app.dir.“……”#做这个:短但易于理解的名字app.contents_dir.“……”#可以使用点、下划线、破折号或什么都不使用,但总是这样#是一致的,并为所有参数使用相同的格式app.dir.contents.“……”app.contents-dir“……”

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

配置选项类似于在某些列表中显示的项目数很少更改。而不是将它们定义为服务容器参数,将它们定义为相关类中的PHP常量。例子:

// src /实体/ post.php命名空间应用程序\实体;班级邮政{上市常量NUMBER_OF_ITEMS=10;/ /……}

常量的主要优点是您可以在任何地方使用它们,包括树枝模板和学说实体,而参数只能从访问的地方提供服务容器

对这种配置值使用常量的唯一明显缺点是,在测试中重新定义它们的值很复杂。

商业逻辑

不要创建任何Bundle来组织你的应用逻辑

发布Symob娱乐下载fony 2.0时,使用了应用程序将其代码划分为逻辑功能:UserBundle,ProductBundle,InvoiceBundle等。但是,捆绑包是可以重用作为独立软件的东西。

如果您需要重用项目中的某些功能,请为其创建一个捆绑(在私有存储库中,以公开可用)。对于其余的应用程序代码,请使用PHP命名空间组织代码而不是捆绑包。

使用自动装配来自动配置应用程序服务

服务自动定向是一个特性,它读取构造函数(或其他方法)上的类型提示,并自动将正确的服务传递给每个方法,从而无需显式配置服务,并简化应用程序维护。

结合使用服务自动配置也添加服务标签对需要它们的服务,例如枝扩展,事件订阅者等。

只要可能,服务应该是私有的

使服务私人防止您通过集装箱- > get ()。相反,您需要使用适当的依赖项注入。

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

如果你使用默认服务.YAML配置,大多数服务将自动配置。但是,在某些边缘案例中,您需要手动配置服务(或其部分)。

YAML是配置服务时推荐使用的格式,因为它对新手友好且简洁,但是Symfony也支持XML和PHP配置。ob娱乐下载

使用注释来定义教条实体映射

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

教义支持多种元数据格式,但建议使用注释,因为它们是最方便和最敏捷的设置和寻找映射信息的方式。

控制器

使您的控制器扩展AbstractController基本控制器

ob娱乐下载Symfony提供A.基础控制器它包含了满足最常见需求的快捷方式,比如呈现模板或检查安全权限。

从这个基本控制器扩展控制器将应用程序与Symfony耦合在一起。ob娱乐下载耦合通常是错误的,但在这种情况下是可以的,因为控制器不应该包含任何业务逻辑。控制器应该只包含几行胶合代码,这样就不会耦合应用程序的重要部分。

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

为路由、缓存和安全性使用属性或注释可以简化配置。您不需要浏览用不同格式(YAML、XML、PHP)创建的几个文件:所有的配置都在您需要的地方,而且它只使用一种格式。

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

@Template注释是有用的,但也涉及到一些魔法。而且,大多数时候@Template是在没有任何参数的情况下使用的,这使得更难知道要呈现的是哪个模板。它还隐藏了一个事实,即控制器应该总是返回回复对象。

使用依赖注入来获取服务

如果你把基底拉长AbstractController,您只能访问最常用的服务(例如嫩枝路由器教义等),直接来自容器通过$以下 - >容器 - > get()$ this-> get()。相反,你必须使用依赖注入来获取服务by类型提示操作方法参数或构造函数参数。

如果它们方便,请使用paramconverters

如果你使用了学说, 那么你就可以可选使用paramconverter自动查询实体并将其作为参数传递给控制器。如果找不到实体,它还会显示一个404页面。

如果从路由变量获得实体的逻辑更复杂,而不是配置paramConverter,最好使控制器内的教义查询更好(例如,通过调用A教义库方法)。

模板

模板名称和变量使用Snake Case

使用小写的snake_case表示模板名、目录和变量(例如:user_profile代替用户资料产品/ edit_form.html.twig代替产品/ EditForm.html.twig)。

带下划线的前缀模板片段

模板片段,也叫模板片段“部分模板”, 允许重用模板内容。在它们的名字前面加上下划线,以更好地区别于完整的模板(例如:_USER_METADATA.HTML.TWIG._caution_message.html.twig)。

形式

将表单定义为PHP类

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

在模板中添加表单按钮

Form类应该与它们将被用于何处无关。例如,用于创建和编辑项目的表单按钮应该根据使用的位置从“添加新”更改为“保存更改”。

它建议在模板中添加按钮添加模板类中的按钮。这也提高了关注的分离,因为按钮样式(CSS类和其他属性)在模板而不是PHP类中定义。

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

在底层对象上定义验证约束

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

使用单个操作来呈现和处理表单

渲染形式处理表格是处理表单的两个主要任务。这两者太相似了(大多数情况下几乎完全相同),所以让一个控制器操作来处理它们要简单得多。

国际化

翻译文件使用XLIFF格式

Symfony支持的所有翻译格式(PHP,Qt,ob娱乐下载.pomo, JSON, CSV, INI等),Xliff.gettext拥有专业翻译人员使用的最佳工具支持。由于它基于XML,所以可以进行验证Xliff.写它们时文件内容。

ob娱乐下载Symfony还支持Xliff文件中的注释,使其更适合翻译人员。最后,良好的翻译都是关于上下文,这些Xliff Notes允许您定义该上下文。

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

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

键应该总是描述它们目的他们的位置。例如,如果一个表单有一个标签为“Username”的字段,那么一个不错的键应该是label.usernameedit_form.label.username

安全

定义一个防火墙

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

此外,您应该使用匿名在防火墙下的钥匙。如果您要求用户登录的网站的不同部分,请使用access_control选项。

使用汽车密码切肉机

自动密码切肉机根据你的PHP安装自动选择最好的编码器/散列器。目前,它试图使用默认情况下,返回到bcrypt

使用选民实施细粒度的安全限制

如果您的安全逻辑很复杂,那么您应该创建自定义安全选民而不是在@Security注解。

网络资产

使用Webpack Encore来处理Web资产

Web资产是CSS,JavaScript和图像文件,使您的网站前端的正面和工作很大。Webpack是领先的JavaScript模块捆绑器,用于在浏览器中编译、转换和打包资产。

网袋Encore.是一个JavaScript库,它摆脱了Webpack的大部分复杂性,而不会隐藏它的任何特性或扭曲它的用法和理念。它最初是为Symfony应用程序创建的,但它适用于使用任何技ob娱乐下载术的任何应用程序。

测试

冒烟测试你的url

在软件工程中,烟雾测试“初步测试揭示了简单的故障,严重到足以拒绝一个潜在的软件发布”。使用PHPUnit)数据提供者您可以定义一个功能测试,检查所有应用程序URL是否已成功加载:

//测试/ applicationavailabilityfunctionstest.php命名空间App \测试;使用ob娱乐下载symfony \ bundle \ frameworkbundle \ test \ webtestcase;班级ApplicationAvailabilityFunctionalTest扩展WebTestCase{/ * ** @dataprovider urlprovider.* /上市函数testPageIsSuccessful$ url{美元的客户=自我::CreateClient.();美元的客户->要求“得到”$ url);这个美元->assertResponseIsSuccessful();}上市函数urlProvider(){收益率['/'];收益率[' /帖子'];收益率['/ post / fixture-post-1'];收益率['/博客/类别/夹具类别'];收益率[“/档案”];/ /……}}

在创建应用程序时添加这个测试,因为它只需要很少的工作,并检查所有页面都不会返回错误。稍后,您将为每个页面添加更特定的测试。

在功能测试中硬编码url

在Syob娱乐下载mfony应用程序中,建议这样做生成URL.当URL发生变化时,使用路由自动更新所有链接。但是,如果一个公共URL发生了变化,用户将无法浏览它,除非您设置一个指向新URL的重定向。

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

这项工作包括代码样本,是在a下获得的许可根据sa 3.0的知识共享执照。