约定优于配置

(重定向自惯例优先原则

约定优于配置convention over configuration[1],也称作按约定编程[2],是一种软件设计范式英语Design paradigm,旨在减少软件开发人员需做决定的数量,获得简单的好处,而又不失灵活性。

本质是说,开发人员仅需规定应用中不符约定的部分。例如,如果模型中有个名为Sale的类,那么数据库中对应的表就会默认命名为sales。只有在偏离这一约定时,例如将该表命名为"products_sold",才需写有关这个名字的配置。

如果所用工具的约定与期待相符,便可省去配置;反之,可以配置来达到所期待的方式。

动机

设计不好的框架通常需要多个配置文件,每一个都有许多设置。这些配置文件为每一个项目提供像是URL,或是将类映射到数据库表的各种信息。大量包含太多参数的配置文件通常是过度复杂的应用设计(代码坏味道)。[3]

例如,在知名的Java对象关系映射框架Hibernate的早期版本中,将类及其属性映射到数据库上需要是在XML文件中的描述,其中大部分信息都应能够按照约定得到,如将类映射到同名的数据库表,将属性分别映射到表上的字段。后续的版本抛弃了XML配置文件,而是使用这些恰当的约定,对于不符合这些约定的情形,可以使用Java 标注来说明(参见下面提供的JavaBeans规范)。

使用

 
项目的目录结构展示了Maven所约定了源代码的位置,只需配置很少的信息就可以自动完成编译,测试和打包等工作。

许多新的框架使用了约定优于配置的方法,包括:Spring[4]Ruby on Rails[5],Kohana PHP,Grails英语Grails (Framework)[6]GrokZend FrameworkCakePHP英语CakePHPsymfonyMavenASP.NET MVCWeb2py(MVC),Apache Wicket

这是一个古老的概念, 甚至在Java类库中也可以找出这一概念的踪迹。例如,JavaBean规范非常多的依赖这一概念。下面摘录JavaBeans 1.1版规范的一段:[7]

一般来说,我们不希望造出一个硕大无朋的java.beans.everything类用来派生其他类,而是希望JavaBeans运行时为一般的对象提供缺省的行为特征,但是允许对象通过继承特定的java.beans.something接口来覆盖缺省的行为特征的一部分。[8]

参考文献

  1. ^ 也译作惯例优于配置,惯例优先原则
  2. ^ Coding by convention
  3. ^ C2 Wiki (2009-09-01). Too Many Parameters. C2 Wiki, 1 September 2009. Retrieved from http://c2.com/cgi/wiki$?TooManyParameters[永久失效連結].
  4. ^ Chapter 13.11 describes the application in the context of spring model/view/controller http://static.springsource.org/spring/docs/2.0.x/reference/mvc.html页面存档备份,存于互联网档案馆
  5. ^ http://rubyonrails.org/页面存档备份,存于互联网档案馆), advertises the paradigm right from 'home'
  6. ^ a description of configuration with the goal of convention http://grails.org/Unified+Configuration页面存档备份,存于互联网档案馆), and relationship to bean referencing from spring 存档副本. [2010-09-29]. (原始内容存档于2010-10-28). 
  7. ^ Sun (no date). JavaBeans specification, section 1.4. Retrieved from http://java.sun.com/javase/technologies/desktop/javabeans/docs/spec.html页面存档备份,存于互联网档案馆).
  8. ^ "As a general rule we don't want to invent an enormous java.beans.everything class that people have to inherit from. Instead we'd like the JavaBeans runtimes to provide default behaviour for 'normal' objects, but to allow objects to override a given piece of default behaviour by inheriting from some specific java.beans.something interface."

外部链接

参见