异步创建 prefab instance

[cloudwu]

Ant 中的 prefab instance 创建都是异步的，需要在 on_ready 回调函数中写异步创建完毕后的业务逻辑。我这几天自己用的时候，做了点封装，让代码写起来更舒服一些。

目前的写法类似 test/simple 中的用法：

world:create_instance {
	prefab = "/asset/avatar.glb/mesh.prefab",
	on_ready = function (inst)
		-- 创建完 avatar 模型后，设置主摄像机朝向它	
		local main_queue = w:first "main_queue camera_ref:in"
		local main_camera <close> =	world:entity(main_queue.camera_ref, "camera:in")
		local dir =	math3d.vector(0, -1, 1)
		if not icamera.focus_prefab(main_camera, inst.tag['*'], dir) then
			error "aabb not	found"
		end
		-- 播放模型中的动画
		local ani = inst.tag.animation[1]
		iani.play(ani, { name = "walk", loop = true })
	end
}

通常，创建 instance 发生在场景初始化或由某个消息触发，这个流程一般是独立的。但这个独立流程中，会有多个 instance 的创建的过程，这些 instance 可能相互依赖，必须等前一个创建完毕，才方便设置后面的状态。

我把这批 instance 创建过程抽象成一个叫 async_instance 的过程，用 coroutine 简化它的编写流程，我写了这么一个辅助模块：

-- aync.lua 用于创建一个 aync_instance 过程
-- 原版 coroutine 不能直接在 ltask 中时候，需要导入 ant.coroutine ，用法一致。
local coroutine = import_package "ant.coroutine"

return function (world)
	local async = {}; async.__index = async
	
	local function async_create_instance(self, arg)
		function arg.on_ready(inst)
			local r = self._ready
			if r >= self._wait then
				self._wait = 0
				self._ready = 1
				assert(coroutine.resume(self._co))
			else
				self._ready = r + 1
			end
		end
		self._wait = self._wait + 1
		return world:create_instance(arg)
	end
	
	function async:create_instance(arg)
		local inst = async_create_instance(self, arg)
		coroutine.yield()
		return inst
	end
	
	async.async_instance = async_create_instance
	async.wait = coroutine.yield

	return function (main_func)
		local co = coroutine.create(main_func)
		local async_inst = setmetatable( { _co = co, _wait = 0, _ready = 1 }, async )
		assert(coroutine.resume(co, async_inst))
	end
end

然后，前面的创建代码就可以改为：

local async_instance = require "async" (world)

function m:init_world()
	-- 在 init_world 这个 stage 中启动一个新的 async_instance 过程
	async_instance(function(async)
		-- 用 aync:create_instance() 代替原来的 world:create_instance
		local inst = async:create_instance { prefab = "/asset/avatar.glb/mesh.prefab" }
		-- 此刻，inst 已经是 ready 的状态，可以使用
		local main_queue = w:first "main_queue camera_ref:in"
		local main_camera <close> =	world:entity(main_queue.camera_ref, "camera:in")
		local dir =	math3d.vector(0, -1, 1)
		if not icamera.focus_prefab(main_camera, inst.tag['*'], dir) then
			error "aabb not	found"
		end
		print_r(inst)
		local ani = inst.tag.animation[1]
		iani.play(ani, { name = "walk", loop = true })
	end)
end

如果是同时创建两个 instance ，不必等第一个创建 ready 后再创建下一个，可以写成：

local inst1 = async:async_instance { prefab = "/asset/avatar.glb/mesh.prefab" }
local inst2 = async:async_instance { prefab = "/asset/avatar.glb/mesh.prefab" }
-- 以上两个 inst1 和 inst2 是同时异步创建的
async.wait()
-- 在 wait 后，inst1, inst2 同时处于 ready 状态

或者，inst2 可以使用 async:create_instance 省掉写 async.wait()

local inst1 = async:async_instance { prefab = "/asset/avatar.glb/mesh.prefab" }
local inst2 = async:create_instance { prefab = "/asset/avatar.glb/mesh.prefab" }
-- 因为后一个 inst2 是用 async:create_instance() 创建，当这个函数返回时，前一个阶段所有的 inst1, inst2 均已 ready 。

[constly]

可以，这个很实用，