felix/backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

first commit

Browse Source
This commit is contained in:
felix
2025-10-18 10:54:08 +08:00
commit a35818e359
194 changed files with 20216 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
deploy/dict_cache_preload.md Executable file
View File

@@ -0,0 +1,77 @@
# 字典链接缓存预加载指南
## 概述
由于字典条目数据(dict_entry)很少变动，为了提高系统性能，我们提供了预加载脚本将所有具有ref_link的条目预加载到Redis缓存中。这样可以避免在运行时重复查询数据库，显著提升处理速度。
## 首次部署
在首次部署系统时，建议运行预加载脚本来初始化Redis缓存：
### Linux/macOS 系统
```bash
# 进入项目根目录
cd /path/to/project
# 运行预加载脚本
./deploy/preload_dict_cache.sh
```
### Windows 系统
```cmd
# 进入项目根目录
cd \path\to\project
# 运行预加载脚本
deploy\preload_dict_cache.bat
```
## 手动运行预加载脚本
您也可以直接使用Python运行预加载脚本：
```bash
# 进入项目根目录
cd /path/to/project
# 查看帮助信息
python backend/utils/preload_dict_links.py --help
# 预加载所有链接关系（默认会清除现有缓存）
python backend/utils/preload_dict_links.py preload
# 预加载所有链接关系（不清除现有缓存）
python backend/utils/preload_dict_links.py preload --no-clear
# 清除所有链接缓存
python backend/utils/preload_dict_links.py clear
# 显示缓存统计信息
python backend/utils/preload_dict_links.py stats
```
## 参数说明
- `--batch-size`: 每批处理的条目数量，默认为1000
- `--no-clear`: 预加载时不清除现有缓存
## 定期维护
虽然字典数据很少变动，但建议定期运行预加载脚本以确保缓存数据与数据库保持同步：
```bash
# 每周日凌晨2点运行预加载
0 2 * * 0 cd /path/to/project && ./deploy/preload_dict_cache.sh
```
## 性能监控
您可以使用以下命令查看缓存统计信息：
```bash
python backend/utils/preload_dict_links.py stats
```
这将显示当前缓存中的条目数量，帮助您监控缓存使用情况。

14
deploy/docker-compose/.env.server Executable file
View File

@@ -0,0 +1,14 @@
# Env: dev、pro
ENVIRONMENT='dev'
# MySQL
DATABASE_HOST='fsm_mysql'
DATABASE_PORT=3306
DATABASE_USER='root'
DATABASE_PASSWORD='123456'
# Redis
REDIS_HOST='fsm_redis'
REDIS_PORT=6379
REDIS_PASSWORD=''
REDIS_DATABASE=0
# Token
TOKEN_SECRET_KEY='1VkVF75nsNABBjK_7-qz7GtzNy3AMvktc9TCPwKczCk'

86
deploy/docker-compose/docker-compose.yml Executable file
View File

@@ -0,0 +1,86 @@
services:
fsm_server:
build:
context: ../../
dockerfile: Dockerfile
image: fsm_server:latest
container_name: fsm_server
restart: always
depends_on:
- fsm_mysql
- fsm_redis
volumes:
- fsm_static:/fsm/backend/static
networks:
- fsm_network
command:
- bash
- -c
- |
wait-for-it -s fsm_mysql:3306 -s fsm_redis:6379 -t 300
supervisord -c /etc/supervisor/supervisord.conf
supervisorctl restart
fsm_mysql:
image: mysql:8.0.29
ports:
- "3306:3306"
container_name: fsm_mysql
restart: always
environment:
MYSQL_DATABASE: fsm
MYSQL_ROOT_PASSWORD: 123456
TZ: Asia/Shanghai
volumes:
- fsm_mysql:/var/lib/mysql
networks:
- fsm_network
command:
--default-authentication-plugin=mysql_native_password
--character-set-server=utf8mb4
--collation-server=utf8mb4_general_ci
--lower_case_table_names=1
fsm_redis:
image: redis:6.2.7
ports:
- "6379:6379"
container_name: fsm_redis
restart: always
environment:
- TZ=Asia/Shanghai
volumes:
- fsm_redis:/var/lib/redis
networks:
- fsm_network
fsm_nginx:
image: nginx:stable
ports:
- "8000:80"
container_name: fsm_nginx
restart: always
depends_on:
- fsm_server
volumes:
- ../nginx.conf:/etc/nginx/conf.d/default.conf:ro
- fsm_static:/www/fsm_server/backend/static
networks:
- fsm_network
networks:
fsm_network:
name: fsm_network
driver: bridge
ipam:
driver: default
config:
- subnet: 172.10.10.0/24
volumes:
fsm_mysql:
name: fsm_mysql
fsm_redis:
name: fsm_redis
fsm_static:
name: fsm_static

9
deploy/fastapi_server.conf Executable file
View File

@@ -0,0 +1,9 @@
[program:fastapi_server]
directory=/fsm
command=/usr/local/bin/gunicorn -c /fsm/deploy/gunicorn.conf.py main:app
user=root
autostart=true
autorestart=true
startretries=5
redirect_stderr=true
stdout_logfile=/var/log/fastapi_server/fsm_server.log

44
deploy/gunicorn.conf.py Executable file
View File

@@ -0,0 +1,44 @@
# fmt: off
# 监听内网端口
bind = '0.0.0.0:8001'
# 工作目录
chdir = '/fsm/backend/'
# 并行工作进程数
workers = 1
# 监听队列
backlog = 512
# 超时时间
timeout = 120
# 设置守护进程,将进程交给 supervisor 管理；如果设置为 True 时，supervisor 启动日志为：
# gave up: fastapi_server entered FATAL state, too many start retries too quickly
# 则需要将此改为: False
daemon = False
# 工作模式协程
worker_class = 'uvicorn.workers.UvicornWorker'
# 设置最大并发量
worker_connections = 2000
# 设置进程文件目录
pidfile = '/fsm/gunicorn.pid'
# 设置访问日志和错误信息日志路径
accesslog = '/var/log/fastapi_server/gunicorn_access.log'
errorlog = '/var/log/fastapi_server/gunicorn_error.log'
# 设置这个值为true 才会把打印信息记录到错误日志里
capture_output = True
# 设置日志记录水平
loglevel = 'debug'
# python程序
pythonpath = '/usr/local/lib/python3.10/site-packages'
# 启动 gunicorn -c gunicorn.conf.py main:app

33
deploy/nginx.conf Executable file
View File

@@ -0,0 +1,33 @@
server {
listen 80 default_server;
listen [::]:80 default_server;
server_name 127.0.0.1;
root /fsm;
client_max_body_size 5M;
client_body_buffer_size 5M;
gzip on;
gzip_comp_level 2;
gzip_types text/plain text/css text/javascript application/javascript application/x-javascript application/xml application/x-httpd-php image/jpeg image/gif image/png;
gzip_vary on;
keepalive_timeout 300;
location / {
proxy_pass http://fsm_server:8001;
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_connect_timeout 300s;
proxy_send_timeout 300s;
proxy_read_timeout 300s;
}
location /static {
alias /www/fsm_server/backend/static;
}
}

36
deploy/preload_dict_cache.bat Executable file
View File

@@ -0,0 +1,36 @@
@echo off
REM 首次部署时预加载字典链接缓存的脚本 (Windows版本)
REM 该脚本应在应用启动前运行
echo 开始预加载字典链接缓存...
REM 检查是否在正确的目录
if not exist "backend\utils\preload_dict_links.py" (
echo 错误: 请在项目根目录运行此脚本
exit /b 1
)
REM 激活虚拟环境（如果存在）
if exist "venv\Scripts\activate.bat" (
call venv\Scripts\activate.bat
echo 已激活虚拟环境
) else if exist ".venv\Scripts\activate.bat" (
call .venv\Scripts\activate.bat
echo 已激活虚拟环境
)
REM 运行预加载脚本
echo 正在运行预加载脚本...
python backend/utils/preload_dict_links.py preload --batch-size 2000
if %errorlevel% neq 0 (
echo 预加载脚本执行失败
exit /b %errorlevel%
)
echo 字典链接缓存预加载完成!
echo 显示缓存统计信息:
python backend/utils/preload_dict_links.py stats
echo 部署预加载完成!

34
deploy/preload_dict_cache.sh Executable file
View File

@@ -0,0 +1,34 @@
#!/bin/bash
# 首次部署时预加载字典链接缓存的脚本
# 该脚本应在应用启动前运行
set -e # 遇到错误时退出
echo "开始预加载字典链接缓存..."
# 检查是否在正确的目录
if [ ! -f "backend/utils/preload_dict_links.py" ]; then
echo "错误: 请在项目根目录运行此脚本"
exit 1
fi
# 激活虚拟环境（如果存在）
if [ -f "venv/bin/activate" ]; then
source venv/bin/activate
echo "已激活虚拟环境"
elif [ -f ".venv/bin/activate" ]; then
source .venv/bin/activate
echo "已激活虚拟环境"
fi
# 运行预加载脚本
echo "正在运行预加载脚本..."
python backend/utils/preload_dict_links.py preload --batch-size 2000
echo "字典链接缓存预加载完成!"
echo "显示缓存统计信息:"
python backend/utils/preload_dict_links.py stats
echo "部署预加载完成!"

155
deploy/supervisor.conf Executable file
View File

@@ -0,0 +1,155 @@
; Sample supervisor config file.
;
; For more information on the config file, please see:
; http://supervisord.org/configuration.html
;
; Notes:
; - Shell expansion ("~" or "$HOME") is not supported. Environment
; variables can be expanded using this syntax: "%(ENV_HOME)s".
; - Quotes around values are not supported, except in the case of
; the environment= options as shown below.
; - Comments must have a leading space: "a=b ;comment" not "a=b;comment".
; - Command will be truncated if it looks like a config file comment, e.g.
; "command=bash -c 'foo ; bar'" will truncate to "command=bash -c 'foo ".
;
; Warning:
; Paths throughout this example file use /tmp because it is available on most
; systems. You will likely need to change these to locations more appropriate
; for your system. Some systems periodically delete older files in /tmp.
; Notably, if the socket file defined in the [unix_http_server] section below
; is deleted, supervisorctl will be unable to connect to supervisord.
[unix_http_server]
file=/tmp/supervisor.sock ; the path to the socket file
;chmod=0700 ; socket file mode (default 0700)
;chown=nobody:nogroup ; socket file uid:gid owner
;username=user ; default is no username (open server)
;password=123 ; default is no password (open server)
; Security Warning:
; The inet HTTP server is not enabled by default. The inet HTTP server is
; enabled by uncommenting the [inet_http_server] section below. The inet
; HTTP server is intended for use within a trusted environment only. It
; should only be bound to localhost or only accessible from within an
; isolated, trusted network. The inet HTTP server does not support any
; form of encryption. The inet HTTP server does not use authentication
; by default (see the username= and password= options to add authentication).
; Never expose the inet HTTP server to the public internet.
;[inet_http_server] ; inet (TCP) server disabled by default
;port=127.0.0.1:9001 ; ip_address:port specifier, *:port for all iface
;username=user ; default is no username (open server)
;password=123 ; default is no password (open server)
[supervisord]
logfile=/var/log/supervisor/supervisord.log ; main log file; default $CWD/supervisord.log
logfile_maxbytes=50MB ; max main logfile bytes b4 rotation; default 50MB
logfile_backups=10 ; # of main logfile backups; 0 means none, default 10
loglevel=info ; log level; default info; others: debug,warn,trace
pidfile=/tmp/supervisord.pid ; supervisord pidfile; default supervisord.pid
nodaemon=true ; start in foreground if true; default false
silent=false ; no logs to stdout if true; default false
minfds=1024 ; min. avail startup file descriptors; default 1024
minprocs=200 ; min. avail process descriptors;default 200
;umask=022 ; process file creation umask; default 022
user=root ; setuid to this UNIX account at startup; recommended if root
;identifier=supervisor ; supervisord identifier, default is 'supervisor'
;directory=/tmp ; default is not to cd during start
;nocleanup=true ; don't clean up tempfiles at start; default false
;childlogdir=/tmp ; 'AUTO' child log dir, default $TEMP
;environment=KEY="value" ; key value pairs to add to environment
;strip_ansi=false ; strip ansi escape codes in logs; def. false
; The rpcinterface:supervisor section must remain in the config file for
; RPC (supervisorctl/web interface) to work. Additional interfaces may be
; added by defining them in separate [rpcinterface:x] sections.
[rpcinterface:supervisor]
supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
; The supervisorctl section configures how supervisorctl will connect to
; supervisord. configure it match the settings in either the unix_http_server
; or inet_http_server section.
[supervisorctl]
serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL for a unix socket
;serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
;username=chris ; should be same as in [*_http_server] if set
;password=123 ; should be same as in [*_http_server] if set
;prompt=mysupervisor ; cmd line prompt (default "supervisor")
;history_file=~/.sc_history ; use readline history if available
; The sample program section below shows all possible program subsection values.
; Create one or more 'real' program: sections to be able to control them under
; supervisor.
;[program:theprogramname]
;command=/bin/cat ; the program (relative uses PATH, can take args)
;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
;numprocs=1 ; number of processes copies to start (def 1)
;directory=/tmp ; directory to cwd to before exec (def no cwd)
;umask=022 ; umask for process (default None)
;priority=999 ; the relative start priority (default 999)
;autostart=true ; start at supervisord start (default: true)
;startsecs=1 ; # of secs prog must stay up to be running (def. 1)
;startretries=3 ; max # of serial start failures when starting (default 3)
;autorestart=unexpected ; when to restart if exited after running (def: unexpected)
;exitcodes=0 ; 'expected' exit codes used with autorestart (default 0)
;stopsignal=QUIT ; signal used to kill process (default TERM)
;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false ; send stop signal to the UNIX process group (default false)
;killasgroup=false ; SIGKILL the UNIX process group (def false)
;user=root ; setuid to this UNIX account to run the program
;redirect_stderr=true ; redirect proc stderr to stdout (default false)
;stdout_logfile=/a/path ; stdout log path, NONE for none; default AUTO
;stdout_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB)
;stdout_logfile_backups=10 ; # of stdout logfile backups (0 means none, default 10)
;stdout_capture_maxbytes=1MB ; number of bytes in 'capturemode' (default 0)
;stdout_events_enabled=false ; emit events on stdout writes (default false)
;stdout_syslog=false ; send stdout to syslog with process name (default false)
;stderr_logfile=/a/path ; stderr log path, NONE for none; default AUTO
;stderr_logfile_maxbytes=1MB ; max # logfile bytes b4 rotation (default 50MB)
;stderr_logfile_backups=10 ; # of stderr logfile backups (0 means none, default 10)
;stderr_capture_maxbytes=1MB ; number of bytes in 'capturemode' (default 0)
;stderr_events_enabled=false ; emit events on stderr writes (default false)
;stderr_syslog=false ; send stderr to syslog with process name (default false)
;environment=A="1",B="2" ; process environment additions (def no adds)
;serverurl=AUTO ; override serverurl computation (childutils)
; The sample eventlistener section below shows all possible eventlistener
; subsection values. Create one or more 'real' eventlistener: sections to be
; able to handle event notifications sent by supervisord.
;[eventlistener:theeventlistenername]
;command=/bin/eventlistener ; the program (relative uses PATH, can take args)
;process_name=%(program_name)s ; process_name expr (default %(program_name)s)
;numprocs=1 ; number of processes copies to start (def 1)
;events=EVENT ; event notif. types to subscribe to (req'd)
;buffer_size=10 ; event buffer queue size (default 10)
;directory=/tmp ; directory to cwd to before exec (def no cwd)
;umask=022 ; umask for process (default None)
;priority=-1 ; the relative start priority (default -1)
;autostart=true ; start at supervisord start (default: true)
;startsecs=1 ; # of secs prog must stay up to be running (def. 1)
;startretries=3 ; max # of serial start failures when starting (default 3)
;autorestart=unexpected ; autorestart if exited after running (def: unexpected)
;exitcodes=0 ; 'expected' exit codes used with autorestart (default 0)
;stopsignal=QUIT ; signal used to kill process (default TERM)
;stopwaitsecs=10 ; max num secs to wait b4 SIGKILL (default 10)
;stopasgroup=false ; send stop signal to the UNIX process group (default false)
;killasgroup=false ; SIGKILL the UNIX process group (def false)
;user=chrism ; setuid to this UNIX account to run the program
;redirect_stderr=false ; redirect_stderr=true is not allowed for eventlisteners
;[group:thegroupname]
;programs=progname1,progname2 ; each refers to 'x' in [program:x] definitions
;priority=999 ; the relative start priority (default 999)
; The [include] section can just contain the "files" setting. This
; setting can list multiple files (separated by whitespace or
; newlines). It can also contain wildcards. The filenames are
; interpreted as relative to this file. Included files *cannot*
; include files themselves.
[include]
files = /etc/supervisor/conf.d/*.conf