PigX Server 后端开发 Skill

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

项目信息

本地项目路径

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

官方文档

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

常用命令

# 构建项目（微服务模式）
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

项目结构

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

公共模块说明

核心开发规范

1. 包命名规范

2. Controller 示例

@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 示例

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 示例

@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 开发

向量存储工厂模式

@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

数据库配置

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/ 目录下的文档文件。