`cocos2dx 非完整` UI解析模块

昨天在cocos2dx的一个群里,遇到一位匿名为x的朋友询问的问题,是关于ui的.他使用c++写了不少的ui封装节点,用来实现游戏中的各种不同效果.然后现在想改用lua,于是尝试使用最小代价去复用自己的代码.当然这个是可以做到的,相信很多人都是知道方法的.今天的这篇文章就来谈谈ui部分的处理以及个人的见解.

我们都知道,cocos2dx引擎提供了ui工具cocostudio.后来改名为cocos engine.这些就不赘述了,很多人都会使用这款工具.新版本的工具我没有使用过,不过我承认是方便了很多.可是很多时候我们期望有着自己一套的资源管理方式,尤其是项目琐碎ui资源,效果资源等等一大堆的时候,后期优化app包大小的时候也是个问题. 所以我个人倾向的方案是提供基于项目的ui库.当然对于lua这样的语言不存在库的说法,我在fw目录下面提供了一个ui模块,为了解决自己提供的ui方式，首先得想明白我们如何去使用自己的ui模块.我期望的方式是这个样子的:

local component_cfg = 
{
    {
        name     = "bg_img",
        creator = ui_parser.parsers.img,  -- 基于cocos2dx ui
        pos     = cc.p(100,200), 
        -- ...
        parent  = self,
    },
    {
        name    = "loading_bar",
        creator = ui_parser.parsers.widget_loading_bar, -- 基于自己扩展的ui
        -- ...
        parent  = "bg_img",        -- 节点内部相互添加也可以支持
    },    

    onfinsh = function(components)
        components["loading_bar"]:set_percent(100), -- 初始化以后的操作
    end,
}

local components = ui_parser.parse(component_cfg)

看上面我提供的实例代码,我期望的是创建一个ui模块,只需要按照lua table的方式一样配置就好.这样有一个好处,可以复用很多其他模块的代码.需要的其他功能我都在注释中写出来了.接下来继续分析一下需求,我们可能会有自己的ui封装,所以得提供一个基类,当然这是仿照oop的说法,所以我就提供了一个ui_widget文件用来实现这个功能:

--小岩<757011285@qq.com>
--2015-5-30 13:25
local ui_widget = {}

function ui_widget:ctor(cfg)
    self.type_ = "ui_widget"
    self.cfg_  = cfg
    self:init_widget()
end

function ui_widget:init_widget()
    error(self.__cname .. ":init_widget() method not implemented!")
end

function ui_widget:get_root_node()
    error(self.__cname .. ":get_root_node() method not implemented!")
end

function ui_widget:add_to_node(parent)
    if parent.type_ and parent.type_ == "ui_widget" then
        parent:get_root_node():addChild(self:get_root_node())
    else
        parent:addChild(self:get_root_node())
    end
end

function ui_widget:add_child(child)
    if child.type_ and child.type_ = "ui_widget" then
        self:get_root_node():addChild(child:get_root_node())
    else
        self:get_root_node():addChild(child)
    end
end

function ui_widget:set_ap(ap)
    self:get_root_node():setAnchorPoint(ap)
end

function ui_widget:get_ap()
    return self:get_root_node():getAnchorPoint()
end

function ui_widget:set_pos(pos)
    self:get_root_node():setPosition(pos)
end

function ui_widget:get_pos()
    local posx, posy = self:get_root_node():getPosition()
    return cc.p(posx, posy)
end

return ui_widget

好了,基本的东西已经提供好了,下面就去处理.首先是处理creator,因为需求中明确的表示,第一我们要兼容cocos ui创建的api,另外我们还会有自己的ui封装.所以我将这些节点的创建方式都放在一起,方便管理.所以就有了ui_creator文件:

--小岩<757011285@qq.com>
--2015-5-30 12:45
local ui_creator = {}

ui_creator.creators_ = 
{
    ccsprite = 
    {
        function(...) 
            return cc.Sprite:create(...) 
        end,
        function(...)
            return cc.Sprite:createWithSpriteFrameName(...)
        end
    },
}

function ui_creator.new_ccsprite(mode, ...)
    return ui_creator.creators_.ccsprite[mode](...)
end

return ui_creator

可能很多人会奇怪这里面的mode参数是做什么用的，这个是用作资源管理用的,在开发初期的时候我们不会对资源进行合并处理,大部分都是散乱的放在各个文件夹中，而后期的时候我们会对资源进行合并.例如打包成为png大图等.通过浏览cocos2dx源码可以知道,cocos2dx的资源管理方式分为local和cache,所以我就提供了两种不同的创建接口.但是又消除了api的不同,对于使用者而言,仅仅是指定一下mode参数而已.对于api消除不同性接下来还要说.看ui_widget可以知道我提供的api和cocos2dx提供的api不同.所以我要消除这部分的不同性.不过要先来看一下ui_parser的实现:

--小岩<757011285@qq.com>
--2015-5-30 12:45
local ui_creator = require "fw.ui.ui_creator"
local checker    = require "fw.ui.check"
local api_adapter= require "fw.ui.api_adapter"

local ui_parser = {}

-- 解析ui控件函数
ui_parser.parsers =
{
    img = function(cfg)
        checker(cfg.mode, "number", string.format("ui_parser.parsers_.img() -- wrong mode %d", tonumber(cfg.mode)))
        checker(cfg.img,  "string", string.format("ui_parser.parsers_.img() -- wrong img %s",  tostring(cfg.img)))
        local img_ins = ui_creator.new_ccsprite(cfg.mode, cfg.img)
        api_adapter.adapter_cc(img_ins)
        return img_ins
    end,
}

local function _strict_loop_with_given_list(list, callback)
    for index, item in ipairs(list) do
        callback(index, item)
    end
end

--解析ui,生成ui控件
function ui_parser.parse(component_cfg)
    local ui_components_ = {}
    local ui_cbs_          = {}
    local unspports_     = {}

    --解析callback
    local function parse_cb(ui_cb)
        table.insert(ui_cbs_, ui_cb)
    end

    --解析ui控件
    local function parse_ui(ui_cfg)
        checker(ui_cfg.name,     "string",     string.format("ui_parser.parse.parse_ui() -- cfg name error!"))
        checker(ui_cfg.creator, "function", string.format("ui_parser.parse.parse_ui() -- cfg creator error!"))

        --处理节点相互添加
        if ui_cfg.parent and type(ui_cfg.parent) == "string" then
            parse_cb(function(ui_components)
                    local ui_component                 = ui_components[ui_cfg.name]
                    local ui_component_type         = ui_component.type_
                    local ui_component_parent         = ui_componens[ui_cfg.parent]
                    local ui_component_parent_type     = ui_component_parent.type_
                    if ui_component_type and ui_component_type == "ui_widget" then
                        ui_component:add_to_node(ui_component_parent)
                    else
                        if ui_component_parent_type and ui_component_parent_type == "ui_widget" then
                            ui_component_parent:add_child(ui_component)
                        end
                    end
                end)
        end

        ui_components_[ui_cfg.name] = ui_cfg.creator(ui_cfg)
    end

    --保存unspport
    local function parse_unspports(unspport)
        table.insert(unspports_, unspport)
    end

    _strict_loop_with_given_list(component_cfg, function(_, item)
            local item_type = type(item)
            if item_type == "table" then
                parse_ui(item)
            elseif item_type == "function" then
                parse_cb(item)
            else
                parse_unspports(item)
            end
        end)

    _strict_loop_with_given_list(ui_cbs_, function(_, cb)
            cb(ui_components_)
        end)

    ui_components_["unspport"] = unspports_

    return ui_components_
end


return ui_parser

其中我做了很多的事情,例如很多时候我们在做UI布局的时候需要做相对适配,所以坐标不好指定,所以我在解析compoennt_cfg的时候认为如果提供的节点是function类型的话,那么就等所有的节点都解析完了之后统一操作,这样就可以处理相对布局的东西了.另外cocos2dx node派生的节点,和我们事先的ui_widget派生的节点如何相互添加的操作也做了.好了，创建的节点我在ui_parser.parsers中封装了,下面我们就来处理api的不同性,并消除掉。

--小岩<757011285@qq.com>
--2015-5-30 14:17
local api_adapter = {}

api_adapter.cc = 
{
    parent = function(node, parent)
                if type(parent) ~= "string" then
                    if parent.type_ and parent.type_ == "ui_widget" then
                        parent:add_child(node)
                    else
                        parent:addChild(node)
                    end
                end
            end,
    pos   = function(node, pos)
                node:setPosition(pos) 
            end,
    ap    = function(node, ap)
                node:setAnchorPoint(ap)
            end,
    show  = function(node, show)
                node:setVisible(show)
            end,
    content_size = function(node,  content_size)
                node:setContentSize(content_size)
            end,
    rotation = function(node, rotation)
                node:setRotation(rotation)
            end,
    scale = function(node, scale)
                node:setScale(scale)
            end,

    scalex = function(node, scalex)
                node:setScaleX(scalex)
            end,
    scaley = function(node, scaley)
                node:setScaleY(scaley)
            end,
    rsx    = function(node, rsx)
                node:setRotationSkewX(rsx)
            end,
    rsy    = function(node, rsy)
                node:setRotationSkewY(rsy)
            end,
}

api_adapter.widget = 
{
    parent = function(node, parent)
                if type(parent) ~= "string" then
                        node:add_to_parent(parent)
                end
            end,
    pos    = function(node, pos)
                node:set_pos(pos)
            end,
    ap     = function(node, ap)
                node:set_ap(ap)
            end,
    show   = function(node, show)
                node:get_root_node():setVisible(show)
            end,
    content_size = function(node, content_size)
                node:set_content_size(content_size)
            end,
}

function api_adapter.adapter_cc(node, cfg)
    if cfg.parent then api_adapter.cc.parent(node, cfg.parent) end
    if cfg.pos    then api_adapter.cc.pos(node, cfg.pos) end
    if cfg.ap     then api_adapter.cc.ap(node, cfg.ap) end
    if cfg.show or type(cfg.show) == "boolean" then api_adapter.cc.show(node, cfg.show) end
    if cfg.content_size then api_adapter.cc.content_size(node, cfg.content_size) end
    if cfg.rotation then api_adapter.cc.rotation(node, cfg.rotation) end
    if cfg.scale  then api_adapter.cc.scale(node, cfg.scale) end
    if cfg.scalex then api_adapter.cc.scalex(node, cfg.scalex) end
    if cfg.scaley then api_adapter.cc.scaley(node, cfg.scaley) end
    if cfg.rsx    then api_adapter.cc.rsx(node, cfg.rsx) end
    if cfg.rsy    then api_adapter.cc.rsy(node, cfg.rsy) end 
end

function api_adapter.adapter_widget(node, cfg)
    if cfg.parent then api_adapter.widget.parent(node, cfg.parent) end
    if cfg.pos    then api_adapter.widget.pos(node, cfg.pos) end
    if cfg.ap     then api_adapter.widget.ap(node, cfg.ap) end
    if cfg.show   then api_adapter.widget.show(node, cfg.show) end
    if cfg.content_size then api_adapter.widget.content_size(node, cfg.content_size) end
end

return api_adapter

我按部就班的提供了上面的工具. 这样就消除了api不同性. 如果添加了我们自己的ui封装,响应的在creator中添加创建函数,在parser中添加响应的解析,在api_adaper中添加相应的函数.这样就做到了我前面预期的事情了。

在这里要说一句抱歉,因为我并没有添加测试用例的功能，所以不能给大家提供直观的测试表现,很快我就会考虑添加的.这篇文章就到这里啦.希望对大家有用。