Skip to content

Commit 2e21a96

Browse files
insistenceinsistence
committed
feat: 新增不同运行环境配置文件，支持指定配置文件运行应用 #I91AE9 #3 
1 parent 402ad06 commit 2e21a96

File tree

18 files changed

+378
-56
lines changed

18 files changed

+378
-56
lines changed

‎dash-fastapi-backend/.env.dev‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# -------- 应用配置 --------
2+
# 应用运行环境
3+
APP_ENV = 'dev'
4+
# 应用名称
5+
APP_NAME = 'Dash-FasAPI-Admin'
6+
# 应用代理路径
7+
APP_ROOT_PATH = ''
8+
# 应用主机
9+
APP_HOST = '0.0.0.0'
10+
# 应用端口
11+
APP_PORT = 9099
12+
# 应用版本
13+
APP_VERSION= '1.2.0'
14+
# 应用是否开启热重载
15+
APP_RELOAD = true
16+
17+
# -------- Jwt配置 --------
18+
# Jwt秘钥
19+
JWT_SECRET_KEY = 'b01c66dc2c58dc6a0aabfe2144256be36226de378bf87f72c0c795dda67f4d55'
20+
# Jwt算法
21+
JWT_ALGORITHM = 'HS256'
22+
# 令牌过期时间
23+
JWT_EXPIRE_MINUTES = 1440
24+
# redis中令牌过期时间
25+
JWT_REDIS_EXPIRE_MINUTES = 30
26+
27+
28+
# -------- 数据库配置 --------
29+
# 数据库主机
30+
DB_HOST = '127.0.0.1'
31+
# 数据库端口
32+
DB_PORT = 3306
33+
# 数据库用户名
34+
DB_USERNAME = 'root'
35+
# 数据库密码
36+
DB_PASSWORD = 'mysqlroot'
37+
# 数据库名称
38+
DB_DATABASE = 'dash-fastapi'
39+
40+
# -------- Redis配置 --------
41+
# Redis主机
42+
REDIS_HOST = '127.0.0.1'
43+
# Redis端口
44+
REDIS_PORT = 6379
45+
# Redis用户名
46+
REDIS_USERNAME = ''
47+
# Redis密码
48+
REDIS_PASSWORD = ''
49+
# Redis数据库
50+
REDIS_DATABASE = 2

‎dash-fastapi-backend/.env.prod‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# -------- 应用配置 --------
2+
# 应用运行环境
3+
APP_ENV = 'prod'
4+
# 应用名称
5+
APP_NAME = 'Dash-FasAPI'
6+
# 应用代理路径
7+
APP_ROOT_PATH = '/prod-api'
8+
# 应用主机
9+
APP_HOST = '0.0.0.0'
10+
# 应用端口
11+
APP_PORT = 9099
12+
# 应用版本
13+
APP_VERSION= '1.2.0'
14+
# 应用是否开启热重载
15+
APP_RELOAD = false
16+
17+
# -------- Jwt配置 --------
18+
# Jwt秘钥
19+
JWT_SECRET_KEY = 'b01c66dc2c58dc6a0aabfe2144256be36226de378bf87f72c0c795dda67f4d55'
20+
# Jwt算法
21+
JWT_ALGORITHM = 'HS256'
22+
# 令牌过期时间
23+
JWT_EXPIRE_MINUTES = 1440
24+
# redis中令牌过期时间
25+
JWT_REDIS_EXPIRE_MINUTES = 30
26+
27+
28+
# -------- 数据库配置 --------
29+
# 数据库主机
30+
DB_HOST = '127.0.0.1'
31+
# 数据库端口
32+
DB_PORT = 3306
33+
# 数据库用户名
34+
DB_USERNAME = 'root'
35+
# 数据库密码
36+
DB_PASSWORD = 'mysqlroot'
37+
# 数据库名称
38+
DB_DATABASE = 'dash-fastapi'
39+
40+
# -------- Redis配置 --------
41+
# Redis主机
42+
REDIS_HOST = '127.0.0.1'
43+
# Redis端口
44+
REDIS_PORT = 6379
45+
# Redis用户名
46+
REDIS_USERNAME = ''
47+
# Redis密码
48+
REDIS_PASSWORD = ''
49+
# Redis数据库
50+
REDIS_DATABASE = 2

‎dash-fastapi-backend/app.py‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
from module_admin.controller.server_controller import serverController
1919
from module_admin.controller.cache_controller import cacheController
2020
from module_admin.controller.common_controller import commonController
21+
from config.env import AppConfig
2122
from config.get_redis import RedisUtil
2223
from config.get_db import init_create_table
2324
from config.get_scheduler import SchedulerUtil
@@ -26,9 +27,10 @@
2627
from utils.common_util import worship
2728

2829
app = FastAPI(
29-
title='Dash-FastAPI',
30-
description='Dash-FastAPI接口文档',
31-
version='1.0.0',
30+
title=AppConfig.app_name,
31+
description=f'{AppConfig.app_name}接口文档',
32+
version=AppConfig.app_version,
33+
root_path=AppConfig.app_root_path,
3234
)
3335

3436
# 前端页面url
@@ -49,14 +51,14 @@
4951

5052
@app.on_event("startup")
5153
async def startup_event():
52-
logger.info("Dash-FastAPI开始启动")
54+
logger.info(f"{AppConfig.app_name}开始启动")
5355
worship()
5456
await init_create_table()
5557
app.state.redis = await RedisUtil.create_redis_pool()
5658
await RedisUtil.init_sys_dict(app.state.redis)
5759
await RedisUtil.init_sys_config(app.state.redis)
5860
await SchedulerUtil.init_system_scheduler()
59-
logger.info("Dash-FastAPI启动成功")
61+
logger.info(f"{AppConfig.app_name}启动成功")
6062

6163

6264
@app.on_event("shutdown")
@@ -103,4 +105,9 @@ async def http_exception_handler(request: Request, exc: HTTPException):
103105
app.include_router(commonController, prefix="/common", tags=['通用模块'])
104106

105107
if __name__ == '__main__':
106-
uvicorn.run(app='app:app', host="0.0.0.0", port=9099, reload=True)
108+
uvicorn.run(
109+
app='app:app',
110+
host=AppConfig.app_host,
111+
port=AppConfig.app_port,
112+
reload=AppConfig.app_reload
113+
)

‎dash-fastapi-backend/config/database.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
from urllib.parse import quote_plus
55
from config.env import DataBaseConfig
66

7-
SQLALCHEMY_DATABASE_URL = f"mysql+pymysql://{DataBaseConfig.USERNAME}:{quote_plus(DataBaseConfig.PASSWORD)}@" \
8-
f"{DataBaseConfig.HOST}:{DataBaseConfig.PORT}/{DataBaseConfig.DB}"
7+
SQLALCHEMY_DATABASE_URL = f"mysql+pymysql://{DataBaseConfig.db_username}:{quote_plus(DataBaseConfig.db_password)}@" \
8+
f"{DataBaseConfig.db_host}:{DataBaseConfig.db_port}/{DataBaseConfig.db_database}"
99

1010
engine = create_engine(
1111
SQLALCHEMY_DATABASE_URL, echo=True

‎dash-fastapi-backend/config/env.py‎

Lines changed: 114 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,54 @@
11
import os
2+
import sys
3+
import argparse
4+
from pydantic import BaseSettings
5+
from functools import lru_cache
6+
from dotenv import load_dotenv
27

38

4-
class JwtConfig:
9+
class AppSettings(BaseSettings):
10+
"""
11+
应用配置
12+
"""
13+
app_env: str = 'dev'
14+
app_name: str = 'RuoYi-FasAPI'
15+
app_root_path: str = '/dev-api'
16+
app_host: str = '0.0.0.0'
17+
app_port: int = 9099
18+
app_version: str = '1.0.0'
19+
app_reload: bool = True
20+
21+
22+
class JwtSettings(BaseSettings):
523
"""
624
Jwt配置
725
"""
8-
SECRET_KEY = "b01c66dc2c58dc6a0aabfe2144256be36226de378bf87f72c0c795dda67f4d55"
9-
ALGORITHM = "HS256"
10-
ACCESS_TOKEN_EXPIRE_MINUTES = 1440
11-
REDIS_TOKEN_EXPIRE_MINUTES = 30
26+
jwt_secret_key: str = 'b01c66dc2c58dc6a0aabfe2144256be36226de378bf87f72c0c795dda67f4d55'
27+
jwt_algorithm: str = 'HS256'
28+
jwt_expire_minutes: int = 1440
29+
jwt_redis_expire_minutes: int = 30
1230

1331

14-
class DataBaseConfig:
32+
class DataBaseSettings(BaseSettings):
1533
"""
1634
数据库配置
1735
"""
18-
HOST = "127.0.0.1"
19-
PORT = 3306
20-
USERNAME = 'root'
21-
PASSWORD = 'mysqlroot'
22-
DB = 'dash-fastapi'
36+
db_host: str = '127.0.0.1'
37+
db_port: int = 3306
38+
db_username: str = 'root'
39+
db_password: str = 'mysqlroot'
40+
db_database: str = 'ruoyi-fastapi'
2341

2442

25-
class RedisConfig:
43+
class RedisSettings(BaseSettings):
2644
"""
2745
Redis配置
2846
"""
29-
HOST = "127.0.0.1"
30-
PORT = 6379
31-
USERNAME = ''
32-
PASSWORD = ''
33-
DB = 2
47+
redis_host: str = '127.0.0.1'
48+
redis_port: int = 6379
49+
redis_username: str = ''
50+
redis_password: str = ''
51+
redis_database: int = 2
3452

3553

3654
class CachePathConfig:
@@ -52,3 +70,82 @@ class RedisInitKeyConfig:
5270
ACCOUNT_LOCK = {'key': 'account_lock', 'remark': '用户锁定'}
5371
PASSWORD_ERROR_COUNT = {'key': 'password_error_count', 'remark': '密码错误次数'}
5472
SMS_CODE = {'key': 'sms_code', 'remark': '短信验证码'}
73+
74+
75+
class GetConfig:
76+
"""
77+
获取配置
78+
"""
79+
80+
def __init__(self):
81+
self.parse_cli_args()
82+
83+
@lru_cache()
84+
def get_app_config(self):
85+
"""
86+
获取应用配置
87+
"""
88+
# 实例化应用配置模型
89+
return AppSettings()
90+
91+
@lru_cache()
92+
def get_jwt_config(self):
93+
"""
94+
获取Jwt配置
95+
"""
96+
# 实例化Jwt配置模型
97+
return JwtSettings()
98+
99+
@lru_cache()
100+
def get_database_config(self):
101+
"""
102+
获取数据库配置
103+
"""
104+
# 实例化数据库配置模型
105+
return DataBaseSettings()
106+
107+
@lru_cache()
108+
def get_redis_config(self):
109+
"""
110+
获取Redis配置
111+
"""
112+
# 实例化Redis配置模型
113+
return RedisSettings()
114+
115+
@staticmethod
116+
def parse_cli_args():
117+
"""
118+
解析命令行参数
119+
"""
120+
if 'uvicorn' in sys.argv[0]:
121+
# 使用uvicorn启动时，命令行参数需要按照uvicorn的文档进行配置，无法自定义参数
122+
pass
123+
else:
124+
# 使用argparse定义命令行参数
125+
parser = argparse.ArgumentParser(description='命令行参数')
126+
parser.add_argument('--env', type=str, default='', help='运行环境')
127+
# 解析命令行参数
128+
args = parser.parse_args()
129+
# 设置环境变量，如果未设置命令行参数，默认APP_ENV为dev
130+
os.environ['APP_ENV'] = args.env if args.env else 'dev'
131+
# 读取运行环境
132+
run_env = os.environ.get('APP_ENV', '')
133+
# 运行环境未指定时默认加载.env.dev
134+
env_file = '.env.dev'
135+
# 运行环境不为空时按命令行参数加载对应.env文件
136+
if run_env != '':
137+
env_file = f'.env.{run_env}'
138+
# 加载配置
139+
load_dotenv(env_file)
140+
141+
142+
# 实例化获取配置类
143+
get_config = GetConfig()
144+
# 应用配置
145+
AppConfig = get_config.get_app_config()
146+
# Jwt配置
147+
JwtConfig = get_config.get_jwt_config()
148+
# 数据库配置
149+
DataBaseConfig = get_config.get_database_config()
150+
# Redis配置
151+
RedisConfig = get_config.get_redis_config()

‎dash-fastapi-backend/config/get_redis.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ async def create_redis_pool(cls) -> aioredis.Redis:
2020
"""
2121
logger.info("开始连接redis...")
2222
redis = await aioredis.from_url(
23-
url=f"redis://{RedisConfig.HOST}",
24-
port=RedisConfig.PORT,
25-
username=RedisConfig.USERNAME,
26-
password=RedisConfig.PASSWORD,
27-
db=RedisConfig.DB,
23+
url=f"redis://{RedisConfig.redis_host}",
24+
port=RedisConfig.redis_port,
25+
username=RedisConfig.redis_username,
26+
password=RedisConfig.redis_password,
27+
db=RedisConfig.redis_database,
2828
encoding="utf-8",
2929
decode_responses=True
3030
)

‎dash-fastapi-backend/config/get_scheduler.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,11 @@ def __find_recent_workday(cls, day):
7070
'sqlalchemy': SQLAlchemyJobStore(url=SQLALCHEMY_DATABASE_URL, engine=engine),
7171
'redis': RedisJobStore(
7272
**dict(
73-
host=RedisConfig.HOST,
74-
port=RedisConfig.PORT,
75-
username=RedisConfig.USERNAME,
76-
password=RedisConfig.PASSWORD,
77-
db=RedisConfig.DB
73+
host=RedisConfig.redis_host,
74+
port=RedisConfig.redis_port,
75+
username=RedisConfig.redis_username,
76+
password=RedisConfig.redis_password,
77+
db=RedisConfig.redis_database
7878
)
7979
)
8080
}

‎dash-fastapi-backend/module_admin/controller/login_controller.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ async def login(request: Request, form_data: CustomOAuth2PasswordRequestForm = D
3232
except LoginException as e:
3333
return response_400(data="", message=e.message)
3434
try:
35-
access_token_expires = timedelta(minutes=JwtConfig.ACCESS_TOKEN_EXPIRE_MINUTES)
35+
access_token_expires = timedelta(minutes=JwtConfig.jwt_expire_minutes)
3636
session_id = str(uuid.uuid4())
3737
access_token = create_access_token(
3838
data={
@@ -45,10 +45,10 @@ async def login(request: Request, form_data: CustomOAuth2PasswordRequestForm = D
4545
expires_delta=access_token_expires
4646
)
4747
await request.app.state.redis.set(f"{RedisInitKeyConfig.ACCESS_TOKEN.get('key')}:{session_id}", access_token,
48-
ex=timedelta(minutes=JwtConfig.REDIS_TOKEN_EXPIRE_MINUTES))
48+
ex=timedelta(minutes=JwtConfig.jwt_redis_expire_minutes))
4949
# 此方法可实现同一账号同一时间只能登录一次
5050
# await request.app.state.redis.set(f"{RedisInitKeyConfig.ACCESS_TOKEN.get('key')}:{result[0].user_id}", access_token,
51-
# ex=timedelta(minutes=JwtConfig.REDIS_TOKEN_EXPIRE_MINUTES))
51+
# ex=timedelta(minutes=JwtConfig.jwt_redis_expire_minutes))
5252
logger.info('登录成功')
5353
# 判断请求是否来自于api文档，如果是返回指定格式的结果，用于修复api文档认证成功后token显示undefined的bug
5454
request_from_swagger = request.headers.get('referer').endswith('docs') if request.headers.get('referer') else False
@@ -107,7 +107,7 @@ async def get_login_user_info(request: Request, current_user: CurrentUserInfoSer
107107
@loginController.post("/logout", dependencies=[Depends(get_current_user), Depends(CheckUserInterfaceAuth('common'))])
108108
async def logout(request: Request, token: Optional[str] = Depends(oauth2_scheme), query_db: Session = Depends(get_db)):
109109
try:
110-
payload = jwt.decode(token, JwtConfig.SECRET_KEY, algorithms=[JwtConfig.ALGORITHM])
110+
payload = jwt.decode(token, JwtConfig.jwt_secret_key, algorithms=[JwtConfig.jwt_algorithm])
111111
session_id: str = payload.get("session_id")
112112
await logout_services(request, session_id)
113113
logger.info('退出成功')

0 commit comments

Comments
 (0)