Yii框架中的Web服务开发指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00520/article/details/148508570

Yii框架中的Web服务开发指南

yii Yii PHP Framework 1.1.x 项目地址: https://gitcode.com/gh_mirrors/yi/yii

什么是Web服务

Web服务是一种支持跨网络机器间互操作的软件系统。在Web应用上下文中，它通常指一组可以通过互联网访问并在远程系统上执行的API接口。例如，基于Flex的客户端可以调用运行在PHP Web应用服务器端的函数。

Yii框架提供了完善的Web服务支持，主要基于SOAP协议实现。SOAP（简单对象访问协议）是Web服务通信协议栈的基础层，它使用XML格式进行数据交换。

Yii中的Web服务组件

Yii框架通过两个核心类简化了Web服务的实现：

CWebService：负责处理SOAP请求和响应
CWebServiceAction：作为控制器动作暴露Web服务接口

这些API被组织到称为"服务提供者"的类中。Yii会为每个类生成WSDL（Web服务描述语言）规范，描述可用的API及客户端应如何调用它们。

注意：使用Yii的Web服务功能需要确保PHP SOAP扩展已启用。

实现服务提供者

服务提供者是一个定义了可远程调用方法的类。Yii利用文档注释和类反射来识别哪些方法可以远程调用，以及它们的参数和返回值类型。

基础示例：股票报价服务

让我们以实现一个简单的股票报价服务为例：

class StockController extends CController
{
    /**
     * 获取股票价格
     * @param string $symbol 股票代码
     * @return float 股票价格
     * @soap
     */
    public function getPrice($symbol)
    {
        $prices = ['IBM' => 100, 'GOOGLE' => 350];
        return $prices[$symbol] ?? 0;
    }
}

在这个例子中：

我们使用@soap标记将getPrice方法声明为Web服务API
通过文档注释指定参数和返回值类型
方法实现简单的股票价格查询逻辑

暴露Web服务

要使服务可被客户端访问，需要在控制器中声明一个CWebServiceAction动作：

class StockController extends CController
{
    public function actions()
    {
        return [
            'quote' => [
                'class' => 'CWebServiceAction',
            ],
        ];
    }
    
    // ... getPrice方法同上 ...
}

这样配置后，通过访问URL http://hostname/path/to/index.php?r=stock/quote 就可以获取该服务的WSDL描述。

消费Web服务

客户端可以使用任何支持SOAP的语言来调用这个Web服务。以下是PHP客户端的示例：

$client = new SoapClient('http://hostname/path/to/index.php?r=stock/quote');
echo $client->getPrice('GOOGLE');  // 输出350

数据类型处理

在定义Web服务API时，需要明确指定参数和返回值的数据类型。Yii支持以下基本类型：

字符串：str/string → xsd:string
整数：int/integer → xsd:int
浮点数：float/double → xsd:float
布尔值：bool/boolean → xsd:boolean
日期：date → xsd:date
时间：time → xsd:time
日期时间：datetime → xsd:dateTime
数组：array → xsd:string
对象：object → xsd:struct
混合类型：mixed → xsd:anyType

对于非基本类型，Yii将其视为复合类型，由类的公共属性组成。这些属性也需要用@soap标记。

复合类型示例

class PostController extends CController
{
    /**
     * 获取文章列表
     * @return Post[] 文章数组
     * @soap
     */
    public function getPosts()
    {
        return Post::model()->findAll();
    }
}

class Post extends CActiveRecord
{
    /**
     * @var integer 文章ID
     * @soap
     */
    public $id;
    
    /**
     * @var string 文章标题
     * @soap
     */
    public $title;
    
    // ... 其他代码 ...
}

类映射配置

当需要接收复合类型参数时，必须配置WSDL类型到PHP类的映射：

class PostController extends CController
{
    public function actions()
    {
        return [
            'service' => [
                'class' => 'CWebServiceAction',
                'classMap' => [
                    'Post' => 'Post',  // WSDL类型 => PHP类
                ],
            ],
        ];
    }
    // ... 其他代码 ...
}

拦截远程方法调用

通过实现IWebServiceProvider接口，服务提供者可以拦截远程方法调用：

class StockController extends CController implements IWebServiceProvider
{
    public function beforeWebMethod($service)
    {
        // 获取当前请求的方法名
        $method = $service->methodName;
        
        // 进行权限检查等操作
        if (!Yii::app()->user->checkAccess($method)) {
            return false; // 阻止方法执行
        }
        
        return true;
    }
    
    // ... 其他代码 ...
}

这种方法可以用于实现权限控制、日志记录等横切关注点。