hmcts/ccd-user-profile-database

ccd-user-profile-api

镜像概述和主要用途

ccd-user-profile-api是一个微服务，用于管理Core Case Data (CCD) 用户的个人资料信息，核心功能包括存储和管理用户UI偏好设置及关联的辖区（Jurisdictions）信息。该服务提供API端点支持用户资料创建及辖区信息查询，需与数据库、IdAM服务认证集成，适用于CCD系统中用户个性化配置和权限管理场景。

核心功能和特性

• 用户资料管理：支持创建用户个人资料，包含用户ID及关联的辖区信息（至少需指定一个辖区）
• 辖区信息查询：提供API接口查询指定用户的辖区ID列表
• 安全集成：通过S2S（Service-to-Service）认证控制服务间访问权限
• 数据库集成：依赖数据库存储用户资料数据，支持自动数据库迁移
• 可观测性：支持Azure Application Insights监控（通过 instrumentation key 配置）

使用场景和适用范围

• CCD系统用户管理：为Core Case Data平台用户提供个性化UI偏好设置存储
• 权限控制辅助：通过辖区信息管理，辅助实现基于辖区的功能权限控制
• 微服务架构集成：作为CCD生态系统的一部分，与ccd_data、ccd_definition等微服务协同工作

使用方法和配置说明

前提条件

• Open JDK 21
• Docker环境

环境变量配置

以下环境变量为必需配置：

构建步骤

项目使用Gradle构建，执行以下命令编译项目：

bash
./gradlew clean build

Gradle升级说明

升级Gradle版本时需执行以下命令并提交更新的gradle-wrapper.jar：

bash
# 示例：升级到v4.9（请替换为目标版本）
./gradlew wrapper --gradle-version 4.9 --distribution-type all

运行步骤

构建Docker镜像

如需本地测试或供其他Docker项目使用，需构建镜像：

bash
# 构建所有镜像（应用+数据库）
docker-compose build

# 仅构建应用镜像
docker-compose build ccd-user-profile-api

启动服务

使用Docker Compose启动服务：

bash
docker-compose up

启动后将创建并运行以下容器：

• 数据库容器：暴露端口5453
• API服务容器：暴露端口4453

数据库处理

• 初始化：首次执行docker-compose up时，数据库将自动执行database目录下的初始化脚本
• 迁移：每次启动服务时自动执行数据库迁移，无需手动操作
• 连接：可通过http://localhost:5453访问数据库，使用环境变量配置的用户名和密码

API详情

端点说明

1. 创建用户个人资料

• URL: POST /user-profile/users
• 功能: 创建用户个人资料及关联辖区信息（至少需指定一个辖区）
• 请求体示例:

json
{
  "id": "user1",
  "jurisdictions": [
    { "id": "TEST1" },
    { "id": "TEST2" }
  ]
}

2. 查询用户辖区信息

• URL: GET /user-profile/users/{uid}/jurisdictions
• 功能: 获取指定用户ID（uid）的辖区ID列表
• 响应: 返回String[]类型的辖区ID数组

测试

功能测试位于aat目录，基于befta-fw框架实现。详细测试框架说明参见https://github.com/hmcts/befta-fw%E3%80%82

许可证

本项目采用MIT许可证 - 详见LICENSE文件。