重构笔记系统：Docker Compose在微服务架构中的应用与优化

news2024/12/24 21:47:41

虽然我的笔记系统的开发是基于微服务的思想，但是在服务的配置和编排上感觉还是不太合理，具体来说，在开发上的配置和在生产上的配置差别太大。现在规模小，后面规模变大，估计这一块会成为系统生长的瓶颈。

因此，我在周末重构了项目结构和docker-compose.yml，本文将分享我在这一过程中的经验，并探讨如何进一步优化基于Docker Compose的微服务架构。

# 所有数据放在data目录下
version: '3'
networks:
  notes_network:

services:  
  redis:
    image: redis:latest
    container_name: redis-token
    networks: 
      - notes_network
    volumes:
      - ./data/redis:/opt/redis/data
      - ./redis/conf/redis.conf:/etc/redis/redis.conf
    ports:
      - 6379:6379
  auth2-db:
    image: postgres:latest
    container_name: auth2-db
    networks:
      - notes_network
    volumes:
      - ./db/auth2/init:/docker-entrypoint-initdb.d/
      - ./data/auth2-db:/var/lib/postgresql/data
    ports:
      - 5434:5432
    env_file:
      - .env
  notes-db:
    image: postgres:latest
    container_name: notes-db
    networks:
      - notes_network
    volumes:
      - ./db/notes/init:/docker-entrypoint-initdb.d/
      - ./data/notes-db:/var/lib/postgresql/data
    ports:
      - 5433:5432
    env_file:
      - .env

  api-gate:
    image: rust:latest
    container_name: api-gate
    networks:
      - notes_network
    working_dir: /app
    volumes:
      - ./src/api-gate/app:/app
    command: ["./test.sh"]
    ports:
      - 8000:8000

  auth2:
    image: rust:latest
    container_name: auth2
    working_dir: /app
    networks:
      - notes_network
    ports:
      - 8002:8002
    volumes:
      - ./src/auth2/app:/app
    command: ["./test.sh"]

  notes-api:
    image: rust:latest
    container_name: note_book_api
    networks:
      - notes_network
    working_dir: /app
    ports:
      - 8003:8003
    volumes:
      - ./src/note_book_api/app:/app
    command: ["./test.sh"]

  auth_app:
    image: nginx:latest
    container_name: auth_app
    networks:
      - notes_network
    volumes:
      - ./src/auth_app/app/dist/:/usr/share/nginx/html
    ports:
      - 8081:80

  web_app:
    image: nginx:latest
    container_name: web_app
    networks:
      - notes_network
    volumes:
      - ./src/web_app/app/dist/:/usr/share/nginx/html
    ports:
      - 8082:80

一、微服务架构的优势与挑战

微服务架构将单一体应用拆分成多个小型、独立的服务，每个服务都围绕特定的业务功能进行构建和部署。这种架构的优势在于提高了系统的可伸缩性、灵活性和可维护性。然而，随着服务数量的增加，配置、部署和管理这些服务成为了一个巨大的挑战。

二、Docker Compose的应用

为了简化微服务架构的部署和管理，我引入了Docker Compose。Docker Compose是一个用于定义和运行多容器Docker应用程序的工具，通过YAML文件来配置应用程序的服务、网络和卷。在我的笔记系统中，我使用Docker Compose将各个微服务编排在一起，形成了一个完整的应用程序。

三、Docker Compose文件解析

我的docker-compose.yml文件包含了多个服务定义，如Redis、Postgres数据库、API网关、身份验证服务、笔记API和前端应用等。每个服务都指定了镜像、容器名称、网络、卷、端口映射和环境变量等配置信息。通过这些配置，我可以轻松地启动、停止和扩展各个服务。

四、优化建议

虽然我的Docker Compose文件已经相对整洁和有序，但仍然存在一些可以优化的地方：

环境变量管理：对于不同环境（开发、测试、生产），应使用不同的环境变量文件。可以通过在Docker Compose文件中引用多个.env文件来实现这一目的。此外，对于需要共享的环境变量，可以考虑使用Docker的秘密管理功能。
启动脚本和命令：尽量避免在服务中使用相同的启动脚本。每个服务应该有一个独特的启动命令或脚本，以确保正确的初始化和启动顺序。同时，要确保这些脚本在容器内具有执行权限。
网络和端口映射：在生产环境中，应谨慎使用端口映射功能，只暴露必要的端口以减少安全风险。同时，可以利用Docker的网络功能实现服务之间的安全通信。
服务依赖和启动顺序：虽然Docker Compose默认按照文件定义的顺序启动服务，但在某些情况下，可能需要明确指定服务的依赖关系。可以使用depends_on指令来实现这一点。然而，需要注意的是，depends_on并不能保证服务的完全同步启动。为了解决这个问题，可以考虑使用健康检查或等待策略来确保依赖服务已准备就绪。
日志和监控：在生产环境中，应配置适当的日志收集和监控机制。可以使用ELK堆栈（Elasticsearch、Logstash和Kibana）等工具来收集、处理和存储日志。同时，通过添加健康检查和性能监控指标，可以确保服务的稳定性和性能。
数据卷权限：在使用数据卷时，要确保容器内的用户或进程具有正确的读写权限。可以在Dockerfile或启动脚本中设置适当的权限和所有权。
资源限制：根据需要，可以为Docker容器设置CPU、内存和磁盘空间等资源限制。这有助于防止单个服务消耗过多资源而影响其他服务的性能。可以使用Docker Compose的deploy指令下的resources选项来配置这些限制（注意：这主要适用于Swarm模式）。对于非Swarm模式或较早版本的Docker Compose，可以考虑使用其他方法（如cgroups）来限制资源使用。
版本控制：将docker-compose.yml文件纳入版本控制系统（如Git）中进行管理，以便跟踪和回滚更改。同时，可以使用Git的子模块或分支功能来管理不同环境或版本的配置文件。
安全性：确保使用最新和最安全的Docker镜像版本，并定期更新依赖库以防止已知的安全漏洞被利用。加强服务之间的通信和数据传输的安全性，例如使用HTTPS和加密连接。对于敏感信息（如密码和密钥），应使用安全的密钥管理系统进行存储和访问。最后，确保Docker守护进程和容器受到适当的访问控制和防火墙保护以防止未经授权的访问和攻击。