LayuiAdminProPHP

LayuiAdminProPHP是针对LayuiAdminPro后台模板使用ThinkPHP5.0+开发的基础版本

此项目期望在基于ThinkPHP5.0+版本框架下编写一套（包含以下通用方案）的功能框架，以可以在大部分新目开始之初可拿来就用无需重复编写下方列出的功能模块提升开发效率。

• 1、账户登录、注册、密码找
• 2、遵循 JWT（JSON Web Token）标准的鉴权方案（使用Redis），这里主要是针对单页面应用、APP后台
• 3、LayuiAdmin菜单方案
• 4、权限验证方案
• 5、数据缓存方案（使用TP内置的缓存Redis驱动，标签化管理）
• 6、WEB IM方案
• 7、日志系统
• 8、微信开发基础方案（包括、微信公众接入、自动回复、自定义菜单、微信登录、微信支付完善中 完善中）
• 9、支付方案（包括、支付宝、微信 完善中）
• 10、验证码方案、邮箱验证、手机验证 （手机验证 完善中）
• 11、基础的系统监控、异步任务处理方案（完善中）等
• 12、简单的shadowsocksr数据库版本的系统后台管理（用户、结点、套餐、账号监控）

由于其他项目的原因使项目很久没有维护了真的是非常抱歉下面有一些注意事项：

• 1、项目内置的TP5有不少安全漏洞请及时更新版本
• 2、现在会在当前状态下设置一个tag，后续会持续维护
• 3、为了方便大家交流后期会创建一个交流群
• 4、后期会在README.md中增加资源分享区，位置在最下面（可怕的不少你不会而是你都不知道有这么一个东西）

等一个项目开始之初送需要基础功能方案。

如果你对LayuiAdmin、ThinkPHP5还不太了解请阅读下面的简单介绍：

• 1、layuiAdmin后台模板介绍：
  • layuiAdmin后台模板为基于layui开发的单页面应用，所有操作无需跳转、采用前后端分离开发模式、更友好的交互体验，减轻浏览器负载、始终基于全新的 layui 版本、面向全屏幕尺寸的响应式适配能力、灵活的主题色配置。这里的基础版本目前只对单页面应用版本（layuiAdmin）进行适配layuiAdmin官网
• 2、ThinkPHP5介绍：
  • ThinkPHP V5.0是一个为API开发而设计的高性能框架——是一个颠覆和重构版本，采用全新的架构思想，引入了很多的PHP新特性，优化了核心，减少了依赖，实现了真正的惰性加载，支持composer，并针对API开发做了大量的优化。 ThinkPHP5是一个全新的里程碑版本，包括路由、日志、异常、模型、数据库、模板引擎和验证等模块都已经重构，但绝对是新项目的首选（无论是WEB还是API开发）。ThinkPHP官网

项目规划：

• 1、完善通用系统后台框架后会独立出一个用户后台分支。
• 2、系统通用后台介绍：就是现在这个项目计划完善成为一个通用的拿来就可以用基础性系统后台项目。
• 3、用户后台介绍：计划做成一个可提高个人生产力的平台，前端依然使用LayuiAdminPro后台模板后端使用PHP实现（主架构开源），
• 目前计划实现的主要服务有：
  • 1、可添加基于微信公众号模板通知的计划任务（如生日提醒、监控等）
  • 2、基于AES加密的记事本（只保存加密后的数据因此除本人外无法确认输入密码后解码的数据是否是正确数据）
  • 3、提供内网穿透服务
  • 4、提供API调用（IP所在地查询、二维码识别与生成、通过HTTP请求头分析客户端数据）
  • 5、数据分享（用户可在平台标记收藏自己的资源同时分享出来）
  • 6、提供简单容用的定制化网址导航。

项目近期任务：

• 1、升级LayuiAdminPro后台模板与官方版本一致。
• 2、设计修改微信类库的代码实现（如结合websocket的扫码登录、支付查询、微信客服等）进行模块化设计。
• 4、重新规划后端的代码实现与规范。
• 5、搭建可提供内网穿透服务、websocket通讯的服务。
• 6、完善WEB IM方案。

运行环境的简单介绍：

• 1、推荐PHP7+版本+MySQL+Nginx
• 2、功能模块中大量运用到Redis

文档：

• 更新日志  
• 演示地址 ，登录用户：test 密码：p123456（测试账号屏蔽大部分敏感权限）

目录结构简介：

www  WEB部署目录（或者子目录）
├─admin           系统后台应用目录
├─public          系统后台入口
│  ├─static        公共资源
│  │  ├─index      Layuiadmin 模板文件
├─extend          主要功能类目录
│  ├─common            公共类文件
│  │  ├─authority            权限相关类
│  │  │  ├─AdminMenuAccess.php   菜单权限
│  │  │  ├─AdminRole.php         用户角色组
│  │  │  ├─AdminRoleMenuAccess.php   菜单权限与用户角色组关系
│  │  │  ├─AdminRoleRouteAccess.php  方法权限与用户角色组关系
│  │  │  ├─AdminRouteAccess.php    方法权限
│  │  │  ├─AdminUserRole.php    系统管理员与角色关系模型
│  │  ├─console            think 命令行
│  │  │  ├─test.php        think 指令类示例
│  │  ├─custom             获取公共信息
│  │  │  ├─TerminalInfo.php      获取web客户端信息类（包括ip信息）
│  │  ├─heillog        日志系列
│  │  │  ├─ErrorLog.php    系统日志写入类
│  │  │  ├─SsrUserLog.php   SSR操作用户记录日志写入类
│  │  ├─helper         自定义助手函数系列
│  │  │  ├─helper.php         自定义助手函数
│  │  ├─menu        菜单系列
│  │  │  ├─AdminMenu.php    系统后台菜单
│  │  │  ├─AppMenu.php      用户前台菜单
│  │  ├─redis        redis系列
│  │  │  ├─RedisLogin.php    redis登录类
│  │  │  ├─RedisModel.php    redis基类
│  │  ├─Safety        密码、验证、JWT系列、数据加密等相关
│  │  │  ├─Safetylogin.php   密码、验证、JWT系列、数据加密等相关
│  │  ├─VerifiController        用以被控制器继承的权限验证、登录验证、基本信息获取
│  │  │  ├─AdminLoginVerifi.php    系统后台
│  │  │  ├─UserLoginVerifi.php     用户前台
│  ├─SendMail        阿里云邮件类
│  │  ├─EmailLog.php    邮件日志类
│  │  ├─SendMail.php    初始化邮件发送类
│  │  ├─Mail.php        邮件发送方法类
├─table.sql        表结构(用户表中的用户需要自己添加)
├─config.js       LayuiAdmin的配置
注意：这里在\thinkphp\library\think\log\driver目录下增加MysqFile.php驱动类使用MySQL记录系统错误日志（可在应用的config.php中修改）

配置简介：

• 应用的配置都在应用目录下的config.php中，具体的直接打开config.php文件就可以了解。
• LayuiAdmin的配置在根目录下config.js中

注意：

• 由于LayuiAdmin需要授权故不在此上次代码授权地址  
• 由于使用了ThinkPHP5.0+框架请先了解熟悉ThinkPHP的使用手册地址  
• 使用项目代码的前提是你已经了解 ThinkPHP5与LayuiAdmin的使用。

下载使用ThinkPHP5.0+框架：

• 1、本项目中不包含 ThinkPHP 与LayuiAdmin 的文件：
  • 使用安装 ThinkPHP

     使用  composer 安装 ThinkPHP
    composer create-project topthink/think=5.0.* tp5  --prefer-dist
    使用  git 安装 ThinkPHP
    https://github.com/top-think/think
    

• 2、获取LayuiAdmin授权授权地址  

思路介绍：

热数据的缓存：

• 项目使用Redis缓存大部分的重复调要数据如：JWT（JSON Web Token）标准的鉴权方案需要的数据、登录保存的用户基本数据、菜单数据、权限数据等。

JWT鉴权处理：

• 登录控制有两种方案Redis+mysql、纯redis 前者考虑到使用纯redis方案是利用redis的kye过期自动删除 不会保存登录数据（我自己找的理由）使用mysql保存基本的登录数据，纯redis方案是把所有的JWT（JSON Web Token）数据保存在redis中然后利用redis的kye过期自动删除功能控制登录的有效性（如何使用鉴权下面详细介绍）。

应用配置config：

• 考虑到部分项目可能会吧前（用户）后台（系统）放在一个项目中（以不同应用的形式存在）使用同一个redis数据库，就在配置文件（应用目录下config.php）中对配置进行了区分（下面会详细说明）。

RBAC、菜单权限、权限的继承：

• 菜单权限与方法权限（控制器方法）共同使用一个用户组系统。
• 除index首页（宿主页面）的渲染、登录注册、退出登录、对外开放API（微信）等控制器外的所有控制器请继承extend\VerifiController\AdminLoginVerifi.php 类由该类进行权限控制。

编写的规范：

• 所有业务逻辑与数据操作都放在模型（M）中，控制器（C）中不再有任何业务逻辑也不要在控制器中进行db操作，控制器只做请求的转发与权限控制。  API数据规范：控制器中所有的API数据（针对LayuiAdmin的）统一使用Result（）助手函数（helper.php）。

• 所有控制器都必须遵守如下规范，这是为了方便RBAC系统读取当前应用下所有的方法做权限列表（如果想隐藏控制器与权限不做下方规则定义方可）。

   ~~~

namespace app\authority\controller;
/**
 * 系统用户组管理       （这里必须加以说明控制器功能）
 */
class Menuaccess extends \VerifiController\AdminLoginVerifi     （继承AdminLoginVerifi）
{
   （必须 有 title 静态方法  方法内以数组键值对【'方法'=>'方法说明'】）

    /**
     * [title 标题]
     * @Effect
     * @return [type] [description]
     */
    static function title()
    {
        return[
            'updateList'=>'更新系统菜单权限',
            'setList'=>'设置用户组菜单权限',
        ];
    }
 }  
~~~  

• 数据模型统一继承在\extend\common\目录下增加基础模型类common\Model，继承后有基础分页查询方法getPageList($page,$limit,$whe,$hidden=[])可用 $whe查询搜索条件【为键值对数组】、$hidden限制输出字段【为索引数组】。

路由配置与RESTful规范：

• 路由配置---在应用下config.php中配置route_config_file=['route'.DS.'模块名','route'.DS.'模块名']来为应用下各模块配置单独的路由规则文件，路由各种文件在应用目录下的route文件夹下以【模块.php】命名.
• RESTful规范。

日志处理：

• 这里在\thinkphp\library\think\log\driver目录下增加MysqFile.php驱动类使用MySQL记录系统错误日志（如果不是要可在应用的config.php中修改）MysqFile.php只是对tp原有的驱动类进行了简单的修改以达到使用mysql记录系统基本的错误（使用extend\heillog\ErrorLog.php类写入）。
• 建议尽可能的对用户、管理员的所有操作进行记录。

常用方法：

• 控制器中所有的API数据（针对LayuiAdmin的）统一使用Result（）助手函数（helper.php）。
• app\login\model\MainUser 类的 MainUser::setUserData($id,$type=false)，当type=false时只获取用户的数据，为true时获取并且更新Redis中的用户数据（排除了密码数据）。  + 分页查询方法getPageList($page,$limit,$whe,$hidden=[])可用 $whe查询搜索条件【为键值对数组】、$hidden限制输出字段【为索引数组】，注意必须是继承common\Model的模型才可以使用。

WEB IM方案 长链接（websocket、GatewayWorker）：

• WEB IM方案前端所以LayIM，后端使用ThinkPHP5+GatewayWorker结合构建。

• 前端具体在/public/static/index/src/views/index.html中（这里注意var socket = new WebSocket('wss://demo.heil.red:8282');中的地址：1、wss是在https情况下使用的同时必须使用域名，如果你本地环境请修改我ws://127.0.0.1:8282）。

• GatewayWorker具体在GatewayWorker/Applications/YourApp/下的三个文件需要根据你的实际环境进行配置（特别注意当tp环境与GatewayWorker环境不在统一网络下）start_gateway.php文件中配置ssl（https证书）。

• 启动GatewayWorker 使用命令行进入到GatewayWorker目录 使用 php start.php start -d命令 没有-d是调试命令。

• gatewayclient（Gateway客户端）/vendor/workerman/gatewayclient/Gateway.php。

• ThinkPHP5在IM模块只的IM控制器中有简单的业务代码。

• GatewayWorker文档 、layim文档。

think 命令行工具：

• 1、需要在下面根目录下的think 文件 中配置

// 定义项目路径
define('APP_PATH', './admin/');
// 加载框架命令行引导文件
require './thinkphp/console.php';

• 2、在应用根目录下的command.php文件中配置指令类的引用地址建议统一放在\extend\console目录下(不需要.php)

// 定义项目路径
return [
    '\extend\console\test',
];

• 3、可在\extend\console目录下增加创建一个指令类test.php
• 4、think指令可配合Linux 的crontab 做计划任务（比如再配合Redis 队列 异步处理订单、支付状态等）提高系统的高可用性。
• 目前这里只有一个\extend\console目录一个test.php指令类做简单示例。  

开始构建：

• 1、获取LayuiAdmin授权并且选择代码，复制黏贴到public\static\index目录下
• 2、使用本项目代码在根目录进行粘贴替换。
• 3、根据自己项目的需求对应用目录下config.php进行配置修改。

资源分享区

软件

• 官方免费Xftp和Xshell [https://www.netsarang.com/en/free-for-home-school/]（这个是官方免费的只需要填写姓名和邮箱就可以收到一封带有下载地址的官方邮件）

composer 包分享

• 自动获取客户端浏览器（内核和版本）网络状态（移动网络或者是WiFi）通过IP获取精确到城市的地理位置（支持自动更新本地纯真IP地址数据库）、移动设备可获取到 系统（IOS、Android精确到系统版本）、微信版本（使用微信时）的类库 [https://github.com/pizepei/TerminalInfo]
  • composer require pizepei/terminal-info
• 时间日历(农历公历互相转换) [https://github.com/XhinLiang/LunarCalendar]
  • composer require overtrue/chinese-calendar

PHP扩展安装

• PHP 扩展下载[http://pecl.php.net/]
• sql server 拓展安装（注意细节）
  • 准备工作:
    • 下载地址：[http://pecl.php.net/package/pdo_sqlsrv]
    • 加入微软的源 curl https://packages.microsoft.com/config/rhel/7/prod.repo > /etc/yum.repos.d/mssqlrelease.repo
    • 或者一次性 安装所有依赖包
      • 防止冲突先卸载原有版本(可选) yum remove unixODBC
      • yum -y install gcc gcc-c++ autoconf libjpeg libjpeg-devel libpng libpng-devel freetype freetype-devel libxml2 libxml2-devel zlib zlib-devel glibc glibc-devel glib2 glib2-devel bzip2 bzip2-devel ncurses ncurses-devel curl curl-devel e2fsprogs e2fsprogs-devel krb5-devel libidn libidn-devel openssl openssl-devel nss_ldap openldap openldap-devel openldap-clients openldap-servers libxslt-devel libevent-devel ntp libtool-ltdl bison libtool vim-enhanced msodbcsql mssql-tools unixODBC-devel
  • 编译安装pdo_sqlsrv驱动
    • 避免出现make: *** No rule to make target `install'. Stop.错误（因为缺少依赖包的原因，请执行上面的依赖安装命令）
    • 为了避免make 时出现【fatal error: sql.h: No such file or directory】错误 （ 安装unixodbc的工具包即可 yum install unixODBC-devel ）
    • 与mysql不同 的dbh new PDO("sqlsrv:Server=localhost,端口号;Database=数据库", 用户名 , 密码);