fastapi_No.25_获取配置项

news2024/9/22 6:48:01

文章目录

- 方式1：隐藏在环境变量中
- - 配置环境变量
  - - Windows中配置环境变量
    - Linux中配置环境变量
  - 在代码中获取环境变量
- 方式2：隐藏在配置文件中
- - 装包
  - 在代码中获取配置文件内容

在之前的代码中，像数据库连接信息等敏感信息，都直接写在代码中，这种方式是不安全的。本篇文章记录两种FastAPI中隐藏配置信息的方法。

方式1：隐藏在环境变量中

在电脑的环境变量中配置需要隐藏的配置信息。

配置环境变量

Windows中配置环境变量

在这里插入图片描述

Linux中配置环境变量

export DBURL="mysql+pymysql://root:123456@127.0.0.1:3306/testdb"

在代码中获取环境变量

import os
def get_dburl_from_env(key):
    '''
    获取系统环境变量中名为key的变量值，
    当不存在时返回None
    :param key:为变量名
    :return :key对应的value，不存在时返回None
    '''
    value = os.getenv(key,None)
    return value

class NoValueException(Exception):
    pass

if __name__ == "__main__":
    db_url = get_dburl_from_env("DBURL")
    if db_url is None:
        raise NoValueException
    print(db_url)
    test_url = get_dburl_from_env("TEST")
    if test_url is None:
        raise NoValueException
    print(test_url)

在这里插入图片描述

方式2：隐藏在配置文件中

将配置信息存放在配置文件中，通过读取配置文件获取配置信息。
例如：
在这里插入图片描述

装包

安装python-dotenv包。

pip install python-dotenv

在代码中获取配置文件内容

'''
方法2：
将隐私内容存放在本地配置文件中，通过读取配置文件获取隐私配置文件
'''
from functools import lru_cache
from pydantic import BaseSettings
from fastapi import FastAPI,Depends

class Settings(BaseSettings):
    # 类似BaseModel一样，配置各个配置项的内容限制和数据类型
    dburl:str

    class Config:
        # env_file配置文件的路径
        env_file = "./No23_配置/config/.env"
        
app = FastAPI()

@lru_cache
def get_settings():
    # 缓存配置项，避免频繁读取配置文件
    return Settings()

@app.get("/")
def get_home(settings:Settings=Depends(get_settings)):
    return {
        "db_url":settings.dburl
    }


if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app="main-file:app",host="127.0.0.1",port=8080,reload=True)