yii2 restful api——app接口编程实例

<?phpnamespace common\components;use common\models\Cart;
use common\models\User;
use Yii;
use yii\rest\Controller;
use yii\web\Response;class ETRestController extends Controller
{
/**
* api返回的json
* @param $status
* @param $code
* @param $message
* @param $data
* @param array $share
* @return string
* @apiVersion 1.0
*/
protected function jsonEncode($status, $data=[], $message='', $code=1, $share=[])
{
$status = boolval($status);
$data = $data ? $data : (object)array();
$message = strval($message);
$code = intval($code);
$share = $share ? $share : (object)array(); $result = [
'status' => $status,
'code' => $code,
'message' => $message,
'data' => $data,
'share' => $share,
]; //设置响应对象
$response = Yii::$app->response;
$response->format = Response::FORMAT_JSON;
$response->data = $result;
} protected function jsonSuccess($data=[], $message='', $code=1, $share=array())
{
$message = $message ? $message : '调用成功';
$this->jsonEncode(true, $data, $message, $code, $share);
} protected function jsonFail($data=array(), $message='', $code=0, $share=array())
{
$message = $message ? $message : '调用失败';
$this->jsonEncode(false, $data, $message, $code, $share);
} protected function isLoggedIn()
{
$user = User::findIdentityByAccessToken(@$_REQUEST['access_token']);
return !!$user;
} protected function getUserId()
{
$user = User::findIdentityByAccessToken(@$_REQUEST['access_token']);
return $user ? $user->id : null;
} protected function getUser()
{
return User::findIdentityByAccessToken(@$_REQUEST['access_token']);
} protected function getAppCartCookieId()
{
return $this->getParam('app_cart_cookie_id') ? $this->getParam('app_cart_cookie_id') : Cart::genAppCartCookieId();
} /**
* 获取 $_REQUEST[$name], 包含get,post方式传过来的值
* @param $name
* @param null $defaultValue
* @return mixed
*/
protected function getParam($name, $defaultValue=null)
{
return isset($_REQUEST[$name]) ? $_REQUEST[$name] : $defaultValue;
}
}

<?phpnamespace api\modules\v1\controllers;use common\models\Address;
use common\models\Area;
use Yii;
use common\components\ETRestController;/**
* 用户收货地址控制器
* Class AddressController
* @package api\modules\v1\controllers
*/
class AddressController extends ETRestController
{
/**
* 地址列表
*/
public function actionIndex()
{
if(!$this->isLoggedIn()){
return $this->jsonFail([], '您还没有登录');
} $user_id = $this->getUserId();
$addresses = Address::findByUser($user_id);
$addressesArr = [];
foreach($addresses as $address){
$addrArr = $address->toArray([], ['area']);
$addrArr['area']['path_names_4print'] = $address->area->getPathNames4Print();
$addressesArr[] = $addrArr;
} $data = [
'addresses' => $addressesArr,
];
return $this->jsonSuccess($data);
} /**
* 添加地址
*/
public function actionCreate()
{
if(!$this->isLoggedIn()){
return $this->jsonFail([], '您还没有登录');
} $user_id = $this->getUserId();
// $area_id = $this->getParam('area_id');
// $telephone = $this->getParam('telephone');
// $detail = $this->getParam('detail');
// $fullname = $this->getParam('fullname');
//
// //字段验证, 不能用
// if(empty($area_id)){
//
// }
//
// //字段必须填写验证
// if (StringUtils.isBlank(areaId)) {
// result = false;
// message = "区域地址areaId(:" + areaId + ") 不能为空";
// return renderString(response, result, message, data);
// }
// if (StringUtils.isBlank(fullname)) {
// result = false;
// message = "请填写收货人姓名，用于收货";
// return renderString(response, result, message, data);
// }
// if (StringUtils.isBlank(telephone)) {
// result = false;
// message = "请填写手机号码，用于收货";
// return renderString(response, result, message, data);
// }
// if (!ValidateUtils.isMobile(telephone)) {
// result = false;
// message = ValidateUtils.getErrMsg();
// return renderString(response, result, message, data);
// } $area_id = $this->getParam('area_id');
$area = Area::findOne($area_id);
if (!$area) {
return $this->jsonFail("区域地址(ID:$area_id) 不存在");
} //非店内消费必须填写门牌地址
if ($area->id != Area::SHIPPING_GROUP_STORE && empty($this->getParam('detail'))) {
return $this->jsonFail([], '请填写门牌地址，用于收货');
} //清除默认地址, 因为把每次添加的地址作为默认地址
Address::updateAll(['is_default'=>Address::NO], 'user_id=:user_id', [':user_id'=>$user_id]); //添加收货地址
$address = new Address();
$addressData = $_REQUEST;
$addressData['is_default'] = Address::YES;
$addressData['user_id'] = $user_id;
if(!($address->load($addressData, '') && $address->save())) {
return $this->jsonFail([], $address->errorsToString());
} //我的收货列表
$addresses = Address::findByUser($user_id);
$addressesArr = [];
foreach($addresses as $item){
$addressesArr[] = $item->toArray([], ['area']);
} //带有区域对象的新地址
$addrArr = [];
$addrArr[] = $address->toArray();
$addrArr['area'] = $address->area->toArray();
$addrArr['area']['path_names_4print'] = $address->area->getPathNames4Print(); $data = [
'addresses' => $addressesArr,
'address' => $addrArr,
];
return $this->jsonSuccess($data);
} public function delete()
{
if(!$this->isLoggedIn()){
return $this->jsonFail([], '您还没有登录');
} $id = $this->getParam('id');
}
}

<?phpnamespace api\modules\v1\controllers;use common\components\ETRestController;
use common\models\Cart;
use common\models\CartItem;
use common\models\User;
use yii\filters\auth\CompositeAuth;
use yii\filters\auth\HttpBasicAuth;
use yii\filters\auth\HttpBearerAuth;
use yii\filters\auth\QueryParamAuth;
use yii\helpers\ArrayHelper;
use yii\validators\Validator;class UserController extends ETRestController
{
/**
* 行为: 登录认证
* @return array
*/
public function behaviors()
{
return ArrayHelper::merge(parent::behaviors(), [
'authenticator' => [
#这个地方使用`ComopositeAuth` 混合认证
'class' => CompositeAuth::className(),
#`authMethods` 中的每一个元素都应该是 一种 认证方式的类或者一个 配置数组
'authMethods' => [
//HttpBasicAuth::className(),
//HttpBearerAuth::className(),
QueryParamAuth::className(), //url as: http://api.eleteam.com/v1/users?access-token=123
]
]
]);
} public function actionView()
{
$user = $this->getUser();
$userArr = [];
$user && $userArr = $user->toArray();
$userArr['level_label'] = '铜牌用户';
$data = [
'user' => $userArr,
'user_id' => $this->getUserId(),
];
return $this->jsonSuccess($data);
} /**
* 注册第一步 - 提交手机号码
* @return string
*/
public function actionRegisterStep1()
{
$mobile = $this->getParam('mobile');
if(strlen($mobile)<11){
return $this->jsonFail([], '手机号格式不正确');
} $user = User::findOneByMobile($mobile, null);
if($user){
return $this->jsonFail([], '手机号已存在');
} //发送手机验证码
//SmsUtils.sendRegisterCode(username); return $this->jsonSuccess(['mobile'=>$mobile]);
} /**
* 注册第二步 - 提交手机号码、密码
* @return string
*/
public function actionRegisterStep2()
{
$mobile = $this->getParam('mobile');
$password = $this->getParam('password');
if(strlen($mobile)<11){
return $this->jsonFail([], '手机号格式不正确');
} $user = User::findOneByMobile($mobile, null);
if($user){
return $this->jsonFail([], '手机号已存在');
} //发送手机验证码
//SmsUtils.sendRegisterCode(username); return $this->jsonSuccess(['mobile'=>$mobile, 'password'=>$password]);
} /**
* 注册完成 - 提交手机号码、密码、验证码
* @return string
*/
public function actionRegisterStep3()
{
$mobile = $this->getParam('mobile');
$password = $this->getParam('password');
$code = $this->getParam('code');
if(strlen($mobile)<11){
return $this->jsonFail([], '手机号格式不正确');
} $user = User::findOneByMobile($mobile, null);
if($user){
return $this->jsonFail([], '手机号已存在');
} if(strlen($password) < 6){
return $this->jsonFail([], '密码必须大于6位');
} //比较验证码
//if (smsService.checkRegisterCode(username, code)) {
//短信验证码已过期，现在固定用 "8888"
if($code != '8888'){
return $this->jsonFail([], '验证码不正确');
} //创建用户
$user = new User();
$user->mobile = $mobile;
$user->password_plain = $password;
$user->setPassword($password);
$user->generateAccessToken();
if($user->save()){
$app_cart_cookie_id = $this->getAppCartCookieId();
$user_id = $user->id; //给新注册用户发送优惠券
//couponUserService.send4NewUser(loginUser.getId()); //转移购物车给用户
if($app_cart_cookie_id) {
$cart = Cart::findOneByAppCartCookieId($app_cart_cookie_id);
if(!$cart){ //创建购物车
$cart = new Cart();
$cart->user_id = $user_id;
$cart->save();
}else{ //转移购物车项给用户
Cart::updateAll(['user_id'=>$user_id], 'app_cart_cookie_id=:app_cart_cookie_id', ['app_cart_cookie_id' => $app_cart_cookie_id]);
CartItem::updateAll(['user_id'=>$user_id], 'app_cart_cookie_id=:app_cart_cookie_id', ['app_cart_cookie_id' => $app_cart_cookie_id]);
}
} $data = [
'user' => $user->toArray(),
'app_cart_cookie_id' => Cart::genAppCartCookieId(), //重新生成保存在前端, 当没登陆时用新的购物车
];
return $this->jsonSuccess($data);
} return $this->jsonFail(['user'=>$user->toArray()], '注册用户失败');
} /**
* 直接注册 - 提交手机号码、密码、验证码
* @return string
*/
public function actionRegister()
{
$mobile = $this->getParam('mobile');
$password = $this->getParam('password');
$code = $this->getParam('code');
if(strlen($mobile) != 11){
return $this->jsonFail([], '手机号格式不正确');
} $user = User::findOneByMobile($mobile, null);
if($user){
return $this->jsonFail([], '手机号已存在');
} if(strlen($password) < 6){
return $this->jsonFail([], '密码必须大于6位');
} //比较验证码
//if (smsService.checkRegisterCode(username, code)) {
//短信验证码已过期，现在固定用 "8888"
if($code != '8888'){
return $this->jsonFail([], '验证码不正确');
} //创建用户
$user = new User();
$user->mobile = $mobile;
$user->password_plain = $password;
$user->setPassword($password);
$user->generateAccessToken();
if($user->save()){
$app_cart_cookie_id = $this->getAppCartCookieId();
$user_id = $user->id; //给新注册用户发送优惠券
//couponUserService.send4NewUser(loginUser.getId()); //转移购物车给用户
if($app_cart_cookie_id) {
$cart = Cart::findOneByAppCartCookieId($app_cart_cookie_id);
if(!$cart){ //创建购物车
$cart = new Cart();
$cart->user_id = $user_id;
$cart->save();
}else{ //转移购物车项给用户
Cart::updateAll(['user_id'=>$user_id], 'app_cart_cookie_id=:app_cart_cookie_id', ['app_cart_cookie_id' => $app_cart_cookie_id]);
CartItem::updateAll(['user_id'=>$user_id], 'app_cart_cookie_id=:app_cart_cookie_id', ['app_cart_cookie_id' => $app_cart_cookie_id]);
}
} $data = [
'user' => $user->toArray(),
'app_cart_cookie_id' => Cart::genAppCartCookieId(), //重新生成保存在前端, 当没登陆时用新的购物车
];
return $this->jsonSuccess($data);
} return $this->jsonFail(['user'=>$user->toArray()], '注册用户失败');
} /**
* 通过手机号码快捷登录
* @param $mobile
* @param $code
* @return string
*/
public function actionMobileLogin($mobile, $code)
{
if(strlen($mobile)<11){
return $this->jsonFail([], '手机号格式不正确');
} //验证码验证, 未实现 @todo
if($code != '8888'){
return $this->jsonFail([], '验证码不正确');
} //手机号存在
$user = User::findOneByMobile($mobile); //如果手机号不存在则创建用户
if(!$user){
$user = new User();
$data = ['User' => ['mobile' => $mobile]];
if($user->load($data) && $user->save(false)){
//
}else{
return $this->jsonFail($user->errors, '创建用户失败');
}
} //如果没有access_token,则创建
$user->access_token = $user->getAccessToken();
return $this->jsonSuccess(['user'=>$user->toArray()], '登录成功');
} /**
* api登录, 返回access-token值
* 购物车商品的保存方式:
* 1. 没有登陆且购物车有值, 以当前购物车为准
* 2. 没有登陆且购物车没值, 以用户的购物车为准
* post: [mobile:123, password=abc]
* @return LoginForm|string
*/
public function actionLogin()
{
$mobile = $this->getParam('mobile');
$password = $this->getParam('password');
$app_cart_cookie_id = $this->getAppCartCookieId(); if(strlen($mobile) != 11){
return $this->jsonFail([], '手机号格式不正确');
} if(!strlen($password)){
return $this->jsonFail([], '请输入密码');
} $user = User::findOneByMobile($mobile);
if($user && $user->validatePassword($password)){
$user_id = $user->id;
$user->getAccessToken();
//转移购物车给用户
if($app_cart_cookie_id) {
$cart = Cart::findOneByAppCartCookieId($app_cart_cookie_id);
if($cart){
$userCart = Cart::myCart($user_id, null);
$cartItems = Cart::findItems($cart->id);
if($cartItems) {
//清空用户的购物车项
CartItem::updateAll(['status'=>CartItem::STATUS_DELETED], 'cart_id=:cart_id', ['cart_id'=>$userCart->id]);
//转移购物车项给用户
CartItem::updateAll(['user_id'=>$user_id, 'cart_id'=>$userCart->id], 'app_cart_cookie_id=:app_cart_cookie_id', ['app_cart_cookie_id' => $app_cart_cookie_id]);
}
}
}
$data = [
'user' => $user->toArray(),
'app_cart_cookie_id' => Cart::genAppCartCookieId(), //重新生成保存在前端, 当没登陆时用新的购物车
];
return $this->jsonSuccess($data);
} return $this->jsonFail([], '手机号或密码错误');// $data = [
// 'username' => $mobile,
// 'password' => $password,
// ];
// $model = new LoginForm();
// if ($model->load($data, '') && $model->login()) {
// return Yii::$app->user->identity->access_token;
// return Yii::$app->user->identity->getAuthKey();
// } else {
// return $model;
// }
} /**
* @param $mobile
* @return string
*/
public function actionSendCode($mobile)
{
if(strlen($mobile)<11){
return $this->jsonFail([], '手机号格式不正确');
} $user = User::findOneByMobile($mobile);
if($user && $user->id){
return $this->jsonFail([], '手机号已存在');
} //发送手机验证码, 未实现, @todo return $this->jsonSuccess([], '验证码已发送');
} /**
* api退出, 前期退出不更新access-token, 任何平台都可以登录用户的账号,便于调试,而且不会导致用户登录的token失效
* 后期如果要实现单点登录时,则清空用户的token即可
* @return bool
*/
public function actionLogout()
{
$app_cart_cookie_id = Cart::genAppCartCookieId(); //重新生成保存在前端, 当没登陆时用新的购物车
return $this->jsonSuccess(['app_cart_cookie_id'=>$app_cart_cookie_id]);
}// public function actionIsLoggedIn($user_id, $api_login_token)
// {
// $result = ['is_logged_in' => false];
// $user = User::findOne($user_id);
// if($user && $user->api_login_token && $user->api_login_token == $api_login_token){
// $result['is_logged_in'] = true;
// }
// return $result;
// }
}