自动化运维与开发课件 任务1 Flask搭建服务器端_第1页
自动化运维与开发课件 任务1 Flask搭建服务器端_第2页
自动化运维与开发课件 任务1 Flask搭建服务器端_第3页
自动化运维与开发课件 任务1 Flask搭建服务器端_第4页
自动化运维与开发课件 任务1 Flask搭建服务器端_第5页
已阅读5页,还剩27页未读, 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

自动化运维与开发

项目3基于RESTfulAPI的B/S架构服务器状态监控系统任务1使用flask搭建服务器端第二篇

Python语言开发篇目录1知识储备任务要求任务实施23任务小结4过渡页1任务要求【任务要求】基于Flask框架搭建一个RESTfulAPI服务器,能够接收客户端发送的请求。​服务器需提供特定的API接口,用于返回服务器的状态数据(如CPU使用率、内存占用等)。服务器返回的数据格式为JSON,确保客户端能够正确解析。​实现基本的错误处理机制,当客户端请求无效时,返回适当的错误响应(如404等状态码)。​任务分析【学习目标】掌握RESTfulAPI设计原则:理解RESTful架构的核心理念,包括资源标识、HTTP方法使用和无状态通信。熟悉Flask框架核心功能:学会创建Flask应用、配置路由、处理HTTP请求以及生成响应。精通JSON响应构建:掌握使用Flask的jsonify模块构造规范的JSON响应数据。理解HTTP状态码应用:学习在API设计中根据请求场景返回适当的HTTP状态码(如200、400、500),提升接口的健壮性和可读性。过渡页2知识储备Flask模块介绍和使用RESTfulAPI原理介绍章节目录1Flask模块介绍和使用RESTfulAPI原理介绍2首先需要了解HTTP协议是怎么工作的。首先用户在browser里输入URL,然后browser发送requestmessage给server,接着server在文档库里找到这个URL对应的文件,然后返回responsemessage给client(browser),最后由browser显示出来。HTTP协议的工作原理RESTfulAPIREST(RepresentationalStateTransfer,表述性状态转移)是一种基于HTTP协议的软件架构风格,用于规范Web服务的设计与交互方式。它通过统一的接口设计实现客户端与服务器之间的高效通信,是目前Web服务开发的主流规范。RESTfulAPI使用HTTP请求来执行数据的创建、读取、更新和删除操作(即CRUD操作),以JSON格式返回数据,提升了系统的可读性、可扩展性和跨平台兼容性。REST并非严格的标准,而是一种设计风格,遵循REST架构的接口称为RESTfulAPI。RESTfulAPI在RESTful风格中,将互联网的资源抽象成资源,将获取资源的方式定义为方法。RESTfulAPI资源导向:所有操作围绕“资源”展开,每个资源通过唯一的URI(统一资源标识符)标识,例如/api/servers表示服务器资源集合,/api/servers/1表示ID为1的具体服务器资源。操作与HTTP方法绑定:资源的操作通过标准HTTP方法定义,而非在URL中包含动词,具体对应关系如下。

GET:读取资源(SELECT),如获取服务器状态。

POST:创建新资源(CREATE),如提交新数据。

PUT:更新资源(UPDATE,提供完整数据)。

PATCH:部分更新资源(UPDATE,提供需修改的数据)。

DELETE:删除资源(DELETE)。无状态:服务器不存储客户端的状态信息,每个请求必须包含所有必要的信息(如认证凭证、资源标识等)。这种设计使服务器更易于扩展,能快速处理并发请求。数据交互格式:通常采用JSON作为数据交换格式(也支持XML等),具有轻量、易解析、跨语言兼容的特点,符合API高效交互需求。RESTfulAPI的核心特性RESTfulAPI客户端请求传统url接口RESTful风格接口查询所有用户/user/findAllGET/users查询编号为1的用户/user/findById?id=1GET/user/1新增一个用户/user/savePOST/user修改编号为1的用户/user/updatePUT/user/1删除编号为1的用户/user/delete?id=1DELETE/user/1既然了解了RESTful的一些规则和特性,那么具体该怎么去设计一个RESTfulAPI呢?要从协议、URL路径、HTTP请求动词、状态码和返回结果等方面详细考虑。RESTfulAPI的设计规范RESTfulAPIREST没有强制标准,但其设计需遵循一系列约定,确保接口的一致性和易用性,主要包括以下方面:​通信协议:必须基于HTTP协议,利用其内置的方法、状态码等机制实现资源操作。​URL设计原则​域名:建议使用专用域名部署API,如;简单场景可使用主域名下的路径,如/api。​版本控制:通过URL路径包含版本号,便于API迭代与兼容,如/v1,v1表示版本1。​路径命名:路径中仅包含名词(资源名称),且使用复数形式表示资源集合,如/servers(服务器集合)、/logs(日志集合),避免出现动词(如/getServers)。例如:/v1/servers:表示服务器资源集合;

/v1/servers/123:表示ID为123的具体服务器资源RESTfulAPI的设计规范RESTfulAPI3.状态码使用:服务端处理完成后客户端也可能不知道具体成功了还是失败了,服务器响应时,包含状态码和返回数据两个部分。服务器会响应一个状态码来判断你的请求是否成功,以下是四种不同层次的状态码。

总之,RESTfulAPI的设计核心是“以资源为中心”,通过HTTP方法定义操作,利用状态码传递结果,最终实现客户端与服务器的无状态交互。这种风格使API具有良好的可读性、可扩展性和跨平台兼容性,是构建分布式监控系统、数据服务等场景的理想选择。1xx=Infor(相关信息)2xx=Success(成功)3xx=Redirect(重定向)4xx=Usererror(客户端错误)5xx=Servererror(服务器端错误)RESTfulAPIRESTfulAPI的设计规范RESTfulAPI大多数情况下,当你在使用你的浏览器的点点看看的时候,其实只用到HTTP的GET方法。GET方法是在你向因特网请求资源的时候才会用到的;当你提交一个表单时,你就会经常用到POST方法来回传数据到网站上;当你删除数据的时候,你需要用到DELETE方法。使用RESTful风格的接口,从接口上可能只能定位其资源,但是无法知晓它具体进行了什么操作,需要具体了解其发生了什么操作动作要从其HTTP请求方法类型上进行判断。具体的HTTP方法和方法含义如下:GET(SELECT):从服务器取出资源(一项或多项)。POST(CREATE):在服务器新建一个资源。PUT(UPDATE):在服务器更新资源(客户端提供完整资源数据)。PATCH(UPDATE):在服务器更新资源(客户端提供需要修改的资源数据)。DELETE(DELETE):从服务器删除资源。RESTfulAPI的设计规范章节目录1Flask模块介绍和使用RESTfulAPI原理介绍2Flask模块属于第三方模块,需要使用pip工具进行安装。Windows系统和OpenEuler系统均通过pipinstallflask命令进行安装。在使用Flask创建Server端时遵循以下流程。导入Flask--->创建app实例--->编写路由及视图函数--->启动服务1.创建Flask应用实例​Flask应用的核心是Flask类的实例,所有功能(如路由定义、请求处理)都围绕该实例展开。创建方法如下:​Flask模块Flask模块使用fromflaskimportFlask​#__name__表示当前模块名称,Flask会根据该参数查找资源路径​app=Flask(__name__)​2.定义路由与视图函数​使用@app.route(path,methods)装饰器定义URL端点及其支持的HTTP方法(如['GET','POST']),路由(route)可以将URL端点与视图函数绑定,当客户端访问指定URL时,对应的视图函数会被执行并返回响应。以下是基本示例:​关键说明:@app.route(path,methods)是Flask的路由装饰器,path参数为URL端点字符串,methods参数定义允许的HTTP方法,默认仅支持GET方法,如果支持多种HTTP方法,则需要放到列表中。​路由支持动态参数,如/user/<id>匹配指定ID的用户,用<>包裹变量。@app.route('/api/status',methods=['POST'])#绑定API路径'/api/status'和handle_status函数defhandle_status():return"Statusreceived"Flask模块Flask模块使用3.处理请求与响应​(1)获取请求数据​:Flask通过request对象获取客户端的请求信息,需从flask模块导入。​Flask模块fromflaskimportrequest​@app.route('/api/servers',methods=['POST'])​defcreate_server():​#获取JSON格式的请求体(适用于API接口)​data=request.get_json()#等价于json.loads(request.data)​(2)构建JSON响应​:使用jsonify函数可构建标准的JSON响应fromflaskimportjsonify​@app.route('/api/servers/<server_id>',methods=['GET'])​defget_server(server_id):

#URL中的<server_id>会作为参数传入​

#模拟查询服务器数据​

server_data={​

"id":server_id,​

"cpu_usage":75.2,​

}​

returnjsonify(server_data),200

#返回JSON响应和200状态码,并构建响应头​Flask模块使用4.启动Web服务器​通过app.run()方法启动Flask内置的开发服务器,默认是在5000端口,示例如下:​以下是run()方法参数说明。​host:绑定的IP地址,表示允许所有网络接口访问(默认仅本地)​port:服务端口,默认5000,可根据需求修改(如8080)​debug:是否开启调试模式(True表示开启),调试模式下修改代码会自动重启服务,且错误时显示详细堆栈信息(生产环境需设为False)if__name__=='__main__':​#启动服务器,host=表示允许外部访问,port指定端口​app.run(host='',port=5000,debug=True)​Flask模块Flask模块使用Flask模块fromflaskimportFlaskapp=Flask(__name__)@app.route('/',methods=['GET'])defhello_world():return'Hello,World!'if__name__=='__main__':app.run(debug=True)

Flask是一个server,基本框架如下:Flask中使用@app.route装饰器将一个函数注册为路由,实现URL和视图函数间的映射。注意:@app的名字可以任意路由:就是处理URL和视图函数之间关系的程序。视图函数:主要负责逻辑处理的数据展现和状态展现路由装饰的表现形式为:@app.route("/路由/<变量名>",methods=[])#默认是GET例如:@app.route("/app/video",methods=["GET","DELETE"])以上创建了一个路由:/app/video,当我们访问/app/video时,客户端能发送GET和DELETE请求route装饰器【案例】以下是一个简单的FlaskRESTfulAPI实现,用于接收get请求并返回数据,测试时先运行flask服务脚本,然后使用浏览器输入url地址:5000/api/servers进行测试:fromflaskimportjsonifyfromflaskimportFlask#__name__表示当前模块名称,Flask会根据该参数查找资源路径app=Flask(__name__)@app.route('/api/servers',methods=['GET'])defget_server_status():#模拟查询服务器数据server_data={"cpu_usage":75.2,"memory_usage":60.5,"disk_usage":55.8}#返回JSON响应和200状态码returnjsonify(server_data),200if__name__=='__main__':#启动服务器,host=表示允许外部访问,port指定端口app.run(host='',port=5000,debug=True)Flask模块Flask模块使用案例过渡页3任务实施Flask实现系统状态数据采集与响应服务任务实施本任务旨在基于Flask框架开发一个RESTfulAPI服务,负责采集服务器的CPU、内存和硬盘状态数据,并通过JSON格式响应给客户端。客户端可通过请求参数指定需要获取的系统指标,服务端将根据请求动态返回相应数据。这为后续客户端数据存储(CSV/MySQL)和监控功能提供基础支持。设计思路功能要点

数据采集:使用psutil库实时获取系统CPU使用、内存使用和硬盘空间信息。

API设计:设计简洁的RESTful接口,支持灵活的数据请求方式,动态决定获取哪些数据指标。

数据封装:将采集的数据规范化为JSON格式,包含时间戳和状态信息。

错误处理:处理无效请求和系统异常,返回适当的错误信息API接口设计采用单一参数化端点/api/status/<data_type>,通过路径参数指定需要获取的系统指标:请求方式:GET路径参数:data_type:必选参数,指定需要获取的指标类型,类型:cpu、memory、disk数据模型设计返回的JSON数据结构包含时间戳和具体的数据信息,以内存数据为例,设计如下。/api/status/cpu#获取CPU指标/api/status/memory#获取内存指标/api/status/disk#获取硬盘指标任务实施{"timestamp":"2025-07-2914:30:00","virtual_total_gb":85,"virtual_used_gb":42.6,"virtual_percent":23}2.实现步骤步骤1:环境准备安装flask库:由于flask是第三方库,需先通过pip安装,Windows或者Linux下运行安装命令:pipinstallflask导入依赖模块:系统状态获取需用到psutil模块和获取时间戳,需用到time模块,假设监控代码文件名为server.py,在代码文件开头导入依赖模块。任务实施importflaskimporttimeimportpsutil步骤2:编写数据采集函数defget_memory_info():"""获取并打印内存相关指标"""virtual_mem=psutil.virtual_memory()#物理内存#转换为GB(保留2位小数)virtual_total_gb=round(virtual_mem.total/(1024**3),2)virtual_used_gb=round(virtual_mem.used/(1024**3),2)print(f"[内存]物理内存总容量:{virtual_total_gb}GB,使用率:{virtual_mem.percent}%")memory_info={"timestamp":time.strftime('%Y-%m-%d%H:%M:%S',time.localtime()),"virtual_total_gb":virtual_total_gb,"virtual_used_gb":virtual_used_gb,"virtual_percent":virtual_mem.percent}returnmemory_info任务实施步骤2:编写数据采集函数defget_cpu_info():"""获取并打印CPU相关指标"""#总使用率(间隔1秒采样,确保准确性)total_percent=psutil.cpu_percent(interval=1)#各核心使用率per_core_percent=psutil.cpu_percent(percpu=True)#系统负载(仅Linux有效,Windows返回(0,0,0))load_avg=psutil.getloadavg()ifhasattr(psutil,'getloadavg')else(0,0,0)cpu_info={"timestamp":time.strftime('%Y-%m-%d%H:%M:%S',time.localtime()),"total_percent":total_percent,"per_core_percent":per_core_percent,"load_avg":load_avg}returncpu_info任务实施步骤2:编写数据采集函数defget_disk_info():"""获取并打印磁盘相关指标(存储+I/O)"""#磁盘存储(以根目录为例,Linux/macOS用'/',Windows用'C:\\')disk_usage=psutil.disk_usage('/')#转换为人性化可读格式disk_total_gb=round(disk_usage.total/(1024**3),2)disk_used_gb=round(disk_usage.used/(1024**3),2)disk_info={"timestamp":time.strftime('%Y-%m-%d%H:%M:%S',time.localtime()),"total_gb":disk_total_gb,"used_gb":disk_used_gb,"percent":disk_usage.percent}returndisk_info任务实施步骤3:实现FlaskAPI服务#__name__表示当前模块名称,Flask会根据该参数查找资源路径app=Flask(__name__)@app.route('/api/status/<data_type>',methods=['GET'])defget_server_status(data_type):#URL中的<data_

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论