用Yii2构建自己的API框架（二、创建common公共应用主体）

提示

本教程相关代码托管在Gitee：gitee.com/toshcn/micr…

在根目录创建common目录

common用作存放公共代码目录

cd micro-hau
mkdir common

common目录结构如下：

common                     // 公共代码存放目录
    - actions              // 公共的独立动作器存放目录
    - commponents          // 公共的组件存放目录
    - config               // 公共配置存放目录
        - .gitignore       // Git配置文件
        - bootstrap.php    // 预配置文件 用来设置别名等
        - main.php         // 主配置文件
        - main-local.php   // 本地环境配置文件
        - params.php       // 主参数配置文件
        - params-local.php // 本地环境参数配置文件
    - language             // 国际化语言翻译对应文件存放目录
    - models               // 公共模型类存放目录

设置根别名

在common/config目录下，创建bootstrap.php文件，在文件内添加如下内容：

<?php
Yii::setAlias('@common', dirname(__DIR__));

创建main.php主配置文件

在common/config目录下，创建main.php文件，在文件内添加如下内容：

<?php
/**
 * 公共主配置文件 本地配置文件里相同项会覆盖主配置文件里的相同项
 */
return [
    'timeZone' => 'Asia/Shanghai', // 设置时区
    'language' => 'zh-CN',         // 设置目标语言
    'charset' => 'utf-8',          // 字符集
    'vendorPath' => dirname(dirname(__DIR__)) . '/vendor', // 设置composer第三方依赖目录
    // 配置公共组件
    'components' => [
        // 缓存组件
        'cache' => [
            'class' => 'yii\caching\FileCache'
        ],
        // 国际化
        'i18n' => [
            'translations' => [
                'common*' => [
                    'class' => 'yii\i18n\PhpMessageSource',
                    'basePath' => '@common/language',
                    //'sourceLanguage' => 'en-US',
                    'fileMap' => [
                        'common' => 'common.php',
                    ],
                ],
            ],
        ],
    ]
];

创建main-local.php本地配置文件

在common/config目录下，创建main-local.php文件，在文件内添加如下内容：

<?php
// 本地相关配置项
return [
    'components' => [
        // 配置数据库组件
        'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'mysql:host=127.0.0.1;dbname=数据库名称', // 数据库连接
            'username' => 'root', // 数据库账号
            'password' => '', // 数据库账号密码
            'charset' => 'utf8', // 数据库连接字符集
            'tablePrefix' => 'hau_', // 表前缀
        ],
    ]
];

创建params.php公共参数文件

在common/config目录下，创建params.php文件，在文件内添加如下内容：

<?php
// 公共参数 使用方式：Yii::$app->params['参数名，如adminEmail']
return [
    'adminEmail' => 'admin@example.com', // 管理员邮箱
    'supportEmail' => 'support@example.com', // 技术支持邮箱
    'senderEmail' => 'noreply@example.com', // 发送邮箱
    'senderEmailName' => 'Example.com mailer', // 发送邮箱名称
];

创建params-local.php本地环境参数文件

在common/config目录下，创建params-locall.php文件，在文件内添加如下内容：

<?php
// 本地环境 公共参数 使用方式：Yii::$app->params['参数名']
return [
];