制作Python Flask项目的Docker镜像及部署

无论是安装一些开源软件，还是对自家项目的部署，更多推荐大家使用Docker的方式，能省去很多的麻烦事。

使用docker部署有很多好处，例如：

构建一次后打包就可以用作测试环境，也可以用作生产环境或与预生产环境，省去了很多测试环节。

可以解决开发人员部署环境的困难。

应用隔离，服务器整合，一个服务器可以用docker部署多套业务，并且隔离性很高。

减少资源的利用，和虚拟机比较省去了很多不必要的资源。

对运维来说，可以快速地进行扩容

每个小的服务都可以进行集群，docker对资源的利用比较小，可以在一台服务器启动多台。

可以多平台部署。

要了解更多有关docker的实战相关，可关注我的Docker实战合集。

下面拿个我在实际项目中使用的方式来介绍，对Python项目如何使用Docker进行打包和部署。实际项目中，我主要使用了如下：

• 将源码打包进docker镜像里，这样更方便进行自动化构建部署，即持续集成，持续部署。
• 使用了gunicorn + gevent方式启动Flask应用，根据CPU的数量启动相应的进程和线程数，以提高单机的并发能力。
• 日志暂时使用loguru进行演示。

整体的目录结构如下：

 [root@drccentosserver02 zll202209]# tree
 .
 └── flask_demo01
     ├── Dockerfile
     └── src
         ├── gunicorn.conf.py
         ├── requirements.txt
         └── server.py
 
 2 directories, 4 files
 [root@drccentosserver02 zll202209]# 

1. 准备个的Flask应用

server.py 如下：

 from flask import Flask, jsonify
 from flask_cors import *
 import os, traceback, time
 from loguru import logger
 
 log_path = f"../logs"
 if not os.path.exists(log_path):
     os.makedirs(log_path)
 t = time.strftime("%Y_%m_%d")
 log_path_file = f"{log_path}/interface_log_{t}.log"
 
 def setup_logging():
     logger.add(log_path_file, rotation="10 MB", retention="90 days", encoding="utf-8", level='INFO', compression="tar.gz")
 
 setup_logging()
 
 app = Flask(__name__)
 app.config['JSON_AS_ASCII'] = False
 CORS(app, supports_cordentials=True)
 
 @app.route('/test', methods=['POST', 'GET'])
 def test():
     try:
         resultObj = {'code': 0, 'message': 'success'}
         return jsonify(resultObj)
     except Exception as e:
         logger.error(f'业务异常:{e.__dict__},traceback={traceback.format_exc()}')
         resultObj = {'code': 1000, 'message': 'Service running exception'}
         return jsonify(resultObj)
 
 if __name__ == '__main__':
     app.run(host='0.0.0.0', port=8080, debug=False)

2. 导出项目依赖requirements.txt

这里更推荐使用2.2的方式，直接导出项目的依赖，这样包会少很多

2.1 导出当前环境依赖包

 导出内容为当前环境所有依赖包及对应版本:
   pip freeze > ./requirements.txt
 安装依赖包：
   pip install -r requirements.txt

2.2 导出项目依赖包

 将路径切换到需要生成依赖的项目的根目录下
 
 pip install pipreqs
 > pipreqs ./
 执行完后，在这个项目下会生成一个requirements.txt文件，里面记录了该项目所用到的依赖
 获得了依赖包，就可以在新环境下安装依赖包的模块：pip install -r requirements.txt
 
 pipreqs ./ --encoding=utf8
 
 如果报错如下：
 (yolov5) PS C:\myself\workGitLab\dining-pos> pipreqs ./
 Traceback (most recent call last):
     ...
     candidates = get_all_imports(input_path,
   File "c:\anaconda3\envs\yolov5\lib\site-packages\pipreqs\pipreqs.py", line 122, in get_all_imports
     contents = f.read()
 UnicodeDecodeError: 'gbk' codec can't decode byte 0x86 in position 92: illegal multibyte sequence
 
 打开：c:\anaconda3\envs\yolov5\lib\site-packages\pipreqs\pipreqs.py
 file_name = os.path.join(root, file_name)
 # with open_func(file_name, "r", encoding=encoding) as f: 将此行的编码改掉即可.
 with open_func(file_name, "r", encoding='utf-8') as f:
   contents = f.read()

3. 项目依赖requirements.txt

这里建议加上Jinja2与Werkzeug的版本，因为不同的Flask依赖不同的Jinjia与Werkzeug版本，导出依赖时，有时导不全，这些都要实际项目过程中不断完善，由于实际项目中Flask不建议直接部署生产环境，这里使用了gunicorn + gevent的方式部署多实例，所以加上了相应依赖。

增加itsdangerous，是因为Flask 1.1.2版本的问题，需要解决ImportError: cannot import name 'json' from 'itsdangerous' 的问题。

以下是准备的 requirements.txt

 Flask==1.1.2
 Flask_Cors==3.0.10
 loguru==0.5.3
 Jinja2==3.0.3
 Werkzeug==1.0.1
 itsdangerous==1.1.0
 gunicorn==20.1.0
 gevent==21.12.0

4. 准备gunicorn.conf.py

 import multiprocessing, os
 # 预加载资源
 preload_app = True
 # 绑定 ip + 端口
 PORT = os.environ.get("PORT")
 bind = f"0.0.0.0:{PORT}"
 # 进程数 = cup数量 * 2 + 1
 workers = multiprocessing.cpu_count() * 2 + 1
 # 线程数 = cup数量 * 2
 threads = multiprocessing.cpu_count() * 2
 # 等待队列最大长度,超过这个长度的链接将被拒绝连接
 backlog = 2048
 # 工作模式--协程
 worker_class = "gevent"
 # 最大客户客户端并发数量,对使用线程和协程的worker的工作有影响
 # 服务器配置设置的值 1200：中小型项目  上万并发： 中大型
 # 服务器硬件：宽带+数据库+内存
 # 服务器的架构：集群 主从
 # worker_connections = 1200
 # 访问记录 记录到标准输出
 accesslog = '-'
 errorlog = '-'

5. 准备Dockerfile

 FROM python:3.8
 LABEL maintainer="xxxxx"
 WORKDIR /opt/demo
 COPY ./src .
 RUN ln -sf /usr/share/zoneinfo/Asia/Shanghai /etc/localtime
 RUN pip install --no-cache-dir -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
 ENV LANG C.UTF-8
 ENV PYTHONUNBUFFERED=1
 CMD ["gunicorn", "-c", "./gunicorn.conf.py", "server:app"]

6. 构建docker镜像

 cd flask_demo01
 docker build -t flask_demo01:1.0 .
 
 构建完成后通过docker images查看，即有构建成功的镜像flask_demo01
 [root@drccentosserver02 flask_demo01]# docker images
 REPOSITORY                                                  TAG                  IMAGE ID       CREATED         SIZE
 flask_demo01                                                1.0                  22982155ee89   5 minutes ago   953MB

7. 运行docker镜像

docker run -e TZ=Asia/Shanghai -d --restart=always \
-p 7777:7777 \
--name my_container_name \
-v /opt/flask_demo/logs:/opt/logs \
-w /opt/flask_demo \
--env PORT=7777 \
--log-opt max-size=10m \
--log-opt max-file=1 \
flask_demo01:1.0

8. 测试请求

[root@drccentosserver02 flask_demo01]# curl -XGET 'http://127.0.0.1:7777/test'
{"code":0,"message":"success"}
[root@drccentosserver02 flask_demo01]# 

9. 其他

查看正在运行的docker容器：docker ps
[root@drccentosserver02 flask_demo01]# docker ps
CONTAINER ID   IMAGE        COMMAND    CREATED    STATUS         PORTS     NAMES
0dccxx   flask_demo01:1.0  "gunicorn -c…" 6..  6.. 0.0.0.0:7777->7777/tcp, :::7777->7777/tcp my_container_name

进入容器：docker exec -it my_container_name /bin/bash
查看进程：top
例如：
top - 17:21:54 up 211 days, 22:45,  0 users,  load average: 0.91, 0.65, 0.55
Tasks:  12 total,   1 running,  11 sleeping,   0 stopped,   0 zombie
%Cpu(s):  2.1 us,  2.9 sy,  0.0 ni, 94.5 id,  0.4 wa,  0.0 hi,  0.0 si,  0.1 st
MiB Mem :   7982.1 total,    153.0 free,   4161.5 used,   3667.7 buff/cache
MiB Swap:      0.0 total,      0.0 free,      0.0 used.   3131.6 avail Mem 
  PID USER      PR  NI    VIRT    RES    SHR S  %CPU  %MEM     TIME+ COMMAND                                                 
   41 root      20   0    8868   1920   1444 R   0.3   0.0   0:00.01 top                                                    
    1 root      20   0   68816  33040   6248 S   0.0   0.4   0:01.19 gunicorn                                                 
    8 root      20   0   72652  30828   2724 S   0.0   0.4   0:00.48 gunicorn                                                 
    9 root      20   0   72664  30952   2808 S   0.0   0.4   0:00.47 gunicorn                                                 
   10 root      20   0   72632  30712   2624 S   0.0   0.4   0:00.47 gunicorn                                                 
   11 root      20   0   72632  30712   2620 S   0.0   0.4   0:00.49 gunicorn                                                 
   12 root      20   0   72632  30720   2628 S   0.0   0.4   0:00.46 gunicorn                                                 
   13 root      20   0   72632  30720   2628 S   0.0   0.4   0:00.47 gunicorn                                                 
   14 root      20   0   72632  30920   2804 S   0.0   0.4   0:00.48 gunicorn                                                 
   15 root      20   0   72632  30712   2620 S   0.0   0.4   0:00.49 gunicorn                                                 
   16 root      20   0   72632  30716   2624 S   0.0   0.4   0:00.50 gunicorn                                                 
   34 root      20   0    5976   2064   1628 S   0.0   0.0   0:00.05 bash 
   
可以看到使用gunicorn+gevent的方式，启动了多个Flask应用

docker问题可关注我的合集：docker实战，如有其他问题，欢迎沟通交流。