cf
是一个基于Lua
语言开发的后端框架, 内置admin
后台管理系统.
今天我们来学会如何快速搭建cfadmin
后台管理系统.
安装
作者本人使用的平台为Mac OSX, 其它Unix Like平台同理. Windows请自行到作者github下载指定版本.
1. MySQL安装
下载MySQL并且启动.
登录MySQL创建一个空的数据库, 数据库名称任意(例如:
cfadmin
).创建一个MySQL账号, 授权为刚刚创建的数据库(例如:
root
,123456789
,"cfadmin").刷新权限.
2. 框架安装
github
与Wiki
上已有docker
部署文档, 所以这里不再赘述. 直接描述实际步奏.
从
github
克隆源码.运行
./build.sh
开始安装依赖, 遇到错误查看文档解决错误.运行
make build
编译框架, 遇到错误查看文档解决错误.
编写运行脚本
cf
框架的入口文件为script/main.lua
, 我们先删除原有的文件后创建一个新的入口文件. 它大概是这样的:
local httpd = require "httpd"
local app = httpd:new("http")
app:static("static")
app:listen("", 8080)
app:run()
这5行代码描述了一个基本到httpd server启动配置.
这时候我们打开浏览器访问: http://localhost:8080/index.html
. 不出意外你会看到欢迎页面.
需要知道的是cf
框架不支持index
配置, 所以如果你省略index.html
就会得到一个404页面. 当然这或许您已经知道了.
app:static
设置静态文件路径, 它有一个缺省的ttl参数用于缓存静态文件.
配置后它会使浏览器缓存访问当前的静态页面, 直到ttl
秒后才重新发起新的请求.
app:listen
方法设置监听端口号, 并且开启监听当前主机所有IP
的8080端口.
app:run
方法启动httpd服务器, 写在这个方法之后的代码将不会被执行.
以上便是一个cf
框架基础web server
的编写方式, 这里不打算讲解基础路由. 需要补充知识点请查看之前我写过的文章.
搭建内置后台管理系统
之前我们启动了一个MySQL Server
并且创建了一个数据库, 现在我们来创建admin
库所需要的基础数据表.
依次打开: lualib/admin/db/database.sql
. 可以看到这个文件內有一套完整的SQL语句. 我们将文件所有内容复制到MySQL GUI
工具上并运行。
运行完毕并且未出错后, 我们开始继续扩展刚刚编写的
script/main.lua
文件.
1. httpd 开启 Cookie 支持
admin
库需要cookie
支持, 所以我们开启配置增加cookie解析与加密支持.
-- httpd启用Cookie扩展
app:enable_cookie()
-- httpd设置Cookie加密的密匙
app:cookie_secure("candymi")
2. 导入DB库
Admin库需要用户认证、权限认证、页面路由.
所以我们需要利用之前创建的MySQL信息创建DB对象. 这个DB对象稍后需要传递到admin库内.
DB对象会自动根据实际负载情况自动扩展连接池大小, 有需要的情况下开发者可以自行调整max
参数设置连接池上限.
local DB = require "DB"
local db = DB:new {
host = "localhost",
port = 3306,
username = 'root',
password = '123456789',
database = 'cfadmin',
charset = 'utf8',
max = 100,
}
db:connect()
db:connect
方法链接失败将会直接抛出异常, 请先检查数据库相关信息是否正确.
3. 导入admin
库
导入Admin库, 并且初始化内部路由. 将之前创建的httpd
对象与db
对象都传递进去.
-- 导入cf内置的admin库
local cfadmin = require "admin"
-- 注册后台页面路由
cfadmin.init_page(app, db)
-- 这个函数仅在第一次初始化数据的时候使用. 多次初始化不会产生错误, 但是会有SQL警告.
cfadmin.init_db()
测试
当上述所有步奏都完成后, 我们尝试运行cfadmin
进行最终测试.
[candy@MacBookPro:~/Documents/core_framework] $ ./cfadmin
[2019/10/26 16:46:32] [INFO] httpd正在监听: 0.0.0.0:8080
[2019/10/26 16:46:32] [INFO] httpd正在运行Web Server服务.
运行成功, 现在我们尝试打开http://localhost:8080/admin
页面进行测试.
OK, 完美运行.
完整的入口文件
local httpd = require "httpd"
local app = httpd:new("http")
-- httpd启用Cookie扩展
app:enable_cookie()
-- httpd设置Cookie加密的密匙
app:cookie_secure("candymi")
local DB = require "DB"
local db = DB:new {
host = "localhost",
port = 3306,
username = 'root',
password = '123456789',
database = 'cfadmin',
charset = 'utf8',
max = 100,
}
db:connect()
-- 导入cf内置的admin库
local cfadmin = require "admin"
-- 注册后台页面路由
cfadmin.init_page(app, db)
-- 这个函数仅在第一次初始化数据的时候使用. 多次初始化不会产生错误, 但是会有SQL警告.
cfadmin.init_db()
app:static("static")
app:listen("", 8080)
app:run()
最后
下一章我们将对admin
库进行配置与介绍.