用Yii2快速构建微服务RESTful API全攻略-php教程-PHP中文网

使用Yii2构建RESTful微服务需五步：一、配置REST路由与ActiveController；二、统一JSON响应格式及错误处理；三、集成JWT实现无状态认证；四、模块化拆分+Guzzle封装RPC调用；五、主从数据库分离与连接池优化。

用yii2快速构建微服务restful api全攻略 - php中文网

如果您希望使用 Yii2 框架高效搭建符合 RESTful 规范的微服务接口，需围绕模块化设计、状态无感知路由、JSON 响应标准化及服务间轻量通信展开。以下是实现该目标的关键实施路径：

一、配置 RESTful 路由与控制器基类

Yii2 默认路由机制需显式启用 RESTful 支持，并通过继承 yii\rest\ActiveController 实现资源自动映射。控制器需绑定数据模型并声明行为，使 GET /users、POST /users 等请求被自动分发至对应动作。

1、在 config/web.php 的 urlManager 组件中启用 enablePrettyUrl 和 enableStrictParsing，并添加 ['class' => 'yii\rest\UrlRule', 'controller' => ['v1/user']] 规则。

2、创建控制器文件 controllers/v1/UserController.php，继承 yii\rest\ActiveController，设置 public $modelClass = 'app\models\User';。

3、在控制器中重写 behaviors() 方法，返回包含 ContentNegotiator 和 VerbFilter 的行为数组，确保仅响应 JSON 并限制 HTTP 动词。

二、定义统一响应格式与错误处理

微服务要求所有接口输出结构一致，便于消费者解析；同时需将异常转化为标准 HTTP 状态码与语义化错误体。Yii2 通过自定义 Response 类和全局 errorHandler 实现该目标。

1、新建 components/ApiResponse.php，继承 yii\web\Response，重写 prepare() 方法，在返回前包裹数据为 ['code' => 0, 'message' => 'success', 'data' => $this->data] 格式。

2、在 config/web.php 中配置 response 组件，将 class 设为 app\components\ApiResponse，并设置 format 为 Response::FORMAT_JSON。

3、在 config/web.php 的 components 中配置 errorHandler，设置 errorAction 为 'v1/error'，并在对应控制器中返回含 code、message 的 JSON 响应。

三、集成 JWT 实现无状态认证

微服务架构下，会话不应依赖服务器存储，JWT 可将用户身份信息加密嵌入令牌，由客户端每次携带，服务端仅验证签名有效性。Yii2 可借助 yii2-jwt 扩展完成签发与校验。

1、执行 composer require filsh/yii2-oauth2-server 或更轻量的 lcobucci/jwt，并在 config/web.php 中注册 jwt 组件，配置密钥与算法。

2、创建 filters/JwtAuth.php，继承 yii\filters\auth\AuthMethod，在 authenticate() 中从 Authorization 请求头提取 Bearer Token，调用 jwt 组件验证并解析出 user_id。

3、在需要保护的控制器中，于 behaviors() 返回值内添加 'authenticator' => ['class' => JwtAuth::class]，并确保 optional 属性正确设置免鉴权动作（如登录）。

四、拆分服务边界与 RPC 调用封装

单一 Yii2 应用需模拟多微服务协作场景，可通过独立模块划分逻辑边界，并利用 HTTP 客户端实现服务间同步调用。关键在于避免硬编码 URL，统一管理服务注册与超时策略。

1、在 modules 目录下分别创建 user、order 等子模块，每个模块拥有独立控制器、模型与配置，通过 urlManager 规则绑定到 /v1/user/*、/v1/order/* 路径。

2、安装 guzzlehttp/guzzle，新建 components/ServiceClient.php，封装通用 POST/GET 方法，内置服务发现逻辑：根据服务名（如 'order'）查表获取其基础 URL，拼接完整 endpoint 并发送请求。

3、在 user 模块中调用订单服务时，不直接使用 file_get_contents() 或 cURL，而是调用 Yii::$app->serviceClient->post('order', '/create', $payload)，由客户端统一处理重试、熔断与日志记录。

五、启用数据库读写分离与连接池支持

高并发微服务需缓解单库压力，Yii2 原生支持主从分离，但需配合连接池中间件提升复用率，防止频繁建连耗尽资源。重点在于配置多个 DB 组件并注入查询构造器。

1、在 config/db.php 中定义 'db_master' 和 'db_slave' 两个组件，分别指向主库与从库地址，确保从库仅用于 SELECT。

2、在 config/web.php 中配置 components，添加 'db' 组件，设置 class 为 yii\db\Connection，并指定 masterConfig 与 slaves 数组，其中 slaves 包含 db_slave 配置。

3、在模型类中重写 getDb() 方法，对非事务性查询强制使用 Yii::$app->get('db_slave')，而 save()、delete() 等操作默认走主库；同时在 config/web.php 中为 db 组件设置 attributes 如 'charset' => 'utf8mb4' 与 'enableSchemaCache' => true。