CarEye 管理系统开发基本约定

Posted CarEye 官方博客

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了CarEye 管理系统开发基本约定相关的知识,希望对你有一定的参考价值。

CarEye 车辆管理平台迭代到了第三代,从最早的layUI+spring  升级到 VUE2+spring boot+MQ,到现在的spring boot+dubbo+Kafka

约定下基本的组件版本和开发规则很有必要

  1. 系统架构图

后端基础框架版本:

Springboot(2.3.1.RELEASE)

Dubbo(3.0.7)

Mybatis-Plus(3.5.2)

Shiro(1.4.0)

组件版本图

工具名称

组件版本

JDK版本

1.8

mysql

  5.6.40

Kafka

               3.2.1

Redis

4.0.1

mongdb

3.4

  1. 系统目录层级说明

项目层级

car-eye-common 项目公共方法包

car-eye-pojo 项目实体和model以及参数包

注:(数据库实体类和业务参数类必须严格分开,不能在实体类里面添加任务的业务参数,实体类以Entity结尾,别的业务参数类以Vo结尾,另外所有的实体类提供一个公共的继承类BaseEntity,继承类包含的参数可在项目里面查看)

car-eye-service 服务提供层

注:(因为没有分库分表所以暂时只用一个服务)

car-eye-service-api 数据访问接口

car-eye-api   应用层对外接口

car-eye-admin管理系统后台接口

car-eye-rule 规则服务器后台接口

car-eye-jt809-server jt809 809后台接口

car-eye-server  跟设备交互服务

car-eye-comm 通信网关

...

可以根据业务的不断新增不通的消费端

2. 常量枚举化

所有的常量参数不要再代码里面写死,需要把常量做成枚举形式

枚举路径如下

 

后面这个枚举作为数据字典

3. 代码开发请用idea安装阿里的代码开发规范

 安装方式如下博客:

4. IDEA工具(阿里巴巴)安装代码规范检查插件

5. swagger 开发规则

swagger对应的数据模型类名称不要取一样的,不然会造成文档错乱!

 

6. 所有的代码使用驼峰命名方式

 

以上是关于CarEye 管理系统开发基本约定的主要内容,如果未能解决你的问题,请参考以下文章

CarEye 管理系统开发基本约定

CarEye 智能云平台升级

CarEye 智能云平台升级

CarEye 智能云平台升级

Monk快速开发框架前期约定

maven 属性的约定:“点大小写”还是“驼峰大小写”?