与您分享电脑世界

用yii2搭建了一个restful风格api接口，想要通过配置文件直接就强制所有action直接返回json数据格式，结果发现移动只要继承use yii\rest\ActiveController;控制器配置文件bootstrap和response的配置就会失效。最后看源码发现ActiveController继承\vendor\yiisoft\yii2\rest\Controller.php控制器里面通过behaviors行为重写了返回信息的数据格式。那么如果选择继承ActiveController控制器的话就只能在当前的行为重写返回数据格式规则，这样就需要每个控制器都去写规则了，如果想全局只能从配置文件里在response里执行到最后截取要出去数据根据自己的需求定义再输出，但是这样又不够灵活，自己看着办吧。参考如下配置内容根据自己需要修改：

return [
   'id' => 'app-api',
   'basePath' => dirname(__DIR__),
   'controllerNamespace' => 'api\controllers',
   'bootstrap' => [
      'log',
      [
         'class' => 'yii\filters\ContentNegotiator',
         'formats' => [
            'application/json' => yii\web\Response::FORMAT_JSON,
            //'text/html' => yii\web\Response::FORMAT_JSON,
            //'application/xml' => yii\web\Response::FORMAT_XML,
         ],
      ]
   ],
   'modules' => [
      'v1' => [  //module 与gii生成module配置的ModuleID 一致
         'class' => 'api\modules\v1\Module',
      ],
   ],
   'components' => [
      'request' => [
         'csrfParam' => '_csrf-api',
         'parsers' => [  //返回的数据格式为json
            'application/json' => 'yii\web\JsonParser',
            'text/json' => 'yii\web\JsonParser',
         ],
      ],
      //'response' => [
      // 'on beforeSend' => function($event) {
      //    if(is_array($event->sender->data)){
      //       $event->sender->format = 'json';
      //    }
      // },
      //],
      'response' => [
         'format' => 'json',//全局controller 返回json 不包括 ActiveController 会被行为重写
         //'charset' => 'UTF-8',
      ],
      'response' => [
         'format' => 'json',
         'formatters' => [
            \yii\web\Response::FORMAT_JSON => [
               'class' => 'yii\web\JsonResponseFormatter',
               'prettyPrint' => YII_DEBUG, // use "pretty" output in debug mode
               'encodeOptions' => JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE,
               // ...
            ],
         ],
      ],
      'response' => [
         'class' => 'yii\web\Response',
         'on beforeSend' => function ($event) {
            $response = $event->sender;
            $response->data = [
               'success' => $response->isSuccessful,
               'code' => $response->getStatusCode(),
               'message' => $response->statusText,
               'data' => $response->data,
            ];
            $response->statusCode = 200;
         },
      ],

在当前控制器里重写ActiveController控制器里的行为内容，参考着用。

class DefaultController extends ActiveController
{
   /**
    * Renders the test view for the module
    * @return string
    */
   //public function behaviors()
   //{
   // return [
   //    [
   //       'class' => 'yii\filters\ContentNegotiator',
   //       'only' => ['view', 'index'],  // in a controller
   //       // if in a module, use the following IDs for user actions
   //       // 'only' => ['user/view', 'user/index']
   //       'formats' => [
   //          'application/json' => Response::FORMAT_JSON,
   //       ],
   //       'languages' => [
   //          'en',
   //          'de',
   //       ],
   //    ],
   // ];
   //}
   public function behaviors()
   {
      $behaviors = parent::behaviors();
      $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_JSON;
      //print_r($behaviors);exit;
      return $behaviors;
   }

一般刚开始使用yii2的时候就会疑惑为什么项目有个\web\assets目录会有一些随机名称的子目录，而且一删除它还会时不时生成。

其实它就是yii2前端页面加载需要资源包，一般包括了静态的css、js、视频、图片、字体等。

一般资源包因为都是放在http无法访问的目录上，所以它才会根据组件和系统配置集中打包生成到\web\assets可访问目录下。

一切从main.php页面中使用use backend\assets\AppAsset;开始，

资源包指定为继承 yii\web\AssetBundle 的 PHP 类， 包名为可自动加载的 PHP 类名， 在资源包类中，要指定资源所在位置， 包含哪些 CSS 和 JavaScript 文件以及和其他包的依赖关系。

<?php

namespace app\assets;

use yii\web\AssetBundle;

class AppAsset extends AssetBundle
{
    public $basePath = '@webroot';
    public $baseUrl = '@web';
    public $css = [
        'css/site.css',
        ['css/print.css', 'media' => 'print'],
    ];
    public $js = [
    ];
    public $depends = [//列出该资源包依赖的其他资源包
         'yii\web\YiiAsset',
 'yii\bootstrap\BootstrapAsset',
];
}

如上 AppAsset 类指定资源文件放在 @webroot 目录下，对应的 URL 为 @web，资源包中包含一个 CSS 文件 css/site.css，没有 JavaScript 文件， 依赖其他两个包 yii\web\YiiAsset 和 yii\bootstrap\BootstrapAsset。

\vendor\yiisoft\yii2\web\YiiAsset.php内容如下，YiiAsset又依赖了yii\web\JqueryAsset

class YiiAsset extends AssetBundle
{
    public $sourcePath = '@yii/assets';
    public $js = [
        'yii.js',
    ];
    public $depends = [
        'yii\web\JqueryAsset',
    ];
}

\vendor\yiisoft\yii2\web\JqueryAsset.php内容如下，可以看到最终加载了\vendor\bower-asset\jquery\dist目录下的jquery.js文件，并复制生成到了\web\assets目录下。

class JqueryAsset extends AssetBundle
{
    public $sourcePath = '@bower/jquery/dist';
    public $js = [
        'jquery.js',
    ];
}

这里顺便说点信息，一般\web\assets会有更新问题，可以使用配置linkAssets属性来让它使用快捷方式指定到资源目录位置，而不是复制多一份方式。不使用就记得更新了文件记得删除让它重新生成。

如果默认的jquery版本不合适，就使用覆盖’yii\web\JqueryAsset’方式调用不同版本的jquery。

    'components' => [
        'assetManager'=> [
            'linkAssets'=> true,//在项目/web/assets目录使用快捷方式指定到资源目录位置
            'bundles' => [
                //'yii\web\JqueryAsset' => false,//禁用
                'yii\web\JqueryAsset' => [
/*                    'js' => [
                        //YII_ENV_DEV ? 'jquery.js' : 'jquery.min.js',
                        '//lib.sinaapp.com/js/jquery/2.2.4/jquery-2.2.4.min.js'
                    ]*/
                ],
            ],

        ],
    ],

其它具体内容可以看看官方文档：https://www.yiichina.com/doc/guide/2.0/structure-assets

最近yii2安装2.0.34最新AdminLTE后台模板和yii2-admin集成rbac管理组件。

composer require dmstr/yii2-adminlte-asset “2.*”

composer require mdmsoft/yii2-admin “2.x-dev”

发现在yii2-admin添加才当时候界面不能正常弹出下拉选择框，最后排查得知是因为yii2最新版Asset引用了最新的jquery-3.4.1.js。

前端脚本调用的时候出现Uncaught TypeError: elem.getClientRects is not a function错误提示。

该函数只能是jquery2才能正常使用，替换jquery即可。