Java应用开发规范详解

需积分: 10 1 下载量 197 浏览量 更新于2024-07-10 收藏 3.17MB DOC 举报
"java应用开发规范说明-v1.3.20201217.doc" 这份文档是关于Java应用开发的规范说明,主要目的是为了统一公司的Java端研发流程和标准,确保代码质量和团队协作效率。文档内容涵盖代码规范、应用说明、系统配置以及研发技术等多个方面。 1. **Java应用开发规范概述** - 目的:制定这份规范的目的是为了规范化公司的Java开发流程,提高代码质量,减少由于不一致的编码习惯导致的问题。 - 概述:文档可能包含对整体开发流程的简要介绍,但具体的概述信息在提供的内容中未提及。 2. **代码规范** - 开发目录-包名说明:根据业务需求,文档提到了两种工程结构。例如,包名通常按照“com.frame”这样的结构组织,其中`frame`代表大模块,`sys`表示子模块。进一步细化,有`dao`、`service`、`impl`、`pojo`、`controller`等子包,分别用于接口、实现、业务逻辑、数据实体和对外接口。 - 文件命名规则:文件命名规则可能遵循一定的约定,比如区分大小写,明确文件类型等,但具体规则未详细说明。 - 特殊说明:枚举的定义允许使用中文,这可能是为了增强代码的可读性。 3. **应用说明** - 系统编码:这部分可能涉及字符集的选择和编码规范。 - 系统微服务端口范围:规定了微服务运行时使用的端口范围,以避免端口冲突。 - 公用Redis数据库索引:说明了如何管理和使用共享的Redis数据库。 - 系统工具类:提供了系统级别的工具类的使用说明。 - 微服务研发规范:详细描述了如何配置和管理微服务,包括hosts配置、Eclipse和Maven的使用、微服务项目的创建、test模块的创建、业务接口的测试等。 - 微服务配置文件:涵盖了各种配置项,如Redis、数据源、Mybatis、脚本更新、获取系统配置文件值和线程池的配置方法。 4. **研发技术** - Mybatis的常用语法:提供了Mybatis框架的使用指南。 - cjhx-system说明:可能是一个特定系统的详细说明,未提供具体信息。 - Eclipse启动读取指定配置文件:指导开发者如何配置Eclipse使其在启动时使用特定的配置文件。 - 前后端对接说明:解释了前端与后端交互的规范和流程。 - Dblink使用说明:Dblink通常是数据库链接工具,用于数据库之间的连接和数据操作。 这份文档为Java应用开发提供了一个全面的指南,涵盖了从代码组织到系统配置的各个方面,对于新加入的开发者或者团队内部的代码审查都有重要的参考价值。遵循这些规范,可以有效地提高代码质量和团队合作效率。