digitalcollab/profile-apollo

profile_service 镜像文档

镜像概述和主要用途

profile_service是一个提供个人资料即服务的Apollo容器，通过GraphQL接口实现用户个人资料的管理功能。该镜像支持在开发、生产和测试三种环境中运行，提供灵活的配置选项和数据验证机制，适用于需要集中管理用户个人信息的微服务架构。

核心功能和特性

• 基于GraphQL的个人资料管理接口
• 支持开发、生产和测试多环境配置
• 环境变量与配置文件分离管理敏感信息
• 集成RabbitMQ、Prisma、Elasticsearch等服务
• 个人资料字段验证（***、电话号码格式等）
• 提供Playground调试界面

使用场景和适用范围

• 微服务架构中的用户个人资料管理服务
• 需要GraphQL接口的用户信息系统
• 开发团队进行个人资料相关功能的开发和测试
• 生产环境中稳定运行的个人资料服务

详细使用方法和配置说明

安装与配置

配置文件

应用配置需要修改以下两个文件：

1. ./src/config.js

   • 包含非敏感环境变量配置，用于区分生产、开发和测试环境

2. ./.env

   • 包含应用所需的敏感信息，可通过环境变量或该文件设置，具体变量如下：
   • MQ_HOST：RabbitMQ实例主机（与./src/config.js中设置对应）
   • MQ_USER：RabbitMQ实例用户名（与./src/config.js中设置对应）
   • MQ_PASS：RabbitMQ实例密码
   • account_url：Concierge实例URL，供微服务使用
   • client_id：在Concierge中为该微服务创建的客户端ID
   • client_secret：上述客户端ID对应的客户端密钥
   • PRISMA_HOST：微服务使用的Prisma实例主机
   • ELASTIC_HOST：微服务使用的Elasticsearch实例主机
   • IMAGE_URL：微服务使用的镜像服务器主机
   • ENGINE_API_KEY：Apollo Engine API密钥

开发环境部署

执行以下命令设置开发环境：

bash
sudo docker-compose -f docker-compose-dev.yml up
sudo npm install
npm start dev

服务启动后可访问：

• Playground端点：http://localhost:4000/playground
• GraphQL端点：http://localhost:4000/graphql
• Prisma服务：http://localhost:4466/profile

生产环境部署

执行以下命令设置生产环境：

bash
sudo docker-compose up --build -d

服务启动后可访问：

• Playground端点：http://localhost:4000/playground
• GraphQL端点：http://localhost:4000/graphql

测试

从项目根目录执行以下命令运行测试：

bash
sudo docker-compose -f docker-compose-test.yml up -d
npm test

数据验证规则

部分字段已实现验证功能，标记**<--**的字段有特定验证规则：

json
profile
{
    gcID,
    name,
    email, <--
    avatar,
    mobilePhone, <--
    officePhone, <--
    address:
    {
        streetAddress,
        city,
        province, 
        country, 
        postalcode
    }
    titleEn,
    titleFr,
    org 
}

Profile验证

初始化"Profile"时，仅gcID、name和email为必填字段。

电子***

电子***必须符合以下格式：name@domain.domainExtension
示例：myname@profile.com

手机/办公电话号码

支持的格式：

• ##########
• ###-###-####
• ###.###.####
• (###) ###-####
• (###)###-####
• +###########
• ###-#######

地址验证

指定地址时，所有字段均为必填项，除非该地址已存在于个人资料中且仅进行修改。