我的第一个python web开发框架(8)——项目结构与RESTful接口风格说明

和黑猫之家聊聊?

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

 

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

  小白:老大有空吗?想和您再聊一会,请教几个问题?

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

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

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

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

  比如说我常用的项目结构:(如下图)

  

 我的第一个python web开发框架(8)——项目结构与RESTful接口风格说明 python教程

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,照着复制粘贴就可以了,只有动手做多了,坑踩多了就理解了。赶快去尝试一下吧,只有使用过你才能真正理解它的用法与好处。


黑猫之家原创文章

来黑猫之家看看呗

发表评论:

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。

Copyright © 2015-2018 黑猫吧(www.heimaoba.cn) 赣ICP备18005425号-1