使用容器进行开发

预计阅读时间:8分钟

先决条件

“将图像作为容器运行”中完成构建图像并将其作为容器化应用程序运行的步骤。

介绍

在本模块中,我们将逐步为在先前模块中构建的应用程序建立本地开发环境。我们将使用Docker来构建映像,并使用Docker Compose来简化所有工作。

在容器中运行数据库

首先,我们将研究如何在容器中运行数据库,以及如何使用卷和网络来持久化数据并允许我们的应用程序与数据库进行通讯。然后,我们将所有内容汇总到一个Compose文件中,该文件使我们可以使用一个命令来设置和运行本地开发环境。最后,我们将看一下如何将调试器连接到在容器内运行的应用程序。

我们可以使用MySQL的Docker Official Image并在容器中运行它,而无需下载MySQL,安装,配置然后运行MySQL数据库作为服务。

在容器中运行MySQL之前,我们将创建几个卷,Docker可以管理这些卷来存储我们的持久数据和配置。让我们使用Docker提供的托管卷功能,而不是使用绑定安装。您可以在我们的文档中阅读有关使用卷的所有信息。

现在创建卷。我们将为数据创建一个,为MySQL配置创建一个。

$ docker volume create mysql
$ docker volume create mysql_config

现在,我们将创建一个网络,我们的应用程序和数据库将使用该网络互相通信。该网络称为用户定义的桥接网络,它为我们提供了很好的DNS查找服务,可在创建连接字符串时使用该服务。

$ docker network create mysqlnet

现在,我们可以在容器中运行MySQL,并将其附加到上面创建的卷和网络上。Docker从Hub提取映像并在本地为您运行。在以下命令中,选项-v用于启动带有卷的容器。有关更多信息,请参阅Docker卷

$ docker run --rm -d -v mysql:/var/lib/mysql \
  -v mysql_config:/etc/mysql -p 3306:3306 \
  --network mysqlnet \
  --name mysqldb \
  -e MYSQL_ROOT_PASSWORD=p@ssw0rd1 \
  mysql

现在,让我们确保我们的MySQL数据库正在运行并且可以连接到它。使用以下命令连接到容器内正在运行的MySQL数据库,并在提示输入密码时输入“ p @ ssw0rd1”:

$ docker exec -ti mysqldb mysql -u root -p
Enter password:
Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 8
Server version: 8.0.23 MySQL Community Server - GPL

Copyright (c) 2000, 2021, Oracle and/or its affiliates.

Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql>

将应用程序连接到数据库

在上面的命令中,我们通过将“ mysql”命令传递到mysqldb容器来登录到MySQL数据库。按CTRL-D退出MySQL交互式终端。

接下来,我们将更新在“构建图像”模块中创建的示例应用程序。要查看Python应用程序的目录结构,请参阅Python应用程序目录结构

好的,既然我们有一个正在运行的MySQL,让我们对其进行更新app.py以将MySQL用作数据存储。让我们也添加一些路由到我们的服务器。一种用于获取记录,另一种用于插入记录。

import mysql.connector
import json
from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello_world():
  return 'Hello, Docker!'

@app.route('/widgets')
def get_widgets() :
  mydb = mysql.connector.connect(
    host="mysqldb",
    user="root",
    password="p@ssw0rd1",
    database="inventory"
  )
  cursor = mydb.cursor()


  cursor.execute("SELECT * FROM widgets")

  row_headers=[x[0] for x in cursor.description] #this will extract row headers

  results = cursor.fetchall()
  json_data=[]
  for result in results:
    json_data.append(dict(zip(row_headers,result)))

  cursor.close()

  return json.dumps(json_data)

@app.route('/initdb')
def db_init():
  mydb = mysql.connector.connect(
    host="mysqldb",
    user="root",
    password="p@ssw0rd1"
  )
  cursor = mydb.cursor()

  cursor.execute("DROP DATABASE IF EXISTS inventory")
  cursor.execute("CREATE DATABASE inventory")
  cursor.close()

  mydb = mysql.connector.connect(
    host="mysqldb",
    user="root",
    password="p@ssw0rd1",
    database="inventory"
  )
  cursor = mydb.cursor()

  cursor.execute("DROP TABLE IF EXISTS widgets")
  cursor.execute("CREATE TABLE widgets (name VARCHAR(255), description VARCHAR(255))")
  cursor.close()

  return 'init database'

if __name__ == "__main__":
  app.run(host ='0.0.0.0')

我们添加了MySQL模块并更新了代码以连接到数据库服务器,创建了数据库和表。我们还创建了一些路由来保存小部件和获取小部件。现在,我们需要重建我们的映像,以便包含我们的更改。

首先,让mysql-connector-python我们使用pip将模块添加到我们的应用程序中。

$ pip3 install mysql-connector-python
$ pip3 freeze > requirements.txt

现在我们可以建立我们的形象。

$ docker build --tag python-docker .

现在,让我们将容器添加到数据库网络,然后运行我们的容器。这使我们可以通过其容器名称访问数据库。

$ docker run \
  --rm -d \
  --network mysqlnet \
  --name rest-server \
  -p 5000:5000 \
  python-docker

让我们测试一下我们的应用程序已连接到数据库并能够添加注释。

$ curl http://localhost:5000/initdb
$ curl http://localhost:5000/widgets

您应该从我们的服务中收到以下JSON。

[]

使用Compose进行本地开发

在本节中,我们将创建一个Compose文件,以使用单个命令启动python-docker和MySQL数据库。我们还将设置Compose文件以python-docker在调试模式下启动应用程序,以便我们可以将调试器连接到正在运行的进程。

python-docker在IDE或文本编辑器中打开代码,然后创建一个名为的新文件docker-compose.dev.yml。将以下命令复制并粘贴到文件中。

version: '3.8'

services:
 web:
  build:
   context: .
  ports:
  - 5000:5000
  volumes:
  - ./:/app

 mysqldb:
  image: mysql
  ports:
  - 3306:3306
  environment:
  - MYSQL_ROOT_PASSWORD=p@ssw0rd1
  volumes:
  - mysql:/var/lib/mysql
  - mysql_config:/etc/mysql

volumes:
  mysql:
  mysql_config:

这个Compose文件非常方便,因为我们不必键入所有参数即可传递给docker run命令。我们可以使用Compose文件声明性地做到这一点。

我们公开端口5000,以便可以访问容器内的dev Web服务器。我们还将本地源代码映射到正在运行的容器中,以在文本编辑器中进行更改,并在容器中提取这些更改。

使用Compose文件的另一个非常酷的功能是我们设置了服务解析来使用服务名称。因此,我们现在可以在连接字符串中使用“ mysqldb”。我们使用“ mysqldb”的原因是因为这就是我们在Compose文件中命名的MySQL服务的名称。

现在,要启动我们的应用程序并确认其运行正常,请运行以下命令:

$ docker-compose -f docker-compose.dev.yml up --build

我们传递该--build标志,以便Docker将编译我们的映像,然后启动容器。

现在让我们测试我们的API端点。运行以下curl命令:

$ curl http://localhost:5000/initdb
$ curl http://localhost:5000/widgets

您应该收到以下回复:

[]

这是因为我们的数据库为空。

下一步

在本模块中,我们看了如何创建一个通用开发映像,该映像可以像正常命令行一样使用。我们还设置了Compose文件,以将我们的源代码映射到正在运行的容器中,并公开调试端口。

在下一个模块中,我们将看一下如何使用GitHub Actions建立CI / CD管道。看:

配置CI / CD

反馈

通过提供您的反馈帮助我们改善此主题。通过在Docker Docs GitHub存储库中创建问题,让我们知道您的想法。或者,创建PR以建议更新。

python本地开发运行