vue开发规范

126 阅读2分钟

1.命名规范

组件名字:组件大写开头,驼峰
组件内部组件引入名字:沿用组件本身大小写名字
    例如  AppNav-->AppNav   不要改app-nav。 新的规范已经不推荐这种写法
文件夹命名:小写开头,驼峰
js命名:小写开头驼峰
不要出现名字后面加一个数字,多个类似组件的问题。
路由名字:全小写,多单词中划线-  例如app-nav

2.引用路径规范

引用公共模块统一用@开头的绝对路径
引用私有代码可以用相对路径也可用绝对路径

3.工具函数书写规范

目前项目里面utils/tool.js是一个工具函数文件。小工具函数统一写进去,不要单独建文件。

4.过滤器的使用

一般的字段翻译有可能出现多次的使用过滤器来处理,减少冗余代码。过滤器在filters/index.js里面

5.代码里面接口使用

不要把api路径直接写在组件里面。通过在api下面建一个业务名字同名的api,封装导出之后,在组件引入。这样结构清晰,也符合现代化规范。
引入的api名字建议大写开头,可以很好识别是api函数。

6.不要滥用本地存储

组件传参除了个别特殊情况不要使用本地存储传参。本地存储是监控不到的。

7.权限控制问题

在partyaffirs里面有个permission指令,权限控制建议用自定义指令。后面会集成到后端,

8.开发习惯

所有人都要用eslint,要对代码格式化
app端性能较弱。大家写代码要注意性能影响。不要一次太多加载冗余接口,例如tab下面多个接口的
控制

9.环境变量配置

环境变量关于路径的配置,只配置相对路径,不要配置ip地址

10.请求的异常处理

所有的弹窗都在axios的封装里面集中处理,不要在业务里面加弹窗,如果需要捕获异常,处理业务,直接处理业务即可

11.关于微服务和iframe的使用

两种各有优劣,简单概括,
iframe:使用简单,性能较弱,不善于处理主应用控制子应用页面跳转等场景
微服务(qiankun):使用成本高,集成子应用后本质上还是spa应用,性能更好,适用于复杂场景。
所以,选取的时候按需要,不要一味的追求挑战,合适的是最好的。