习题 52: 创建你的 web 游戏 *************************************** 这本书马上就要结束了。本章的练习对你是一个真正的挑战。当你完成以后,你就可以算\ 是一个能力不错的 Python 初学者了。为了进一步学习,你还需要多读一些书,多写一些程序,\ 不过你已经具备进一步学习的技能了。接下来的学习就只是时间、动力、以及资源的问题了。 在本章习题中,我们不会去创建一个完整的游戏,取而代之的是我们会为《习题 42》中的\ 游戏创建一个“引擎(engine)”,让这个游戏能够在浏览器中运行起来。这会涉及到将\ 《习题 42》中的游戏“重构(refactor)”,将《习题 47》中的架构混合进来,添加自动测试\ 代码,最后创建一个可以运行游戏的 web 引擎。 这是一节很庞大的习题。我预测你要花一周到一个月才能完成它。最好的方法是一点一点来,\ 每晚上完成一点,在进行下一步之前确认上一步有正确完成。 重构《习题 42》的游戏 ========================= 你已经在两个练习中修改了 ``gothonweb`` 项目,这节习题中你会再修改一次。这种修改\ 的技术叫做“重构(refactoring)”,或者用我喜欢的讲法来说,叫“修修补补(fixing stuff)”。\ 重构是一个编程术语,它指的是清理旧代码或者为旧代码添加新功能的过程。你其实已经\ 做过这样的事情了,只不过不知道这个术语而已。这是写软件过程的第二个自然属性。 你在本节中要做的,是将《习题 47》中的可以测试的房间地图,以及《习题 42》中的游戏\ 这两样东西归并到一起,创建一个新的游戏架构。游戏的内容不会发生变化,只不过我们\ 会通过“重构”让它有一个更好的架构而已。 第一步是将 ``ex47/game.py`` 的内容复制到 ``gothonweb/map.py``\中,然后将 ``tests/ex47_tests.py`` 的内容复制到 ``tests/map_tests.py`` 中,然后再次运行 ``nosetests``\,确认他们还能正常工作。 .. note:: 从现在开始我不会再向你展示运行测试的输出了,我就假设你回去运行这些测试,而且\ 知道怎样的输出是正确的。 将《习题 47》的代码拷贝完毕后,你就该开始重构它,让它包含《习题 42》中的地图。\ 我一开始会把基本架构为你准备好,然后你需要去完成 ``map.py`` 和 ``map_tests.py`` 里边的内容。 首先要做的是使用 ``Room`` 类来构建基本的地图架构: .. literalinclude:: ex/ex52/gothonweb/gothonweb/map.py :linenos: 你会发现我们的 ``Room`` 类和地图有一些问题: 1. 在进入一个房间以前会打印出一段文字作为房间的描述,我们需要将这些描述和每个房间\ 关联起来,这样房间的次序就不会被打乱了,这对我们的游戏是一件好事。这些描述本来\ 是在 ``if-else`` 结构中的,这是我们后面要修改的东西。 2. 原版游戏中我们使用了专门的代码来生成一些内容,例如炸弹的激活键码,舰舱的选择等,\ 这次我们做游戏时就先使用默认值好了,不过后面的加分习题里,我会要求你把这些功能\ 再加到游戏中。 3. 我为所有的游戏中的失败结尾写了一个 ``generic_death``\,你需要去补全这个函数。\ 你需要把原版游戏中所有的失败结尾都加进去,并确保代码能正确运行。 4. 我添加了一种新的转换模式,以 ``"*"`` 为标记,用来在游戏引擎中实现“catch-all”动作。 等你把上面的代码基本写好以后,接下来就是引导你继续写下去的自动测试的内容 ``tests/map_test.py`` 了: .. literalinclude:: ex/ex52/gothonweb/tests/map_tests.py :linenos: 你在这部分练习中的任务是完成地图,并且让自动测试可以完整地检查过整个地图。\ 这包括将所有的 ``generic_death`` 对象修正为游戏中实际的失败结尾。让你的代码成功\ 运行起来,并让你的测试越全面越好。后面我们会对地图做一些修改,到时候这些测试\ 将保证修改后的代码还可以正常工作。 会话(session)和用户跟踪 =========================== 在你的 web 程序运行的某个位置,你需要追踪一些信息,并将这些信息和用户的浏览器关联\ 起来。在 HTTP 协议的框架中,web 环境是“无状态(stateless)”的,这意味着你的每一次请求\ 和你其它的请求都是相互独立的。如果你请求了页面 A,输入了一些数据,然后点了一个页面 B 的链接,那你在页面 A 输入的数据就全部消失了。 解决这个问题的方法是为 web 程序建立一个很小的数据存储功能,给每个浏览器进程赋予一个\ 独一无二的数字,用来跟踪浏览器所作的事情。这个存储通常用数据库或者存储在磁盘上的文件\ 来实现。在 ``lpthw.web`` 这个小框架中实现这样的功能是很容易的,以下就是一个这样的例子: .. literalinclude:: ex/ex52/gothonweb/session_sample.py :linenos: 为了实现这个功能,你需要创建一个 ``sessions/`` 文件夹作为程序的会话存储位置,\ 创建好以后运行这个程序,然后检查 ``/count`` 页面,刷新一下这个页面,看计数会不会累加\ 上去。关掉浏览器后,程序就会“忘掉”之前的位置,这也是我们的游戏所需的功能。\ 有一种方法可以让浏览器永远记住一些信息,不过这会让测试和开发变得更难。如果你\ 回到 ``/reset/`` 页面,然后再访问 ``/count`` 页面,你可以看到你的计数器被重置了,\ 因为你已经把会话杀掉了。 你需要花点时间弄懂这段代码,注意会话开始时 ``count`` 的值是如何设为 0 的。另外\ 再看看 ``sessions/`` 下面的文件,看你能不能把它们打开。下面是我把一个 Python 会话打开并且解码的过程: .. code-block:: pycon >>> import pickle >>> import base64 >>> base64.b64decode(open("sessions/XXXXX").read()) "(dp1\nS'count'\np2\nI1\nsS'ip'\np3\nV127.0.0.1\np4\nsS'session_id'\np5\nS'XXXX'\np6\ns." >>> >>> x = base64.b64decode(open("sessions/XXXXX").read()) >>> >>> pickle.loads(x) {'count': 1, 'ip': u'127.0.0.1', 'session_id': 'XXXXX'} 所以会话其实就是使用 ``pickle`` 和 ``base64`` 这些库写到磁盘上的字典。存储和管理\ 会话的方法很多,大概和 Python 的 web 框架那么多,所以了解它们的工作原理并不重要。\ 当然如果你需要调试或者清空会话时,知道点原理还是有用的。 创建引擎 ================== 你应该已经写好了游戏地图和它的单元测试代码。现在我要求你制作一个简单的游戏引擎,\ 用来让游戏中的各个房间运转起来,从玩家收集输入,并且记住玩家到了那一幕。我们将\ 用到你刚学过的会话来制作一个简单的引擎,让它可以: 1. 为新用户启动新的游戏。 2. 将房间展示给用户。 3. 接受用户的输入。 4. 在游戏中处理用户的输入。 5. 显示游戏的结果,继续游戏的下一幕,知道玩家角色死亡为止。 为了创建这个引擎,你需要将我们久经考验的 ``bin/app.py`` 搬过来,创建一个功能完备的、\ 基于会话的游戏引擎。这里的难点是我会先使用基本的 HTML 文件创建一个非常简单的版本,\ 接下来将由你完成它,基本的引擎是这个样子的: .. literalinclude:: ex/ex52/gothonweb/bin/app.py :linenos: 这个脚本里你可以看到更多的新东西,不过了不起的事情是,整个基于网页的游戏引擎只要\ 一个小文件就可以做到了。这段脚本里最有技术含量的事情就是将会话带回来的那几行,\ 这对于调试模式下的代码重载是必须的,否则每次你刷新网页,会话就会消失,游戏也不会\ 再继续了。 在你运行 bin/app.py 之前,你需要修改 PYTHONPATH 环境变量。不知道什么是环境变量?\ 为了运行一个最基本的 Python 程序,你就得学会环境变量,Python 的这一点确实有点挫。\ 不过没办法,用 Python 的人就喜欢这样: 在你的命令行终端,输入下面的内容: .. code-block:: console export PYTHONPATH=$PYTHONPATH:. 如果你用的是 Windows,那就在 PowerShell 中输入以下内容: .. code-block:: console $env:PYTHONPATH = "$env:PYTHONPATH;." 你只要针对每一个命令行会话界面输入一次就可以了,不过如果你运行 Python 代码时\ 看到了 import 错误,那你就需要去执行一下上面的命令,或者也许是因为你上次执行的 有错才导致 import 错误的。 接下来你需要删掉 ``templates/hello_form.html`` 和 ``templates/index.html``\,\ 然后重新创建上面代码中提到的两个模板。这里是一个非常简单的 ``templates/show_room.html`` 供你参考: .. literalinclude:: ex/ex52/gothonweb/templates/show_room.html :linenos: 这就用来显示游戏中的房间的模板。接下来,你需要在用户跑到地图的边界时,用一个 模板告诉用户他的角色的死亡信息,也就是 ``templates/you_died.html`` 这个模板: .. literalinclude:: ex/ex52/gothonweb/templates/you_died.html :linenos: 准备好了这些文件,你现在可以做下面的事情了: 1. 让测试代码 ``tests/app_tests.py`` 再次运行起来,这样你就可以去测试这个游戏。\ 由于会话的存在,你可能顶多只能实现几次点击,不过你应该可以做出一些基本的测试来。 2. 删除 ``sessions/*`` 下的文件,再重新运行一遍游戏,确认游戏是从一开始运行起来的。 3. 执行 ``python bin/app.py`` 脚本,试玩一下你的游戏。 你需要和往常一样刷新和修正你的游戏,慢慢修改游戏的 HTML 文件和引擎,直到你实现\ 游戏需要的所有功能为止。 你的期末考试 =============== 你有没有觉着我一下子给了你超多的信息呢?那就对了,我想要你在学习技能的同时可以\ 有一些可以用来鼓捣的东西。为了完成这节习题,我将给你最后一套需要你自己完成的练习。\ 你将注意到,到目前为止你写的游戏并不是很好,这只是你的第一版代码而已。你现在的\ 任务是让游戏更加完善,实现下面的这些功能: 1. 修正代码中所有我提到和没提到的 bug,如果你发现了新的 bug,你可以告诉我。 2. 改进所有的自动测试,让你可以测试更多的内容,直到你可以不用浏览器就能测到所有\ 的内容为止。 3. 让 HTML 页面看上去更美观一些。 4. 研究一下网页登录系统,为这个程序创建一个登录界面,这样人们就可以登录这个游戏,\ 并且可以保存游戏高分。 5. 完成游戏地图,尽可能地把游戏做大,功能做全。 6. 给用户一个“帮助系统”,让他们可以查询每个房间里可以执行哪些命令。 7. 为你的游戏添加新功能,想到什么功能就添加什么功能。 8. 创建多个地图,让用户可以选择他们想要玩的一张来进行游戏。你的 ``bin/app.py`` 应该可以运行提供给它的任意的地图,这样你的引擎就可以支持多个不同的游戏。 9. 最后,使用你在习题 48 和 49 中学到的东西来创建一个更好的输入处理器。你手头\ 已经有了大部分必要的代码,你只需要改进语法,让它和你的输入表单以及游戏引擎\ 挂钩即可。 祝你好运!