thinklua是一个轻量级的(非常简单的)web框架，有基本的MVC功能，支持简单的自定义路由
主要功能：
- mysql操作封装
- redis操作封装
- 自动请求分发
- 简单的自定义路由
目前该框架还在测试阶段
- apps ----应用目录
- common ----函数库
- config ----应用配置目录
- controllers ----控制器目录
- models ----模型目录
- views ----模板目录
- bootstrap.lua ----应用启动文件
- init.lua ----应用初始化文件
- conf ----nginx配置目录
- lib ----lua库目录
- public ----用户访问目录(静态资源)
- tmp ----临时目录
只需要在nginx添加如下配置即可：
lua_code_cache on;
lua_package_path '/the/root/path/thinklua/apps/?.lua;/the/root/path/thinklua/lib/?.lua;;';
init_by_lua_file '/the/root/path/thinklua/apps/init.lua';
server {
listen 8000;
set $root /the/root/path/thinklua;
set $app_root $root/apps;
set $template_root $app_root/views;
location / {
content_by_lua_file $app_root/bootstrap.lua;
}
location /static/ {
root $root/public/;
}
}
如定义一个blog控制器，在apps/controllers目录下面建立一个blog.lua的文件：
定义如下： local _M = { _VERSION = '0.01' }
function _M.index(self)
self.withoutLayout = true
self:assign('title', 'blog')
self:display()
end
function _M.detail(self)
ngx.say('detail')
ngx.say(self:get('id'))
end
return _M
- controller : 当前控制器的名称
- action ：当前访问URL对应的方法名称
- params ：当前url中的参数
- withoutLayout : 是否不使用布局模板
- layout : 布局模板(默认为layouts/layout.html)
- assign : 模板赋值
- display : 调用模板并显示
- get : 获取get请求或url中的参数
- post : 获取post请求参数
- json : 返回json字符串
- jsonp : 返回jsonp字符串
======
- 功能：模板赋值
- 用法：assign(name, value)
- 参数说明：
name为模板变量的名称(可以是一个包含键值对的table)
value为模板变量的值
例如：
function _M.read(self)
self:assign("name", "shixinke")
self:assign({city = "hz", province = "zj"})
self:display()
end
======
- 功能：显示模板
- 用法：display(tpl, data)
- 参数说明：
- tpl为模板文件(默认为nil,系统自动定位到当前控制器及当前方法，如/blog/read即为 views/blog/read.html)
- data为模板变量(默认为nil)
例如：
function _M.read(self)
self:assign("name", "shixinke")
self:assign({city = "hz", province = "zj"})
self:display()
end
或
function _M.read(self)
self:assign("name", "shixinke")
self:assign({city = "hz", province = "zj"})
self:display('blog/post.html')
end
======
- 功能：获取get请求参数及url路由中的参数
- 用法：get(name)
- 参数说明：name为get请求或路由参数中的键名(name为空时表示所有get请求参数及路由参数)
例如：
function _M.read(self)
local id = self:get('id')
end
======
- 功能：获取post请求参数
- 用法：post(name)
- 参数说明：name为post请求参数中的键名(name为空时表示所有post请求参数)
例如：
function _M.read(self)
local id = self:post('id')
end
======
- 功能：返回json格式数据
- 用法：json(code, message, data)
- 参数说明：code 为返回数据状态编码(非HTTP状态码)(可以是一个table，表示整个返回数据)
- message 为提示信息
- data 为返回数据
例如：
function _M.read(self)
self:json(200, 'failed', {id = 100})
end
======
- 功能：返回jsonp格式数据
- 用法：jsonp(code, message, data, callback)
- 参数说明：
- code 为返回数据状态编码(非HTTP状态码)(可以是一个table，表示整个返回数据)
- message 为提示信息
- data 为返回数据
- callback 为回调函数
例如：
function _M.read(self)
self:jsonp(200, 'failed', {id = 100}, 'callback')
end
当访问URL为http://domain.com/blog/detail 时，
对应的文件为apps/controllers/blog.lua，访问的是blog控制器的detail方法
支持在控制器前面加目录，如http://domain.com/admin/blog/add，访问的是
apps/controllers/admin/blog.lua
但是开启layer是需要配置的：
layers="admin"
将模块放于layers的配置项中，多个使用,隔开
支持在URL后面添加后缀，如.html
比如访问:http://domain.com/blog/detail.html
需要在项目配置文件config.lua中添加 url_suffix的配置
如定义一个province模型，在apps/models目录下面建立一个province.lua的文件：
定义如下：
local _M = {
_VERSION = '0.01',
table = 'province',
pk = 'id'
}
func.extends_model(_M)
return _M
说明:属性table表示模型对应的表名
pk表示主键(没有主键的可以不填，组合主键也不用填)
func.extends_model(_M)表示当前模型继承自基类模型
- config : 数据库连接配置
- table_name ：数据库表名
- db ：mysql连接对象
- remains : 是否保留上次查询的条件(用于两次相同条件的查询，每次查询默认都会清空查询条件)
- sql : 完整的查询语句
- fields : 设置查询字段
- table : 设置查询表名
- where : 设置查询条件
- group : 设置分组
- order : 设置排序
- limit : 设置查询条数限制
- query : 执行sql查询语句
- exec : 执行非查询sql语句
- find : 查询单条数据
- findAll : 查询多条数据
- count : 查询数据条目数
- insert : 插入数据
- update : 更新数据
- delete : 删除数据
- close : 关闭数据库连接
注：模型基类实现链式操作的方法
======
- 功能：设置查询字段
- 用法：fields(field)
- 参数说明：field表示要查询的字段(可以是字符串也可以是table)
例如：
function _M.lists(self)
self:fields('id,name'):findAll('table_name')
-- self:fields(array('id', 'name')):findAll('table_name')
end
======
- 功能：设置查询的表名
- 用法：table(table_name)
- 参数说明：table_name表示要查询的表名
例如：
function _M.lists(self)
self:fields('id,name'):table('table_name'):findAll()
end
======
- 功能：设置查询条件
- 用法：where(field, condition, value)
- 参数说明:
- field：查询的字段或者整个查询条件(可以是一个table)
- condition(查询条件)
- value(匹配的值)
例如：
self:where(array('id'=>2))
self:where(array('id'=>array('>=', 2)))
self:where('name', 'LIKE', 'shixinke')
self:where('id="2"')
======
- 功能：设置查询分组
- 用法：group(field)
- 参数说明：
- field 用于分组的字段(可以是一个table或者字符串)
例如：
self:group('name')
self:group({'class_name', 'name'})
======
- 功能：查询排序
- 用法：order(field, direction)
- 参数说明：
- field 用于排序的字段(可以是一个table或者字符串)
- direction：排序类型，是正序还是倒序(默认正序)
例如：
self:order('name')
self:order('name', 'asc')
self:order({'name', 'asc'})
======
- 功能：查询分页
- 用法：limit(offset, limit)
- 参数说明：
- offset:查询分页起始条目
- limit : 查询多少条数据
例如：
self:limit(15)
self:limit(0, 15)
======
- 功能：执行查询语句
- 用法：query(sql)
- 参数说明：
- sql 执行的sql语句
例如：
self:query('select * from user where id >=2')
======
- 功能：执行非查询语句
- 用法：exec(sql)
- 参数说明：
- sql 执行的sql语句
例如：
self:exec('UPDATE user SET name="shixinke" WHERE id=2')
======
- 功能：查询所有数据
- 用法：find(table, field, where)
- 参数说明：
- table : 表名
- field 要查询的字段
- where : 查询条件
例如：
self:find('user', {'id', 'name'}, {id=2})
======
- 功能：查询所有数据
- 用法：findAll(table, field, where)
- 参数说明：
- table : 表名
- field 要查询的字段
- where : 查询条件
例如：
self:findAll('user', {'id', 'name'}, {class_name='G1'})
======
- 功能：查询表数据条目数
- 用法：count(table, where)
- 参数说明：
- table 操作的表名
- where 查询条件
例如：
self:count('user', {class_name="G1"})
self:where({class_name="G1"}):count()
======
- 功能：插入数据
- 用法：insert(table, data)
- 参数说明：
- table 操作的表名
- data 要插入的数据
例如：
self:insert('user', {name="shixinke", class_name="G1"})
======
- 功能：修改数据
- 用法：update(table, data, where)
- 参数说明：
- table 操作的表名
- data 要更新的数据
- where 修改条件
例如：
self:where({id=2}):update('user', {name="shixinke"})
self:update('user', {name="shixinke"}, {id=2})
======
- 功能：删除数据
- 用法：delete(table, where)
- 参数说明：
- table 操作的表名
- where 删除条件(是一个table或者字符串，与where函数的参数类似)
例如：
self:where({id=2}):delete('user')
self:delete('user', {id=2})
======
- 功能：关闭数据库连接
- 用法：close()
例如：
self:close()
框架中的视图使用的是lua-resty-template模板引擎，更多内容请参照:lua-resty-template
配置文件在apps/config/config.lua文件中
如：
local config = {
debug = true,
database = {
host = '127.0.0.1',
port = 3306,
user = 'shixinke',
password = '[email protected]',
database = 'geoip',
charset = 'utf8',
timeout = 1000,
max_idle_timeout = 6000,
pool_size = 100
},
cache = {
host = '127.0.0.1',
port = 6379,
timeout = 1000,
max_idle_timeout = 6000,
pool_size = 1000
},
routes = {
default_controller = 'index',
router_status = 'on',
layer_status = 'on',
layers = 'purview,monitor,config',
url_suffix = '.html',
view_suffix = '.html',
rules = {
{method = 'get', pattern = '/blog/:id', url = '/blog/detail'},
{method = 'get', pattern = '/lists/index', url = '/index/lists?id=11'}
}
},
pages = {
charset = 'UTF-8',
not_found = '',
server_error = ''
}
}
return config;
- debug：表示应用是否开启debug模式
- database:表示数据库相关配置
- cache:为redis相关配置
- routes :为路由URL相关配置
- default_controller:默认控制器
- default_action:默认方法
- router_status：是否开启路由配置
- rules:路由规则
- pages :表示页面相关的配置
- charset:表示页面的编码
- not_found:表示404页面url
- server_error:表示50x页面url
因为配置文件中项目初始化时已经加载，不需要在使用时加载配置文件，是一个全局变量，因此可以使用config.database.host类似的形式来读取配置文件
只需要在配置中打开路由开关即可，默认是根据URL自动匹配
-
转发 如： {method = 'get', pattern = '/lists/index', url = '/index/lists?id=11'}
表示当请求是/lists/index这个url时，其实它访问的是/index/lists?id=11这个url
-
":"传递参数 如：
{method = 'get', pattern = '/blog/:id', url = '/blog/detail'}
表示当请求为/blog/12类似的url时，实际访问的是/blog/detail?id=12这个url
{method = 'get', pattern = '/:alias', url = '/blog/detail' }
表示当请求为/abc类似的url时，实际访问的是/blog/detail?alias=abc这个url
-
“*” 匹配 如：
{method = 'get', pattern = '/blog/*', url = '/blog/index'}
表示当请求为/blog/123或/blog/add类似的url时，实际访问的是/blog/index这个url
-
全正则匹配
{method = 'get', pattern = '/category-([^\\s]+)', url = '/test/index?category=$1'},
表示以category开关的url，转向到/test/index这个方法，并将正则匹配内容传入到category中
-
全模糊匹配
{method = 'get', pattern = '/:category/:id', url = '/test/detail'}
注：表示以如果path为xx/xx的会请求到/test/detail这个方法(不影响其他通过url直接匹配的规则)
- 性能优化
- 添加更多如cookie等类库的支持
author:shixinke
email:[email protected]