赣州市智悦科技Java项目MVC开发规范V1.11详解

需积分: 0 0 下载量 77 浏览量 更新于2024-08-04 收藏 26KB DOCX 举报
赣州智悦科技有限公司的Java项目开发规范V1.11是一个内部开发指南,旨在提升团队协作效率和代码质量。该规范建立在阿里巴巴Java开发手册v1.3.0的基础之上,并针对公司特定情况进行调整。以下是一些关键知识点: 1. **项目结构**: - 项目包定义遵循统一的标准,所有公司内部产品使用`top.zywork`作为前缀,如`top.zywork.controller`用于存放控制器层类。 - 非公司内部产品在客户有要求时可能会保留此前缀,但通常不强制。 2. **MVC架构**: - 坚持MVC(Model-View-Controller)设计模式,将应用程序划分为清晰的层次: - **控制器层**:主要负责处理用户请求,类名后缀为`Controller`,如`top.zywork.controller`. - **服务层接口**:封装业务逻辑,接口以`Service`为后缀,如`top.zywork.service`。 - **服务层实现类**:提供具体业务实现,后缀为`ServiceImpl`,如`top.zywork.service.impl`。 - **通用业务管理类**:用于执行复杂的业务操作,类名后缀为`Manager`,如`top.zywork.manager`。 - **DAO层**:数据访问对象,接口后缀可以是`DAO`或`Mapper`(结合MyBatis)。 - 实现类后缀为`DAOImpl`,或在MyBatis中无实现类。 - **数据对象类** (`DO`):封装数据源对象,后缀为`DO`,位于`top.zywork.dos`。 - **数据传输对象类** (`DTO`):用于服务层与外部交互的数据载体,后缀为`DTO`,在`top.zywork.dto`。 - **值对象类** (`VO`):向视图层传递数据的简单对象,后缀为`VO`,在`top.zywork.vo`。 - **数据查询对象** (`Query`):接收并处理查询请求,后缀为`Query`,例如`top.zywork.query`。 - **通用工具类**:包含辅助方法和工具函数,后缀为`Utils`,在`top.zywork.common`。 - **常量类**:存储常量定义,后缀为`Constants`,在`top.zywork.constant`。 - **枚举类**:用于定义可枚举的值,后缀为`Enum`,在`top.zywork.enums`。 - **过滤器类**:处理请求的预处理或后处理逻辑,后缀为`Filter`,在`top.zywork.filter`。 3. **目标与原则**: - 提升代码可读性和可维护性,减少代码耦合。 - 通过明确的命名约定和组织结构,简化团队间的沟通和协作。 - 遵循阿里巴巴Java开发手册的原则,避免重复已有规则。 遵循这些开发规范有助于保持项目的一致性和高效性,使得团队成员能够更好地理解和协作开发Java项目。