README.md 4.4 KB
项目框架基础：
vue 脚手架4.5.12搭建vue2项目
基础组件：
vue 2.6.11+ElementUI2.15.1+axios0.21.1+router3.2.0
公共组件：
Echarts5.0.2 报表 Excel：vue-json-excel0.3.0 导出excel vuescroll：滚动条 等
规范：
- 目录结构说明： Api：根据需求封装的请求，公共类型，不要随意修改。 Assets：公共资源，包括图片，css文件，js文件，字体库等。 Components：公共组件，根据项目需要，如果有重复可多次使用的相同或相似的功能，分装为组件，方便重复使用。 Router：index.js主路由和子路由，所有前端会分配子路由。 Store：vuex，按需使用。 Tools：公共JS方法，如日期格式化等。通过全局变量this.BASE.使用公用的方法。如有新的需求，可以自行添加，注释一定要详细明了。 Views：所有页面。 jsonData: 前端需要的数据
- Vue文件分割开，html写在vue文件中，js写在assets/js/模块名称/.js，Scss文件写在assets/css/模块名称/.scss Vue文件引入方式：
<script>
import main from '../assets/js/main'
export default main
</script>
<style lang="sass" scoped>
@import "../assets/css/main.scss";
</style>
- 文件起名按照驼峰法命名，包括文件夹名称、文件名称、变量名称、函数名称等，尽量使用准确的英文单词命名，减少拼音使用次数。
- 引用使用尽量使用如下格式引用：
.set('@', resolve('src')) .set('@assets', resolve('src/assets')) .set('@components', resolve('src/components')) .set('@views', resolve('src/views')) .set('@store', resolve('src/store'));
例如：@import "../assets/css/main.less";改成@import "@assets/css/main.less";
- Sass语法按照官方语法写，树级结构，使用class样式，不要使用id样式。
- 代码缩进，统一为2。设置方式：文件-首选项-设置，搜索tabsize。严格按照2的缩进编写代码，提高代码美观程度。
- 代码注释，方法用途（方法的输入、输出注释），关键代码注释。
- 代码自我优化，js，css代码自行优化，用最短得代码，高效完成功能和效果。
- 资源优化，图片资源，优化后再放入项目中，选择正确的资源放置位置。
- 防止死循环。
自己的功能做完后需要自测。
接口访问，统一封装，统一通过this.API.get(url, 参数)
针对请求超过1s的接口，必须进行loading加载中提示。
防抖动。
控制台零报错，见到错误第一时间解决。
引入新的组件，前端成员共同商讨，选择合适、轻量、简单易上手的组件。
组件引入后，如果无用请卸载。
遇到技术难点，攻克时不要一把抓，什么都粘进来，弄明白每一行的用途，并注释。
后台提供可阅读的接口文档，包括接口地址、请求类型、请求参数、返回数据注释用途等。
与后台约定所有请求的基本头类型，推荐application/json，或约定一个其他类型的。
与后台约定数据格式，请求格式、返回数据的格式，code统一使用200int型。
与后台约定，message提示内容由后台编写，所有code ！==200的自动显示message内容。
Git代码统一管理，没有账号就先借用一下使用。有账号的按照自己的账号编写代码。 每天提交一次代码，如单个功能未开发完成可以在完成后提交。每周提交一次代码。 代码编写规范：先拉取最新代码-创建本地分支-开发-提交-合并分支-本地验证无误、无冲突可以push。 Git使用教程：https://www.liaoxuefeng.com/wiki/896043488029600/900003767775424
Git commit 时需要填写提交关键信息。
本次改动目标：
- 全面完成前后端分离，完成解耦。
- 统一项目全局的常用文字的字体、字号、字色。
- 基于ElementUI开发，需统一使用其按钮、表格、表单等，形成风格统一。
- 提升报表Echarts，按照最新的API实现所有报表。
- 地图建议设计更好看的地图图片，或更换百度高德等，后期讨论、调研决定。
- 设计方面，如UI时间比较紧，建议只设计登录页、框架页面、公共页出设计稿，定稿后修改。其他所有的表格表单，按照ElementUI实现。
开发工具：
Visual Studio Code V1.55.2，小版本区别没关系。
任务：
2周移植项目。