个人第一个python web开发框架（8）——项目结构与RESTful接口风格说明

　　PS：再次说明一下，本来不想写的太啰嗦的，可以前那个系列发布后发现，好多朋友都想立刻拿到代码当即能上手开发本身的项目，对代码结构、基础常识、分类目录与文件功能结构、经常使用函数......等等什么都不懂，而后就想使用，我真的很无语，还有一些朋友有十几年开发经验也会问一些很基础的问题，我都不知道怎么回答了。一会儿拿到整个项目的代码，初学者要上手并非那么容易的事情，不少代码通过层层封装后，反复跳转调用，不弄晕就很不容易了，因此得一步步来，了解整个代码的发展历程，知道它是怎么变化的，了解经常使用代码函数的使用方法，这样才能快速上手，游刃有余。

 

　　过了两天，小白与老菜在公司加完班后，小白看到老菜准备走人，赶忙逮着机会走了过去。

　　小白：老大有空吗？想和您再聊一会，请教几个问题？

　　老菜：哈哈...有什么问题说来听听。

　　小白：按您上次说的准备工做基本都准备好了，包括开发环境、前端页面、数据库设计等，如今就要进入编码阶段了，上次讲的文件分类摆放什么的不太明白，为何要这么作？还有就是我没有积累过各类经常使用工具函数，可否发几个给我？

　　老菜：工具函数回头发给你，对于文件分类摆放我再细说一下。

　　我与不少开发人员合做过，因为很多程序员对项目文件的分类管理不过重视，因此开发一段时间之后，就会发现整个项目变得很乱很难管理，你们根据本身的喜爱随便建立目录，而各个程序文件也没有分类放到对应的文件夹里，另外因为你们没有查看别人代码的习惯且文件管理混乱，一样的功能常常会本身写本身的，形成重复开发。时间久了之后须要对项目进行维护时，就是各类找，项目小问题还不大，项目大时程序文件比较多要修改一个bug都很麻烦。因此在开发前，你们须要先约定好项目结构说明，这样你们在开发时都会分门别类的在对应分类文件夹里建立程序文件，且程序文件命名都使用统一的规范，可读性强，你们理解起来也容易。

　　好比说我经常使用的项目结构：（以下图）

　　

api	接口api文件夹
common	工具函数文件夹
config	配置文件夹
external_interface	外部接口调用文件夹
log	日志文件夹
logic	逻辑层文件夹
service	python服务
static	静态文件夹
test	测试文件夹
main.py	程序主文件

 

 

 

 

　　有了约束后，相关开发人员清楚各个目录功能，就很容易找到本身想要的代码或函数，同时也知道要添加的文件或函数往哪里加。

　　好比说管理员管理表（manager），咱们通常接口文件名会用这个表名来命名：manager.py，针对这个表进行的查询、添加记录、修改记录、删除记录和其余操做，这些功能函数都会放在manager.py中，方便出现异常时定位查找。

　　工具函数文件必须使用功能名称的英文名来命名，通常我还会加上后缀_helper来进行区分，让你们一看到这个文件就知道他是common里的工具函数文件，好比：datetime_helper.py（日期操做包）、db_helper.py（数据库操做包）、log_helper.py（日志操做包）等。逻辑层文件名，我会添加后缀_logic，python服务文件会添加后缀_service，测试类文件会添加后缀_test来区分文件功能。固然不添加后缀或用其余约定好的前缀或后缀名均可以，只要你们遵循统一的约束，开发起来就会轻松多了。

 

　　另外，因为python的url路由和.net、php的不同，不是用文件名来作为访问路由的，而是在文件中自定义的，因此在命名上也是要遵循必定的约束，这样管理起来才比较容易。如今比较流行RESTful风格的接口（路由），你能够尝试一下用这个小项目练练手，熟悉一下。

　　关于RESTful的说明网上有太多文章了，这里就再也不细说它的定义。那么使用它有什么好处呢？我我的以为使用这种url设计风格，最大的好处就是咱们不用再为url起名而苦恼了（哈哈...说笑的...），RESTful风格设计的url结构清晰，让人容易理解每一个url的做用，扩展起来也方便。

　　那么咱们来讲说怎么用它来设计url。首先url名称上尽可能使用名词，不要用动词，好比对管理员表进行操做，url设计不要用add_manager、edit_manager等方式；对资源的操做，咱们使用HTTP协议里的动词来实现。

　　GET：获取资源

　　POST：建立资源

　　PUT：更新资源

　　DELETE：删除资源

　　例如：

　　获取管理员列表：GET http://127.0.0.1/manager/?page=0&rows=20&sidx=id&sord=desc

　　添加管理员：POST http://127.0.0.1/manager/

　　修改id为1的管理员记录信息：PUT http://127.0.0.1/manager/1/

　　获取id为1的管理员记录信息：GET http://127.0.0.1/manager/1/

　　删除id为1的管理员记录：DELETE http://127.0.0.1/manager/1/

　　启用或禁用id为1的管理员记录：PUT http://127.0.0.1/manager/1/enable/ （启用）   PUT http://127.0.0.1/manager/1/disable/ （禁用）

　　固然，为了让url更清晰，有时还会添加一些分类类别（也有多是多级分类），好比先后端接口区分，会在manager前增长manage或admin，例如：GET http://127.0.0.1/manage/manager/（获取后台管理系统的管理员列表）

　　好了，你本身上网去查查相关资料，若是不会的话参考我给你的demo，照着复制粘贴就能够了，只有动手作多了，坑踩多了就理解了。赶快去尝试一下吧，只有使用过你才能真正理解它的用法与好处。

 

 

版权声明：本文原创发表于 博客园，做者为 AllEmpty 本文欢迎转载，但未经做者赞成必须保留此段声明，且在文章页面明显位置给出原文链接，不然视为侵权。

python开发QQ群：669058475（本群已满）、733466321（能够加2群）    做者博客：http://www.cnblogs.com/EmptyFS/