1、规范的意义和作用
- 编码规范可以最大限度的提高团队开发的合作效率
- 编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护
- 编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码
- 规范性编码还可以让开发人员养成好的编码习惯,甚至锻炼出更加严谨的思维
2.项目结构
解释:
- controller:存放的是各请求的入口controller类;
- mapper:存放的是各个方法所用的sql的文件,一般为java类或XML文件;
- service:是承载controller方法的业务逻辑的service类,请将业务逻辑内容写在service方法中;
- model:存放的为方法里所引用到的实体类,model里还可分为:dto、vo等,dto是mapper方法里引用相关联数据的类,vo则是用于表层传输的实体对象;
- Application,启动类!springboot由于内嵌容器,因此不需要再安装tomcat等容器去启动。但是需要一个启动的入口,而这个Application正是起到这种作用;
- application.properties,项目核心配置文件,数据库连接配置、参数配置等等都靠此文件规整;
pom.xml,主要描述了项目的maven坐标,依赖关系等。
3.包规范
- 项目基本包:com.company.{项目英文名(较长时适当简化)}.{模块名(可选)}
- config:配置类
- startup:与服务启动相关的类
- client:提供客户端实现的相关类
- common:公共类,定义常量类,组件
- entity: 数据库相关的实体类
- model:数据模型类(参数模型,数据传输模型等)
- control:控制层接口
- service: 服务层
- dao:数据库访问层