用户登录实现

• 项目目标
• 系统核心概念
• 功能实现步骤
• 系统概述
• API 接口详解
  • 1. 用户登录
  • 2. 获取用户信息
  • 3. 获取系统配置
  • 4. 用户注销
  • 5. 用户管理
• 注意事项
• 代码实现
  • ApiProfileController
  • AppConstant
  • ApiUserController
  • UserService
• 总结

项目目标

本项目旨在构建一个功能完备的 RAG（Retrieval-Augmented Generation）系统，主要目标包括：

• 知识库管理：支持创建、更新和删除知识库，便于用户高效维护内容。
• 文档处理：包括文档的拆分、片段的向量化处理，以提升检索效率和准确性。
• 问答系统：提供高效的向量检索和实时生成回答的能力，支持复杂汇总类问题的处理。
• 系统优化：通过统计分析和推理问答调试，不断优化系统性能和用户体验。

系统核心概念

在 RAG 系统中，以下是几个核心概念：

• 应用：知识库的集合。每个应用可以自定义提示词，以满足不同的个性化需求。
• 知识库：由多个文档组成，便于用户对内容进行分类和管理。
• 文档：系统中对应的真实文档内容。
• 片段：文档经过拆分后的最小内容单元，用于更高效的处理和检索。

功能实现步骤

1. 数据库设计 查看 01.md
   设计并实现项目所需的数据表结构与数据库方案，为后续的数据操作打下坚实基础。

2. 用户登录 查看 02.md
   实现了安全可靠的用户认证系统，保护用户数据并限制未经授权的访问。

3. 模型管理 查看 03.md
   支持针对不同平台的模型（如 OpenAI、Google Gemini、Claude）进行管理与配置。

4. 知识库管理 查看 04.md
   提供创建、更新及删除知识库的功能，方便用户维护与管理文档内容。

5. 文档拆分 查看 05.md
   可将文档拆分为多个片段，便于后续向量化和检索操作。

6. 片段向量 查看 06.md
   将文本片段进行向量化处理，以便进行语义相似度计算及高效检索。

7. 命中率测试 查看 07.md
   通过语义相似度和 Top-N 算法，检索并返回与用户问题最相关的文档片段，用于评估检索的准确性。

8. 文档管理 查看 08.md
   提供上传和管理文档的功能，上传后可自动拆分为片段便于进一步处理。

9. 片段管理 查看 09.md
   允许对已拆分的片段进行增、删、改、查等操作，确保内容更新灵活可控。

10. 问题管理 查看 10.md
    为片段指定相关问题，以提升检索时的准确性与关联度。

11. 应用管理 查看 11.md
    提供创建和配置应用（智能体）的功能，并可关联指定模型和知识库。

12. 向量检索 查看 12.md
    基于语义相似度，在知识库中高效检索与用户问题最匹配的片段。

13. 推理问答调试 查看 13.md
    提供检索与问答性能的评估工具，帮助开发者进行系统优化与调试。

14. 对话问答 查看 14.md
    为用户提供友好的人机交互界面，结合检索到的片段与用户问题实时生成回答。

15. 统计分析 查看 15.md
    对用户的提问与系统回答进行数据化分析，并以可视化图表的形式呈现系统使用情况。

16. 用户管理 查看 16.md
    提供多用户管理功能，包括用户的增删改查及权限控制。

17. API 管理 查看 17.md
    对外提供标准化 API，便于外部系统集成和调用本系统的功能。

18. 存储文件到 S3 查看 18.md
    将用户上传的文件存储至 S3 等对象存储平台，提升文件管理的灵活性与可扩展性。

19. 文档解析优化 查看 19.md
    介绍与对比常见的文档解析方案，并提供提升文档解析速度和准确性的优化建议。

20. 片段汇总 查看 20.md
    对片段内容进行汇总，以提升总结类问题的查询与回答效率。

21. 文档多分块与检索 查看 21.md
    将片段进一步拆分为句子并进行向量检索，提升检索的准确度与灵活度。

22. 多文档支持 查看 22.md
    兼容多种文档格式，包括 .doc, .docx, .xls, .xlsx, .ppt, .pptx 等。

23. 对话日志 查看 23.md
    记录并展示对话日志，用于后续分析和问题回溯。

24. 检索性能优化 查看 24.md
    提供整库扫描和分区检索等多种方式，进一步提高检索速度和效率。

25. Milvus 查看 25.md
    将向量数据库切换至 Milvus，以在大规模向量检索场景中获得更佳的性能与可扩展性。

26. 文档解析方案和费用对比 查看 26.md
    对比不同文档解析方案在成本、速度、稳定性等方面的差异，为用户提供更加经济高效的选择。

27. 爬取网页数据 查看 27.md
    支持从网页中抓取所需内容，后续处理流程与本地文档一致：分段、向量化、存储与检索。

本文将详细介绍一个用户认证系统的 API，包括登录、获取用户信息、获取系统配置以及注销功能。除此之外，我们还将探讨相关的代码实现，帮助开发者更好地理解和应用这些功能。

系统概述

本用户认证系统提供了一系列 API 接口，用于管理用户的登录、信息获取、系统配置查看以及注销功能。通过这些接口，开发者可以轻松集成认证机制，确保系统的安全性和用户数据的保护。

API 接口详解

1. 用户登录

功能描述

用户通过提供用户名和密码进行登录，成功后系统会返回一个 JWT（JSON Web Token）令牌，用于后续的认证请求。

请求

• 方法: POST

• URL: http://localhost:8080/api/user/login

• 请求体:

  {
    "username": "admin",
    "password": "Kimi@2024"
  }
  

响应

{
  "message": "成功",
  "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MzA2MzMyNjUsInVzZXJJZCI6MX0=.aTVsg7Wj4LioKnj6nZg6v8rqMyroQA8yIvliYI8n1v8",
  "code": 200
}

说明

• 成功登录后，data 字段会返回一个 JWT 令牌，该令牌将在后续的请求中用于用户认证。

---

2. 获取用户信息

功能描述

通过 JWT 令牌，用户可以获取当前登录用户的详细信息，包括角色、权限、昵称等。

请求

• 方法: GET

• URL: http://localhost:8080/api/user

• 请求头:

  • Authorization: Bearer <JWT_TOKEN>

响应

{
  "message": null,
  "data": {
    "role": "ADMIN",
    "phone": "",
    "permissions": [
      "USER:READ",
      "USER:EDIT",
      "DATASET:CREATE",
      "DATASET:READ",
      "DATASET:EDIT",
      "APPLICATION:READ",
      "APPLICATION:CREATE",
      "APPLICATION:DELETE",
      "APPLICATION:EDIT",
      "SETTING:READ",
      "MODEL:READ",
      "MODEL:EDIT",
      "MODEL:DELETE",
      "MODEL:CREATE",
      "TEAM:READ",
      "TEAM:CREATE",
      "TEAM:DELETE",
      "TEAM:EDIT",
      "..."
    ],
    "nick_name": "系统管理员",
    "id": "1",
    "email": "",
    "username": "admin"
  },
  "code": 200
}

说明

• 需要在请求头中携带有效的 JWT 令牌。
• 返回的数据包括用户的角色、权限列表、昵称、ID、邮箱和用户名等信息。

---

3. 获取系统配置

功能描述

获取系统的配置信息，如版本号和许可证状态，帮助用户了解系统的当前状态。

请求

• 方法: GET

• URL: /api/profile

• 请求头:

  • Authorization: Bearer <JWT_TOKEN>

响应

{
  "code": 200
  "message": null,
  "data": {
    "version": "v1.7.0 (build at 2024-10-31T12:49, commit: 44b3aed5)",
    "IS_XPACK": false,
    "XPACK_LICENSE_IS_VALID": false
  }

}

说明

• 需要在请求头中携带有效的 JWT 令牌。
• 返回的数据包括系统是否启用 XPACK、许可证的有效性以及系统版本信息。

---

4. 用户注销

功能描述

用户通过此接口可以注销当前会话，使 JWT 令牌失效，确保账号安全。

请求

• 方法: POST

• URL: http://localhost:8080/api/user/logout

• 请求头:

  • Authorization: Bearer <JWT_TOKEN>

响应

{
  "code": 200,
  "message": "成功",
  "data": true
}

说明

• 注销操作将使当前 JWT 令牌失效。
• 需要在请求头中携带有效的 JWT 令牌。

---

5. 用户管理

GET http://localhost:8080/api/user_manage/1/20

{
  "code": 200,
  "message": "成功",
  "data":
  {
    "total": 1,
    "records":
    [
      {
        "id": "f0dd8f71-e4ee-11ee-8c84-a8a1595801ab",
        "username": "admin",
        "email": "",
        "phone": "",
        "is_active": true,
        "role": "ADMIN",
        "nick_name": "系统管理员",
        "create_time": "2024-09-14T19:07:05.887462",
        "update_time": "2024-09-14T19:08:25.556513",
        "source": "LOCAL"
      }
    ],
    "current": 1,
    "size": 20
  }
}

注意事项

• 认证: 除了登录接口外，其他接口均需要在请求头中携带 Authorization 字段，格式为 Bearer <JWT_TOKEN>，其中 <JWT_TOKEN> 为登录成功后返回的令牌。
• 响应码: 所有成功的响应均返回 code: 200，失败时请参考具体的错误码说明。
• 密码安全: 请确保在传输过程中使用 HTTPS 以保障密码和令牌的安全。

代码实现

以下是用户认证系统的关键代码实现，基于 Java 语言和相关框架。

ApiProfileController

负责处理获取系统配置信息的请求。

package com.litongjava.maxkb.controller;

import com.jfinal.kit.Kv;
import com.litongjava.annotation.RequestPath;
import com.litongjava.model.result.ResultVo;

@RequestPath("/api/profile")
public class ApiProfileController {

  @RequestPath
  public ResultVo index() {
    Kv data = Kv.by("version", "v1.5.1 (build at 2024-08-29T17:29, commit: 30b1bdfe)");
    data.set("IS_XPACK", false).set("XPACK_LICENSE_IS_VALID", false);
    return ResultVo.ok(data);
  }
}

AppConstant

定义应用程序的常量，例如用于 JWT 生成的密钥。

package com.litongjava.maxkb.consts;

public class AppConstant {
  public static final String SECRET_KEY = "java-max-kb";
}

ApiUserController

处理用户相关的请求，包括获取用户信息、登录和注销。

package com.litongjava.maxkb.controller;

import com.litongjava.annotation.RequestPath;
import com.litongjava.jfinal.aop.Aop;
import com.litongjava.maxkb.model.UserLoginReqVo;
import com.litongjava.maxkb.service.UserService;
import com.litongjava.model.result.ResultVo;
import com.litongjava.tio.boot.http.TioRequestContext;

@RequestPath("/api/user")
public class ApiUserController {

  @RequestPath
  public ResultVo index() {
    Long id = TioRequestContext.getUserIdLong();
    return Aop.get(UserService.class).index(id);
  }

  public ResultVo login(UserLoginReqVo vo) {
    return Aop.get(UserService.class).login(vo);
  }

  public ResultVo logout() {
    Long userId = TioRequestContext.getUserIdLong();
    return Aop.get(UserService.class).logout(userId);
  }
}

UserService

业务逻辑层，负责处理用户的登录、信息获取和注销操作。

package com.litongjava.maxkb.service;

import java.util.List;

import com.jfinal.kit.Kv;
import com.litongjava.db.TableInput;
import com.litongjava.db.TableResult;
import com.litongjava.db.activerecord.Db;
import com.litongjava.db.activerecord.Row;
import com.litongjava.jfinal.aop.Aop;
import com.litongjava.kit.RecordUtils;
import com.litongjava.maxkb.constant.TableNames;
import com.litongjava.maxkb.consts.AppConstant;
import com.litongjava.maxkb.consts.KbTableNames;
import com.litongjava.maxkb.model.ResultPage;
import com.litongjava.maxkb.model.UserLoginReqVo;
import com.litongjava.model.page.Page;
import com.litongjava.model.result.ResultVo;
import com.litongjava.table.services.ApiTable;
import com.litongjava.tio.utils.crypto.Md5Utils;
import com.litongjava.tio.utils.jwt.JwtUtils;
import com.litongjava.tio.utils.token.TokenManager;

public class UserService {

  public ResultVo login(UserLoginReqVo vo) {
    vo.setPassword(Md5Utils.getMD5(vo.getPassword()));
    String loginSql = String.format("select id from %s where username=? and password=?", KbTableNames.max_kb_user);
    Long userId = Db.queryLong(loginSql, vo.getUsername(), vo.getPassword());
    if (userId == null) {
      return ResultVo.fail("用户名或者密码不正确");
    }
    String token = JwtUtils.createTokenByUserId(AppConstant.SECRET_KEY, userId);
    TokenManager.login(userId, token);
    return ResultVo.ok("成功", token);
  }

  public ResultVo index(Long userId) {
    String sql = String.format("select id,username,email,phone,nick_name,role from %s where id=?", TableNames.max_kb_user);
    Row row = Db.findFirst(sql, userId);
    Kv kv = row.toKv();
    List<String> permissions = Aop.get(PermissionsService.class).getPermissionsByRole(kv.getStr("role"));
    kv.set("permissions", permissions);
    return ResultVo.ok(kv);
  }

  public ResultVo logout(Long userId) {
    TokenManager.logout(userId);
    return ResultVo.ok();
  }

  public ResultVo page(Integer pageNo, Integer pageSize) {
    TableInput tableInput = new TableInput();
    tableInput.setPageNo(pageNo).setPageSize(pageSize).setColumns("id,username,email,phone,is_active,role,nick_name,create_time,update_time,source");
    TableResult<Page<Row>> tableResult = ApiTable.page(TableNames.max_kb_user, tableInput);
    Page<Row> page = tableResult.getData();
    int totalRow = page.getTotalRow();
    List<Row> list = page.getList();
    List<Kv> kvs = RecordUtils.recordsToKv(list, false);
    ResultPage<Kv> resultPage = new ResultPage<>(pageNo, pageSize, totalRow, kvs);
    return ResultVo.ok(resultPage);
  }
}

总结

本文详细介绍了 MaxKb 用户认证系统的 API 接口及其实现，包括登录、获取用户信息、获取系统配置和注销功能。通过这些接口，开发者可以有效地管理用户认证过程，确保系统的安全性和可靠性。同时，通过提供的代码示例，读者可以更深入地理解系统的内部工作机制，并在实际项目中灵活应用。

在实际应用中，建议结合具体业务需求，对现有接口进行优化和扩展，例如增加多因素认证、完善权限管理等，以进一步提升系统的安全性和用户体验。