public/技术规范/系统开发配置规范.md

56 lines
2.1 KiB
Markdown
Raw Normal View History

2022-04-18 11:09:51 +08:00
# 系统设计管理规范
> 拟稿:技术组
>
> <div><span>版本号 1.0.0 </span></div>
>
## 目录
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
- [Java后端开发规范](#java%E5%90%8E%E7%AB%AF%E5%BC%80%E5%8F%91%E8%A7%84%E8%8C%83)
- [前言](#%E5%89%8D%E8%A8%80)
- [系统设计](#%E7%B3%BB%E7%BB%9F%E8%AE%BE%E8%AE%A1)
- [附件的存储](#%E9%99%84%E4%BB%B6%E7%9A%84%E5%AD%98%E5%82%A8)
- [环境变量配置](#%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E9%85%8D%E7%BD%AE)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## 前言
本文的规范和建议都是经过大量的实际项目场景总结出来的规范,,规范分如下两级:
- ![强制](D:/chinaweal-code/public/img/icon/强制.png) :开发者必须遵循的开发规范要求
- ![推荐](D:/chinaweal-code/public/img/icon/推荐.png) :开发者选择性遵循的开发规范要求
## 系统设计
### 附件的存储
- ![强制](../img/icon/强制.png) 业务过程中产生的附件,存放的目录结构如下:
物理路径:`{父目录}/{业务模块}/{日期yyyyddmm}/{业务号}/{文件名}`
数据库记录路径:`{业务模块}/{日期}/{业务号}/{文件名}`
其中父目录可以通过后台动态配置指定。
> ![正例](../img/icon/正例.png)
>
> 物理路径D:/file/food/20220417/4401061060520121/cf053a26469043f9a4cd8ebb41354b48.jpg
>
> 数据库记录路径food/20220417/4401061060520121/cf053a26469043f9a4cd8ebb41354b48.jpg
> ![反例](../img/icon/反例.png)
>
> 物理路径D:/file/cf053a26469043f9a4cd8ebb41354b48.jpg
>
> 数据库记录路径cf053a26469043f9a4cd8ebb41354b48.jpg
### 环境变量配置
- ![强制](../img/icon/强制.png) 针对生产、测试、培训不同的系统运行环境,需要建立对应配置文件存在,防止测试环境使用正式环境的接口。
> ![正例](../img/icon/正例.png) application.yml、application-dev.yml、application-prod237.yml
> ![反例](../img/icon/反例.png) application.yml