JSON 和 XML 视图

在 CakePHP 2.1 中有两个新的视图类。XmlView 和 JsonView 让你可以容易地创建 XML 和 JSON 响应，并且与 RequestHandlerComponent 集成。

在应用程序中启用 RequestHandlerComponent 的同时启用对 xml 和/或 json扩展名的支持, 你就可以自动利用新的视图了。在本节的其余部分，数据视图即指XmlView 和 JsonView 。

有两个方法来生成数据视图。第一种办法是使用 _serialize 键，而第二种办法是创建正常的视图文件。

在你的应用中启用数据视图

在使用数据视图类之前，需要进行一些设置：

  • 用 Router::parseExtensions() 方法启用 json 和/或 xml 扩展名。这让路由可以处理多种扩展名。
  • 把 RequestHandlerComponent 添加到控制器的组件列表中。这会让视图类能够自动根据内容类型进行切换。你也可以使用 viewClassMap 来设置组件，把内容类型映射为自定义的类及/或其它数据类型。

2.3 新版功能: 增加了 RequestHandlerComponent::viewClassMap() 方法，用于映射类型到视图类。以前版本的 viewClassMap 设置将不起作用。

在添加 Router::parseExtensions('json'); 到你的路由文件后, 当请求使用.json 扩展名、或者 Accept 头是 application/json 时，CakePHP 将会自动切换视图类。

通过 serialize 键使用数据视图

_serialize 键是一个特殊的视图变量，它在使用数据视图的时候指示其它的视图变量应当如何序列化。如果在把数据转化为 json/xml 之前不需要做任何定制的格式化，那么这样做可以让你省去为控制器的动作定义视图文件。

如果你需要在生成响应之前对视图变量进行任何格式化或者操作，你就应该创建视图文件。_serialize 的值可以是字符串或者一个需要进行序列化的视图变量的数组:

  1. class PostsController extends AppController {
  2.     public $components = array('RequestHandler');
  3.  
  4.     public function index() {
  5.         $this->set('posts', $this->Paginator->paginate());
  6.         $this->set('_serialize', array('posts'));
  7.     }
  8. }

你也可以定义 _serialize 为合并多个视图变量的数组:

  1. class PostsController extends AppController {
  2.     public $components = array('RequestHandler');
  3.  
  4.     public function index() {
  5.         // 创建 $posts 和 $comments 的代码
  6.         $this->set(compact('posts', 'comments'));
  7.         $this->set('_serialize', array('posts', 'comments'));
  8.     }
  9. }

定义 _serialize 为数组有额外的好处，即，在使用 XmlView 时自动添加一个顶层的 <response> 元素。如果你设置 _serialize 为字符串，又使用XmlView，确保你的视图变量有一个单独的顶层元素。如果没有，Xml 就无法生成。

通过视图文件使用数据视图

如果你在创建最终的输出之前想要对你的视图内容进行操作的话，你就应当使用视图文件。例如，如果我们有一些文章(posts)，其中一个字段含有生成的 HTML，我们可能想在JSON 响应中略去该字段。这种情况下就需要用到视图文件了:

  1. // 控制器代码
  2. class PostsController extends AppController {
  3.     public function index() {
  4.         $this->set(compact('posts', 'comments'));
  5.     }
  6. }
  7.  
  8. // 视图代码 - app/View/Posts/json/index.ctp
  9. foreach ($posts as &$post) {
  10.     unset($post['Post']['generated_html']);
  11. }
  12. echo json_encode(compact('posts', 'comments'));

你可以做更复杂的操作，也可以使用助件(helper)来格式化数据。

注解

数据视图类不支持布局。他们假定视图文件会输出序列化的内容。

  • class XmlView
  • 用来生成 Xml 视图数据的视图类。上文说明了如何在应用程序中使用 XmlView。

缺省情况下，当使用 _serialize 时，XmlView 将会用一个 <response> 节点将你的序列化的视图变量包起来。你可以用 _rootNode 视图变量来定制个这个节点的名称。

2.3 新版功能: 新增_rootNode 功能。

  • class JsonView
  • 用来生成 Json 视图数据的视图类。上文描述了如何在应用程序中使用 JsonView。

JSONP 响应

2.4 新版功能.

当使用 JsonView 时，你可以使用一个特殊的视图变量 jsonp 来返回 JSONP 响应。设置它为 true 使得视图类会检查是否设置了查询字符串(_query string)参数，如果是，就把 json 响应包裹在一个给定名称的函数内。如果你想要使用定制的查询字符串参数，而不是 "callback"，就设置 _jsonp 为需要的名称而不是 true。