利用配置文件的编程思想



我们现在要设计一个程序，让我们能通过发送邮件、短信、微信的形式给别人发送消息

我们以前的写法是先定义一个notify.py文件



def email():
    pass

def msg():
    pass

def wechat():
    pass



在这个文件中定义好三种方法，然后在执行文件中引入他们并使用



from 原来的你 import notify def run(): notify.email() notify.msg() notify.wechat() if __name__ == '__main__': run()



这样的方法能实现目标，但是如果我们不想用邮件发送了，那就需要到每一个使用到的地方去删除邮件发送的方法，很麻烦

所以现在的我们使用配置文件settings



NOTIFY_LIST = [
    'notify.email.Email',
    # 'notify.msg.Msg',
    'notify.wechat.Wechat',
]



notify包中我们定义各种方法

RestHighLevelClient配置用户名密码 reshade怎么用配置文件_python

每一个方法都是一个文件中放一个类

在使用时，我们直接导入这个notify包



from notify import send_xxxx
def run():
    send_xxxx('报警')

if __name__ == '__main__':
    pass



那么这个send_xxxx方法从哪里来的呢，我们知道导入一个包时其实会执行这个包的__init__文件，所以我们看看这个文件中做了什么



import settings
import importlib

def send_xxxx(content):
    for path in settings.NOTIFY_LIST:
        # 'notify.email.Email',
        # 'notify.msg.Msg',
        # 'notify.wechat.Wechat'
        module_path,class_name = path.rsplit('.',maxsplit=1)
        # importlib.import_module("notify.email")
        # 根据字符串导入模块：notify.email
        module = importlib.import_module(module_path)
        # 根据类名称去模块中获取类
        cls = getattr(module,class_name)
        # 根据类实例化
        obj = cls()
        obj.send(content)



在这个文件中，我们首先导入配置文件，然后定义了一个send_xxx方法，在这个方法中我们循环配置文件中我们定义的NOTIFY_LIST列表，得到一个个字符串，然后通过importlib.import_module方法通过字符串导入模块，再通过反射获得模块中的类，最后实例化这个类

并执行send方法，这样我们就可以通过修改配置文件来决定我们的发送方式，而不需要去修改我们的代码逻辑，如果想添加方法只要在notify包中增加模块，并在配置文件中添加即可



谈谈你对rest api 的认识

rest是面向资源的一种规范

  • API与用户的通信协议，总是使用HTTPs协议。
  • 域名 
  • https://api.example.com                         尽量将API部署在专用域名（会存在跨域问题）
  • https://example.org/api/                        API很简单
  • 版本
  • URL，如：https://api.example.com/v1/
  • 请求头                                                  跨域时，引发发送多次请求
  • 路径，视网络上任何东西都是资源，均使用名词表示（可复数）
  • method
  • GET      ：从服务器取出资源（一项或多项）
  • POST    ：在服务器新建一个资源
  • PUT      ：在服务器更新资源（客户端提供改变后的完整资源）
  • PATCH  ：在服务器更新资源（客户端提供改变的属性）
  • DELETE ：从服务器删除资源
  • 过滤，通过在url上传参的形式传递搜索条件
  • https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
  • https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
  • https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
  • https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
  • https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件
  • 状态码 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
  • 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
  • 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
  • 204 NO CONTENT - [DELETE]：用户删除数据成功。
  • 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
  • 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
  • 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
  • 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
  • 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
  • 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
  • 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
  • 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
  • 错误处理，状态码是4xx时，应返回错误信息，error当做key。
{              
                              error:                "Invalid API key"              
               }

  • 返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范。
GET                /               collection：返回资源对象的列表（数组）              
               GET                /               collection               /               resource：返回单个资源对象              
               POST                /               collection：返回新生成的资源对象              
               PUT                /               collection               /               resource：返回完整的资源对象              
               PATCH                /               collection               /               resource：返回完整的资源对象              
               DELETE                /               collection               /               resource：返回一个空文档

  • Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。
{               "link"               : {              
                              "rel"               :                  "collection https://www.example.com/zoos"               ,              
                              "href"               :                 "https://api.example.com/zoos"               ,              
                              "title"               :                "List of zoos"               ,              
                              "type"               :                 "application/vnd.yourformat+json"              
               }}