架构#

Maven#

项目依赖管理，基于pom——project object model(项目对象模型)，可以理解为依赖配置

1. 聚合项目的pom

   使用SpringBoot对SpringFramework的相关依赖进行管理

   1
   <parent>
   2
       <groupId>org.springframework.boot</groupId>
   3
       <artifactId>spring-boot-starter-parent</artifactId>
   4
       <version>4.0.0</version>
   5
   </parent>

   SpringBoot未将SpringAI的依赖纳入管理，故需要导入bom的pom的<dependencyManagement>来对其进行管理

   1
   <dependencyManagement>
   2
       <dependencies>
   3
           <dependency>
   4
               <groupId>org.springframework.ai</groupId>
   5
               <artifactId>spring-ai-bom</artifactId>
   6
               <version>2.0.0</version>
   7
               <type>pom</type>
   8
               <scope>import</scope>
   9
           </dependency>
   10
       </dependencies>
   11
   </dependencyManagement>

2. 通用类的pom

   加个lombok即可

   1
   <dependency>
   2
       <groupId>org.projectlombok</groupId>
   3
       <artifactId>lombok</artifactId>
   4
   </dependency>

3. 平凡Java对象的pom

   1
   <dependencies>
   2
       <!-- Spring -->
   3
       <dependency>
   4
           <groupId>org.springframework.boot</groupId>
   5
           <artifactId>spring-boot-starter-validation</artifactId>
   6
       </dependency>
   7
   
   8
       <!-- common依赖 -->
   9
       <dependency>
   10
           <groupId>com.ethercraft</groupId>
   11
           <artifactId>oxygen-common</artifactId>
   12
           <version>1.0-SNAPSHOT</version>
   13
           <scope>compile</scope>
   14
       </dependency>
   15
   
   16
       <!-- 第三方依赖 -->
   17
       <dependency>
   18
           <groupId>org.projectlombok</groupId>
   19
           <artifactId>lombok</artifactId>
   20
       </dependency>
   21
   </dependencies>

   展开收起

   即可

4. server的pom

   1
   <dependencies>
   2
       <!-- 其余子模块 -->
   3
       <dependency>
   4
           <groupId>com.ethercraft</groupId>
   5
           <artifactId>oxygen-common</artifactId>
   6
           <version>1.0-SNAPSHOT</version>
   7
           <scope>compile</scope>
   8
       </dependency>
   9
       <dependency>
   10
           <groupId>com.ethercraft</groupId>
   11
           <artifactId>oxygen-pojo</artifactId>
   12
           <version>1.0-SNAPSHOT</version>
   13
           <scope>compile</scope>
   14
       </dependency>
   15
   
   16
       <!-- 第三方依赖 -->
   17
       <!-- Spring -->
   18
       <dependency><!-- spring-starter-webmvc -->
   19
           <groupId>org.springframework.boot</groupId>
   20
           <artifactId>spring-boot-starter-webmvc</artifactId>
   21
       </dependency>
   22
       <dependency><!-- HTTP 客户端 -->
   23
           <groupId>org.springframework.boot</groupId>
   24
           <artifactId>spring-boot-starter-restclient</artifactId>
   25
       </dependency>
   26
       <dependency><!-- BCrypt加密 -->
   27
           <groupId>org.springframework.security</groupId>
   28
           <artifactId>spring-security-crypto</artifactId>
   29
       </dependency>
   30
       <dependency><!-- 参数校验 -->
   31
           <groupId>org.springframework.boot</groupId>
   32
           <artifactId>spring-boot-starter-validation</artifactId>
   33
       </dependency>
   34
       <dependency><!-- Redis -->
   35
           <groupId>org.springframework.boot</groupId>
   36
           <artifactId>spring-boot-starter-data-redis</artifactId>
   37
       </dependency>
   38
       <dependency><!-- Security -->
   39
           <groupId>org.springframework.boot</groupId>
   40
           <artifactId>spring-boot-starter-security</artifactId>
   41
       </dependency>
   42
       <dependency><!-- Ollama -->
   43
           <groupId>org.springframework.ai</groupId>
   44
           <artifactId>spring-ai-starter-model-ollama</artifactId>
   45
       </dependency>
   46
       <dependency><!-- RAG Advisor -->
   47
           <groupId>org.springframework.ai</groupId>
   48
           <artifactId>spring-ai-vector-store-advisor</artifactId>
   49
       </dependency>
   50
       <dependency><!-- RAG -->
   51
           <groupId>org.springframework.ai</groupId>
   52
           <artifactId>spring-ai-rag</artifactId>
   53
       </dependency>
   54
       <dependency><!-- Qdrant 向量数据库 -->
   55
           <groupId>org.springframework.ai</groupId>
   56
           <artifactId>spring-ai-starter-vector-store-qdrant</artifactId>
   57
       </dependency>
   58
       <dependency><!-- 文档解析 -->
   59
           <groupId>org.springframework.ai</groupId>
   60
           <artifactId>spring-ai-tika-document-reader</artifactId>
   61
       </dependency>
   62
       <dependency><!-- Testcontainers -->
   63
           <groupId>org.springframework.ai</groupId>
   64
           <artifactId>spring-ai-spring-boot-testcontainers</artifactId>
   65
       </dependency>
   66
   
   67
       <!-- MySQL -->
   68
       <dependency>
   69
           <groupId>org.mybatis.spring.boot</groupId>
   70
           <artifactId>mybatis-spring-boot-starter</artifactId>
   71
           <version>4.0.1</version>
   72
       </dependency>
   73
       <dependency>
   74
           <groupId>com.mysql</groupId>
   75
           <artifactId>mysql-connector-j</artifactId>
   76
       </dependency>
   77
   
   78
       <!-- JWT -->
   79
       <dependency>
   80
           <groupId>io.jsonwebtoken</groupId>
   81
           <artifactId>jjwt-api</artifactId>
   82
           <version>0.12.7</version>
   83
       </dependency>
   84
       <dependency>
   85
           <groupId>io.jsonwebtoken</groupId>
   86
           <artifactId>jjwt-impl</artifactId>
   87
           <version>0.12.7</version>
   88
           <scope>runtime</scope>
   89
       </dependency>
   90
       <dependency>
   91
           <groupId>io.jsonwebtoken</groupId>
   92
           <artifactId>jjwt-jackson</artifactId>
   93
           <version>0.12.7</version>
   94
           <scope>runtime</scope>
   95
       </dependency>
   96
   
   97
       <!-- 接口文档生成 -->
   98
       <dependency>
   99
           <groupId>org.springdoc</groupId>
   100
           <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
   101
           <version>3.0.3</version>
   102
       </dependency>
   103
   
   104
       <!-- OSS -->
   105
       <dependency>
   106
           <groupId>com.aliyun.oss</groupId>
   107
           <artifactId>aliyun-sdk-oss</artifactId>
   108
           <version>3.17.4</version>
   109
       </dependency>
   110
   
   111
       <!-- other -->
   112
       <dependency>
   113
           <groupId>org.projectlombok</groupId>
   114
           <artifactId>lombok</artifactId>
   115
           <scope>provided</scope>
   116
       </dependency>
   117
       <dependency>
   118
           <groupId>com.github.pagehelper</groupId>
   119
           <artifactId>pagehelper-spring-boot-starter</artifactId>
   120
           <version>4.0.0</version>
   121
       </dependency>
   122
   
   123
   </dependencies>

   展开收起

统一响应类#

1
package com.ethercraft.result;
2

3
import com.ethercraft.constant.ResultStatus;
4
import lombok.AllArgsConstructor;
5
import lombok.Getter;
6

7
@AllArgsConstructor
8
@Getter
9
public class Result<T> {
10
    private final int code;
11
    private final String message;
12
    private final T data;
13

14
    public static <T> Result<T> success(T data) {
15
        return new Result<>(ResultStatus.SUCCESS, "Success", data);
16
    }
17

18
    public static Result<Void> success() {
19
        return new Result<>(ResultStatus.SUCCESS, "Success", null);
20
    }
21

22
    public static Result<Void> fail() {
23
        return new Result<>(ResultStatus.FAIL, "Fail", null);
24
    }
25
}