python實現RESTful服務(基於flask)
前言
上一篇文章講到如何用java實現RESTful服務,這就來講講怎么用python來實現吧,因為要搭建一套java和python互調的服務,兩者都不能少啊。
對於python的述求呢也是要輕量化,並且能快捷開發,因為我這套服務主要控制邏輯還是在java端,python這塊負責一些工具邏輯,比如網頁爬取、文字轉拼音、圖像處理等等,在java端當成工具類來使用,所以輕量和快捷開發就是重點了
web框架選擇
java端需要選擇一個web容器,同樣的,python也需要選擇一個web框架,當然自己實現一套也可以哈,不過本着【人生苦短,我用python】的原則,還是找框架吧
知乎上有一個討論Python 有哪些好的 Web 框架?,從這個討論中最后我選擇了flask,原因是:
- Django,流行但是笨重,還麻煩,人生苦短,肯定不選
- web.py,輕量,但據說作者仙逝無人維護,好吧,先pass
- tornado,據說倡導自己造輪子,雖然是facebook開源的吧,但聽到這個,就算了吧
-
還有一些其他的就不說了,直到看到一個人做了如下回復,就暫定了flask,再發現flask寫RESTful居然超簡單,於是就它了
擼代碼
選定了flask框架,那就動手寫代碼咯
安裝flask
pip install flask
hello world
#!/usr/bin/env python # -*- coding: utf-8 -*- # by vellhe 2017/7/9 from flask import Flask # Flask初始化參數盡量使用你的包名,這個初始化方式是官方推薦的,官方解釋:http://flask.pocoo.org/docs/0.12/api/#flask.Flask app = Flask(__name__) @app.route('/HelloWorld') def hello_world(): return "Hello World!" if __name__ == "__main__": # 這種是不太推薦的啟動方式,我這只是做演示用,官方啟動方式參見:http://flask.pocoo.org/docs/0.12/quickstart/#a-minimal-application app.run(debug=True)
注:代碼里參見的官方文檔都是英文的,也有一個不錯的中文網站做了很好的翻譯,可以在扎個上面找到很好的對應:
http://www.pythondoc.com/flask/quickstart.html
驗證結果:
-
PostMan驗證
PostMan驗證 -
瀏覽器打開
瀏覽器打開
完美!!!就這幾行代碼就實現了一個簡單的網頁,簡直爽得不要不要的了
簡單的RESTful實現
光實現一個簡單網頁可不是本事(畢竟python用SimpleHTTPServer都可以不用寫代碼),實現RESTful是不是也同樣簡單呢?
#!/usr/bin/env python # -*- coding: utf-8 -*- # by vellhe 2017/7/9 from flask import Flask, abort, request, jsonify app = Flask(__name__) # 測試數據暫時存放 tasks = [] @app.route('/add_task/', methods=['POST']) def add_task(): if not request.json or 'id' not in request.json or 'info' not in request.json: abort(400) task = { 'id': request.json['id'], 'info': request.json['info'] } tasks.append(task) return jsonify({'result': 'success'}) @app.route('/get_task/', methods=['GET']) def get_task(): if not request.args or 'id' not in request.args: # 沒有指定id則返回全部 return jsonify(tasks) else: task_id = request.args['id'] task = filter(lambda t: t['id'] == int(task_id), tasks) return jsonify(task) if task else jsonify({'result': 'not found'}) if __name__ == "__main__": # 將host設置為0.0.0.0,則外網用戶也可以訪問到這個服務 app.run(host="0.0.0.0", port=8383, debug=True)
驗證結果



以上是通過最原始的方式實現,沒有使用flask的RESTful擴展庫,就這種實現方式都已經非常給力了,這么一點代碼就搞定了RESTful服務,真的是人生苦短啊,但這真的就完美了嗎?
答案肯定是no啦~ 必須要試試flask的RESTful擴展庫才知道什么叫真正的爽啊
使用flask的RESTful擴展庫 flask-restful
強烈建議參考官方文檔(因為下面我也是照搬不誤):http://flask-restful.readthedocs.io/en/0.3.5/quickstart.html#a-minimal-api
安裝flask-restful
pip install flask-restful
demo
#!/usr/bin/env python # -*- coding: utf-8 -*- # by vellhe 2017/7/9 from flask import Flask from flask_restful import reqparse, abort, Api, Resource app = Flask(__name__) api = Api(app) TODOS = { 'todo1': {'task': 'build an API'}, 'todo2': {'task': '哈哈哈'}, 'todo3': {'task': 'profit!'}, } def abort_if_todo_doesnt_exist(todo_id): if todo_id not in TODOS: abort(404, message="Todo {} doesn't exist".format(todo_id)) parser = reqparse.RequestParser() parser.add_argument('task') # Todo # shows a single todo item and lets you delete a todo item class Todo(Resource): def get(self, todo_id): abort_if_todo_doesnt_exist(todo_id) return TODOS[todo_id] def delete(self, todo_id): abort_if_todo_doesnt_exist(todo_id) del TODOS[todo_id] return '', 204 def put(self, todo_id): args = parser.parse_args() task = {'task': args['task']} TODOS[todo_id] = task return task, 201 # TodoList # shows a list of all todos, and lets you POST to add new tasks class TodoList(Resource): def get(self): return TODOS def post(self): args = parser.parse_args() todo_id = int(max(TODOS.keys()).lstrip('todo')) + 1 todo_id = 'todo%i' % todo_id TODOS[todo_id] = {'task': args['task']} return TODOS[todo_id], 201 ## ## Actually setup the Api resource routing here ## api.add_resource(TodoList, '/todos') api.add_resource(Todo, '/todos/<todo_id>') if __name__ == '__main__': app.run(debug=True)
驗證結果
查詢列表:

查詢單任務:

刪除任務:

添加任務(這是用post表單形式,還可以改成json形式啦):

更新任務:

flask-restful框架使用總結
這個框架用Resource類將封裝好了http的各種請求,只需定義一下對應的函數即可,返回值也是可以直接丟對象過去,非常方便,寫好接口類用API配置一下路徑就搞定了
后語
Perfect!!!經過這一番測試,flask-restful完全滿足了我的需求,框架輕量,開發方便,以class為單位去開發我的各個接口給到java調用,果然是【人生苦短,我用python】啊~