写一个框架的详细步骤.docx

1、写一个框架的详细步骤定位所谓定位就是回答几个问题，我出于什么目的要写一个框架，我的这个框架是干什么的，有什么特性适用于什么场景，我的这个框架的用户对象是谁，他们会怎么使用，框架由谁维护将来怎么发展等等。如果你打算写框架，那么肯定心里已经有一个初步的定位，比如它是一个缓存框架、Web MVC框架、IOC框架、ORM/数据访问框架、RPC框架或是一个用于Web开发的全栈式框架。是 否要重复造轮子除非是练手项目，一般我们是有了解决不了问题的时候才会考虑不使用既有的成熟的框架而重复造轮子的，这个时候需要列出新框架主要希望解决 什么问题。有关是否应该重复造轮子的话题讨论了很多，我的建议是在把问题列清后进

2、行简单的研究看看是否可以通过扩展现有的框架来解决这个问题。一般而言大 部分成熟的框架都有一定的扩展和内部组件的替换能力，可以解决大部分技术问题，但在如下情况下我们可能不得不自己去写一个框架，比如即使通过扩展也无法满 足技术需求、安全原因、需要更高的生产力、需要让框架和公司内部的流程更好地进行适配、开源的普适框架无法满足性能需求、二次开发的成本高于重新开发的成 本等等。主打轻量级轻量级是很多人打算自己写一个新框架的原因，但我们要明白，大部分项目在一开始的时候其实都是轻量级的，随着框架 的用户越来越多，它必定需要满足各种奇怪的需求，在经过了无数次迭代之后，框架的主线流程就会多很多扩展点、检测点，这

3、样框架势必变得越来越重（从框架的 入口到框架的工作结束的方法调用层次越来越多，势必框架也就越来越慢），如果你打算把框架定位于一个轻量级的框架的话，那么在今后的迭代过程中需要进行一 些权衡，在心中有坚定的轻量级的理念的同时不断做性能测试来确保框架的轻量，否则随着时间的发展框架可能会越来越重进而偏离了开始的定位。特性如果你打算写一个框架，并且只有轻量级这一个理由的话，你或许应该再为自己的框架想一些新特性，就像做一个产品一样，如果找不出两个以上的亮点，那么这个产品不太可能成功，比如你的新框架可以是一个零配置的框架，可以是一个前端开发也能用的后端框架。其它一般来说框架是给程序员使用的，我们要考虑框架使

4、用的频度是怎么样的，这可能决定的框架的性能需求和稳定性需求。还有，需要考虑框架将来怎么发展，是希望走开源路线还是商业路线。当然，这些问题也可以留到框架有一个大致的结构后再去考虑。我们来为本文模拟一个场景，假设我们觉得现有的Spring MVC等框架开发起来效率有点低，打算重复造轮子，对于新框架的定位是一个给Java程序员使用的轻量级的、零配置的、易用的、易扩展的Web MVC框架。调研虽然到这里你已经决定去写一个框架了，但是在着手写之前还是至少建议评估一下市面上的类似（成熟）框架。需要做的是通读这些框架的文档以及阅读一些源码，这么做有几个目的：通过分析现有框架的功能，可以制定出一个新框架要实现

5、的功能列表。通过分析现有框架的问题，总结出新框架需要避免的东西和改善的地方。通过阅读现有框架的源码，帮助自己理清框架的主线流程为总体设计做铺垫（后面总体设计部分会更多谈到）。如果能充分理解现有的框架，那么你就是站在巨人的肩膀上写框架，否则很可能就是在井底造轮子。新 开发一个框架的好处是没有兼容历史版本的包袱，但是责任也同样重大，因为如果对于一开始的定位或设计工作没有做好的话，将来如果要对格局进行改变就会有巨 大的向前兼容的包袱（除非你的框架没有在任何正式项目中使用），兼容意味着框架可能会越来越重，可能会越来越难看，阅读至少一到两个开源实现，做好充分的 调研工作可以使你避免犯大错。假设我们评估了

6、一些主流框架后已经很明确，我们的MVC框架是一个Java平台的、基于Servlet的轻量级的Web MVC框架，主要的理念是约定优于配置，高内聚大于低耦合，提供主流Web MVC框架的大部分功能，并且易用方面有所创新，新特性体包括：起手零配置，总体上约定由于配置，即使需要扩展配置也支持通过代码和配置文件两种方式进行配置。除了Servlet之外不依赖其它类库，支持通过插件方式和诸如Spring等框架进行整合。更优化的项目结构，不需要按照传统的Java Web项目结构那样来分离代码和WEB-INF，视图可以和代码在一起，阅读代码更便利。拦截器和框架本身更紧密，提供Action、Controller

7、和Global三个级别的拦截器（或者说过滤器）。丰富的Action的返回值，返回的可以是视图、可以是重定向、可以是文件、可以是字符串、可以是Json数据，可以是Javascript代码等等。支持针对测试环境自动生成测试的视图模型数据，以便前端和后端可以同时开发项目。支持在开发的时候自动生成路由信息、模型绑定、异常处理等配置的信息页面和调试页面，方便开发和调试。提供一套通用的控件模版，使得，并且支持多种模版引擎，比如Jsp、Velocity、Freemarker、Mustache等等。嗯，看上去挺诱人的，这是一个不错的开端，如果你要写的框架自己都不觉得想用的话，那么别人就更不会有兴趣来尝试使用你

8、的框架了。解决难点之 所以把解决难点放在开搞之前是因为，如果实现这个框架的某些特性，甚至说实现这个框架的主流程有一些核心问题难以解决，那么就要考虑对框架的特性进行调 整，甚至取消框架的开发计划了。有的时候我们在用A平台的时候发现一个很好用的框架，希望把这个框架移植到B平台，这个想法是好的，但之所以在这以前这么 多年没有人这么干过是因为这个平台的限制压根不可能实现这样的东西。比如我们要实现一个MVC框架，势必需要依赖平台提供的反射特性，如果你的语言平台压 根就没有运行时反射这个功能，那么这就是一个非常难以解决的难点。又比如我们在某个平台实现一个类似于.NET平台Linq2Sql的数据访问框架，但

9、如 果这个目标平台的开发语言并不像C#那样提供了类型推断、匿名类型、Lambda表达式、扩展方法的话那么由于语法的限制你写出来的框架在使用的时候是无 法像.NET平台Linq2Sql那样优雅的，这就违背了实现框架的主要目的，实现新的框架也就变得意义不大了。对于我们要实现的MVC框 架貌似不存在什么根本性的无法解决的问题，毕竟在Java平台已经有很多可以参考的例子了。如果框架的实现总体上没什么问题的话，就需要逐一评估框架的这 些新特性是否可以解决。建议对于每一个难点特性做一个原型项目来证明可行，以免在框架实现到一半的时候发现有无法解决的问题就比较尴尬了。分析一下，貌似我们要实现的这8大特性只有第

10、1点要研究一下，看看如何免配置通过让代码方式让我们的Web MVC框架可以和Servlet进行整合，如果无法实现的话，我们可能就需要把第1点特性从零配置改为一分钟快速配置了。开搞首先需要给自己框架取一个名字，取名要考虑到易读、易写、易记，也需要尽量避免和市面上其它产品的名字重复，还有就是最好不要起一个侮辱其它同类框架的名字以免引起公愤。如果将来打算把项目搞大的话，可以提前注册一下项目的相关域名，毕竟现在域名也便宜，避免到时候项目名和域名差距很大，或项目的或.org域名对应了一个什么不太和谐的网站这就尴尬了。然后就是找一个地方来托管自己的代码，如果一开始不希望公开代码的话，最好除了本地源代码仓库

11、还有一个异地的仓库以免磁盘损坏导致抱憾终身，当然如果不怕出丑的话也可以在起步的时候就使用Github等网站来托管自己的代码。总体设计对 于总体设计我的建议是一开始不一定需要写什么设计文档画什么类图，因为可能一开始的时候无法形成这么具体的概念，我们可以直接从代码开始做第一步。框架的 使用者一般而言还是开发人员，抛开框架的内在的实现不说，框架的API设计的好坏取决于两个方面。对于普通开发人员而言就是使用层面的API是否易于使 用，拿我们的MVC框架举例来说：最基本的，搭建一个HelloWorld项目，声明一个Controller和Action，配置一个路由规则让Get方法的请求可以解析到这个Act

12、ion，可以输出HelloWorld文字，怎么实现如果要实现从Cookie以及表单中获取相关数据绑定到Action的参数里面，怎么实现如果要配置一个Action在调用前需要判断权限，在调用后需要记录日志，怎么实现我们这里说的API，它不一定全都是方法调用的API，广义上来说我们认为框架提供的接入层的使用都可以认为是API，所以上面的一些功能都可以认为是MVC框架的API。框架除了提供基本的功能，还要提供一定程度的扩展功能，使得一些复杂的项目能够在某些方面对框架进行增强以适应各种需求，比如：我的Action是否可以返回图片验证码我的Action的参数绑定是否可以从Memcached中获取数据如果

13、出现异常，能否在开发的时候显示具体的错误信息，在正式环境显示友好的错误页面并且记录错误信息到数据库一 般而言如果要实现这样的功能就需要自己实现框架公开的一些类或接口，然后把自己的实现注册到框架中，让框架可以在某个时候去使用这些新的实现。这就需 要框架的设计者来考虑应该以怎么样的友好形式公开出去哪些内容，使得以后的扩展实现在自由度以及最少实现上的平衡，同时要兼顾外来的实现不破坏框架已有的 结构。要想清楚这些不是一件容易的事情，所以在框架的设计阶段完全可以使用从上到下的方式进行设计。也就是不去考虑框架怎么实现，而是以一 个使用者的身份来写一个框架的示例网站，API怎么简单怎么舒服就怎么设计，只从使

14、用者的角度来考虑问题。对于相关用到的类，直接写一个空的类（能用接口 的尽量用接口，你的目的只是通过编译而不是能运行起来），让程序可以通过编译就可以了。你可以从框架的普通使用开始写这样一个示例网站，然后再写各种扩展 应用，在此期间你可能会用到框架内部的20个类，这些类就是框架的接入类，在你的示例网站通过编译的那刹那，其实你已经实现了框架的接入层的设计。这里值得一说的是API的设计蕴含了非常多的学问以及经验，要在目标平台设计一套合理易用的API首先需要对目标平台足够了解，每一个平台都有一些约定俗成的规范，如果设计的API能符合这些规范那么开发人员会更容易接受这个框架，此外还有一些建议：之 所以我们

15、把API的设计先行，而不是让框架的设计先行是因为这样我们更容易设计出好用的API，作为框架的实现者，我们往往会进行一些妥协，我们可能会为 了在框架内部DRY而设计出一套丑陋的API让框架的使用者去做一些重复的工作；我们也可能会因为想让框架变得更松耦合强迫框架的使用者去使用到框架的一 些内部API去初始化框架的组件。如果框架不是易用的，那么框架的内部设计的再合理又有什么意义尽量少暴露一些框架内部的类名吧，对 于框架的使用者来说，你的框架对他一点都不熟悉，如果要上手你的框架需要学习一到两个类尚可接受，如果要使用到十几个类会头晕脑胀的，即使你的框架有非常 多的功能以及配置，可以考虑提供一个入口类，比

16、如创建一个ConfigCenter类作为入口，让使用者可以仅仅探索这个类便可对框架进行所有的配置。一 个好的框架是可以让使用者少犯错误的，框架的设计者务必要考虑到，框架的使用者没有这个业务来按照框架的最佳实践来做，所以在设计API的时候，如果你希 望API的使用者一定要按照某个方式来做的话，可以考虑设置一个简便的重载来加载默认的最合理的使用方式而不是要求使用者来为你的方法初始一些什么依赖， 同时也可以在API内部做一些检测，如果发现开发人员可能会犯错进行一些提示或抛出异常。好的框架无需过多的文档，它可以在开发人员用的时候告知它哪里错 了，最佳实践是什么，即便他们真的错了也能以默认的更合理的方式

17、来弥补这个错误。建议所有的API都有一套统一的规范，比如入口都叫XXXCenter或XXXManager，而不是叫XXXCenter、YYYManager和 ZZZService。API往往需要进行迭代和改良的，在首个版本中把好名字用掉也不一定是一个好办法，最好还是给自己的框架各种API的名字留一点余 地，这样以后万一需要升级换代不至于太牵强。下一步工作就是把项目中那些空的类按照功能进行划分。目的很简单，就是让你的框架 的100个类或接口能够按照功能进行拆分和归类，这样别人一打开你的框架就可以马上知道你的框架分为哪几个主要部分，而不是在100个类中晕眩；还有因为 一旦在你的框架有使用者后你再要

18、为API相关的那些类调整包就比困难了，即使你在创建框架的时候觉得我的框架就那么十几个类无需进行过多的分类，但是在将 来框架变大又发现当初设计的不合理，无法进行结构调整就会变得很痛苦。因此这个工作还是相当重要的，对于大多数框架来说，可以有几种切蛋糕的方式：分 层。我觉得框架和应用程序一样，也需要进行分层。传统的应用程序我们分为表现层、逻辑层和数据访问层，类似的对于很多框架也可以进行横向的层次划分。要分 层的原因是我们的框架要处理的问题是基于多层抽象的，就像如果没有OSI七层模型，要让一个HTTP应用去直接处理网络信号是不合理的也是不利于重用的。 举一个例子，如果我们要写一个基于Socket的RP

19、C的框架，我们需要处理方法的代理以及序列化，以及序列化数据的传输，这完全是两个层面的问题，前者 偏向于应用层，后者偏向于网络层，我们完全有理由把我们的框架分为两个层面的项目（至少是两个包），和，前者不关心 网络实现来处理所有RPC的功能，后者不关心RPC来处理所有的Socket功能，在将来即使我们要淘汰我们的RPC的协议了，我们也可以重用 项目，因为它和RPC的实现没有任何关系，它关注的只是socket层面的东西。横切。刚才说的分层是横向的分 割，横切是纵向的分割（横切是跨多个模块的意思，不是横向来切的意思）。其实横切关注点就是诸如日志、配置、缓存、AOP、IOC等通用的功能，对于这部 分功能

20、，我们不应该把他们和真正的业务逻辑混淆在一起。对于应用类项目是这样，对于框架类项目也是这样，如果某一部分的代码量非常大，完全有理由为它分出 一个单独的包。对于RPC项目，我们可能就会把客户端和服务端通讯的消息放在common包内，把配置的处理单独放在config包内。功能。也就是要实现一个框架主要解决的问题点，比如对于上面提到的RPC框架的core部分，可以想到的是我们主要解决是客户端如何找到服务端，如何把进 行方法调用以及把方法的调用信息传给目标服务端，服务端如何接受到这样的信息根据配置在本地实例化对象调用方法后把结果返回客户端三大问题，那么我们可能 会把项目分为routing、client

21、、server等几个包。如果是一个RPC框架，大概是这样的结构：对于我们的Web MVC框架，举例如下：我们可以有一个项目，细分如下的包：common：公共的一组件，下面的各模块都会用到config：配置模块，解决框架的配置问题startup：启动模块，解决框架和Servlet如何进行整合的问题plugin：插件模块，插件机制的实现，提供IPlugin的抽象实现routing：路由模块，解决请求路径的解析问题，提供了IRoute的抽象实现和基本实现controller：控制器模块，解决的是如何产生控制器model：视图模型模块，解决的是如何绑定方法的参数action：action模块，解决的是

22、如何调用方法以及方法返回的结果，提供了IActionResult的抽象实现和基本实现view：视图模块，解决的是各种视图引擎和框架的适配filter：过滤器模块，解决是执行Action，返回IActionResult前后的AOP功能，提供了IFilter的抽象实现以及基本实现我们可以再创建一个项目，细分如下的包：filters：一些IFilter的实现results：一些IActionResult的实现routes：一些IRoute的实现plugins：一些IPlugin的实现这里我们以IXXX来描述一个抽象，可以是接口也可以是抽象类，在具体实现的时候根据需求再来确定。这 种结构的划分方式完全

23、吻合上面说的切蛋糕方式，可以看到除了横切部分和分层部分，作为一个Web MVC框架，它核心的组件就是routing、model、view、controller、action（当然，对于有些MVC框架它没有route部 分，route部分是交由Web框架实现的）。如果我们在这个时候还无法确定框架的模块划分的话，问题也不大，我们可以在后续的搭建龙骨的步骤中随着更多的类的建立，继续理清和确定模块的划分。经过了设计的步骤，我们应该心里对下面的问题有一个初步的规划了：我们的框架以什么形式来提供如何优雅的API我们的框架包含哪些模块，模块大概的作用是什么搭建龙骨在 经过了初步的设计之后，我们可以考虑为框架

24、搭建一套龙骨，一套抽象的层次关系。也就是用抽象类、接口或空的类实现框架，可以通过编译，让框架撑起来，就像 造房子搭建房子的钢筋混凝土结构（添砖加瓦是后面的事情，我们先要有一个结构）。对于开发应用程序来说，其实没有什么撑起来一说，因为应用程序中很多模块 都是并行的，它可能并没有一个主结构，主流程，而对于框架来说，它往往是一个高度面向对象的，高度抽象的一套程序，搭建龙骨也就是搭建一套抽象层。这么说 可能有点抽象，我们还是来想一下如果要做一个Web MVC框架，需要怎么为上面说的几个核心模块进行抽象（我们也来体会一下框架中一些类的命名，这里我们为了更清晰，为所有接口都命名为IXXX，这点不太 符合J

25、ava的命名规范）：routing MVC的入口是路由每一个路由都是IRoute代表了不同的路由实现，它也提供一个getRouteResult()方法来返回RouteResult对象我们实现一个框架自带的DefaultRoute，使得路由支持配置，支持默认值，支持正则表达式，支持约束等等我们需要有一个Routes类来管理所有的路由IRoute，提供一个findRoute()方法来返回RouteResult对象，自然我们这边调用的就是IRoute的getRouteResult()方法，返回能匹配到的结果RouteResult对象就是匹配的路由信息，包含了路由解析后的所有数据controller

26、路由下来是控制器我们有IControllerFactory来创建Controller，提供createController()方法来返回IControllerIController代表控制器，提供一个execute()方法来执行控制器我们实现一个框架自带的DefaultControllerFactory来以约定由于配置的方式根据约定规则以及路由数据RouteResult来找到IController并创建它我 们为IController提供一个抽象实现，AbstractController，要求所有MVC框架的使用者创建的控制器需要继承 AbstractController，在这个抽象实现中我们

27、可以编写一些便捷的API以便开发人员使用，比如view()方法、file()方法、 redirect()方法、json()方法、js()方法等等action 找到了控制器后就是来找要执行的方法了我们有IActionResult来代表Action返回的结果，提供一个execute()方法来执行这个结果我们的框架需要实现一些自带的IActionResult，比如ContentResult、ViewResult、FileResult、JsonResult、RedirectResult来对应AbstractController的一些便捷方法再来定义一个IActionInvoker来执行Action，提

28、供一个invokeAction()方法我们需要实现一个DefaultActionInvoker以默认的方式进行方法的调用，也就是找到方法的一些IFilter按照一定的顺序执行他们，最后使用反射进行方法的调用得到上面说的IActionResult并执行它的execute()方法filter 我们的框架很重要的一点就是便捷的过滤器刚才提到了IFilter，代表的是一个过滤器，我们提供IActionFilter对方法的执行前后进行过滤，提供IResultFilter对IActionResult执行前后进行过滤我们的IActionInvoker怎么找到需要执行的IFilter呢，我们需要定义一个IFi

29、lterProvider来提供过滤器，它提供一个getFilters()方法来提供所有的IFilter的实例我 们的框架可以实现一些自带的IFilterProvider，比如AnnotationFilterProvider通过扫描Action或 Controller上的注解来获取需要执行的过滤器信息；比如我们还可以实现GlobalFilterProvider，开发人员可以直接通过配置或代 码方式告知框架应用于全局的IFilter既然我们实现了多个IFilterProvider，我们自然需要有一个类来管理这些IFilterProvider，我们实现一个FilterProviders类并提供get

30、Filters()方法（这和我们的Routes类来管理IRoute是类似的，命名统一）view 各种IActionResult中最特殊最复杂的就是ViewResult，我们需要有一个单独的包来处理ViewResult的逻辑我们需要有IViewEngine来代表一个模版引擎，提供一个getViewEngineResult()方法返回ViewEngineResultViewEngineResult包含视图引擎寻找视图的结果信息，里面包含IView和寻找的一些路径等IView自然代表的是一个视图，提供render()方法（或者为了统一也可以叫做execute）来渲染视图我 们的框架可以实现常见的一些

31、模版引擎，比如FreemarkerViewEngine、VelocityViewEngine 等，VelocityViewEngine返回的ViewEngineResult自然包含的是一个实现IView的VelocityView，不会返回 其它引擎的IView同样的，我们是不是需要一个ViewEngines来管理所有的IViewEngine呢，同样也是实现findViewEngine()方法common 这里可以放一些项目中各个模块都要用到的一些东西比 如各种context，context代表的是执行某个任务需要的环境信息，这里我们可以定义HttpContext、 ControllerCont

32、ext、ActionContext和ViewContext，后者继承前者，随着MVC处理流程的进行，View执行时的 上下文相比Action执行时的上下文信息肯定是多了视图的信息，其它同理，之所以把这个信息放在common里面而不是放在各个模块自己的包内是因为这 样更清晰，可以一目了然各种对象的执行上下文有一个立体的概念比如各种helper或utility接下去就不再详细阐述model、plugin等模块的内容了。看到这里，我们来总结一下，我们的MVC框架在组织结构上有着高度的统一：如果xxx本身并无选择策略，但xxx的创建过程也不是一个new这么简单的，可以由xxxFactory类来提供一个xxx如果我们需要用到很多个yyy，那么我们会有各种yyyProvider（通过getyyy()方法）来提供这些yyy，并且我们需要有一个yyyProviders来管理这些yyyProvider如果zzz的选择是有策略性的，会按照需要选择zzz1或zzzN，那么我们可能会有一个zzzs来管理这些zzz并且（通过f