PigX Server 后端开发 Skill#

PigX 企业级微服务平台开发指南 - Spring Cloud Alibaba + Java 17

项目信息#

属性值Java 版本Java 17Spring Boot3.5.9Spring Cloud2025.0.1Spring Cloud Alibaba2023.0.3.3AI/MLLangChain4j 1.6.0, Spring AI 1.0.2数据库MySQL + PostgreSQL (pgvector)ORMMyBatis-Plus服务发现Nacos构建工具Maven版本5.11.0

本地项目路径#

text

D:\WorkSpace\my_workspace\lhb\lhb-server

官方文档#

• 文档入口: https://docs.pig4cloud.com（需要微信扫码登录）

---

常用命令#

bash

# 构建项目（微服务模式）
mvn clean install

# 构建单体模式
mvn clean install -P boot

# 构建指定模块
mvn clean install -pl pigx-knowledge

# 跳过测试
mvn clean install -DskipTests

# 格式化代码
mvn spring-javaformat:apply

# 运行单体模式
cd pigx-boot && mvn spring-boot:run

---

项目结构#

text

lhb-server/
├── pigx-boot/           # 单体部署启动器
├── pigx-auth/           # 认证模块
├── pigx-upms/           # 用户权限管理模块
├── pigx-gateway/        # API 网关
├── pigx-register/       # Nacos 注册中心
├── pigx-visual/         # 可视化管理模块
├── pigx-common/         # 公共模块
├── db/                  # 数据库初始化脚本
└── docker-compose.yml   # Docker 编排配置

---

公共模块说明#

模块功能pigx-common-bom依赖版本管理pigx-common-core核心工具类pigx-common-security安全认证pigx-common-oss对象存储pigx-common-excelExcel 处理pigx-common-feignFeign 远程调用pigx-common-gateway网关配置pigx-common-job定时任务pigx-common-log日志处理pigx-common-swaggerAPI 文档pigx-common-websocketWebSocket 支持pigx-common-seata分布式事务pigx-common-sentinel限流熔断

---

核心开发规范#

1. 包命名规范#

类型命名规则示例Controller后缀 Controller``AiDatasetControllerService 接口无后缀EmbeddingStoreServiceService 实现后缀 Impl``EmbeddingStoreServiceImplMapper后缀 Mapper``AiDatasetMapperEntity后缀 Entity``AiDatasetEntityDTO后缀 DTO``AiMultimodalEmbeddingArkDTOEnum后缀 Enums``EmbedBizTypeEnums

2. Controller 示例#

java

@RestController
@RequestMapping("/xxx")
@RequiredArgsConstructor
public class XxxController {

    private final XxxService xxxService;

    @GetMapping("/page")
    public R<IPage<XxxEntity>> page(Page page, XxxEntity entity) {
        return R.ok(xxxService.page(page, entity));
    }

    @PostMapping
    public R<Boolean> save(@RequestBody XxxEntity entity) {
        return R.ok(xxxService.save(entity));
    }

    @DeleteMapping("/{id}")
    public R<Boolean> deleteById(@PathVariable Long id) {
        return R.ok(xxxService.removeById(id));
    }
}

3. Service 示例#

java

public interface XxxService extends IService<XxxEntity> {}

@Service
@RequiredArgsConstructor
public class XxxServiceImpl implements XxxService {
    private final XxxMapper xxxMapper;

    @Override
    public IPage<XxxEntity> page(Page page, XxxEntity entity) {
        return xxxMapper.selectPage(page, entity);
    }
}

4. Entity 示例#

java

@Data
@TableName("xxx_table")
public class XxxEntity implements Serializable {
    @TableId(type = IdType.ASSIGN_ID)
    private Long id;
    private String name;
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createTime;
}

---

AI/RAG 开发#

向量存储工厂模式#

java

@Component
public class QdrantEmbeddingStoreFactory implements EmbeddingStoreFactory {
    @Override
    public boolean support(String storeType) {
        return "QDRANT".equals(storeType);
    }

    @Override
    public EmbeddingStore createEmbeddingStore(EmbedStoreEntity store, DatasetEntity dataset) {
        // 创建向量存储实例
    }
}

支持的向量存储#

Qdrant、Milvus、Chroma、PGVector、Neo4j

---

数据库配置#

yaml

spring:
  datasource:
    url: jdbc:postgresql://localhost:5432/pigxx_boot
    username: postgres
    password: postgres
  redis:
    host: 127.0.0.1
    database: 5
  cloud:
    nacos:
      server-addr: pigx-register:8848

---

注意事项#

1. 代码格式化：提交前运行 mvn spring-javaformat:apply
2. 安全配置：配置文件已加密，密码为 pigx
3. Git 分支：主分支 dev
4. 版本：Java 17+，Spring Boot 3.5.9

---

参考文档#

• Spring Cloud Alibaba: https://sca.aliyun.com
• MyBatis-Plus: https://baomidou.com
• LangChain4j: https://docs.langchain4j.dev

参考资料#

更多后端文档请参考 references/ 目录下的文档文件。