# fg

**Repository Path**: acircumstance/fg

## Basic Information

- **Project Name**: fg
- **Description**: 家庭谱系微服务
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-30
- **Last Updated**: 2026-03-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# fg - 家庭谱系微服务

## 简介

fg 是一个专注于家庭族谱管理的微服务系统，采用现代化的微服务架构设计。该系统旨在帮助用户建立、管理和展示家族谱系关系，支持基于身份证号的便捷登录方式，提供完整的族谱关系绑定与可视化功能。

## 软件架构

本项目采用分层微服务架构，主要包含以下核心模块：

### 模块说明

| 模块 | 说明 |
|------|------|
| fg-api | API 接口定义模块 |
| fg-common | 公共组件模块，包含工具类、异常处理、配置等 |
| fg-repository | 数据访问层，封装数据库操作逻辑 |
| fg-service | 核心服务层，包含多个子模块 |
| ├─ fg-ai | AI 相关功能模块 |
| ├─ fg-core | 核心业务模块，包含适配器、应用服务、领域模型、基础设施 |
| ├─ fg-gateway | 网关服务，负责请求路由与认证 |
| └─ fg-oss | 对象存储服务 |

### 技术栈

- **框架**: Spring Boot + Spring Cloud
- **数据库**: MySQL + MyBatis-Plus
- **网关**: Spring Cloud Gateway
- **认证**: JWT (JSON Web Token)
- **缓存**: Redis

## 核心功能

1. **用户管理**
   - 基于身份证号的注册与登录
   - 用户信息维护

2. **族谱管理**
   - 族谱成员的增删改查
   - 家族关系绑定（父母子女关系）
   - 人物中心图展示
   - 成员列表管理

3. **安全功能**
   - JWT 认证
   - 敏感词过滤
   - 白名单机制

## 项目结构

```
fg/
├── fg-api/                    # API 模块
├── fg-common/                 # 公共模块
│   ├── config/               # 配置类
│   ├── constants/            # 常量定义
│   ├── dto/                  # 数据传输对象
│   ├── enums/                # 枚举类型
│   ├── exception/            # 异常处理
│   └── utils/                # 工具类
├── fg-repository/            # 数据访问层
│   ├── mapper/               # MyBatis Mapper 接口
│   ├── po/                   # 持久化对象
│   ├── service/              # 服务接口及实现
│   └── utils/                # 敏感词过滤工具
└── fg-service/               # 服务模块
    ├── fg-ai/                # AI 服务
    ├── fg-core/              # 核心服务
    │   ├── fg-core-adapter/  # 适配器层
    │   ├── fg-core-application/ # 应用服务层
    │   ├── fg-core-domain/   # 领域层
    │   ├── fg-core-infra/    # 基础设施层
    │   └── fg-core-starter/  # 启动配置
    ├── fg-gateway/           # 网关服务
    └── fg-oss/               # 对象存储
```

## API 接口

### 用户服务

| 接口 | 方法 | 描述 |
|------|------|------|
| `/core/user/login` | POST | 用户登录 |
| `/core/user/register` | POST | 用户注册 |

## 安装教程

### 环境要求

- JDK 1.8+
- Maven 3.6+
- MySQL 5.7+
- Redis 3.0+

### 构建步骤

1. 克隆项目：
```bash
git clone https://gitee.com/acircumstance/fg.git
```

2. 构建项目：
```bash
cd fg
mvn clean install -DskipTests
```

3. 配置数据库：
   - 创建数据库并执行初始化 SQL
   - 修改 `application.yaml` 配置文件中的数据库连接信息

4. 启动服务：
   - 依次启动网关服务、核心服务等模块

## 使用说明

### 用户注册

```json
POST /core/user/register
{
  "userId": "用户ID",
  "userType": "用户类型",
  "data": {
    "idCardNo": "身份证号",
    "name": "姓名",
    "gender": "性别"
  }
}
```

### 用户登录

```json
POST /core/user/login
{
  "userId": "用户ID",
  "userType": "用户类型",
  "data": {
    "idCardNo": "身份证号",
    "password": "密码"
  }
}
```

## 相关文档

- [毕业设计产品需求文档](./docs/family-tree-graduation-design-prd.md)
- [族谱社交数据库设计文档](./docs/family-tree-social-database-design-prd.md)

## 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

## 许可证

本项目遵循 LICENSE 开源协议。

## 联系方式

- 项目地址：https://gitee.com/acircumstance/fg