【前端开发必备小技巧】前端代码规范Vue篇

最新推荐文章于 2024-09-02 12:54:06 发布
最新推荐文章于 2024-09-02 12:54:06 发布
阅读量1.2k 收藏 17
点赞数 27
文章标签： 前端 代码规范 vue.js
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/stc_ljc/article/details/141753638
版权

文章目录

🟢 前端代码规范

规范的目的是为了编写高质量的代码，让你的团队成员每天得心情都是愉悦的，大家在一起是快乐的。
引自《阿里规约》的开头片段:
…现代软件架构的复杂性需要协同开发完成，如何高效地协同呢?无规矩不成方圆，无规范难以协同，比如，制订交通法规表面上是要限制行车权，实际上是保障公众的人身安全，试想如果没有限速，没有红绿灯，谁还敢上路行驶。对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率，降低沟通成本。代码的字里行间流淌的是软件系统的血液，质量的提升是尽可能少踩坑，杜绝踩重复的坑，切实提升系统稳定性，码出质量。

🟢 一、前端代码规范Vue篇

在这里插入图片描述

👉1、Vue编码基础

Vue 项目规范以 Vue 官方规范https://v2.cn.vuejs.org/v2/style-guide/中的A规范为基础，在其上面进行项目开发，故所有代码均遵守该规范。

请仔仔细细阅读 Vue官方规范，切记，此为第一步。

👉1.1、组件规范
  1. 组件名为多个单词
    组件名应该始终是多个单词组成(大于等于 2)，且命名规范为KebabCase格式。
    这样做可以避免跟现有的以及未来的 HTML 元素相冲突，因为所有的 HTML 元素名称都是单个单词的。

正例:

export default {
  name: 'TodoItem',
  // ...
}

反例:

export default {
  name: 'Todo',
  // ...
}
export default {
  name: 'todo-item',
  // ...
}
  1. 组件文件名为 pascal-case 格式

正例:

components/
|- my-component.vue

反例:

components/
|- myCoaponent.vue
|- MyCoaponent.vue
  1. 基础组件文件名为 base 开头，使用完整单词而不是缩写

正例:

components/
|-base-button.vue
|-base-table.vue
|-base-icon.vue

反例:

components/
|- MySutton.vue
|- VueTable.vue
|- Icon.vue
  1. 和父组件紧密属合的子组件应该以父组件名作为前缀命名

正例:

components/
|- todo-list.vue
|- todo-list-item.vue
|- todo-list-item-button.vue
|- user-profi1e-options.vue(完整单词)

反例:

components/
|- TodoList.vue
|- TodoItem. vue
|- TodoButton.vue
|- UProfopts.vue(使用了缩写)
  1. 在Template 模版中使用组件，应使用 PascalCase 模式，并且使用自闭合组件。

正例:

<1--在单文件组件、字符串模板和JSX中-->
<myComponent />
<Rom><table :colum="data"/></Rom>

反例:

<my-component /><row><table :column="data"/></row>
  1. 组件的 data 必须是一个函致
    当在组件中使用 data 属性的时候 (除了 new Vue 外的任何地方)，它的值必须是返回一个对象的函数。 因为如果直按是一个对象的话，子组件之间的属性值会互相影响，

正例:

export default {
  name: 'App',
  data(){
    return{
      title:'我是一个标题',
    }
  },
}

反例:

export default {
  name: 'App',
  data:{
    title:'我是一个标题',
  },
}
  1. Prop 定义应该尽量详细
    • 必须使用 camelCase 驼峰命名
    • 必须指定类型
    • 必须加上注释，表明其含义
    • 必须加上 required 或者 default，两者二选其一
    • 如果有业务需要，必须加上 validator 验证

正例:

export default {
  name: "HelloWorld",
  props: {
    //组件状态，用于控制组件的颜色
    status: {
      type: String,
      required: true,
      validator: function (value) {
        return ["succ", "info", "error"].indexof(value) !== -1;
      },
    },
    // 用户级别，用于显示皇冠个效
    userLevel: {
      type: String,
      required: true,
    },
  },
};
  1. 为组件样式设置作用域

正例:

<template>
  <div class="hello">
      HelloWorld
  </div>
</template>
<!-- Add "scoped" attribute to limit CSS to this component only -->
<style scoped>
.hello {
  color: white;
  font-size: 22px;
  margin: 10px 0 0;
}
</style>

反例:

<template>
  <div class="hello">
      HelloWorld
  </div>
</template>
<!-- 没有scoped 特性-->
<style >
.hello {
  color: white;
  font-size: 22px;
  margin: 10px 0 0;
}
</style>
  1. 如果特性元素较多，应该主动换行

正例:

      <MyComponent 
        foo="a" 
        bar="b" 
        baz="c">
      </MyComponent>

反例:

     <MyComponent foo="a" bar="b" baz="c"></MyComponent>
👉1.2、模板中使用简单的表达式

组件模板应该只包含简单的表达式，复杂的表达式则应该重构为计算属性或方法。复杂表达式会让你的模极变得不那么声明式。我们应该尽量描述应该出现的是什么，而非如何计算那个值。而且计算属性和方法使得代码可以重用。
正例:

<template>
  <div >
    {{ normalizedFullName }}
  </div>
</template>

<script>
export default {
  name: "HelloWorld",
  computed:{
    normalizedFullName:function(){
      return this.fullName.split(' ').map((word)=>{
        return word[0].toUpperCase()+word.split(1)
      }).join(' ')
    }
  }
};
</script>

反例:

<template>
  <div >
    {{ fullName.split(' ').map((word)=>{
        return word[0].toUpperCase()+word.split(1)
      }).join(' ')}}
  </div>
</template>
👉1.3、指令都使用缩写形式

指令推荐都使用缩写形式，(用 : 表示v·bind: ，用 @ 表示 v-on， 用#表示 v-slot:)
正例:

   <input
   @input="onInput"
   @focus="onFocus">

反例:

   <input
  v-on:input="onInput"
   @focus="onFocus">
👉1.4、 标签顺序保持一致

单文件组件应该总是让标签顺序保持为
正例:

<template>

</template>

<script>

</script>

<style scoped>

</style>

反例:

<template>

</template>

<style scoped>

</style>

<script>

</script>
👉1.5、必须为 v-for 设置键值 key
👉1.6、v-show 与 v-if 选择

如果运行时，需要非常颜繁地切换，使用v·show;如果在运行时，条件很少改变，使用v-if。

👉1.7、script 标签内部结构顺序

components>props>data>compued>watch>filter>钩子函数(钩子函数按其执行顺序)>methods

👉1.8、Vue Router 规范
  1. 页面跳转数据传递使用路由参数
    页面跳转，例如A页面跳转到B页面，需要将A页面的数据传递到B页面，推使用路由参数进行传参，而不是将需要传递的数据保存 vuex，然后在 B页面取出 vuex的数据，因为如果在 B页面刚新会导致 vuex 数据丢失
    正例:
let id='1113'
this.$router.push({name:'userDetail',
	query:{
 	 id:id
	}
})
  1. 使用路由懒加载(延迟加载)机制
{
    path: "/Login",
    name: "Login",
    // 登录页
    component: () => import('@/components/Login/Login.vue'),
},

3.router 中的命名规范
path、childrenPoints命名规范采用kebab-case命名规范(尽量vue文件的目录结构保持一致，因为目录、文件名都是kebab-case，这样很方便找到对应的文件)

 {
        path:'/system/system-list',
        // 系统列表
        name:'SystemList',
        component:()=>import('../components/system/system-list.vue')
    }

4.router 中的 path 命名规范
path除了采用kebab-case命名规范以外，必须以/开头，即使是children里的path也要以/开头。如下示例
目的:
经常有这样的场景:某个页面有问题，要立刻找到这个文件，如果不用以/开头，path为parent和children组成的，可能经常需要在router文件里搜索多次才能找到，而如用以/开头，则能立刻搜索到对应的组件

{
    path: '/',
    // 首页
    name: 'home',
    component: () => import('../components/home/home.vue'),
    redirect: '/panel',
    // 重定向到看板页
    children:[
        {
            path:'/panel',
            // 大屏面板
            name:'Panel',
            component:()=>import('../components/panel/panel.vue'),
            meta: {
                bg: 'bg'
            },
            // 背景图
        },
        {
        path:'/system',
        // 系统设置
        name:'System',
        component:()=>import('../components/system/system.vue')
    }]
}

👉2、Vue 项目目录规范

👉2.1、基础

vue 项目中的所有命名一定要与后端命名统一。
比如权限:后端 privilege,前端无论 router,store,api等都必须使用 privielege 单词!

👉2.2、使用 Vue-cli 脚手架

使用 vue·cli3 来初始化项目，项目名按照上面的命名规范

👉2.3、 目录说明

目录名按照上面的命名规范，其中components 组件用大写驼峰，其余除components 组件目录外的所有目录均便用 kebab-case 合名。

src源码目录

 |-- api 				所有api接口
 |-- assets 			静志资源，images，icons，styles等
 |-- components			公用组件
 |-- config				配置信息
 |-- constants			常量信息，项目所有Enun，全局常量等
 |-- directives			自定义指令
 |-- filters			过滤器，全局工具
 |-- datas				模拟教据，临时存放
 |-- lib				外部引用的插件存放及修改文件
 |-- mock				模拟接口，临时存放
 |-- plugins			插件，全局使用
 |-- router				路由，统一管理
 |-- store				vuex，统一管理
 |-- themes				自定义样式主题
 |-- views				视图目录
 |  |-- role				role模块名
 |  |-- role-list.vue		role列表页面
 |  |-- role-add. vue		role新建页面
 |  |-- role-update.vue		role更新页面
 |  |-- index.less			role模块样式
 |  |-- components			role模块通用组件文件夹
 |  |-- employee			employee模块

1. api 目录

  • 文件、变量命名要与后端保持一致。
  • 此目录对应后端 API 接口，按照后端一个controller 一个api.js文件。若项目较大时，可以按照业务划分子目录，并与后端保持一致。
  • api中的方法名字要与后端 api url 尽量保持语义高度一致性。
  • 对于 api中的每个方法要添加注释，注释与后端swagger 接口文档保持一致。

正例:

后端ulr:EmployeeController.java

/employee/add
/employee/delete/id
/employee/update

前端:employee.js

//添加员工
addEmployee:(data)=>{
	rerutn postAxios('/employee/add',data)
}
//更新员工
updateEmployee:(data)=>{
	rerutn postAxios('/employee/update',data)
}
//删除员工
deleteEmployee:(employeeId)=>{
	rerutn postAxios('/employee/delete/'+employeeId)
}

2. assets目录
assels 为静态资源，里面存放 images,styles,icons等静态资源，静态资源命名格式为 kebab-case

|-- assets
|-- images
|  |-- background-color.png
|  |-- upload-header.png
|-- styles

3.components目录
此目录应按照组件进行目录划分，目录命名为KebabCase，组件命名规则也为KebabCase

|--  error-log
|  |--index.vue
|  |-- index.less
|-- markdow-editor
|  |--index.vue
|  |--index.js
|-- kebab-case

4.constants 目录
此目录存放项目所有常量，如果常量在vue 中使用，请使用vue-enum 插件(https://gitee.com/lab1024/vue-enum)
vue-enum
目录结构:

|--  index.js
|--  role.js
|--  employee.js

例子：index.js

export let enumInfo = {
    SOURCE_IN_TYPE: {
        PURCHASE_IN: {
            value: 1,
            desc: '采购入库'
        },
        REFUND_IN: {
            value: 2,
            desc: '退货入库'
        },
        CHECK_IN: {
            value: 3,
            desc: '盘点入库'
        },
        CONFIRM_IN: {
            value: 4,
            desc: '取消订单入库'
        }
    }
}

5.router与store 目录

这两个目录一定要将业务进行拆分，不能放到一个文件里。
router 尽量按照 views 中的结构保持一致
srore 按照业务进行拆分不同的正文件

6.views 目录

  • 命名要与后端、router、api等保持一致
  • components 中组件要使用 Pascalcase 规则
|-- views				视图目录
|  |-- role				role模块名
|  |-- role-list.vue		role列表页面
|  |-- role-add. vue		role新建页面
|  |-- role-update.vue		role更新页面
|  |-- index.less			role模块样式
|  |-- components			role模块通用组件文件夹
|  |  |-- role-header.vue			role头部组件
|  |  |-- role-modal.vue			role弹出窗组件
|  |-- employee			employee模块
|  |-- behavior-log		行为日志log模块
|  |-- code-generator	代码生成器模块
👉2.4、注释说明

整理必须加注释的地方

  • 公共组件使用说明
  • api 目录的接口js 文件必须加注释
  • store 中的 state,mutation, action等必须加注释
  • vue 文件中的template 必须加注释，若文件较大添加 slart end 注释
  • vue 文件的 methods，每个method 必须添加注释
  • vue 文件的 data,非常见单词要加注释
👉2.5、其他
  1. 尽量不要手动操作 DOM
    因使用 vue 框架，所以在项目开发中尽量使用 vue 的数据驱动更新 DOM，尽量(不到万不得已)不要手动操作DOM，包括:增删改 dom 元素、以及更改样式、添加事件等
  2. 删除无用代码
    因使用了 git/svn 等代码版本工具，对于无用代码必须及时删除，例如:一些调试的console 语句、无用的弃用功能代码.

✒️总结

如果这篇【文章】有帮助到你💖，希望可以给我点个赞👍，创作不易，如果有对前端端或者对python感兴趣的朋友,请多多关注💖💖💖，咱们一起探讨和努力！！！
👨‍🔧 个人主页 : 前端初见

前端初见
关注
  • 27
    点赞
  • 踩
  • 17
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
【前端开发必备小技巧】前端代码规范html、css篇
stc_ljc的博客
08-28 1020
规范的目的是为了编写高质量的代码，让你的团队成员每天得心情都是愉悦的，大家在一起是快乐的。
浏览器兼容性问题：前端开发者必备的解决技巧
官方推荐
08-31 5127
浏览器兼容性问题：前端开发者必备的解决技巧
vue3前端必备技能
ffkddkfk的博客
06-04 147
hello</p>，意思是将 intro 值渲染到 p 标签中。○使用语法：<p v-text="uname">hello
如何让你的代码变得更优雅？这些代码规范和技巧必须知道（进阶必备，建议收藏）
欧阳的技术博客
07-12 2万+
如何做一名优秀的程序猿？从改善每一行代码开始1. 看你的代码就知道你几斤几两2. 编程标准3. 命名规范4. 松耦合，高复用 1. 看你的代码就知道你几斤几两 1.1 面试常会犯的错 ????‍♂️：面试者 ????‍⚖️：面试官 面试前 ????‍♂️：先把简历写好，机构老师特别交代：一出去就要说三年工作经验???? ????‍♂️：面试题要背，工资不能要低了~ ????‍♂️：包装一下 ????‍♂️：… 面试中 ????‍⚖️：问题回答的不错，可以看看你最近做的项目么？ ????‍♂️：
【建议收藏】前端开发必备文档（持续更新中...）
weixin_56527169的博客
08-14 2039
记录前端学习的技术栈
前端面试技巧和注意事项_前端面试必备技巧
weixin_39724382的博客
12-21 304
2020最全的前端面试指南，一个多月 1.8w 字的面试经验积累，凭借它最终成功入职大厂……今年的金三银四刚好赶上疫情，很多大公司都停止招聘甚至裁员，想跳槽的小伙伴被打的措手不及。需求减少要求肯定随之提高，谨以此面经献给在如此艰难之时逆风而动、勇敢坚强的你~前言今年问的难度和深度应该比前几年有所增加，下面从总体分析和重要点两个维度来分析一下：总体分析前端问的最多的还是 js基础、计算机网络基础等，...
vscode 前端常用必备插件汇总。
热门推荐
前端技术栈
01-14 4万+
持续更新，欢迎推荐好的插件。 1. vscode基础智能能提示类插件 2. vscode美化优化类插件 3. vscode各大框架辅助插件 4. markdown工具类插件
vscode 前端常用必备插件汇总
2301_78850344的博客
05-06 978
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。因此收集整理了一份《2024年Web前端开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！
前端开发书籍分享
m0_67537062的博客
04-08 1244
​为了方便前端开发者搜寻书籍，这期间一直在持续搜集各种前端书籍的电子版，从最初的几十本到后来的两百本，截至今天，一共搜集了330本前端书籍。在这里统一作一个整理，分享给前端开发者。电子书下载地址：链接：https://pan.baidu.com/s/1hTH5NpNhEy0hL0GMtYhLuQ?pwd=zhfi提取码11：zhfi百度网盘链接经常失效，如果失效了请加这个百度网盘群(725669278)。我在这个百度网盘群的群共享里面放了一份资料，可以直接去下载。
超400集前端全栈精英开发班培训课程 前端大神全程亲授 十大专题打造前端高级架构师
09-21
### 超400集前端全栈精英开发班培训课程知识点详解 #### 一、课程概述 本课程为前端全栈精英开发班培训课程，共计超过400集视频教程，由资深前端专家亲自授课。该课程面向零基础学员至具备一定基础的开发者，通过...
前端面试必备技巧（二）重难点梳理
solocoder的博客
06-05 1249
针对面试中出镜率比较高的重难点知识梳理。 相比于第一篇 前端面试必备技巧，本篇文章更贴合今年的面试实际。第一篇比较全面，也比较基础，建议先看一遍上一篇再看本篇会更容易理解。 一、ES6常见用法 关于 ES6（泛指 ECMAScript 2015 及以后的版本）几乎是面试必问的，一般的问法是：“平常会使用 ES6 吗？列举几个 ES6 的用法”。 回答出来三四个就差不多了，但回答的每一个都要弄清楚，有的面试官会延伸着追问。 如果时间充足，还是建议看看 阮一峰的 ES6 入门教程 。 1.1 let 和 c
web前端开发规范，CSS如何清除默认样式
m0_60143737的博客
07-23 489
如果你正在使用 React.js 或 React Native 创建用户界面，可以试一试本文推荐的这些框架。 React.js 和 React Native 是流行的用户界面（UI）开发平台，且都是开源技术。在 StackOverflow 的 2019 年开发人员调查中，它们在期望度和使用率方面都有很高的排名。React.js 是 Facebook 在 2011 年作为一个 JavaScript 库开发而成的，目的是满足跨平台、动态和高性能 UI 的需求；而 Facebook 在 2015 年发布的 Rea
后端输出二进制数据，前端fetch接受二进制数据，并转化为字符输出
cdcdhj的博客
09-01 501
在这个前端代码中，我们使用fetch API请求PHP脚本，并获取二进制数据。然后，我们将ArrayBuffer转换为字符串，以便在JavaScript中使用。在PHP中，你可以将字符串或其他数据类型转换为二进制数据，并通过HTTP响应发送给前端。
从面向对象(OOP)到面向切面(AOP)：编程范式的演变
妍思码匠的博客
08-30 1386
本文深入探讨了面向切面编程（AOP）在前端开发中的应用，解释了AOP如何通过动态增强与代码复用、降低模块间耦合度，为前端项目带来更高效、更模块化的解决方案。通过具体案例分析，如日志记录切面和动态埋点的实现，展示了如何利用装饰器模式、高阶组件等技术在前端实现AOP。理解AOP的原理与实践，将有助于开发者构建更易于维护和扩展的前端应用。无论你是前端新手还是资深开发者，本文都将为你提供有价值的见解和实用技巧。
vue3使用-watch监听总结
weixin_44072254的博客
09-01 497
{deep: true, immediate: true, flush: 'post'}：deep是深度监听；flush:如果想在侦听器回调中能访问被 Vue 更新之后的所属组件的 DOM就用'post'，sync'创建一个同步触发的侦听器，它会在 Vue 进行任何更新之前触发；flush: 'post'， 如果想在侦听器回调中能访问被 Vue 更新之后的所属组件的 DOM就用'post'flush: sync'，创建一个同步触发的侦听器，它会在 Vue 进行任何更新之前触发。监听数组的方式-示例。
深入理解JavaScript闭包：避免常见的内存泄漏问题
最新发布
官方推荐
09-02 3791
深入理解JavaScript闭包：避免常见的内存泄漏问题
KEYSIGHT是德 Infiniium EXR系列 示波器
XLTYQYB的博客
08-29 1442
该系列的所有型号都集成了一个 10 位 ADC，并且在所有通道上同时提供 16 GSa/s 的采样率。高分辨率 ADC 的效用取决于示波器的前端底噪是否足够低以提供与之匹配的额外的量化电平空间。我们的低噪声前 端包含定制 IC，例如 130 纳米 BiCMOS IC（其中集成了用户可选的模拟滤波器），并且带宽可通过软件 许可证升级。使用硬件滤波时，噪声低至 43 μV，系统 ENOB 达到 9.0 位。Infiniium EXR系列 示波器 型号比较。垂直分辨率是 8 位示波器的 4 倍。
Vue前端开发规范：提升团队协作效率
Vue前端开发规范是一份旨在提升团队协作效率和代码可维护性的文档。它强调了编码规范在软件开发过程中的重要性，尤其是在大型项目中，一致的编码风格能够降低沟通成本，增强代码可读性。规范并不是一成不变的，而是...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

前端初见

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值