ShortUrlService 短链接实现思路

本文分析一下 ShortUrlService 的实现思路，结合 Yii 2.0 的 Service Locator 看一下如何配置使用；

代码示意

shorturl/
├── composer.json
├── controllers/
│   └── ShortUrlController.php
├── models/
│   └── ShortUrlModel.php
├── Module.php
├── README.md
└── service/
    ├── IShortUrl.php
    ├── Redis.php
    └── ShortUrlService.php

• 采用 Extensions 组织代码；
  扩展里面内容比较随意，示例中有 Module，有自定义 service 目录；
• 关于 Yii2 Module，可以参照 示例；对短链接没有实质意义；
  通常一个 Module 包括 models、controllers、views；
• 采用 composer 发布代码；
  了解手动安装；
• Yii2 中，在项目根目录下的 composer.json 文件配置，install 到 vendor 目录下；

接口 IShortUrl

• 使用接口明确标明对外提供的服务功能有哪些；

interface IShortUrl{
    public function getUrl($shortTag);
    public function getShortTag($url);
}

• Why you should always use PHP interfaces?
• 为何使用 shortTag，而非 shortUrl？
  我们使用大于短信，而其采用短信模板，要求披露详细 URL，例如：http://host/$shortTag;

ShortUrlService 实现接口 IShortUrl

• Application Components

class ShortUrlService extends \yii\base\Component implements IShortUrl{
    ...
}

• 通过 Service Locator 机制使用 ShortUrlService；

• 依赖关系

  
  
  

  ShortUrlService 的依赖关系

依赖 Redis

• ShortUrlService 的两个依赖之一；
• Application Components；

interface IRedis{
    public function get($key);
    public function set($key, $value);
}
class Redis extends \yii\base\Component implements IRedis {
    ...
}

依赖 ShortUrlModel

• ShortUrlService 的两个依赖之一；
• dbModel

class ShortUrlModel extends  ActiveRecord {
    public static function getDb(){
        ...
    }
    ...
}

• 通过重写 getDb()，指定特定的 db connection：shortTagDb；

如何配置使用？

• 在 Yii2 项目根目录下的 composer.json 文件进行配置，下载到 vendor 目录下；

• 配置文件 config/main.php 的片段（components 变量）

  
  
  

  图A：配置文件 config/main.php 的片段
• shortTagDb
  配置数据库链接；Yii db component；
  'class' => 'yii\db\Connection'；
• shortTagRedis
  配置 redis 数据服务；
• 通过 Service Locator 机制进行实例化；

单元测试

• 测试代码的目录结构大体上保持和业务代码一致；
  tests/shorturl/service/ShortUrlServiceTest.php
  
  

  单元测试示意
• phpunit tests/shorturl/service/ShortUrlServiceTest.php
  注意要在 tests 同级目录下运行；

phpunit.xml
tests/

候选方法

• 在配置文件中明确依赖的方法；

  
  
  

  图B：标记为注释的内容
• 拆分本 Extension；
  1. 将依赖 Redis 和 dbModel 拆分出去；
  2. 在 composer.json 中明确标明依赖；
  3. 配置方法和 图A 相同；

组装 url 的匿名函数及其调用

• 匿名函数的定义

 44   'f' => function($target_url, $demand_id) {
 45       eval("\$target_url = \"{$target_url}\";");
 46       $target_url = urlencode($target_url);
 47       return function($user_id) use ($target_url) {
 48           $token = get_sms_token($user_id);
 49           $long_url = 'http://m.example.com/index.php?r=site/xyz&user_id={$user_id}&token={$token}&target_url={$target_url}'; // 中转地址,
 50           eval("\$long_url=\"{$long_url}\";");
 51           return $long_url;
 52       };
 53   }

• 该函数与 target_url 配置在一起，便于就近了解该函数用法；
  $target_url 中有 $demand_id 变量；
• 匿名函数的使用 call_user_func；
  call_user_func(Yii::$app->params['sms_url']['f']($target_url, $demand_id), $supplier->user_id);