首页 > 编程知识 正文

命名规则,springboot是什么框架

时间:2023-05-05 12:48:31 阅读:114241 作者:2861

SpringBoot项目目录结构

Java SpringBoot的学习应该是全方位的,但是写这个博客的契机是因为一个小插曲。 最初给方案下的数据库命名的时候,当然我想数据库的名字叫file,然后被同学们纠正了。 仔细检查后,发现SpringBoot项目的目录结构具有命名约定,编码和命名反映了相应模块的功能。

一、规范的意义和作用

编码规范可以最大限度地提高团队开发的合作效率,编码规范可以最大限度地降低软件维护成本。 另外,几乎没有软件。 在整个生命周期中,第一个开发人员保持编码规范可以提高软件的可读性,使开发人员能够尽快全面理解新的代码规范化代码,从而使开发人员养成良好的编码习惯,甚至更好

(一)公共组件

通用组件通常是指Java库,它提供软件包通用组件仓库地址以解决特定问题。 https://git.com pany.com/Java-library-group通用组件的坐标命名约定分组编号: com.company.library固定值组件名称:基于名称组件名称

服务组件通常是指可以独立部署、运行和维护的服务包服务组件的仓库地址。 https://git.com pany.com/server-micro service-group APP应用程序组件的坐标命名约定组编号: com.company.server固定值组件名称: name

开发环境: JDK1.7开发工具: intellijidea2017(Lombokplugin安装)构建工具: Maven3.x代码管理工具: Git /TortoiseGit四、项目结构规范

(一)概述

项目对应于代码仓库中的仓库,而项目结构是基于Maven创建的项目目录结构。 通用组件项目。 通常会创建Maven通用项目。 服务组件项目通常创建Maven聚合项目,并在聚合项目目录下创建多个Maven模块,以继承充当服务组件项目一部分的Maven聚合项目。

(二)项目名称

中文名称必须是英文名称、仓库、项目、项目根和组件(公共组件、服务组件)的名称。用于描述代码仓库的项目名称和代码仓库的名称匹配。 项目名称的定义通常由团队负责人确定示例项目的名称。 人脸数据仓库项目英文名: data-warehouse-face项目目录名称: data-warehouse-face项目仓库地址: https://git.com pany.com//初始版本的数据仓库- face.git:1.0.0示例是服务组件,根据上面定义的信息确定服务组件的Maven坐标名称: com.company.server

需要样本模块名称。 {项目名称}-{模块名称}模块名称角色模块名称为模块组件名称的脸部数据仓库数据访问模块名称的简短表示。 数据仓库-面访问(四)项目目录

项目目录遵循Maven规则目录格式(五)源代码目录

什么是源目录{项目目录}/src/main/包定义目录: src/main/assembly代码目录: src/main/java资源目录: src docs冷静手套run-manage.sh执行管理脚本(在参数start、stop、status和help info控制程序中执行) sh :服务组件启动脚本sh :服务组件

(一)箱包规格

项目基本包: com.company.{项目英文名(如果长则酌情简化) }.{模块名(可选) }config :配置类startup :与服务启动相关的类client 组件entity333333数据传输模型等)控制:控制层接口service:服务层dao :数据库访问层(2)日志记录

SLF4j接口的统一使用(3)异常处理

运行时异常(通过参数检查等避免或抛出运行时异常,日志记录检查异常)检查异常需要捕获、处理、日志记录)四)接口定义

接口地址定义是有意接口地址定义明确、简洁、无歧义的具有相同服务组件接口定义一致格式控制类的顶级地址格式:/{顶级类名} 例如,/librarypersonallibrary相关接口的顶级地址接口定义使用Swagger的API注释说明来标记完整的请求信息,以及请求方法、请求地址和参数选项

RequestBody(JSON格式)POST Mulitpart 响应方式 统一的响应模型

(五)辅助工具

字符串处理:apache common-lang3时间日期处理:joda-timeJSON处理:Gson,Fastjson集合扩展工具:guava文件和流处理:commons-io编解码:commons-codec建议:尽可能使用开源组件

(六)代码注释

类、接口、枚举顶层注释接口方法注释静态方法注释公开方法注释类的属性字段注释常量注释不限于以上

六、代码控制规范

(一)拉取原则

强制 每日开始工作拉取 约定 提交之前拉取

(二)提交原则

强制 提交代码必须构建成功(比如:编译,打包成共)提交代码必须完整(比如:少提文件)提交代码必须忽略到本地临时文件(比如:target, logs, .idea, *.iml,dist 等) 约定 完成一个功能提交修改一个Bug修改提交解决冲突提交每日结束工作提交

(三)提交注释

强制 中文填写注释注释反映本次提交变更情况 约定 注释描述添加前缀,前缀如下[创建] 通常在项目创建时使用[新增][修改][删除][修复-number] 修复Bug使用,number是Bug编号

七、构建规范

(一)公共组件构建规范

构建输出组件包构建输出组件源码包构建发布到公司私有仓库

(二)服务组件构建规范

服务组件包命名:{组件名称}-{版本号}-冷静的手套.zip构建输出到工程根目录下的dist/{组件名称}-{yyyyMMddHH}目录

版权声明:该文观点仅代表作者本人。处理文章:请发送邮件至 三1五14八八95#扣扣.com 举报,一经查实,本站将立刻删除。