软件行业开发部开发人员代码编写规范手册.docxVIP

软件行业开发部开发人员代码编写规范手册

第1章项目结构与文件组织

1.1根目录架构与模块划分

在大型软件工程中，清晰的根目录架构是维护代码库的基石，它决定了开发效率、团队协作的顺畅度以及后期重构的便捷性。整个项目根目录通常应严格遵循单一职责原则，避免将无关的配置文件或测试代码混入业务逻辑核心区域。

根目录下应包含一个名为`src`的目录作为存放区，该目录直接位于项目根目录下，不包含任何子目录，以确保项目入口点唯一且易于发现。在`src`目录下，根据功能模块将代码划分为多个子文件夹，例如`api`,`domain`,`entity`,`service`,`controller`等，每个子目录代表一个独立的业务逻辑层或技术组件。

每个业务模块下必须建立`main.java`或`entrypoint.sh`文件，该文件作为模块的启动入口，负责加载依赖、初始化配置并调用具体的业务方法，确保模块具备完整的上下文环境。模块内部应严格遵循“单一职责”原则，将相关的Controller、Service、Repository或DTO封装在独立的类包中，严禁将多个功能混合在同一个类内，以保持代码的可读性和可维护性。所有接口定义必须位于`api`目录下，而具体的业务实现逻辑应位于`domain`或`service`目录下，形成“接口在前，