levernfulcrum/lnf-employee-service

LNF Employee Service 镜像文档

1. 镜像概述

LNF Employee Service 是一个专为员工信息管理设计的Docker镜像，旨在提供便捷、高效的员工数据管理解决方案。该镜像封装了完整的员工服务应用，可快速部署并集成到企业现有的IT架构中，帮助企业实现员工信息的数字化管理。

2. 核心功能和特性

2.1 核心功能

• 员工信息的CRUD操作（创建、读取、更新、删除）
• 员工数据的批量导入和导出
• 基于角色的访问控制
• 员工信息查询与筛选

2.2 主要特性

• 轻量级设计，资源占用低
• 支持多种数据库后端（默认SQLite，可配置MySQL/PostgreSQL）
• RESTful API接口，易于集成
• 内置数据验证机制，确保数据完整性
• 容器化部署，环境一致性保障

3. 使用场景和适用范围

3.1 使用场景

• 中小企业员工信息管理系统
• 企业HR部门内部数据管理工具
• 与考勤、薪资等系统集成的员工数据服务
• 临时项目团队的人员信息管理

3.2 适用范围

• 各类企业HR部门
• 需要管理员工信息的组织和机构
• 开发团队构建员工相关业务系统

4. 使用方法和配置说明

4.1 基本使用（Docker Run）

bash
docker run -d -p 8080:8080 --name lnf-employee-service lnf/employee-service:latest

4.2 环境变量配置

4.3 Docker Compose 配置示例

yaml
version: '3.8'
services:
  employee-service:
    image: lnf/employee-service:latest
    container_name: lnf-employee-service
    ports:
      - "8080:8080"
    environment:
      - SPRING_PROFILES_ACTIVE=prod
      - DB_TYPE=mysql
      - DB_URL=jdbc:mysql://mysql:3306/employee_db
      - DB_USERNAME=root
      - DB_PASSWORD=password
    volumes:
      - employee-data:/app/data
    depends_on:
      - mysql

  mysql:
    image: mysql:8.0
    container_name: employee-mysql
    environment:
      - MYSQL_ROOT_PASSWORD=password
      - MYSQL_DATABASE=employee_db
    volumes:
      - mysql-data:/var/lib/mysql

volumes:
  employee-data:
  mysql-data:

4.4 数据持久化

通过挂载数据卷实现数据持久化：

bash
docker run -d -p 8080:8080 -v employee-data:/app/data --name lnf-employee-service lnf/employee-service:latest

5. API接口说明

服务启动后，可通过访问 http://localhost:8080/swagger-ui.html 查看完整的API文档。

5.1 主要API端点

• GET /api/employees - 获取所有员工列表
• GET /api/employees/{id} - 获取指定ID的员工信息
• POST /api/employees - 创建新员工
• PUT /api/employees/{id} - 更新员工信息
• DELETE /api/employees/{id} - 删除员工信息
• POST /api/employees/import - 批量导入员工数据
• GET /api/employees/export - 导出员工数据

6. 注意事项

• 生产环境中应使用非默认密码，并确保数据库安全
• 首次启动服务时会自动创建初始管理员账户（admin/admin123）
• 建议定期备份数据卷中的数据
• 不同环境配置应通过环境变量或外部配置文件进行管理

volumes:
  employee-data: