跳到主要内容

webgm_utils

简介​

提供webgm操作相关的工具库

组件接口​

FUrlWhitelist.gs​

URL的白名单标记

函数原型函数作用
void init_whitelist(map url2flag, map prefix2flag)初始化白名单
bool is_whitelist_url(string url)是否为白名单的url，不需要进行权限认证
void set_whitelist_url(string url, bool flag)设置白名单的url
void add_whitelist_url(string url)添加白名单的url
void del_whitelist_url(string url)移除白名单的url
void set_whitelist_prefix(string skip_prefix, bool flag)设置白名单的前缀
void add_whitelist_prefix(string skip_prefix)添加白名单的前缀
void del_whitelist_prefix(string skip_prefix)移除白名单的前缀

webgm_cmds.gs​

webgm的消息号处理

函数原型函数作用
void add_handler(string url, function func)注册handler
void add_handler_forward_func(function func)添加前置处理函数
bool call_handler_forward_funcs(mixed req, mixed res)执行所有前置处理函数
void add_handler_backward_func(function func)添加后置处理函数
bool call_handler_backward_funcs(mixed req, mixed res)执行所有后置处理函数
void register_all_handlers(string dir, string prefix = "/")将指定文件夹下的文件注册成handler
void register_internal_filters(array files)提供注册内部使用的filters

webgm_hotfix.gs​

webgm的热修复相关逻辑

函数原型函数作用
bool update_handler(string file_name)模拟GS中的update操作
string hotfix_handler(string file_path, mixed file_content, function success_callback)执行热更操作
array find_programs(string file_name)获取同名的program
mixed copyfile_to_localstorage(string file_path, mixed file_content)拷贝文件到本地存储

webgm_post.gs​

webgm的请求发送

函数原型函数作用
map post(string url, mixed data = nil, int type = Content_Type.json, map headers = , map extra = )发送post请求(规范返回值)
map co_execute_async_by_urls(function handle_func, map url2data = , int timeout = 5)异步执行相关urls的操作(handle_func)
map co_execute_async(function handle_func, map key2data = , int timeout = 5)异步执行相关keys的操作(handle_func)

webgm_resp.gs​

webgm的回包处理

函数原型函数作用
void send_response_success(object res, mixed data = "", bool is_table = false)发送操作成功的回包
void send_response_failure(object res, mixed data = "", bool is_table = false)发送操作失败的回包
void send_response_illegal(object res, mixed data = "", bool is_table = false)发送请求参数不合法/缺失的回包
void send_response_unauthorized(object res, mixed data = "", bool is_table = false)发送未认证的回包
void send_response_forbidden(object res, mixed data = "", bool is_table = false)发送没有权限的回包
void send_response_file(object res, string file_name, mixed file_buff)发送文件数据的回包
void send_response_json(object res, mixed data)发送json数据的回包
void send_response_buffer(object res, mixed buff)发送buffer数据的回包
map gen_response(ResponseCode code, mixed data = "")生成回包数据
bool check_response(mixed result)检查回包数据的格式是否符合要求
mixed gen_response_data(mixed data = "", bool is_table = false)生成回包数据
map gen_response_data_of_table_by_maps(array maps)将Map List数据格式，Table控件的数据格式
map gen_response_data_of_table_by_arrs(array arrs)将Array List数据格式，Table控件的数据格式

枚举​

ResponseCode​


    Success = 200,      // 求成功
    Failure = 400,      // 请求失败
    Illegal = 404,      // 请求参数不合法/缺失

    UnAuthorized = 401, // 未认证
    Forbidden = 403,    // 没有权限

    Download = 1001    // 下载文件

ContentType​


    rep_buffer,
    rep_html,
    rep_json,
    rep_string,
    rep_multipart,
    rep_css,
    req_urlencoded,
    rep_js