浅谈lumen框架的自定义依赖注入

比如我现在有个token认证系统，目前我用mysql的token表实现，将来有可能会改成redis，怎么实现未来的无缝连接呢。

先定义一个合约文件app/Contracts/TokenHandler.php

<?php 
 
namespace AppContracts; 
 
/** 
 * 处理Token的Contracts 
 * @package AppContracts 
 */
interface TokenHandler 
{ 
 /** 
  * 创建一个token 
  * @param $userId integer 用户Id 
  * @return string 
  */
 public function createToken($userId); 
 
 /** 
  * 得到该token的用户 
  * @param $token string token值 
  * @return AppUser 拥有该token的用户 
  */
 public function getTokenUser($token); 
 
 /** 
  * 删除一个token 
  * @param $token string token值 
  * @return bool 是否成功 
  */
 public function removeToken($token); 
}

这里定义了3个方法：创建token，得到token对应用户，删除token。

然后我们写一个Mysql下的实现app/Services/MysqlTokenHandler.php

<?php 
 
namespace AppServices; 
 
use AppContractsTokenHandler; 
use AppOrmToken; 
 
/** 
 * 处理Token的Contracts对应的Mysql Service 
 * @package AppServices 
 */
class MysqlTokenHandler implements TokenHandler 
{ 
 /** 
  * @var int 一个用户能够拥有的token最大值 
  */
 protected $userTokensMax = 10; 
 
 /** 
  * @inheritdoc 
  */
 public function createToken($userId) 
 { 
  while (Token::where('user_id', $userId)->count() >= $this->userTokensMax) { 
   Token::where('user_id', $userId)->orderBy('updated_at', 'asc')->first()->delete(); 
  } 
 
  $token = IlluminateSupportStr::random(32); 
  if (!Token::create(['token' => $token, 'user_id' => $userId])) { 
   return false; 
  } 
 
  return $token; 
 } 
 
 /** 
  * @inheritdoc 
  */
 public function getTokenUser($token) 
 { 
  $tokenObject = Token::where('token', $token)->first(); 
 
  return $tokenObject && $tokenObject->user ? $tokenObject->user : false; 
 } 
 
 /** 
  * @inheritdoc 
  */
 public function removeToken($token) 
 { 
  return Token::find($token)->delete(); 
 } 
}

然后在bootstrap/app.php里绑定两者的映射关系：

$app->singleton(
 AppContractsTokenHandler::class,
 AppServicesMysqlTokenHandler::class
);

如果将来换成了redis，只要重新写一个RedisTokenHandler的实现并重新绑定即可，具体的业务逻辑代码不需要任何改变。

于是在controller里就可以直接注入该对象实例，只要在参数前声明合约类型：

public function logout(Request $request, TokenHandler $tokenHandler) 
{ 
 if ($tokenHandler->removeToken($request->input('api_token'))) { 
  return $this->success([]); 
 } else { 
  return $this->error(Lang::get('messages.logout_fail')); 
 } 
}

也可以在代码里手动得到注入对象的实例，比如：

$currentUser = app(AppContractsTokenHandler::class)->getTokenUser($request->input('api_token'));