exhibition_service_api/app/Services/CommonService.php

<?php


namespace App\Services;

use Illuminate\Http\Request;
use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Support\Facades\DB;
use  App\Exceptions\ApiException;
use App\Models\BaseModel;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Cache;

/**
 * 用于后台管理员用户
 * */
abstract class CommonService
{
    use CacheTrait;
    /**
     * BaseModel
     * @var BaseModel
     */
    protected $model;

    /**
     * 是否缓存数据
     * @var bool
     */
    protected $cache = false;
    /**
     * 缓存空间
     * @var string
     */
    protected $cacheBucket = '';

    /**
     * CommonBaseService constructor.
     * @param BaseModel $model
     */
    public function __construct(BaseModel $model)
    {
        $this->model = $model;
    }

    /**
     * 获取url地址
     *
     * @return string  http://lumen.lwj_house.cn
     */
    public function getBaseUrl()
    {
        return app()->make(Request::class)->root();
    }

    /**
     * 缓存key
     * @param $id
     * @return string
     */
    protected function getCacheId($id)
    {
        return $this->cacheBucket . '-' . md5($id);
    }

    /**
     * 获取绑定的model
     * @return BaseModel
     */
    public function getModel()
    {
        return $this->model;
    }

    /**
     * 开启事务
     */
    public function beginTransaction()
    {
        $this->model->getConnection()->beginTransaction();
    }

    /**
     * 提交事务
     */
    public function commit()
    {
        $this->model->getConnection()->commit();
    }

    /**
     * 回滚事务
     */
    public function rollback()
    {
        $this->model->getConnection()->rollBack();
    }

    /**
     * 保存数据
     * @param $data
     * @return BaseModel
     */
    public function save($data)
    {
        $this->model = $this->model->newInstance();
        $data = $this->model->filter($data);
        foreach ($data as $key => $item) {
            $this->model->$key = $item;
        }
        $this->model->save();
        return $this->model;
    }

    /**
     * 批量保存数据
     * @param $data
     */
    public function saveAll($data)
    {
        if (empty($data)) {
            return;
        }
        //过滤字段数据
        foreach ($data as &$item) {
            $item = $this->model->filter($item);
        }
        //批量插入
        $this->model->newInstance()->getConnection()->table($this->model->getTable())->insert($data);
    }

    /**
     * 根据主键判断保存或者更新
     * @param $data
     * @return BaseModel
     */
    public function saveOrUpdate($data)
    {
        $key = $this->model->getKeyName();
        if (isset($data[$key]) && !empty($data[$key])) {
            return $this->update($data[$key], $data);
        } else {
            return $this->save($data);
        }
    }

    /**
     * 详情
     * @param $id
     * @return BaseModel
     */
    public function show($id)
    {
        return $this->findOneById($id);
    }

    /**
     * 更新数据
     * @param int $id
     * @param array $data 更新数据
     * @return BaseModel
     */
    public function update($id, array $data)
    {
        if ($this->cache) {
            Cache::forget($this->getCacheId($id));
        }
        if (method_exists($this->model, 'runSoftDelete')) {
            $model = $this->model->whereKey($id)->withAll()->first();
        } else {
            $model = $this->model->whereKey($id)->first();
        }
        //被删除的记录 抛出异常
        if (empty($model)) {
            throw new ApiException(1009);
        }
        $data = $this->model->filter($data);
        foreach ($data as $key => $item) {
            $model->$key = $item;
        }
        $model->save();
        return $model;
    }

    /**
     * 根据多个条件更新数据
     * @param array $criteria
     * @param array $data
     * @return bool
     */
    public function updateBy($criteria, array $data)
    {
        if ($this->cache) {
            if (method_exists($this->model, 'runSoftDelete')) {
                $list = $this->model->newInstance()->buildQuery($criteria)->withAll()->get();
            } else {
                $list = $this->model->newInstance()->buildQuery($criteria)->get();
            }
            foreach ($list as $item) {
                Cache::forget($this->getCacheId($item[$this->model->getKeyName()]));
            }
        }
        $data = $this->model->filter($data);
        if (method_exists($this->model, 'runSoftDelete')) {
            $res = $this->model->newInstance()->buildQuery($criteria)->withAll()->update($data);
        } else {
            $res = $this->model->newInstance()->buildQuery($criteria)->update($data);
        }

        return $res;
    }

    /**
     * 列表查询
     * @param $data
     * @return Collection
     */
    public function index($data)
    {
        return $this->model->whereRaw($this->getCondition($data))->paginate($this->getPageSize($data));
    }

    /**
     * 获取查询条件
     * @param $data
     * @return string
     */
    protected function getCondition($data)
    {
        if (!is_array($data)) {
            return '';
        }
        $data = $this->model->filter($data);
        $condition = '1=1';
        foreach ($data as $key => $item) {
            $condition .= " and " . $key . "='" . $item . "'";
        }
        return $condition;
    }

    /**
     * 获取分页行数
     * @param $data
     * @return int
     */
    protected function getPageSize($data)
    {
        return $data['page_size'] ?? config('app.app_rows');
    }

    /**
     * 删除数据
     * @param $id int|array
     * @return bool|null
     */
    public function delete($id)
    {
        if (is_array($id)) {
            return $this->deleteBy([
                $this->model->getKeyName() => [
                    ['in', $id]
                ]
            ]);
        } else {
            return $this->deleteBy([
                $this->model->getKeyName() => $id
            ]);
        }
    }

    /**
     * 根据条件删除数据
     * @param $criteria
     * @return bool|null
     */
    public function deleteBy($criteria)
    {
        if (method_exists($this->model, 'runSoftDelete')) {
            $res = $this->model->newInstance()->buildQuery($criteria)->withAll()->get();
        } else {
            $res = $this->model->newInstance()->buildQuery($criteria)->get();
        }

        if ($this->cache) {
            foreach ($res as $item) {
                Cache::forget($this->getCacheId($item[$this->model->getKeyName()]));
            }
        }
        if (method_exists($this->model, 'runSoftDelete')) {
            return $this->model->newInstance()->buildQuery($criteria)->withAll()->delete();
        } else {
            //系统所有删除均为软删除
            if(!empty($this->model::DELETED_AT)){
                $data=[];
                $data[$this->model::DELETED_AT]=$this->model::STATUS_DELETED;
                return $this->model->newInstance()->buildQuery($criteria)->update($data);
            }else{
                return $this->model->newInstance()->buildQuery($criteria)->delete();
            }
        }
    }

    /**
     * 根据条件恢复数据
     * @param $criteria
     * @return bool|null
     */
    public function restoreBy($criteria)
    {

        $res = $this->model->newInstance()->buildQuery($criteria)->get();
        if ($this->cache) {
            foreach ($res as $item) {
                Cache::forget($this->getCacheId($item[$this->model->getKeyName()]));
            }
        }
        return $this->model->newInstance()->buildQuery($criteria)->restore();
    }

    /**
     * 启用
     * @param $id
     * @return bool|null
     */
    public function enabled($id)
    {
        if ($this->cache) {
            Cache::forget($this->getCacheId($id));
        }
        $model = $this->model->newInstance();
        return $model->whereKey($id)->restore();
    }

    /**
     * 禁用
     * @param $id
     * @return mixed
     */
    public function disabled($id)
    {
        if ($this->cache) {
            Cache::forget($this->getCacheId($id));
        }
        $model = $this->model->newInstance();
        return $model->whereKey($id)->update(['status' => $model::STATUS_DISABLED]);
    }

    /**
     * id获取详情
     * @param $id
     * @return BaseModel
     */
    public function findOneById($id, $fields = '*')
    {
        $model = $this->model->newInstance();
        if ($this->cache && $fields == '*') {
            $info = Cache::remember($this->getCacheId($id), config('cache.time'), function () use ($model, $id, $fields) {
                if (method_exists($model, 'runSoftDelete')) {
                    return $model->whereKey($id)->withAll()->select(DB::raw($fields))->first();
                } else {
                    return $model->whereKey($id)->select(DB::raw($fields))->first();
                }
            });
        } else {
            if (method_exists($model, 'runSoftDelete')) {
                $info = $model->whereKey($id)->withAll()->selectRaw($fields)->first();
            } else {
                $info = $model->whereKey($id)->select(DB::raw($fields))->first();
            }
        }
        return $info;
    }

    /**
     * 查找数据
     * @param array|string $criteria
     * @return BaseModel
     */
    public function findOneBy($criteria, $fields = '*')
    {
        return $this->model->newInstance()->buildQuery($criteria)->select(DB::raw($fields))->first();
    }

    /**
     * 查找数据
     * @param array|string $criteria
     * @return Collection
     */
    public function findBy($criteria, $fields = '*')
    {
        return $this->model->newInstance()->buildQuery($criteria)->select(DB::raw($fields))->get();
    }

    /**
     * 查询符合条件的行数
     * @param $criteria
     * @return int
     */
    public function count($criteria)
    {
        return $this->model->newInstance()->buildQuery($criteria)->count();
    }

    /**
     * sql原生查询
     * @param $sql
     * @return array
     */
    public function query($sql)
    {
        $data = $this->model->getConnection()->select($sql);
        return json_decode(json_encode($data), true);
    }

    /**
     * 字段唯一性性验证
     * 修改数据验证时请组装主键notIn条件语句,返回false时为存在重复
     * @param $field
     * @param $value
     * @param $criteria
     * @return bool
     */
    public function checkFieldUnique($field, $value, $criteria)
    {
        $collection = $this->model->newInstance()->buildQuery($criteria)->selectRaw($field)->get();
        if (empty($collection->toArray())) {
            return true;
        }
        $checkArray = array_column($collection->toArray(), $field);
        if (in_array($value, $checkArray)) {
            return false;
        }
        return true;
    }

    /**
     * Increment a column's value by a given amount.
     * @param $criteria
     * @param $column
     * @param int $amount
     * @param array $extra
     * @return int
     */
    public function incrementBy($criteria, $column, $amount = 1, array $extra = [])
    {
        return $this->model->newInstance()->buildQuery($criteria)->increment($column, $amount, $extra);
    }

    /**
     * Decrement a column's value by a given amount.
     * @param $criteria
     * @param $column
     * @param int $amount
     * @param array $extra
     * @return int
     */
    public function decrementBy($criteria, $column, $amount = 1, array $extra = [])
    {
        return $this->model->newInstance()->buildQuery($criteria)->decrement($column, $amount, $extra);
    }

    /**
     * 获取某一字段值
     * @param $field
     * @param $criteria
     * @return string|int|array
     */
    public function getFieldBy($field, $criteria)
    {
        $findOne = $this->findOneBy($criteria, $field);
        $findOne = $findOne ? $findOne->toArray() : [];
        return $findOne[$field] ?? '';
    }

    /**
     * 根据id获取某一个字段值
     * @param $field
     * @param $id
     * @return array|int|string
     */
    public function getFieldById($field, $id)
    {
        return $this->getFieldBy($field, [
            $this->model->getKeyName() => $id
        ]);
    }

    /**
     * 获取模型的table
     * @return string
     */
    public function getTable()
    {
        return $this->model->getTable();
    }

    /**
     * 分页
     * @param $items 数据结果集
     * @param $total 总数量
     * @return LengthAwarePaginator
     */
    public function paginator($items, $total)
    {
        $request = app()->make(Request::class);
        $params = $request->all();
        if (isset($params['page'])) unset($params['page']);
        $path = $request->url();
        $perPage = $this->getPageSize($params);
        $options = [
            'path' => $path,
            'query' => $params,
        ];
        $page = new LengthAwarePaginator($items, $total, $perPage, $currentPage = null, $options);
        return $page;
    }

    /**
     * 通用缓存方法
     * @param string $key
     * @param array $data
     * */
    public function setCacheData($key, $data,$cacheTime=0)
    {
        $cacheTime=empty($cacheTime)?config('cache.def_time'):$cacheTime;
        Cache::put($this->getCacheKey($key), $data, $cacheTime);
    }

    /**
     * 通用缓存方法
     * @param string $key
     * @param array $data
     * */
    public function getCacheData($key)
    {
        $dataKey= $this->getCacheKey($key);
        return Cache::get($dataKey);
    }

    public function getCacheKeysAll($key)
    {
        return $this->getCacheClient()->keys('*' . $key . '*');
    }

    /**
     * 模糊清除所有前缀的缓存
     * @param $key
     */
    public function removeByKey($key)
    {
        $list = $this->getCacheKeysAll($key);
        foreach($list as $item){
            $this->getCacheClient()->del($item);
        }
    }

    /**
     * 获取通用缓存数据key
     * @param string $key
     * @return string
     * */
    private function getCacheKey($key)
    {
        return $this->cacheBucket.$key;
    }
}