使用Yii2时遇到的实际问题

5

最近一直在学习Yii2框架,可能是一直以来对它的青睐,让我难以对其它框架再产生兴趣,学习中遇到了许多问题,于是把问题和解决办法也记录下来,这样方便以后复习和交流。

目录

  • 扩展XmlResponseFormatter
  • 在原有的Yii2框架上,新建一个api应用
  • 配置Yii2 request Parser使之可以通过Yii::$app->request->post()来接收 xml 和 json的数据
  • 使用 TimestampBehavior 来自动填充 created_at 和 updated_at

扩展XmlResponseFormatter

在做微信接口测试的时候发现,每次返回数据的时候都是自己写的 xml 信息然后 echo 出来,今天突然看到了 Yii::$app->response->format = Response::FORMAT_XML; 原来通过这个就可以设置返回的数据为 xml ,当然 response 这个类在 Controller 里面是没有加载的,所以首先得加载一下 use yii\web\Response; ,最后把需要返回的数据用数组的形式来返回即可:

<?php
// ... ...
use yii\web\Response;

public function actionIndex(){
    // ... ... 原来的逻辑代码
    Yii::$app->response->format = Response::FORMAT_XML;
    return [
            "ToUserName"=>$postObject->FromUserName,
            "FromUserName"=>$postObject->ToUserName,
            "CreateTime"=>time(),
            "MsgType"=>"music",
            "Music"=>[
                "Title"=>$recognition,
                "Description"=>$decode,
                "MusicUrl"=>$musicurl,
                "HQMusicUrl"=>$musicurl,
            ]
        ];
}

这样使用之后发现请求得到的结果是:

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <ToUserName><SimpleXMLElement><FromUserName><SimpleXMLElement/></FromUserName></SimpleXMLElement></ToUserName>
    <FromUserName><SimpleXMLElement><ToUserName><SimpleXMLElement/></ToUserName></SimpleXMLElement></FromUserName>
    <CreateTime>1416207112</CreateTime>
    <MsgType>music</MsgType>
    <Music>
        <Title>maps maroon5</Title>
        <Description>120976464.mp3?xcode=7ba3137f5fd742bcba7a6f5a2ffb7764172503013bacbdc8</Description>
        <MusicUrl>http://zhangmenshiting.baidu.com/data2/music/120976464/120976464.mp3?xcode=7ba3137f5fd742bcba7a6f5a2ffb7764172503013bacbdc8</MusicUrl>
        <HQMusicUrl>http://zhangmenshiting.baidu.com/data2/music/120976464/120976464.mp3?xcode=7ba3137f5fd742bcba7a6f5a2ffb7764172503013bacbdc8</HQMusicUrl>
    </Music>
</response>

问题就来了,微信需要的格式是前外层以 <xml>...</xml> 来定义的,后来终于在 Response 里面的 formatters 发现了信息,它里面定义了每个类相应的信息,我们可以通过手动指定一些信息来覆盖掉系统默认的。

Yii::$app->response->formatters = [Response::FORMAT_XML=> ['class'=>yii\web\XmlResponseFormatter', 'rootTag'=>'xml'];

通过这样设置之后,最外层的 response 终于变成了 xml,又发现了一个问题,那就是我的内容里面根本就没有SimpleXMLElement相关的东西,这个怎么会多出来?回看了一下逻辑代码发现有:

$postObject = simplexml_load_string($postStr, 'SimpleXMLElement', LIBXML_NOCDATA);

最后只能在return的时候加上类型转换为字符串,这下终于恢复正常了。

return [
    "ToUserName"=>(string)$postObject->FromUserName,
    "FromUserName"=>(string)$postObject->ToUserName,
    // ...
]

在使用这个的时候有的数据是需要加上 CDataSection(<![CDATA[ ... ]]>) 的,因为不然如果内容里面带有了 < 这种就会出问题。这个确实让我头疼了很久,首先看了一下源代码原来的类 XmlResponseFormatter, 确实无法满足相应的需求,满足不了需求就只能扩展了

step1. 在应用下创建一个 component 目录
step2. 在component目录下新建一个 MyXmlResponseFormatter.php 的文件
step3. 实现这个类

<?php

namespace weixin\component;

use yii\web\XmlResponseFormatter;
use DOMElement;
use DOMText;
use yii\helpers\StringHelper;
use yii\base\Arrayable;
use DOMCdataSection;

class MyXmlResponseFormatter extends XmlResponseFormatter{
    public $rootTag = "xml";  // 这里我就可以把 rootTag 的默认值修改成 xml 了
    /**
     * 如果需要使用 CDATA 那就需要把原来的数据转成数组,并且数组含有以下key
     * ,我们就把这个节点添加成一个 DOMCdataSection
     */
    const CDATA = '---cdata---';  // 这个是是否使用CDATA 的下标
     /**
     * @param DOMElement $element
     * @param mixed $data
     */
    protected function buildXml($element, $data)
    {
        if (is_object($data)) {
            // 这里保持原来的代码不变
        } elseif (is_array($data)) {
            foreach ($data as $name => $value) {
                if (is_int($name) && is_object($value)) {
                    $this->buildXml($element, $value);
                } elseif (is_array($value) || is_object($value)) {
                    $child = new DOMElement(is_int($name) ? $this->itemTag : $name);
                    $element->appendChild($child);
                    // 主要就是修改这一个点,如果值是一个数组,并且含有 CDATA 的,那么就直接创建一个 CdataSection 节点,
                    // 而不把它本身当作列表再回调。
                    if(array_key_exists(self::CDATA, $value)){
                        $child->appendChild(new DOMCdataSection((string) $value[0]));
                    }else{
                        $this->buildXml($child, $value);
                    }
                } else {
                    $child = new DOMElement(is_int($name) ? $this->itemTag : $name);
                    $element->appendChild($child);
                    $child->appendChild(new DOMText((string) $value));
                }
            }
        } else {
            $element->appendChild(new DOMText((string) $data));
        }
    }
}

step4. 修改默认的 xml 解析所使用的类为新建的扩展类

Yii::$app->response->formatters = [
    Response::FORMAT_XML=> ['class'=>'weixin\component\MyXmlResponseFormatter']
];

step5. 如果说字符串需要使用 CDATA 的时候需要设置

use weixin\component\MyXmlResponseFormatter as MXRF;

return [
    "ToUserName"=>[$postObj->FromUserName,MXRF::CDATA=>true],
    "FromUserName"=>[$postObj->ToUserName,MXRF::CDATA=>true],
    "CreateTime"=>time(),
    "MsgType"=>"music",
    "Music"=>[
        "Title"=>[$recognition,MXRF::CDATA=>true],
        "Description"=>[$decode,MXRF::CDATA=>true],
        "MusicUrl"=>[$musicurl,MXRF::CDATA=>true],
        "HQMusicUrl"=>[$musicurl,MXRF::CDATA=>true],
    ]
];

经过本次的修改算是对如何修改和扩展Yii2 有了一定的认识。

在原有的Yii2框架上,新建一个api应用

在做东西的时候需要清晰的结构和逻辑,这样做出来的东西相对来说会比较漂亮,所以为了api我们可能得新建一个应用,这里面全是api相关的程序,我通过Google “yii2 create new application”,“yii2 add new application”,都没有找到相要的答案,于是只能开动自己的脑筋了。

$ cp -a environments/dev/frontend environments/dev/api

$ cp -a environments/prod/frontend environments/prod/api

# file: environments/index.php
<?php
// 这里仅说明了我添加了哪些信息,不需要删除任何信息,只需要添加。
return [
    'Development' => [
        'setWritable' => [
            // ... 在原来的后面添加上
            'api/runtime',
            'api/web/assets'
        ],
        'setCookieValidationKey' => [
            // ... 在原来的后面添加上
            'api/config/main-local.php',
        ],
    ],
    'Production' => [
        // 这里和上面一样的添加
    ],
];

创建相应的目录:

$ mkdir -p api/{assets,config,controllers,models,runtime,web/assets}

$ touch api/{assets,config,controllers,models,runtime,web/assets}/.gitkeep

复制配置文件:

$ cp -a frontend/config/params.php frontend/config/main.php frontend/config/bootstrap.php frontend/config/.gitignore api/config

$ cp frontend/runtime/.gitignore api/runtime/

$ cp frontend/web/.gitignore api/web

# file api/config/main.php

return [
    'id' => 'app-api',
    // ...
    'controllerNamespace' => 'api\controllers',
]

# file common/config/bootstrap.php
Yii::setAlias('api', dirname(dirname(__DIR__)) . '/api');

// 配置的其它信息看自己的需求而定

$ ./init

新建一个Controller来测试一下:

# file: api/controllers/SiteController.php
<?php
namespace api\controllers;

use yii\web\Controller;

class SiteController extends Controller {
    public $layout = false;

    public function actionIndex(){
        return "test";
    }
}

然后通过浏览器访问相应的地址 http://hostname/api/web/index.php?r=site/index 能出来 test 则代表 ok 啦,以上步骤都是一步步的尝试和查看源代码得来的,可能会有不规范的地方,若有不对的地方请到 Github (yii2-usage)上留言。

配置Yii2 request Parser使之可以通过Yii::$app->request->post()来接收 xml 和 json的数据

大家都知道 Yii2 接收 POST 数据是使用 Yii::$app->request->post();,但是如果发送过来的数据格式是 jsonxml 的时候,通过这个方法就无法获取到数据了,Yii2 这么强大的组件型框架肯定想到了这一点。

对于 json 的解析 Yii2 已经写好了 [[JsonResponseFormatter]] ,在配置文件里面配置一下即可使用。

# file app/config/main.php

'components' =>[
    'request' => [
        'parsers' => [
            'application/json' => 'yii\web\JsonParser',
            'text/json' => 'yii\web\JsonParser',
        ],
    ],
],

配置好之后访问提交过来的数据就太简单啦

# json raw data
{"username": "bob"}

# access data
$post_data = Yii::$app->request->post();
echo $post_data["username"];

# or
echo Yii::$app->request->post("username");

可以通过 composer 添加依赖:bobchengbin/yii2-xml-request-parser 来完成

# file app/config/main.php

'components' =>[
    'request' => [
        'parsers' => [
            'text/xml' => 'bobchengbin\Yii2XmlRequestParser\XmlRequestParser',
            'application/xml' => 'bobchengbin\Yii2XmlRequestParser\XmlRequestParser',

            'application/json' => 'yii\web\JsonParser',
            'text/json' => 'yii\web\JsonParser',
        ],
    ],
],

经过上面的三步之后,就可以直接访问提交过来的 xml 数据了。

# raw data
<xml><username><![CDATA[bob]]></username></xml>

# access data
Yii::$app->request->post('username');

这样不管别人传过来的数据是 html、json、xml 格式都可以非常方便的获取了,在和各种接口打交道的时候用上这个可以方便太多了。

使用 TimestampBehavior 来自动填充 created_at 和 updated_at

Yii2 官方默认提供了一个 TimestampBehavior 来方便我们来自动填充 created_atupdated_at ,它会自动在你插入新数据的时候帮你填充这两个值为当前时间,当然你也可以设置成别的时间,当你更新数据的时候它会自动把 updated_at 改成最后更新的时间。

我创建了一个 user_weixin 表,然后设置 created_atupdated_at 两个字段为 datetime 类型,并在相应的 Model 里面使用上 TimestampBehavior

# file app/models/UserWeixin.php

<?php
... ... 
use yii\behaviors\TimestampBehavior;

class UserWeixin extends ActiveRecord {

    public function behaviors(){
        return [TimestampBehavior::className()];
    }
}

然后正常的调用保存数据,发现那两个字段的值均为 '0000-00-00 00:00:00',看到这个感觉甚是奇怪,去看了一下默认生成的用户模型,common/models/User.php,发现它也没有做其它的别的操作就可以的啊,我这样为什么不行呢,去看了一下表结构,发现系统创建的 user 表的两个字段是使用的 int 类型,而不是 datetime,于是把 user_weixin 表的两个字段也改成了 int 类型,再测试一次发现好了。

不甘心的我去看了一下 TimestampBehavior 类的注释,发现确实没有说明这个问题,所以大家在声明 created_at 和 updated_at 字段类型的时候需要注意一下

你可能感兴趣的

23 条评论
苏生不惑 · 2014年12月21日

看了下yii,感觉学习还有点难度,一个form要记那么多规则

回复

肆意的青春 作者 · 2014年12月21日

你说的这个是个问题噢,由于现在前端发展的非常快速,有了许多集成工具,导致框架本身的许多功能是多余的了。

比如资源包的管理,还有各种 Widgets,这些我觉得都最好不使用框架的,使用比较流行的前端解决方案比较好。

回复

youto · 2014年12月25日

楼主您好,我用yii2 无法接受到微信服务器post过来的XML数据包。我发现只要是通过Curl POST过来的数据包,再yii2里面 都无法接收到!是不是配置文件没有配置好?请给我一点点提示,谢谢

回复

肆意的青春 作者 · 2014年12月25日

你在 Controller 里面输出 Yii::$app->getRequest()->getRawBody() 看一下有是否有 POST 传过来的数据,如果这里有的话。那你就可以按 《配置Yii2 request Parser使之可以通过Yii::$app->request->post()来接收 xml 和 json的数据》 来配置。

回复

youto · 2014年12月25日

谢谢楼主,我先试一试!

回复

youto · 2014年12月25日

现在可以了,就是通过楼主的方法实现的,多谢楼主!楼主好人啊!!!都有给你生孩子的冲动了,可惜我是个男的

回复

肆意的青春 作者 · 2014年12月25日

哈哈

回复

__FresHmaN · 2015年04月23日

最后的坑表示很不明白!

回复

肆意的青春 作者 · 2015年04月23日

因为以前个人习惯存的时间都是 datetime 类型,而现在变成了 int,其实就是当时没有去看源码导致的这些笑话。

回复

__FresHmaN · 2015年04月23日

这样写容易误导人哦,哈哈,应该改下术语,我以为是Yii2的坑呢

回复

肆意的青春 作者 · 2015年04月23日

嗯,已改正 thanks :)

回复

stsczx · 2015年04月27日

抱歉,初学者,“可以通过 composer 添加依赖:bobchengbin/yii2-xml-request-parser 来完成”这个能详细说一下步骤吗?

回复

肆意的青春 作者 · 2015年04月27日

在项目目录下运行这个命令就行 $ composer require bobchengbin/yii2-xml-request-parser '*' 这样就会安装好这个依赖了。

回复

肆意的青春 作者 · 2015年04月27日

建议把 composer 的文档都过一遍,这对以后做项目很有用, composer.lock 这个文件最好加到 git 里面去,然后线上直接用 composer install 就好了,我以前没加进来,每次线上运行 composer update 慢得要死!!(以这个为例)

回复

stsczx · 2015年04月27日

非常感谢,但是现在碰到一个问题,我不知道如果微信用户发一个消息的话,微信平台会来访问的URL是什么?是申请时候那个吗?用微信的调试工具老说我请求失败

回复

肆意的青春 作者 · 2015年04月27日

是你在微信那里设置的 url ,需要能在公网被访问的(抱歉没用过那个调试工具)

回复

stsczx · 2015年04月27日

我直接外网访问是有响应的,但是通过手机发一个消息就说该公众号暂时无法提供服务

回复

肆意的青春 作者 · 2015年04月27日

用 Yii 的 debug 去查看之前的访问信息,程序里面多记些 Yii::trace(); 来看数据,比如接收数据就 trace 记录一下,一步一步地。最后 return 数据之前也可以把数据先记录一下,再一步步排查

回复

stsczx · 2015年04月27日

我的测试函数就一句 return 'error'; 用浏览器访问是有响应的,就是通过微信访问好像就根本没去调用制定的url

回复

肆意的青春 作者 · 2015年04月27日

去看微信的文档吧,不要太着急! 文档里面有写相应的返回类型的,你直接返回一个 error 它是不会认的。而且刚才也说了啊,它调用的 url 是你在微信里面配置的 url ,不会再变了,只是传给服务器的数据不同罢了。

回复

载入中...