介绍

当您构建好自己的cf开发环境或基于作者提供的dockerfile构建好容器后并且将指定目录挂在到/app/script目录后, 就可以开始根据此篇文档进行service构建了。 本文假设您已经比较了解cf框架目录结构并且参考过基本的API与cf介绍.

快速开始

默认情况下, cf框架会在当前文件夹下寻找script/main.lua文件当做入口文件. 运行用户指需要完成的初始化与框架初始化后. 则开始进入事件循环等待请求.

使用者可根据httpd库的使用方法, 开始初始化main.lua. 以下是一个简单示例, 为使用者注册了一个'/api'路由提供测试

  1.   local httpd = require "httpd"
  2.   local app = httpd:new("App")
  3.  
  4.   app:api('/api', function(content)
  5.       return '{"code":200}'
  6.   end)
  7.  
  8.   app:listen("0.0.0.0", 8080)
  9.   app:run()

API与USE区别

API注册的路由Content-Type为Application/json, USE注册的路由类型为text/html.

如果批量注册API/USE路由?

路由处理方法分为2种: 一种是上述的回调处理函数, 一种是使用class库创建的http对象. 一般来说, 使用class对象结构化更清晰

在项目使用之初, 可能并不需要进行模块化. 所有文件写入到一个文件内即可, 这样方便快速开发与调试.但是当项目需求逐渐增多, 与前端同学对接API/前后端分离的后台API的数量直线上升. 这样, 我们的批量路由注册才能提现出模块化对项目的重要性.

第一步, 使用者需要编写批量注册的路由表(以API路由为例):

  1. --- 首先我们在script文件夹内新建一个文件夹admin;
  2. --- 然后新建一个admin/init.lua的文件, 这个文件内容如下:
  3. return {
  4.  {route = '/r1', class = require "admin.r1"},
  5.  {route = '/r2', class = require "admin.r2"},
  6.  {route = '/r3', class = require "admin.r3"},
  7. }

然后在scrit/main.lua文件内添加批量注册路由, 需要指名路由类型、路由前缀、路由表的文件:

  1. app:group(app.API, '/admin', require 'admin')

最后, 我们需要在script/admin 开始创建在真正的路由表对应的处理函数:

  1. --- r1.lua
  2.   local class = require "class"
  3.  
  4.   local r1 = class("r1")
  5.  
  6.   function r1:ctor(content)
  7.  
  8.   end
  9.  
  10.   function r1:get()
  11.       return 'this request build-in '..self.__name
  12.   end
  13.   return r1
  1. --- r2.lua
  2.   local class = require "class"
  3.  
  4.   local r2 = class("r2")
  5.  
  6.   function r2:ctor(content)
  7.  
  8.   end
  9.  
  10.   function r2:get()
  11.       return 'this request build-in '..self.__name
  12.   end
  13.   return r2
  1. --- r3.lua
  2.   local class = require "class"
  3.  
  4.   local r3 = class("r3")
  5.  
  6.   function r3:ctor(content)
  7.  
  8.   end
  9.  
  10.   function r3:get()
  11.       return 'this request build-in '..self.__name
  12.   end
  13.   return r3

测试一下: curl localhost:8080/admin/r1.

最后

上述所有代码可以在script文件夹内找到.